feat(scope): Bring back lastEventId on isolation scope (#11951)

Author: andreiborza

packages/astro/src/index.server.ts

@@ -40,6 +40,7 @@ export {
   makeNodeTransport,
   getDefaultIntegrations,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/aws-serverless/src/index.ts

@@ -35,6 +35,7 @@ export {
   makeNodeTransport,
   NodeClient,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/browser/src/exports.ts

@@ -28,6 +28,7 @@ export {
   captureMessage,
   close,
   createTransport,
+  lastEventId,
   flush,
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub,

packages/bun/src/index.ts

@@ -55,6 +55,7 @@ export {
   makeNodeTransport,
   NodeClient,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/core/src/baseclient.ts

@@ -650,6 +650,11 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 
     this.emit('preprocessEvent', event, hint);
 
+    const eventId = event.event_id || hint.event_id;
+    if (eventId) {
+      isolationScope.setLastEventId(eventId);
+    }
+
     return prepareEvent(options, event, hint, currentScope, this, isolationScope).then(evt => {
       if (evt === null) {
         return evt;

packages/core/src/exports.ts

@@ -120,6 +120,14 @@ export function setUser(user: User | null): void {
   getIsolationScope().setUser(user);
 }
 
+/**
+ * The last event id of the isolation scope.
+ * @returns The last event id of the isolation scope.
+ */
+export function lastEventId(): string | undefined {
+  return getIsolationScope().lastEventId();
+}
+
 /**
  * Create a cron monitor check in and send it to Sentry.
  *

packages/core/src/index.ts

@@ -15,6 +15,7 @@ export {
   captureException,
   captureEvent,
   captureMessage,
+  lastEventId,
   close,
   flush,
   setContext,

packages/core/src/scope.ts

@@ -94,6 +94,9 @@ export class Scope implements ScopeInterface {
   /** The client on this scope */
   protected _client?: Client;
 
+  /** Contains the last event id of a captured event.  */
+  protected _lastEventId?: string;
+
   // NOTE: Any field which gets added here should get added not only to the constructor but also to the `clone` method.
 
   public constructor() {
@@ -130,6 +133,7 @@ export class Scope implements ScopeInterface {
     newScope._sdkProcessingMetadata = { ...this._sdkProcessingMetadata };
     newScope._propagationContext = { ...this._propagationContext };
     newScope._client = this._client;
+    newScope._lastEventId = this._lastEventId;
 
     _setSpanForScope(newScope, _getSpanForScope(this));
 
@@ -143,13 +147,27 @@ export class Scope implements ScopeInterface {
     this._client = client;
   }
 
+  /**
+   * @inheritDoc
+   */
+  public setLastEventId(lastEventId: string | undefined): void {
+    this._lastEventId = lastEventId;
+  }
+
   /**
    * @inheritDoc
    */
   public getClient<C extends Client>(): C | undefined {
     return this._client as C | undefined;
   }
 
+  /**
+   * @inheritDoc
+   */
+  public lastEventId(): string | undefined {
+    return this._lastEventId;
+  }
+
   /**
    * @inheritDoc
    */

packages/core/test/lib/base.test.ts

@@ -1,7 +1,15 @@
 import type { Client, Envelope, ErrorEvent, Event, TransactionEvent } from '@sentry/types';
 import { SentryError, SyncPromise, dsnToString, logger } from '@sentry/utils';
 
-import { Scope, addBreadcrumb, getCurrentScope, getIsolationScope, makeSession, setCurrentClient } from '../../src';
+import {
+  Scope,
+  addBreadcrumb,
+  getCurrentScope,
+  getIsolationScope,
+  lastEventId,
+  makeSession,
+  setCurrentClient,
+} from '../../src';
 import * as integrationModule from '../../src/integration';
 import { TestClient, getDefaultTestClientOptions } from '../mocks/client';
 import { AdHocIntegration, TestIntegration } from '../mocks/integration';
@@ -226,7 +234,6 @@ describe('BaseClient', () => {
       const client = new TestClient(options);
 
       client.captureException(new Error('test exception'));
-
       expect(TestClient.instance!.event).toEqual(
         expect.objectContaining({
           environment: 'production',
@@ -244,6 +251,14 @@ describe('BaseClient', () => {
       );
     });
 
+    test('sets the correct lastEventId', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      const client = new TestClient(options);
+
+      const eventId = client.captureException(new Error('test exception'));
+      expect(eventId).toEqual(lastEventId());
+    });
+
     test('allows for providing explicit scope', () => {
       const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
       const client = new TestClient(options);
@@ -343,6 +358,14 @@ describe('BaseClient', () => {
       );
     });
 
+    test('sets the correct lastEventId', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      const client = new TestClient(options);
+
+      const eventId = client.captureMessage('test message');
+      expect(eventId).toEqual(lastEventId());
+    });
+
     test('should call `eventFromException` if input to `captureMessage` is not a primitive', () => {
       const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
       const client = new TestClient(options);
@@ -444,6 +467,14 @@ describe('BaseClient', () => {
       );
     });
 
+    test('sets the correct lastEventId', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      const client = new TestClient(options);
+
+      const eventId = client.captureEvent({ message: 'message' }, undefined);
+      expect(eventId).toEqual(lastEventId());
+    });
+
     test('does not overwrite existing timestamp', () => {
       expect.assertions(2);
 

packages/deno/src/index.ts

@@ -30,6 +30,7 @@ export {
   close,
   createTransport,
   continueTrace,
+  lastEventId,
   flush,
   getClient,
   isInitialized,

packages/google-cloud-serverless/src/index.ts

@@ -35,6 +35,7 @@ export {
   makeNodeTransport,
   NodeClient,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/node/src/index.ts

@@ -56,6 +56,7 @@ export {
   addBreadcrumb,
   isInitialized,
   getGlobalScope,
+  lastEventId,
   close,
   createTransport,
   flush,

packages/remix/src/index.server.ts

@@ -43,6 +43,7 @@ export {
   makeNodeTransport,
   getDefaultIntegrations,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/remix/src/index.types.ts

@@ -30,5 +30,6 @@ export declare const continueTrace: typeof clientSdk.continueTrace;
 
 export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
 export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
+export const lastEventId = runtime === 'client' ? clientSdk.lastEventId : serverSdk.lastEventId;
 
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;

packages/sveltekit/src/index.types.ts

@@ -48,6 +48,7 @@ export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
 
 export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
 export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
+export declare function lastEventId(): string | undefined;
 
 export declare const continueTrace: typeof clientSdk.continueTrace;
 

packages/sveltekit/src/server/index.ts

@@ -36,6 +36,7 @@ export {
   makeNodeTransport,
   getDefaultIntegrations,
   defaultStackParser,
+  lastEventId,
   flush,
   close,
   getSentryRelease,

packages/types/src/scope.ts

@@ -59,6 +59,18 @@ export interface Scope {
    */
   getClient<C extends Client>(): C | undefined;
 
+  /**
+   * Sets the last event id on the scope.
+   * @param lastEventId The last event id of a captured event.
+   */
+  setLastEventId(lastEventId: string | undefined): void;
+
+  /**
+   * This is the getter for lastEventId.
+   * @returns The last event id of a captured event.
+   */
+  lastEventId(): string | undefined;
+
   /**
    * Add internal on change listener. Used for sub SDKs that need to store the scope.
    * @hidden

packages/vercel-edge/src/index.ts

@@ -30,6 +30,7 @@ export {
   captureFeedback,
   close,
   createTransport,
+  lastEventId,
   flush,
   getClient,
   isInitialized,