feat: Add scope inheritance

packages/core/src/base.ts

@@ -192,8 +192,9 @@ export abstract class BaseClient<B extends Backend, O extends Options>
   /**
    * @inheritDoc
    */
-  public createScope(): Scope {
+  public createScope(parentScope?: Scope): Scope {
     const newScope = new Scope();
+    newScope.setParentScope(parentScope);
     newScope.setOnChange((scope: Scope) => {
       this.getBackend().storeScope(scope);
     });

packages/core/src/scope.ts

@@ -71,7 +71,10 @@ export class Scope implements BaseScope {
    * @param tags Tags context object to merge into current context.
    */
   public setTag(key: string, value: string): void {
-    this.tags[key] = value;
+    this.tags = {
+      ...this.tags,
+      [key]: value,
+    };
     this.notifyListeners();
   }
 
@@ -80,7 +83,10 @@ export class Scope implements BaseScope {
    * @param extra Extra context object to merge into current context.
    */
   public setExtra(key: string, extra: any): void {
-    this.extra[key] = extra;
+    this.extra = {
+      ...this.extra,
+      [key]: extra,
+    };
     this.notifyListeners();
   }
 
@@ -93,6 +99,14 @@ export class Scope implements BaseScope {
     this.notifyListeners();
   }
 
+  /**
+   * Inherit values from the parent scope.
+   * @param scope
+   */
+  public setParentScope(scope?: Scope): void {
+    Object.assign(this, scope);
+  }
+
   /** Returns breadcrumbs. */
   public getBreadcrumbs(): Breadcrumb[] {
     return this.breadcrumbs;

packages/core/test/lib/scope.test.ts

@@ -0,0 +1,62 @@
+import { Scope } from '../../src/scope';
+
+describe('Scope', () => {
+  test('fingerprint', () => {
+    const scope = new Scope();
+    scope.setFingerprint(['abcd']);
+    expect(scope.getFingerprint()).toEqual(['abcd']);
+  });
+
+  test('extra', () => {
+    const scope = new Scope();
+    scope.setExtra('a', 1);
+    expect(scope.getExtra()).toEqual({ a: 1 });
+  });
+
+  test('tags', () => {
+    const scope = new Scope();
+    scope.setTag('a', 'b');
+    expect(scope.getTags()).toEqual({ a: 'b' });
+  });
+
+  test('user', () => {
+    const scope = new Scope();
+    scope.setUser({ id: '1' });
+    expect(scope.getUser()).toEqual({ id: '1' });
+  });
+
+  test('breadcrumbs', () => {
+    const scope = new Scope();
+    scope.addBreadcrumb({ message: 'test' }, 100);
+    expect(scope.getBreadcrumbs()).toEqual([{ message: 'test' }]);
+  });
+
+  test('basic inheritance', () => {
+    const parentScope = new Scope();
+    parentScope.setExtra('a', 1);
+
+    const scope = new Scope();
+    scope.setParentScope(parentScope);
+    expect(parentScope.getExtra()).toEqual(scope.getExtra());
+  });
+
+  test('parent changed inheritance', () => {
+    const parentScope = new Scope();
+    const scope = new Scope();
+    scope.setParentScope(parentScope);
+    parentScope.setExtra('a', 2);
+    expect(scope.getExtra()).toEqual({});
+    expect(parentScope.getExtra()).toEqual({ a: 2 });
+  });
+
+  test('child override inheritance', () => {
+    const parentScope = new Scope();
+    parentScope.setExtra('a', 1);
+
+    const scope = new Scope();
+    scope.setParentScope(parentScope);
+    scope.setExtra('a', 2);
+    expect(parentScope.getExtra()).toEqual({ a: 1 });
+    expect(scope.getExtra()).toEqual({ a: 2 });
+  });
+});

packages/shim/src/shim.ts

@@ -39,9 +39,13 @@ export class Shim {
    */
   public pushScope(client?: any): void {
     const usedClient = client || this.getCurrentClient();
+    // We want to clone the last scope and not create a new one
+    const stack = this.getStack();
+    const parentScope =
+      stack.length > 0 ? stack[stack.length - 1].scope : undefined;
     this.getStack().push({
       client: usedClient,
-      scope: this.createScope(usedClient),
+      scope: this.createScope(usedClient, parentScope),
       type: 'local',
     });
   }
@@ -120,11 +124,12 @@ export class Shim {
    * Obtains a new scope instance from the client.
    *
    * @param client A SDK client that implements `createScope`.
+   * @param parentScope Optional parent scope to inherit from.
    * @returns The scope instance or an empty object on error.
    */
-  public createScope(client?: any): Scope | undefined {
+  public createScope(client?: any, parentScope?: Scope): Scope | undefined {
     try {
-      return client && client.createScope();
+      return client && client.createScope(parentScope);
     } catch {
       return undefined;
     }

packages/shim/test/mocks/client.ts

@@ -17,7 +17,10 @@ export class ScopeMock implements Scope {
   }
 
   public setExtra(key: string, extra: any): void {
-    this.extra[key] = extra;
+    this.extra = {
+      ...this.extra,
+      [key]: extra,
+    };
   }
 
   public setFingerprint(fingerprint: string[]): void {
@@ -26,6 +29,8 @@ export class ScopeMock implements Scope {
 
   public clear(): void {
     this.user = undefined;
+    this.extra = {};
+    this.fingerprint = undefined;
   }
 }