feat(crons): Add interface for heartbeat checkin (#9706)

Author: Luca Forstner

packages/core/src/server-runtime-client.ts

@@ -147,7 +147,7 @@ export class ServerRuntimeClient<
    * to create a monitor automatically when sending a check in.
    */
   public captureCheckIn(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string {
-    const id = checkIn.status !== 'in_progress' && checkIn.checkInId ? checkIn.checkInId : uuid4();
+    const id = 'checkInId' in checkIn && checkIn.checkInId ? checkIn.checkInId : uuid4();
     if (!this._isEnabled()) {
       DEBUG_BUILD && logger.warn('SDK not enabled, will not capture checkin.');
       return id;
@@ -164,7 +164,7 @@ export class ServerRuntimeClient<
       environment,
     };
 
-    if (checkIn.status !== 'in_progress') {
+    if ('duration' in checkIn) {
       serializedCheckIn.duration = checkIn.duration;
     }
 

packages/node/test/client.test.ts

@@ -354,6 +354,38 @@ describe('NodeClient', () => {
       ]);
     });
 
+    it('sends a checkIn envelope for heartbeat checkIns', () => {
+      const options = getDefaultNodeClientOptions({
+        dsn: PUBLIC_DSN,
+        serverName: 'server',
+        release: '1.0.0',
+        environment: 'dev',
+      });
+      client = new NodeClient(options);
+
+      // @ts-expect-error accessing private method
+      const sendEnvelopeSpy = jest.spyOn(client, '_sendEnvelope');
+
+      const id = client.captureCheckIn({ monitorSlug: 'heartbeat-monitor', status: 'ok' });
+
+      expect(sendEnvelopeSpy).toHaveBeenCalledTimes(1);
+      expect(sendEnvelopeSpy).toHaveBeenCalledWith([
+        expect.any(Object),
+        [
+          [
+            expect.any(Object),
+            {
+              check_in_id: id,
+              monitor_slug: 'heartbeat-monitor',
+              status: 'ok',
+              release: '1.0.0',
+              environment: 'dev',
+            },
+          ],
+        ],
+      ]);
+    });
+
     it('does not send a checkIn envelope if disabled', () => {
       const options = getDefaultNodeClientOptions({ dsn: PUBLIC_DSN, serverName: 'bar', enabled: false });
       client = new NodeClient(options);

packages/types/src/checkin.ts

@@ -43,6 +43,13 @@ export interface SerializedCheckIn {
   };
 }
 
+export interface HeartbeatCheckIn {
+  // The distinct slug of the monitor.
+  monitorSlug: SerializedCheckIn['monitor_slug'];
+  // The status of the check-in.
+  status: 'ok' | 'error';
+}
+
 export interface InProgressCheckIn {
   // The distinct slug of the monitor.
   monitorSlug: SerializedCheckIn['monitor_slug'];
@@ -61,7 +68,7 @@ export interface FinishedCheckIn {
   duration?: SerializedCheckIn['duration'];
 }
 
-export type CheckIn = InProgressCheckIn | FinishedCheckIn;
+export type CheckIn = HeartbeatCheckIn | InProgressCheckIn | FinishedCheckIn;
 
 type SerializedMonitorConfig = NonNullable<SerializedCheckIn['monitor_config']>;