feat: Domain / integration node / hub tests (#1394)

* feat: Move get global hub to global function

* feat: Fix domain handling in node

* feat: More domain tests

* feat: Add tests for unhandled promises

* feat: Add tests for hub

* ref: Minor code changes

* ref: Only clone top stack

Author: HazAT

packages/browser/src/index.ts

@@ -19,7 +19,7 @@ export {
   configureScope,
 } from '@sentry/minimal';
 
-export { Hub, Scope } from '@sentry/hub';
+export { getGlobalHub, Hub, Scope } from '@sentry/hub';
 
 export { BrowserBackend, BrowserOptions } from './backend';
 export { BrowserClient } from './client';

packages/browser/test/index.test.ts

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

packages/hub/src/global.ts

@@ -1,5 +1,14 @@
+import { Hub } from './hub';
 import { Carrier } from './interfaces';
 
+/**
+ * API compatibility version of this hub.
+ *
+ * WARNING: This number should only be incresed when the global interface
+ * changes a and new methods are introduced.
+ */
+export const API_VERSION = 2;
+
 /** Global interface helper for type safety. */
 interface Global {
   __SENTRY__: Carrier;
@@ -15,3 +24,35 @@ global.__SENTRY__ = global.__SENTRY__ || {
 export function getGlobalCarrier(): Carrier {
   return global.__SENTRY__;
 }
+
+/**
+ * Returns the latest global hum 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();
+
+  if (!registry.hub || registry.hub.isOlderThan(API_VERSION)) {
+    registry.hub = new Hub();
+  }
+
+  return registry.hub;
+}
+
+/**
+ * This will create a new {@link Hub} and add to the passed object on
+ * __SENTRY__.hub.
+ * @param carrier object
+ */
+export function getHubFromCarrier(carrier: any): Hub {
+  if (carrier && carrier.__SENTRY__ && carrier.__SENTRY__.hub) {
+    return carrier.__SENTRY__.hub;
+  } else {
+    carrier.__SENTRY__ = {};
+    carrier.__SENTRY__.hub = new Hub();
+    return carrier.__SENTRY__.hub;
+  }
+}

packages/hub/src/hub.ts

@@ -1,16 +1,8 @@
 import { Breadcrumb, SentryEvent } from '@sentry/types';
-import { getGlobalCarrier } from './global';
+import { API_VERSION } from './global';
 import { Layer } from './interfaces';
 import { Scope } from './scope';
 
-/**
- * API compatibility version of this hub.
- *
- * WARNING: This number should only be incresed when the global interface
- * changes a and new methods are introduced.
- */
-export const API_VERSION = 2;
-
 /**
  * Internal class used to make sure we always have the latest internal functions
  * working in case we have a version conflict.
@@ -23,30 +15,13 @@ export class Hub {
    */
   public constructor(
     private readonly stack: Layer[] = [],
-    public readonly version: number = API_VERSION,
+    private readonly version: number = API_VERSION,
   ) {
     if (stack.length === 0) {
       this.stack.push({ scope: this.createScope(), type: 'process' });
     }
   }
 
-  /**
-   * Returns the latest global hum 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.
-   */
-  public static getGlobal(): Hub {
-    const registry = getGlobalCarrier();
-
-    if (!registry.hub || registry.hub.isOlderThan(API_VERSION)) {
-      registry.hub = new Hub();
-    }
-
-    return registry.hub;
-  }
-
   /**
    * Internal helper function to call a method on the top client if it exists.
    *
@@ -97,7 +72,7 @@ export class Hub {
    */
   public pushScope(client?: any): void {
     const usedClient = client || this.getCurrentClient();
-    // We want to clone the last scope and not create a new one
+    // We want to clone the content of prev scope
     const stack = this.getStack();
     const parentScope =
       stack.length > 0 ? stack[stack.length - 1].scope : undefined;
@@ -234,14 +209,3 @@ export class Hub {
     }
   }
 }
-
-/** TODO */
-export function hubFromCarrier(carrier: any): Hub {
-  if (carrier && carrier.__SENTRY__ && carrier.__SENTRY__.hub) {
-    return carrier.__SENTRY__.hub;
-  } else {
-    carrier.__SENTRY__ = {};
-    carrier.__SENTRY__.hub = new Hub();
-    return carrier.__SENTRY__.hub;
-  }
-}

packages/hub/src/index.ts

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

packages/hub/src/interfaces.ts

@@ -2,7 +2,7 @@ import { Hub } from './hub';
 import { Scope } from './scope';
 
 /** The type of a process stack layer. */
-export type LayerType = 'process' | 'domain' | 'local';
+export type LayerType = 'process' | 'local';
 
 /** A layer in the process stack. */
 export interface Layer {
@@ -13,6 +13,5 @@ export interface Layer {
 
 /** An object that contains a hub and maintains a scope stack. */
 export interface Carrier {
-  stack: Layer[];
   hub?: Hub;
 }

packages/hub/src/scope.ts

@@ -141,8 +141,8 @@ export class Scope {
 
   /**
    * Sets the breadcrumbs in the scope
-   * @param breadcrumbs
-   * @param maxBreadcrumbs
+   * @param breadcrumbs Breadcrumb
+   * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
    */
   public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): void {
     this.breadcrumbs =
@@ -155,8 +155,9 @@ export class Scope {
   /**
    * Applies the current context and fingerprint to the event.
    * Note that breadcrumbs will be added by the client.
-   * @param event
-   * @param maxBreadcrumbs
+   * Also if the event has already breadcrumbs on it, we do not merge them.
+   * @param event SentryEvent
+   * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
    */
   public applyToEvent(event: SentryEvent, maxBreadcrumbs?: number): void {
     if (this.extra && Object.keys(this.extra).length) {

packages/hub/test/lib/global.test.ts

@@ -0,0 +1,22 @@
+import { getGlobalHub, getHubFromCarrier, Hub } from '../../src';
+
+describe('global', () => {
+  test('getGlobalHub', () => {
+    expect(getGlobalHub()).toBeTruthy();
+    expect((global as any).__SENTRY__.hub).toBeTruthy();
+  });
+
+  test('getHubFromCarrier', () => {
+    const bla = { a: 'b' };
+    getHubFromCarrier(bla);
+    expect((bla as any).__SENTRY__.hub).toBeTruthy();
+    expect((bla as any).__SENTRY__.hub).toBe((bla as any).__SENTRY__.hub);
+    getHubFromCarrier(bla);
+  });
+
+  test('getGlobalHub', () => {
+    const newestHub = new Hub([], 999999);
+    (global as any).__SENTRY__.hub = newestHub;
+    expect(getGlobalHub()).toBe(newestHub);
+  });
+});