feat: SDK unified API (#1402)

* feat: Add/change functions on hub/minimal to conform unified api

* fix: Domain tests

* feat: Add event processor

* fix: Scope init

* ref: Rename main to default hub

Author: HazAT

packages/browser/src/index.ts

@@ -19,11 +19,11 @@ export {
   configureScope,
 } from '@sentry/minimal';
 
-export { getGlobalHub, Hub, Scope } from '@sentry/hub';
+export { getDefaultHub, Hub, Scope } from '@sentry/hub';
 
 export { BrowserBackend, BrowserOptions } from './backend';
 export { BrowserClient } from './client';
-export { init, getCurrentClient } from './sdk';
+export { init } from './sdk';
 
 import * as Integrations from './integrations';
 export { Integrations };

packages/browser/src/sdk.ts

@@ -1,5 +1,4 @@
 import { initAndBind } from '@sentry/core';
-import { getCurrentClient as shimGetCurrentClient } from '@sentry/minimal';
 import { BrowserOptions } from './backend';
 import { BrowserClient } from './client';
 import {
@@ -62,8 +61,3 @@ export function init(options: BrowserOptions): void {
     new Breadcrumbs(),
   ]);
 }
-
-/** Returns the current BrowserClient, if any. */
-export function getCurrentClient(): BrowserClient {
-  return shimGetCurrentClient() as BrowserClient;
-}

packages/browser/test/index.test.ts

@@ -9,7 +9,7 @@ import {
   captureException,
   captureMessage,
   configureScope,
-  getGlobalHub,
+  getDefaultHub,
   init,
   Scope,
   SentryEvent,
@@ -25,11 +25,11 @@ describe('SentryBrowser', () => {
   });
 
   beforeEach(() => {
-    getGlobalHub().pushScope();
+    getDefaultHub().pushScope();
   });
 
   afterEach(() => {
-    getGlobalHub().popScope();
+    getDefaultHub().popScope();
   });
 
   describe('getContext() / setContext()', () => {
@@ -75,7 +75,8 @@ describe('SentryBrowser', () => {
     });
 
     it('should record auto breadcrumbs', done => {
-      getGlobalHub().pushScope(
+      getDefaultHub().pushScope();
+      getDefaultHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.breadcrumbs!).to.have.lengthOf(3);
@@ -97,7 +98,7 @@ describe('SentryBrowser', () => {
       addBreadcrumb({ message: 'test2' });
 
       captureMessage('event');
-      getGlobalHub().popScope();
+      getDefaultHub().popScope();
     });
   });
 
@@ -115,7 +116,8 @@ describe('SentryBrowser', () => {
     });
 
     it('should capture an exception', done => {
-      getGlobalHub().pushScope(
+      getDefaultHub().pushScope();
+      getDefaultHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.exception).to.not.be.undefined;
@@ -133,11 +135,12 @@ describe('SentryBrowser', () => {
       } catch (e) {
         captureException(e);
       }
-      getGlobalHub().popScope();
+      getDefaultHub().popScope();
     });
 
     it('should capture a message', done => {
-      getGlobalHub().pushScope(
+      getDefaultHub().pushScope();
+      getDefaultHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.message).to.equal('test');
@@ -148,11 +151,12 @@ describe('SentryBrowser', () => {
         }),
       );
       captureMessage('test');
-      getGlobalHub().popScope();
+      getDefaultHub().popScope();
     });
 
     it('should capture an event', done => {
-      getGlobalHub().pushScope(
+      getDefaultHub().pushScope();
+      getDefaultHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.message).to.equal('test');
@@ -163,7 +167,7 @@ describe('SentryBrowser', () => {
         }),
       );
       captureEvent({ message: 'test' });
-      getGlobalHub().popScope();
+      getDefaultHub().popScope();
     });
   });
 });

packages/core/src/sdk.ts

@@ -1,7 +1,4 @@
-import {
-  bindClient as shimBindClient,
-  getCurrentClient as shimGetCurrentClient,
-} from '@sentry/minimal';
+import { getDefaultHub } from '@sentry/hub';
 import { Integration } from '@sentry/types';
 import { Client, Options } from './interfaces';
 
