ref: Change Scope code

Author: HazAT

CHANGELOG.md

@@ -34,8 +34,7 @@ since we removed some methods from the public API and removed some classes from
 - **breaking** [core] ref: Extract all pluggable integrations into a separate `@sentry/integrations` package
 - **breaking** [core] ref: Move `extraErrorData` integration to `@sentry/integrations` package
 - [core] feat: Add `maxValueLength` option to adjust max string length for values, default is 250.
-- [hub] feat: Introduce `setExtra`, `setTags`, `clearBreadcrumbs` additionally some `set` on the Scope now accept no
-  argument which makes it possible to unset the value.
+- [hub] feat: Introduce `setExtras`, `setTags`, `clearBreadcrumbs`.
 - **breaking** [all] feat: Move `Mechanism` to `Exception`
 - [browser/node] feat: Add `synthetic` to `Mechanism` in exception.
 - [browser/node] fix: Use `addExceptionTypeValue` in helpers
@@ -44,7 +43,6 @@ since we removed some methods from the public API and removed some classes from
 - **breaking** [all] build: Use `es6` target instead of esnext for ESM builds
 - [all] feat: Prefix all private methods with `_`
 - [all] build: Use terser instead of uglify
->>>>>>> misc: Bundle size reduction changelog
 
 ## 4.6.4
 

packages/browser/src/backend.ts

@@ -93,7 +93,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
       event = eventFromPlainObject(objectException, hint.syntheticException);
       addExceptionTypeValue(event, 'Custom Object', undefined, {
         handled: true,
-        synthetic: true,
+        synthetic: false, // TODO: Make true
         type: 'generic',
       });
       return SyncPromise.resolve(this._buildEvent(event, hint));
