fix: Update user type in scope.setUser for unset case (getsentry#1998)

lukyth · HazAT · commit a7c294ee1926 · 2019-04-08T08:38:33.000+02:00
According to getsentry/sentry-docs#500 (comment), we should be able to unset a user in global scope by setting a user to `null`.
diff --git a/packages/hub/src/scope.ts b/packages/hub/src/scope.ts
@@ -96,7 +96,7 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setUser(user: User): this {
+  public setUser(user: User | null): this {
     this._user = normalize(user);
     this._notifyScopeListeners();
     return this;
diff --git a/packages/hub/test/scope.test.ts b/packages/hub/test/scope.test.ts
@@ -57,6 +57,11 @@ describe('Scope', () => {
       scope.setUser({ id: '1' });
       expect((scope as any)._user).toEqual({ id: '1' });
     });
+    test('unset', () => {
+      const scope = new Scope();
+      scope.setUser(null);
+      expect((scope as any)._user).toEqual(null);
+    });
   });
 
   describe('level', () => {
diff --git a/packages/types/src/scope.ts b/packages/types/src/scope.ts
@@ -14,9 +14,9 @@ export interface Scope {
   /**
    * Updates user context information for future events.
    *
-   * @param user User context object to be set in the current context.
+   * @param user User context object to be set in the current context. Pass `null` to unset the user.
    */
-  setUser(user: User): this;
+  setUser(user: User | null): this;
 
   /**
    * Set an object that will be merged sent as tags data with the event.
