feat: Introduce hub.run (#1584)

* feat: Introduce hub.run

* meta: Add changelog

Author: HazAT

CHANGELOG.md

@@ -13,6 +13,7 @@
 - [core] ref: Move debug initialization as the first step
 - [node] fix: Make handlers types compatibile with Express
 - [utils] fix: Dont break when non-string is passed to truncate
+- [hub] feat: Add `run` function that makes `this` hub the current global one
 
 ## 4.0.4
 

packages/hub/src/global.ts

@@ -11,6 +11,18 @@ export function getMainCarrier(): Carrier {
   return carrier.__SENTRY__;
 }
 
+/**
+ * Replaces the current main hub with the passed one on the global object
+ *
+ * @returns The old replaced hub
+ */
+export function makeMain(hub?: Hub): Hub | undefined {
+  const registry = getMainCarrier();
+  const oldHub = registry.hub;
+  registry.hub = hub;
+  return oldHub;
+}
+
 /**
  * Returns the default hub instance.
  *

packages/hub/src/hub.ts

@@ -1,5 +1,6 @@
 import { Breadcrumb, SentryBreadcrumbHint, SentryEvent, SentryEventHint, Severity } from '@sentry/types';
 import { uuid4 } from '@sentry/utils/misc';
+import { makeMain } from './global';
 import { Layer } from './interfaces';
 import { Scope } from './scope';
 
@@ -250,4 +251,18 @@ export class Hub {
       callback(top.scope);
     }
   }
+
+  /**
+   * For the duraction of the callback, this hub will be set as the global current Hub.
+   * This function is useful if you want to run your own client and hook into an already initialized one
+   * e.g.: Reporting issues to your own sentry when running in your component while still using the users configuration
+   */
+  public run(callback: ((hub: Hub) => void)): void {
+    const oldHub = makeMain(this);
+    try {
+      callback(this);
+    } finally {
+      makeMain(oldHub);
+    }
+  }
 }

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

@@ -1,5 +1,5 @@
 import { SentryEvent } from '@sentry/types';
-import { Hub, Scope } from '../../src';
+import { getCurrentHub, Hub, Scope } from '../../src';
 
 const clientFn = jest.fn();
 const asyncClientFn = async () => Promise.reject('error');
@@ -300,4 +300,18 @@ describe('Hub', () => {
     const eventId = hub.captureEvent(event);
     expect(eventId).toBe(hub.lastEventId());
   });
+
+  test('run', () => {
+    const currentHub = getCurrentHub();
+    const myScope = new Scope();
+    const myClient = { a: 'b' };
+    myScope.setExtra('a', 'b');
+    const myHub = new Hub(myClient, myScope);
+    myHub.run(hub => {
+      expect(hub.getScope()).toBe(myScope);
+      expect(hub.getClient()).toBe(myClient);
+      expect(hub).toBe(getCurrentHub());
+    });
+    expect(currentHub).toBe(getCurrentHub());
+  });
 });