@@ -23,7 +20,7 @@ export function initAndBind<F extends Client, O extends Options>(
   options: O,
   defaultIntegrations: Integration[] = [],
 ): void {
-  if (shimGetCurrentClient()) {
+  if (getDefaultHub().getClient()) {
     return;
   }
 
@@ -44,5 +41,5 @@ export function initAndBind<F extends Client, O extends Options>(
     });
   }
 
-  shimBindClient(client);
+  getDefaultHub().bindClient(client);
 }

packages/hub/src/global.ts

@@ -21,19 +21,19 @@ global.__SENTRY__ = global.__SENTRY__ || {
 };
 
 /** Returns the global shim registry. */
-export function getGlobalCarrier(): Carrier {
+export function getMainCarrier(): Carrier {
   return global.__SENTRY__;
 }
 
 /**
- * Returns the latest global hum instance.
+ * Returns the default hub instance.
  *
  * If a hub is already registered in the global carrier but this module
  * contains a more recent version, it replaces the registered version.
  * Otherwise, the currently registered hub will be returned.
  */
-export function getGlobalHub(): Hub {
-  const registry = getGlobalCarrier();
+export function getDefaultHub(): Hub {
+  const registry = getMainCarrier();
 
   if (!registry.hub || registry.hub.isOlderThan(API_VERSION)) {
     registry.hub = new Hub();

packages/hub/src/hub.ts

@@ -8,18 +8,23 @@ import { Scope } from './scope';
  * working in case we have a version conflict.
  */
 export class Hub {
+  /** Is a {@link Layer}[] containing the client and scope */
+  private readonly stack: Layer[] = [];
+
   /**
-   * Creates a new instance of the hub
-   * @param stack Is a {@link Layer}[] containing the client and scope
+   * Creates a new instance of the hub, will push one {@link Layer} into the
+   * internal stack on creation.
+   *
+   * @param client bound to the hub.
+   * @param scope bound to the hub.
    * @param version number, higher number means higher priority.
    */
   public constructor(
-    private readonly stack: Layer[] = [],
+    client?: any,
+    scope: Scope = new Scope(),
     private readonly version: number = API_VERSION,
   ) {
-    if (stack.length === 0) {
-      this.stack.push({ scope: this.createScope(), type: 'process' });
-    }
+    this.stack.push({ client, scope });
   }
 
   /**
@@ -28,7 +33,7 @@ export class Hub {
    * @param method The method to call on the client/client.
    * @param args Arguments to pass to the client/fontend.
    */
-  public _invokeClient(method: string, ...args: any[]): void {
+  private invokeClient(method: string, ...args: any[]): void {
     const top = this.getStackTop();
     if (top && top.client && top.client[method]) {
       top.client[method](...args, top.scope);
@@ -61,25 +66,42 @@ export class Hub {
     return this.version < version;
   }
 
+  /**
+   * This binds the given client to the current scope.
+   * @param client An SDK client (client) instance.
+   */
+  public bindClient(client?: any): void {
+    const top = this.getStackTop();
+    top.client = client;
+    if (top && top.scope && client) {
+      top.scope.addScopeListener((s: Scope) => {
+        if (client.getBackend) {
+          try {
+            client.getBackend().storeScope(s);
+          } catch {
+            // Do nothing
+          }
+        }
+      });
+    }
+  }
+
   /**
    * Create a new scope to store context information.
    *
    * The scope will be layered on top of the current one. It is isolated, i.e. all
    * breadcrumbs and context information added to this scope will be removed once
    * the scope ends. Be sure to always remove this scope with {@link this.popScope}
    * when the operation finishes or throws.
-   * @param client Optional client, defaults to the current client.
    */
-  public pushScope(client?: any): void {
-    const usedClient = client || this.getCurrentClient();
+  public pushScope(): void {
     // We want to clone the content of prev scope
     const stack = this.getStack();
     const parentScope =
       stack.length > 0 ? stack[stack.length - 1].scope : undefined;
     this.getStack().push({
-      client: usedClient,
-      scope: this.createScope(parentScope),
-      type: 'local',
+      client: this.getClient(),
+      scope: Scope.clone(parentScope),
     });
   }
 
@@ -95,34 +117,20 @@ export class Hub {
   }
 
   /**
-   * Creates a new scope with a custom client instance and executes the given
-   * operation within. The scope is automatically removed once the operation
+   * Creates a new scope with and executes the given operation within.
+   * The scope is automatically removed once the operation
    * finishes or throws.
    *
-   * The client can be configured with different options than the enclosing scope,
-   * such as a different DSN or other callbacks.
-   *
    * This is essentially a convenience function for:
    *
-   *     pushScope(client);
+   *     pushScope();
    *     callback();
    *     popScope();
    *
-   * @param arg1 Either the client or callback.
-   * @param arg2 Either the client or callback.
+   * @param callback that will be enclosed into push/popScope.
    */
-  public withScope(arg1: (() => void) | any, arg2?: (() => void) | any): void {
-    let callback: () => void = arg1;
-    let client: any = arg2;
-    if (!!(arg1 && arg1.constructor && arg1.call && arg1.apply)) {
-      callback = arg1;
-      client = arg2;
-    }
-    if (!!(arg2 && arg2.constructor && arg2.call && arg2.apply)) {
-      callback = arg2;
-      client = arg1;
-    }
-    this.pushScope(client);
+  public withScope(callback: (() => void)): void {
+    this.pushScope();
     try {
       callback();
     } finally {
@@ -131,7 +139,7 @@ export class Hub {
   }
 
   /** Returns the client of the currently active scope. */
-  public getCurrentClient(): any | undefined {
+  public getClient(): any | undefined {
     return this.getStackTop().client;
   }
 
@@ -145,18 +153,6 @@ export class Hub {
     return this.stack[this.stack.length - 1];
   }
 
-  /**
-   * Obtains a new scope instance from the client.
-   *
-   * @param parentScope Optional parent scope to inherit from.
-   * @returns The scope instance or an empty object on error.
-   */
-  public createScope(parentScope?: Scope): Scope {
-    const newScope = new Scope();
-    newScope.setParentScope(parentScope);
-    return newScope;
-  }
-
   /**
    * Captures an exception event and sends it to Sentry.
    *
@@ -193,7 +189,7 @@ export class Hub {
    * @param breadcrumb The breadcrumb to record.
    */
   public addBreadcrumb(breadcrumb: Breadcrumb): void {
-    this._invokeClient('addBreadcrumb', breadcrumb);
+    this.invokeClient('addBreadcrumb', breadcrumb);
   }
 
   /**
@@ -208,4 +204,15 @@ export class Hub {
       callback(top.scope);
     }
   }
+
+  /**
+   * This will be called to receive the event
+   * @param callback
+   */
+  public addEventProcessor(callback: () => (event: SentryEvent) => void): void {
+    const top = this.getStackTop();
+    if (top.scope && top.client) {
+      top.scope.addEventProcessor(callback());
+    }
+  }
 }

packages/hub/src/index.ts

@@ -1,4 +1,4 @@
-export { Carrier, Layer, LayerType } from './interfaces';
+export { Carrier, Layer } from './interfaces';
 export { Scope } from './scope';
 export { Hub } from './hub';
-export { getGlobalHub, getHubFromCarrier } from './global';
+export { getDefaultHub, getHubFromCarrier } from './global';

packages/hub/src/interfaces.ts

@@ -1,14 +1,10 @@
 import { Hub } from './hub';
 import { Scope } from './scope';
 
-/** The type of a process stack layer. */
-export type LayerType = 'process' | 'local';
-
 /** A layer in the process stack. */
 export interface Layer {
   client?: any;
   scope?: Scope;
-  type: LayerType;
 }
 
 /** An object that contains a hub and maintains a scope stack. */