feat: Add setContext on scope (#2026)

* feat: Add setContext on scope

* meta: Add changelog

Author: HazAT

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- [hub] feat: Add `setContext` on the scope
+
 ## 5.0.8
 
 - [core] fix: Don't disable client before flushing

packages/hub/src/scope.ts

@@ -27,6 +27,9 @@ export class Scope implements ScopeInterface {
   /** Extra */
   protected _extra: { [key: string]: any } = {};
 
+  /** Contexts */
+  protected _context: { [key: string]: any } = {};
+
   /** Fingerprint */
   protected _fingerprint?: string[];
 
@@ -162,6 +165,15 @@ export class Scope implements ScopeInterface {
     return this;
   }
 
+  /**
+   * @inheritDoc
+   */
+  public setContext(name: string, context: { [key: string]: any } | null): this {
+    this._context[name] = context ? normalize(context) : undefined;
+    this._notifyScopeListeners();
+    return this;
+  }
+
   /**
    * Inherit values from the parent scope.
    * @param scope to clone.
@@ -175,6 +187,7 @@ export class Scope implements ScopeInterface {
       newScope._breadcrumbs = [...scope._breadcrumbs];
       newScope._tags = { ...scope._tags };
       newScope._extra = { ...scope._extra };
+      newScope._context = { ...scope._context };
       newScope._user = scope._user;
       newScope._level = scope._level;
       newScope._fingerprint = scope._fingerprint;
@@ -191,6 +204,7 @@ export class Scope implements ScopeInterface {
     this._tags = {};
     this._extra = {};
     this._user = {};
+    this._context = {};
     this._level = undefined;
     this._fingerprint = undefined;
     this._notifyScopeListeners();
@@ -263,6 +277,9 @@ export class Scope implements ScopeInterface {
     if (this._user && Object.keys(this._user).length) {
       event.user = { ...this._user, ...event.user };
     }
+    if (this._context && Object.keys(this._context).length) {
+      event.contexts = { ...this._context, ...event.contexts };
+    }
     if (this._level) {
       event.level = this._level;
     }

packages/hub/test/scope.test.ts

@@ -1,11 +1,13 @@
 import { Event, EventHint, Severity } from '@sentry/types';
+import { getGlobalObject } from '@sentry/utils';
 
-import { Scope } from '../src';
+import { addGlobalEventProcessor, Scope } from '../src';
 
 describe('Scope', () => {
   afterEach(() => {
     jest.resetAllMocks();
     jest.useRealTimers();
+    getGlobalObject<any>().__SENTRY__.globalEventProcessors = undefined;
   });
 
   describe('fingerprint', () => {
@@ -59,6 +61,7 @@ describe('Scope', () => {
     });
     test('unset', () => {
       const scope = new Scope();
+      scope.setUser({ id: '1' });
       scope.setUser(null);
       expect((scope as any)._user).toEqual(null);
     });
@@ -80,6 +83,20 @@ describe('Scope', () => {
     });
   });
 
+  describe('context', () => {
+    test('set', () => {
+      const scope = new Scope();
+      scope.setContext('os', { id: '1' });
+      expect((scope as any)._context.os).toEqual({ id: '1' });
+    });
+    test('unset', () => {
+      const scope = new Scope();
+      scope.setContext('os', { id: '1' });
+      scope.setContext('os', null);
+      expect((scope as any)._user).toEqual({});
+    });
+  });
+
   test('chaining', () => {
     const scope = new Scope();
     scope.setLevel(Severity.Critical).setUser({ id: '1' });
@@ -113,14 +130,15 @@ describe('Scope', () => {
   });
 
   test('applyToEvent', () => {
-    expect.assertions(6);
+    expect.assertions(7);
     const scope = new Scope();
     scope.setExtra('a', 2);
     scope.setTag('a', 'b');
     scope.setUser({ id: '1' });
     scope.setFingerprint(['abcd']);
     scope.setLevel(Severity.Warning);
     scope.addBreadcrumb({ message: 'test' }, 100);
+    scope.setContext('os', { id: '1' });
     const event: Event = {};
     return scope.applyToEvent(event).then(processedEvent => {
       expect(processedEvent!.extra).toEqual({ a: 2 });
@@ -129,19 +147,22 @@ describe('Scope', () => {
       expect(processedEvent!.fingerprint).toEqual(['abcd']);
       expect(processedEvent!.level).toEqual('warning');
       expect(processedEvent!.breadcrumbs![0]).toHaveProperty('message', 'test');
+      expect(processedEvent!.contexts).toEqual({ os: { id: '1' } });
     });
   });
 
   test('applyToEvent merge', () => {
-    expect.assertions(7);
+    expect.assertions(8);
     const scope = new Scope();
     scope.setExtra('a', 2);
     scope.setTag('a', 'b');
     scope.setUser({ id: '1' });
     scope.setFingerprint(['abcd']);
     scope.addBreadcrumb({ message: 'test' }, 100);
+    scope.setContext('server', { id: '2' });
     const event: Event = {
       breadcrumbs: [{ message: 'test1' }],
+      contexts: { os: { id: '1' } },
       extra: { b: 3 },
       fingerprint: ['efgh'],
       tags: { b: 'c' },
@@ -155,6 +176,10 @@ describe('Scope', () => {
       expect(processedEvent!.breadcrumbs).toHaveLength(2);
       expect(processedEvent!.breadcrumbs![0]).toHaveProperty('message', 'test1');
       expect(processedEvent!.breadcrumbs![1]).toHaveProperty('message', 'test');
+      expect(processedEvent!.contexts).toEqual({
+        os: { id: '1' },
+        server: { id: '2' },
+      });
     });
   });
 
@@ -193,6 +218,14 @@ describe('Scope', () => {
     expect((scope as any)._extra).toEqual({});
   });
 
+  test('clearBreadcrumbs', () => {
+    const scope = new Scope();
+    scope.addBreadcrumb({ message: 'test' }, 100);
+    expect((scope as any)._breadcrumbs).toHaveLength(1);
+    scope.clearBreadcrumbs();
+    expect((scope as any)._breadcrumbs).toHaveLength(0);
+  });
+
   test('addEventProcessor', () => {
     expect.assertions(3);
     const event: Event = {
@@ -218,6 +251,34 @@ describe('Scope', () => {
     });
   });
 
+  test('addEventProcessor + global', () => {
+    expect.assertions(3);
+    const event: Event = {
+      extra: { b: 3 },
+    };
+    const localScope = new Scope();
+    localScope.setExtra('a', 'b');
+
+    addGlobalEventProcessor((processedEvent: Event) => {
+      processedEvent.dist = '1';
+      return processedEvent;
+    });
+
+    localScope.addEventProcessor((processedEvent: Event) => {
+      expect(processedEvent.extra).toEqual({ a: 'b', b: 3 });
+      return processedEvent;
+    });
+
+    localScope.addEventProcessor((processedEvent: Event) => {
+      expect(processedEvent.dist).toEqual('1');
+      return processedEvent;
+    });
+
+    return localScope.applyToEvent(event).then(final => {
+      expect(final!.dist).toEqual('1');
+    });
+  });
+
   test('addEventProcessor async', async () => {
     jest.useFakeTimers();
     expect.assertions(6);

packages/types/src/scope.ts

@@ -56,6 +56,13 @@ export interface Scope {
    */
   setLevel(level: Severity): this;
 
+  /**
+   * Sets context data with the given name.
+   * @param name of the context
+   * @param context Any kind of data. This data will be normailzed.
+   */
+  setContext(name: string, context: { [key: string]: any } | null): this;
+
   /** Clears the current scope and resets its properties. */
   clear(): this;