ref: Rename getDefaultHub to getCurrentHub (#1457)

Author: HazAT

packages/browser/src/index.ts

@@ -15,7 +15,7 @@ export {
 
 export { addBreadcrumb, captureMessage, captureException, captureEvent, configureScope } from '@sentry/minimal';
 
-export { getHubFromCarrier, getDefaultHub, Hub, Scope } from '@sentry/hub';
+export { getHubFromCarrier, getCurrentHub, Hub, Scope } from '@sentry/hub';
 
 export { BrowserBackend, BrowserOptions } from './backend';
 export { BrowserClient } from './client';

packages/browser/src/integrations/breadcrumbs.ts

@@ -1,4 +1,4 @@
-import { getDefaultHub } from '@sentry/hub';
+import { getCurrentHub } from '@sentry/hub';
 import { Integration, Severity } from '@sentry/types';
 import { isFunction, isString } from '@sentry/utils/is';
 import { getGlobalObject, parseUrl } from '@sentry/utils/misc';
@@ -87,7 +87,7 @@ export class Breadcrumbs implements Integration {
           }
         }
 
-        getDefaultHub().addBreadcrumb(breadcrumbData);
+        getCurrentHub().addBreadcrumb(breadcrumbData);
 
         // this fails for some browsers. :(
         if (originalConsoleLevel) {
@@ -148,15 +148,15 @@ export class Breadcrumbs implements Integration {
           .apply(global, args)
           .then((response: Response) => {
             fetchData.status_code = response.status;
-            getDefaultHub().addBreadcrumb({
+            getCurrentHub().addBreadcrumb({
               category: 'fetch',
               data: fetchData,
               type: 'http',
             });
             return response;
           })
           .catch((error: Error) => {
-            getDefaultHub().addBreadcrumb({
+            getCurrentHub().addBreadcrumb({
               category: 'fetch',
               data: fetchData,
               level: Severity.Error,
@@ -196,7 +196,7 @@ export class Breadcrumbs implements Integration {
         from = parsedFrom.relative;
       }
 
-      getDefaultHub().addBreadcrumb({
+      getCurrentHub().addBreadcrumb({
         category: 'navigation',
         data: {
           from,
@@ -290,7 +290,7 @@ export class Breadcrumbs implements Integration {
               } catch (e) {
                 /* do nothing */
               }
-              getDefaultHub().addBreadcrumb({
+              getCurrentHub().addBreadcrumb({
                 category: 'xhr',
                 data: xhr.__sentry_xhr__,
                 type: 'http',

packages/browser/src/integrations/helpers.ts

@@ -1,4 +1,4 @@
-import { getDefaultHub } from '@sentry/hub';
+import { getCurrentHub } from '@sentry/hub';
 import { SentryEvent, SentryWrappedFunction } from '@sentry/types';
 import { isFunction } from '@sentry/utils/is';
 import { htmlTreeAsString } from '@sentry/utils/misc';
@@ -64,13 +64,13 @@ export function wrap(
     } catch (ex) {
       ignoreNextOnError();
 
-      getDefaultHub().withScope(async () => {
-        getDefaultHub().addEventProcessor(async (event: SentryEvent) => ({
+      getCurrentHub().withScope(async () => {
+        getCurrentHub().addEventProcessor(async (event: SentryEvent) => ({
           ...event,
           ...(options && options.mechanism),
         }));
 
-        getDefaultHub().captureException(ex);
+        getCurrentHub().captureException(ex);
       });
 
       throw ex;
@@ -126,7 +126,7 @@ export function breadcrumbEventHandler(eventName: string): (event: Event) => voi
       target = '<unknown>';
     }
 
-    getDefaultHub().addBreadcrumb({
+    getCurrentHub().addBreadcrumb({
       category: `ui.${eventName}`, // e.g. ui.click, ui.input
       message: target,
     });

packages/browser/src/integrations/inboundfilters.ts

@@ -1,5 +1,5 @@
 import { logger } from '@sentry/core';
-import { getDefaultHub } from '@sentry/hub';
+import { getCurrentHub } from '@sentry/hub';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isRegExp } from '@sentry/utils/is';
 import { BrowserOptions } from '../backend';
@@ -27,7 +27,7 @@ export class InboundFilters implements Integration {
   public install(options: BrowserOptions = {}): void {
     this.configureOptions(options);
 
-    getDefaultHub().addEventProcessor(async (event: SentryEvent) => {
+    getCurrentHub().addEventProcessor(async (event: SentryEvent) => {
       if (this.shouldDropEvent(event)) {
         return null;
       }

packages/browser/src/integrations/sdkinformation.ts

@@ -1,4 +1,4 @@
-import { getDefaultHub } from '@sentry/hub';
+import { getCurrentHub } from '@sentry/hub';
 import { Integration, SentryEvent } from '@sentry/types';
 import { SDK_NAME, SDK_VERSION } from '../version';
 
@@ -13,7 +13,7 @@ export class SDKInformation implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    getDefaultHub().addEventProcessor(async (event: SentryEvent) => ({
+    getCurrentHub().addEventProcessor(async (event: SentryEvent) => ({
       ...event,
       sdk: {
         name: SDK_NAME,

packages/browser/test/index.test.ts

@@ -8,7 +8,7 @@ import {
   captureException,
   captureMessage,
   configureScope,
-  getDefaultHub,
+  getCurrentHub,
   init,
   Scope,
   SentryEvent,
@@ -24,11 +24,11 @@ describe('SentryBrowser', () => {
   });
 
   beforeEach(() => {
-    getDefaultHub().pushScope();
+    getCurrentHub().pushScope();
   });
 
   afterEach(() => {
-    getDefaultHub().popScope();
+    getCurrentHub().popScope();
   });
 
   describe('getContext() / setContext()', () => {
@@ -72,8 +72,8 @@ describe('SentryBrowser', () => {
     });
 
     it('should record auto breadcrumbs', done => {
-      getDefaultHub().pushScope();
-      getDefaultHub().bindClient(
+      getCurrentHub().pushScope();
+      getCurrentHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.breadcrumbs!).to.have.lengthOf(2);
@@ -87,7 +87,7 @@ describe('SentryBrowser', () => {
       addBreadcrumb({ message: 'test2' });
 
       captureMessage('event');
-      getDefaultHub().popScope();
+      getCurrentHub().popScope();
     });
   });
 
@@ -103,8 +103,8 @@ describe('SentryBrowser', () => {
     });
 
     it('should capture an exception', done => {
-      getDefaultHub().pushScope();
-      getDefaultHub().bindClient(
+      getCurrentHub().pushScope();
+      getCurrentHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.exception).to.not.be.undefined;
@@ -122,12 +122,12 @@ describe('SentryBrowser', () => {
       } catch (e) {
         captureException(e);
       }
-      getDefaultHub().popScope();
+      getCurrentHub().popScope();
     });
 
     it('should capture a message', done => {
-      getDefaultHub().pushScope();
-      getDefaultHub().bindClient(
+      getCurrentHub().pushScope();
+      getCurrentHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.message).to.equal('test');
@@ -138,12 +138,12 @@ describe('SentryBrowser', () => {
         }),
       );
       captureMessage('test');
-      getDefaultHub().popScope();
+      getCurrentHub().popScope();
     });
 
     it('should capture an event', done => {
-      getDefaultHub().pushScope();
-      getDefaultHub().bindClient(
+      getCurrentHub().pushScope();
+      getCurrentHub().bindClient(
         new BrowserClient({
           afterSend: (event: SentryEvent) => {
             expect(event.message).to.equal('test');
@@ -154,7 +154,7 @@ describe('SentryBrowser', () => {
         }),
       );
       captureEvent({ message: 'test' });
-      getDefaultHub().popScope();
+      getCurrentHub().popScope();
     });
   });
 });

packages/core/src/sdk.ts

@@ -1,4 +1,4 @@
-import { getDefaultHub } from '@sentry/hub';
+import { getCurrentHub } from '@sentry/hub';
 import { Integration } from '@sentry/types';
 import { Client, Options } from './interfaces';
 import { logger } from './logger';
@@ -21,7 +21,7 @@ export function initAndBind<F extends Client, O extends Options>(
   options: O,
   defaultIntegrations: Integration[] = [],
 ): void {
-  if (getDefaultHub().getClient()) {
+  if (getCurrentHub().getClient()) {
     return;
   }
 
@@ -34,7 +34,7 @@ export function initAndBind<F extends Client, O extends Options>(
 
   // This should happen here if any integration uses {@link Hub.addEventProcessor}
   // there needs to be a client on the hub already.
-  getDefaultHub().bindClient(client);
+  getCurrentHub().bindClient(client);
 
   let integrations = [...defaultIntegrations];
   if (Array.isArray(options.integrations)) {

packages/hub/src/global.ts

@@ -18,7 +18,7 @@ export function getMainCarrier(): Carrier {
  * contains a more recent version, it replaces the registered version.
  * Otherwise, the currently registered hub will be returned.
  */
-export function getDefaultHub(): Hub {
+export function getCurrentHub(): Hub {
   const registry = getMainCarrier();
 
   if (!registry.hub || registry.hub.isOlderThan(API_VERSION)) {

packages/hub/src/index.ts

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

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

@@ -1,8 +1,8 @@
-import { getDefaultHub, getHubFromCarrier, Hub } from '../../src';
+import { getCurrentHub, getHubFromCarrier, Hub } from '../../src';
 
 describe('global', () => {
   test('getGlobalHub', () => {
-    expect(getDefaultHub()).toBeTruthy();
+    expect(getCurrentHub()).toBeTruthy();
     expect((global as any).__SENTRY__.hub).toBeTruthy();
   });
 
@@ -17,6 +17,6 @@ describe('global', () => {
   test('getGlobalHub', () => {
     const newestHub = new Hub(undefined, [], 999999);
     (global as any).__SENTRY__.hub = newestHub;
-    expect(getDefaultHub()).toBe(newestHub);
+    expect(getCurrentHub()).toBe(newestHub);
   });
 });