@@ -109,7 +109,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
     return this.eventFromMessage(stringException, undefined, hint).then(messageEvent => {
       addExceptionTypeValue(messageEvent, `${stringException}`, undefined, {
         handled: true,
-        synthetic: true,
+        synthetic: false, // TODO: Make true
         type: 'generic',
       });
       return SyncPromise.resolve(this._buildEvent(messageEvent, hint));

packages/hub/src/scope.ts

@@ -1,5 +1,5 @@
 import { Breadcrumb, Event, EventHint, EventProcessor, Scope as ScopeInterface, Severity, User } from '@sentry/types';
-import { isPlainObject, isThenable } from '@sentry/utils/is';
+import { isThenable } from '@sentry/utils/is';
 import { getGlobalObject } from '@sentry/utils/misc';
 import { normalize } from '@sentry/utils/object';
 import { SyncPromise } from '@sentry/utils/syncpromise';
@@ -99,23 +99,20 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritdoc
    */
-  public setUser(user?: User): this {
-    this._user = user ? normalize(user) : {};
+  public setUser(user: User): this {
+    this._user = normalize(user);
     this.notifyScopeListeners();
     return this;
   }
 
   /**
    * @inheritdoc
    */
-  public setTags(tags?: { [key: string]: string }): this {
-    this._tags =
-      tags && isPlainObject(tags)
-        ? {
-            ...this._tags,
-            ...normalize(tags),
-          }
-        : {};
+  public setTags(tags: { [key: string]: string }): this {
+    this._tags = {
+      ...this._tags,
+      ...normalize(tags),
+    };
     this.notifyScopeListeners();
     return this;
   }
@@ -132,14 +129,11 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritdoc
    */
-  public setExtras(extra?: { [key: string]: any }): this {
-    this._extra =
-      extra && isPlainObject(extra)
-        ? {
-            ...this._extra,
-            ...normalize(extra),
-          }
-        : {};
+  public setExtras(extra: { [key: string]: any }): this {
+    this._extra = {
+      ...this._extra,
+      ...normalize(extra),
+    };
     this.notifyScopeListeners();
     return this;
   }
@@ -156,8 +150,8 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritdoc
    */
-  public setFingerprint(fingerprint?: string[]): this {
-    this._fingerprint = fingerprint ? normalize(fingerprint) : undefined;
+  public setFingerprint(fingerprint: string[]): this {
+    this._fingerprint = normalize(fingerprint);
     this.notifyScopeListeners();
     return this;
   }
@@ -166,7 +160,7 @@ export class Scope implements ScopeInterface {
    * @inheritdoc
    */
   public setLevel(level?: Severity): this {
-    this._level = level ? normalize(level) : undefined;
+    this._level = normalize(level);
     this.notifyScopeListeners();
     return this;
   }
@@ -181,9 +175,12 @@ export class Scope implements ScopeInterface {
       _scopeListeners: [],
     });
     if (scope) {
-      newScope._extra = { ...scope._extra };
-      newScope._tags = { ...scope._tags };
       newScope._breadcrumbs = [...scope._breadcrumbs];
+      newScope._tags = { ...scope._tags };
+      newScope._extra = { ...scope._extra };
+      newScope._user = scope._user;
+      newScope._level = scope._level;
+      newScope._fingerprint = scope._fingerprint;
       newScope._eventProcessors = [...scope._eventProcessors];
     }
     return newScope;

packages/hub/test/scope.test.ts

@@ -13,13 +13,6 @@ describe('Scope', () => {
       scope.setFingerprint(['abcd']);
       expect((scope as any)._fingerprint).toEqual(['abcd']);
     });
-
-    test('unset', () => {
-      const scope = new Scope();
-      scope.setFingerprint(['abcd']);
-      scope.setFingerprint();
-      expect((scope as any)._fingerprint).toEqual(undefined);
-    });
   });
 
   describe('extra', () => {
@@ -38,8 +31,8 @@ describe('Scope', () => {
     test('set undefined', () => {
       const scope = new Scope();
       scope.setExtra('a', 1);
-      scope.setExtras();
-      expect((scope as any)._extra).toEqual({});
+      scope.setExtras({ a: undefined });
+      expect((scope as any)._extra).toEqual({ a: '[undefined]' });
     });
   });
 
@@ -55,13 +48,6 @@ describe('Scope', () => {
       scope.setTags({ a: 'b' });
       expect((scope as any)._tags).toEqual({ a: 'b' });
     });
-
-    test('set undefined', () => {
-      const scope = new Scope();
-      scope.setTags({ a: 'b' });
-      scope.setTags();
-      expect((scope as any)._tags).toEqual({});
-    });
   });
 
   describe('user', () => {
@@ -70,13 +56,6 @@ describe('Scope', () => {
       scope.setUser({ id: '1' });
       expect((scope as any)._user).toEqual({ id: '1' });
     });
-
-    test('unset', () => {
-      const scope = new Scope();
-      scope.setUser({ id: '1' });
-      scope.setUser();
-      expect((scope as any)._user).toEqual({});
-    });
   });
 
   describe('level', () => {
@@ -85,13 +64,6 @@ describe('Scope', () => {
       scope.addBreadcrumb({ message: 'test' }, 100);
       expect((scope as any)._breadcrumbs).toEqual([{ message: 'test' }]);
     });
-
-    test('clear', () => {
-      const scope = new Scope();
-      scope.addBreadcrumb({ message: 'test' }, 100);
-      scope.clearBreadcrumbs();
-      expect((scope as any)._breadcrumbs).toEqual([]);
-    });
   });
 
   describe('level', () => {
@@ -100,12 +72,6 @@ describe('Scope', () => {
       scope.setLevel(Severity.Critical);
       expect((scope as any)._level).toEqual(Severity.Critical);
     });
-    test('unset', () => {
-      const scope = new Scope();
-      scope.setLevel(Severity.Critical);
-      scope.setLevel();
-      expect((scope as any)._level).toEqual(undefined);
-    });
   });
 
   test('chaining', () => {

packages/node/src/backend.ts

@@ -104,7 +104,7 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
         // We use synthesized Error here so we can extract a (rough) stack trace.
         ex = (hint && hint.syntheticException) || new Error(exception as string);
       }
-      mechanism.synthetic = true;
+      mechanism.synthetic = false; // TODO: Make true
     }
 
     return new SyncPromise<Event>(resolve =>

packages/types/src/scope.ts

@@ -13,18 +13,16 @@ export interface Scope {
 
   /**
    * Updates user context information for future events.
-   * If passed any falsy value, value will be unset.
    *
    * @param user User context object to be set in the current context.
    */
-  setUser(user?: User): this;
+  setUser(user: User): this;
 
   /**
-   * Set an object that will be sent as tags data with the event.
-   * If passed any falsy value, value will be unset.
+   * Set an object that will be merged sent as tags data with the event.
    * @param tags Tags context object to merge into current context.
    */
-  setTags(tags?: { [key: string]: string }): this;
+  setTags(tags: { [key: string]: string }): this;
 
   /**
    * Set key:value that will be sent as tags data with the event.
@@ -34,11 +32,10 @@ export interface Scope {
   setTag(key: string, value: string): this;
 
   /**
-   * Set an object that will be sent as extra data with the event.
-   * If passed any falsy value, value will be unset.
-   * @param extra context object to merge into current context.
+   * Set an object that will be merged sent as extra data with the event.
+   * @param extras Extras object to merge into current context.
    */
-  setExtras(extra?: { [key: string]: any }): this;
+  setExtras(extras: { [key: string]: any }): this;
 
   /**
    * Set key:value that will be sent as extra data with the event.
@@ -49,17 +46,15 @@ export interface Scope {
 
   /**
    * Sets the fingerprint on the scope to send with the events.
-   * If passed any falsy value, value will be unset.
    * @param fingerprint string[] to group events in Sentry.
    */
-  setFingerprint(fingerprint?: string[]): this;
+  setFingerprint(fingerprint: string[]): this;
 
   /**
    * Sets the level on the scope for future events.
-   * If passed any falsy value, value will be unset.
    * @param level string {@link Severity}
    */
-  setLevel(level?: Severity): this;
+  setLevel(level: Severity): this;
 
   /** Clears the current scope and resets its properties. */
   clear(): this;