fix(node): Make sure we use same ID for checkIns

Author: AbhiPrasad

packages/node/src/client.ts

@@ -153,8 +153,9 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
    * @param checkIn An object that describes a check in.
    * @param upsertMonitorConfig An optional object that describes a monitor config. Use this if you want
    * to create a monitor automatically when sending a check in.
+   * @returns A string representing the id of the check in.
    */
-  public captureCheckIn(checkIn: CheckIn, monitorConfig?: MonitorConfig): void {
+  public captureCheckIn(checkIn: CheckIn, monitorConfig?: MonitorConfig): string | undefined {
     if (!this._isEnabled()) {
       __DEBUG_BUILD__ && logger.warn('SDK not enabled, will not capture checkin.');
       return;
@@ -163,8 +164,10 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
     const options = this.getOptions();
     const { release, environment, tunnel } = options;
 
+    const id = checkIn.checkInId || uuid4();
+
     const serializedCheckIn: SerializedCheckIn = {
-      check_in_id: uuid4(),
+      check_in_id: id,
       monitor_slug: checkIn.monitorSlug,
       status: checkIn.status,
       duration: checkIn.duration,
@@ -183,6 +186,7 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
 
     const envelope = createCheckInEnvelope(serializedCheckIn, this.getSdkMetadata(), tunnel, this.getDsn());
     void this._sendEnvelope(envelope);
+    return id;
   }
 
   /**

packages/node/src/sdk.ts

@@ -279,6 +279,7 @@ export function captureCheckIn(
   }
 
   __DEBUG_BUILD__ && logger.warn('Cannot capture check in. No client defined.');
+  return;
 }
 
 /** Node.js stack parser */

packages/node/test/client.test.ts

@@ -294,8 +294,8 @@ describe('NodeClient', () => {
       // @ts-ignore accessing private method
       const sendEnvelopeSpy = jest.spyOn(client, '_sendEnvelope');
 
-      client.captureCheckIn(
-        { monitorSlug: 'foo', status: 'ok', duration: 1222 },
+      const id = client.captureCheckIn(
+        { monitorSlug: 'foo', status: 'in_progress' },
         {
           schedule: {
             type: 'crontab',
@@ -315,9 +315,8 @@ describe('NodeClient', () => {
             expect.any(Object),
             {
               check_in_id: expect.any(String),
-              duration: 1222,
               monitor_slug: 'foo',
-              status: 'ok',
+              status: 'in_progress',
               release: '1.0.0',
               environment: 'dev',
               monitor_config: {
@@ -333,6 +332,26 @@ describe('NodeClient', () => {
           ],
         ],
       ]);
+
+      client.captureCheckIn({ monitorSlug: 'foo', status: 'ok', duration: 1222, checkInId: id });
+
+      expect(sendEnvelopeSpy).toHaveBeenCalledTimes(2);
+      expect(sendEnvelopeSpy).toHaveBeenCalledWith([
+        expect.any(Object),
+        [
+          [
+            expect.any(Object),
+            {
+              check_in_id: id,
+              monitor_slug: 'foo',
+              duration: 1222,
+              status: 'ok',
+              release: '1.0.0',
+              environment: 'dev',
+            },
+          ],
+        ],
+      ]);
     });
 
     it('does not send a checkIn envelope if disabled', () => {

packages/types/src/checkin.ts

@@ -38,14 +38,16 @@ export interface SerializedCheckIn {
   };
 }
 
-export interface CheckIn {
+export type CheckIn = {
   // The distinct slug of the monitor.
   monitorSlug: SerializedCheckIn['monitor_slug'];
+  // Check-In ID (unique and client generated).
+  checkInId?: SerializedCheckIn['check_in_id'];
   // The status of the check-in.
   status: SerializedCheckIn['status'];
   // The duration of the check-in in seconds. Will only take effect if the status is ok or error.
   duration?: SerializedCheckIn['duration'];
-}
+};
 
 type SerializedMonitorConfig = NonNullable<SerializedCheckIn['monitor_config']>;