feat: initalScope in SDK Options (#3544)

* feat: initalScope in SDK Options

* fix: Tests

* Update packages/browser/test/unit/index.test.ts

Co-authored-by: Rodolfo Carvalho <[email protected]>

* fix: Linter

Co-authored-by: Rodolfo Carvalho <[email protected]>

Author: HazAT

packages/browser/test/unit/index.test.ts

@@ -179,6 +179,29 @@ describe('SentryBrowser initialization', () => {
     delete global.SENTRY_RELEASE;
   });
 
+  it('should use initialScope', () => {
+    init({ dsn, initialScope: { tags: { a: 'b' } } });
+    expect(global.__SENTRY__.hub._stack[0].scope._tags).to.deep.equal({ a: 'b' });
+  });
+
+  it('should use initalScope Scope', () => {
+    const scope = new Scope();
+    scope.setTags({ a: 'b' });
+    init({ dsn, initialScope: scope });
+    expect(global.__SENTRY__.hub._stack[0].scope._tags).to.deep.equal({ a: 'b' });
+  });
+
+  it('should use initalScope callback', () => {
+    init({
+      dsn,
+      initialScope: scope => {
+        scope.setTags({ a: 'b' });
+        return scope;
+      },
+    });
+    expect(global.__SENTRY__.hub._stack[0].scope._tags).to.deep.equal({ a: 'b' });
+  });
+
   it('should have initialization proceed as normal if window.SENTRY_RELEASE is not set', () => {
     // This is mostly a happy-path test to ensure that the initialization doesn't throw an error.
     init({ dsn });

packages/core/src/sdk.ts

@@ -17,6 +17,7 @@ export function initAndBind<F extends Client, O extends Options>(clientClass: Cl
     logger.enable();
   }
   const hub = getCurrentHub();
+  hub.getScope()?.update(options.initialScope);
   const client = new clientClass(options);
   hub.bindClient(client);
 }

packages/core/test/lib/sdk.test.ts

@@ -1,3 +1,4 @@
+import { Scope } from '@sentry/hub';
 import { Client, Integration } from '@sentry/types';
 
 import { installedIntegrations } from '../../src/integration';
@@ -16,11 +17,15 @@ jest.mock('@sentry/hub', () => {
     getCurrentHub(): {
       bindClient(client: Client): boolean;
       getClient(): boolean;
+      getScope(): Scope;
     } {
       return {
         getClient(): boolean {
           return false;
         },
+        getScope(): Scope {
+          return new Scope();
+        },
         bindClient(client: Client): boolean {
           client.setupIntegrations();
           return true;

packages/types/src/options.ts

@@ -2,6 +2,7 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import { Event, EventHint } from './event';
 import { Integration } from './integration';
 import { LogLevel } from './loglevel';
+import { CaptureContext } from './scope';
 import { SdkMetadata } from './sdkmetadata';
 import { SamplingContext } from './transaction';
 import { Transport, TransportClass, TransportOptions } from './transport';
@@ -124,6 +125,11 @@ export interface Options {
    */
   autoSessionTracking?: boolean;
 
+  /**
+   * Set data to the inital scope
+   */
+  initialScope?: CaptureContext;
+
   /**
    * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
    * and provide additional data about every request.