feat(core): Add top level getClient() method (#9638)

This can be used instead of `getCurrentHub().getClient()`.

This prepares us also for a post-hub time, but makes sense generally
IMHO, also simplifies user-facing interaction with the client (e.g. to
lazy-add integrations etc).

This is a 1-1 replacement, so should be pretty straightforward.

Author: mydea

packages/angular/src/errorhandler.ts

@@ -115,7 +115,7 @@ class SentryErrorHandler implements AngularErrorHandler {
 
     // Optionally show user dialog to provide details on what happened.
     if (this._options.showDialog) {
-      const client = Sentry.getCurrentHub().getClient();
+      const client = Sentry.getClient();
 
       if (client && client.on && !this._registeredAfterSendEventHandler) {
         client.on('afterSendEvent', (event: Event) => {

packages/angular/test/errorhandler.test.ts

@@ -1,6 +1,6 @@
 import { HttpErrorResponse } from '@angular/common/http';
 import * as SentryBrowser from '@sentry/browser';
-import type { Event } from '@sentry/types';
+import type { Client, Event } from '@sentry/types';
 
 import { createErrorHandler, SentryErrorHandler } from '../src/errorhandler';
 
@@ -505,10 +505,7 @@ describe('SentryErrorHandler', () => {
           }),
         };
 
-        // @ts-expect-error this is a minmal hub, we're missing a few props but that's ok
-        jest.spyOn(SentryBrowser, 'getCurrentHub').mockImplementationOnce(() => {
-          return { getClient: () => client };
-        });
+        jest.spyOn(SentryBrowser, 'getClient').mockImplementationOnce(() => client as unknown as Client);
 
         const showReportDialogSpy = jest.spyOn(SentryBrowser, 'showReportDialog');
 

packages/astro/src/index.server.ts

@@ -21,6 +21,7 @@ export {
   getActiveTransaction,
   getHubFromCarrier,
   getCurrentHub,
+  getClient,
   Hub,
   makeMain,
   Scope,

packages/astro/test/client/sdk.test.ts

@@ -1,6 +1,6 @@
 import type { BrowserClient } from '@sentry/browser';
 import * as SentryBrowser from '@sentry/browser';
-import { BrowserTracing, getCurrentHub, SDK_VERSION, WINDOW } from '@sentry/browser';
+import { BrowserTracing, getClient, getCurrentHub, SDK_VERSION, WINDOW } from '@sentry/browser';
 import { vi } from 'vitest';
 
 import { init } from '../../../astro/src/client/sdk';
@@ -60,7 +60,7 @@ describe('Sentry client SDK', () => {
         });
 
         const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
-        const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+        const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 
         expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
         expect(browserTracing).toBeDefined();
@@ -76,7 +76,7 @@ describe('Sentry client SDK', () => {
         });
 
         const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
-        const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+        const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 
         expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
         expect(browserTracing).toBeUndefined();
@@ -91,7 +91,7 @@ describe('Sentry client SDK', () => {
         });
 
         const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
-        const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById('BrowserTracing');
+        const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing');
 
         expect(integrationsToInit).not.toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));
         expect(browserTracing).toBeUndefined();
@@ -108,9 +108,7 @@ describe('Sentry client SDK', () => {
 
         const integrationsToInit = browserInit.mock.calls[0][0]?.integrations;
 
-        const browserTracing = (getCurrentHub().getClient() as BrowserClient)?.getIntegrationById(
-          'BrowserTracing',
-        ) as BrowserTracing;
+        const browserTracing = getClient<BrowserClient>()?.getIntegrationById('BrowserTracing') as BrowserTracing;
         const options = browserTracing.options;
 
         expect(integrationsToInit).toContainEqual(expect.objectContaining({ name: 'BrowserTracing' }));

packages/browser/src/exports.ts

@@ -33,6 +33,7 @@ export {
   flush,
   getHubFromCarrier,
   getCurrentHub,
+  getClient,
   Hub,
   lastEventId,
   makeMain,

packages/browser/src/integrations/breadcrumbs.ts

@@ -19,6 +19,7 @@ import {
   severityLevelFromString,
 } from '@sentry/utils';
 
+import { getClient } from '../exports';
 import { WINDOW } from '../helpers';
 
 type HandlerData = Record<string, unknown>;
@@ -103,7 +104,7 @@ export class Breadcrumbs implements Integration {
       addInstrumentationHandler('history', _historyBreadcrumb);
     }
     if (this.options.sentry) {
-      const client = getCurrentHub().getClient();
+      const client = getClient();
       client && client.on && client.on('beforeSendEvent', addSentryBreadcrumb);
     }
   }

packages/browser/src/profiling/utils.ts

@@ -5,6 +5,7 @@ import type { DebugImage, Envelope, Event, StackFrame, StackParser, Transaction
 import type { Profile, ThreadCpuProfile } from '@sentry/types/src/profiling';
 import { browserPerformanceTimeOrigin, forEachEnvelopeItem, GLOBAL_OBJ, logger, uuid4 } from '@sentry/utils';
 
+import { getClient } from '../exports';
 import { WINDOW } from '../helpers';
 import type { JSSelfProfile, JSSelfProfiler, JSSelfProfilerConstructor, JSSelfProfileStack } from './jsSelfProfiling';
 
@@ -532,7 +533,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
     return false;
   }
 
-  const client = getCurrentHub().getClient();
+  const client = getClient();
   const options = client && client.getOptions();
   if (!options) {
     __DEBUG_BUILD__ && logger.log('[Profiling] Profiling disabled, no options found.');

packages/browser/src/sdk.ts

@@ -1,5 +1,6 @@
 import type { Hub } from '@sentry/core';
 import {
+  getClient,
   getCurrentHub,
   getIntegrationsToSetup,
   getReportDialogEndpoint,
@@ -252,7 +253,7 @@ function startSessionTracking(): void {
  * Captures user feedback and sends it to Sentry.
  */
 export function captureUserFeedback(feedback: UserFeedback): void {
-  const client = getCurrentHub().getClient<BrowserClient>();
+  const client = getClient<BrowserClient>();
   if (client) {
     client.captureUserFeedback(feedback);
   }

packages/browser/test/unit/eventbuilder.test.ts

@@ -1,15 +1,18 @@
-import type { Client } from '@sentry/types';
-
 import { defaultStackParser } from '../../src';
 import { eventFromPlainObject } from '../../src/eventbuilder';
 
 jest.mock('@sentry/core', () => {
   const original = jest.requireActual('@sentry/core');
   return {
     ...original,
-    getCurrentHub(): {
-      getClient(): Client;
-    } {
+    getClient() {
+      return {
+        getOptions(): any {
+          return { normalizeDepth: 6 };
+        },
+      };
+    },
+    getCurrentHub() {
       return {
         getClient(): any {
           return {

packages/browser/test/unit/index.test.ts

@@ -11,6 +11,7 @@ import {
   captureMessage,
   configureScope,
   flush,
+  getClient,
   getCurrentHub,
   init,
   Integrations,
@@ -271,31 +272,31 @@ describe('SentryBrowser initialization', () => {
     it('should set SDK data when Sentry.init() is called', () => {
       init({ dsn });
 
-      const sdkData = (getCurrentHub().getClient() as any).getOptions()._metadata.sdk;
+      const sdkData = getClient()?.getOptions()._metadata?.sdk || {};
 
       expect(sdkData?.name).toBe('sentry.javascript.browser');
-      expect(sdkData?.packages[0].name).toBe('npm:@sentry/browser');
-      expect(sdkData?.packages[0].version).toBe(SDK_VERSION);
+      expect(sdkData?.packages?.[0].name).toBe('npm:@sentry/browser');
+      expect(sdkData?.packages?.[0].version).toBe(SDK_VERSION);
       expect(sdkData?.version).toBe(SDK_VERSION);
     });
 
     it('uses SDK source from window for package name', () => {
       global.SENTRY_SDK_SOURCE = 'loader';
       init({ dsn });
 
-      const sdkData = (getCurrentHub().getClient() as any).getOptions()._metadata.sdk;
+      const sdkData = getClient()?.getOptions()._metadata?.sdk || {};
 
-      expect(sdkData?.packages[0].name).toBe('loader:@sentry/browser');
+      expect(sdkData.packages?.[0].name).toBe('loader:@sentry/browser');
       delete global.SENTRY_SDK_SOURCE;
     });
 
     it('uses SDK source from global for package name', () => {
       const spy = jest.spyOn(utils, 'getSDKSource').mockReturnValue('cdn');
       init({ dsn });
 
-      const sdkData = (getCurrentHub().getClient() as any).getOptions()._metadata.sdk;
+      const sdkData = getClient()?.getOptions()._metadata?.sdk || {};
 
-      expect(sdkData?.packages[0].name).toBe('cdn:@sentry/browser');
+      expect(sdkData.packages?.[0].name).toBe('cdn:@sentry/browser');
       expect(utils.getSDKSource).toBeCalledTimes(1);
       spy.mockRestore();
     });
@@ -332,11 +333,11 @@ describe('SentryBrowser initialization', () => {
         },
       });
 
-      const sdkData = (getCurrentHub().getClient() as any).getOptions()._metadata?.sdk;
+      const sdkData = getClient()?.getOptions()._metadata?.sdk || {};
 
       expect(sdkData.name).toBe('sentry.javascript.angular');
-      expect(sdkData.packages[0].name).toBe('npm:@sentry/angular');
-      expect(sdkData.packages[0].version).toBe(SDK_VERSION);
+      expect(sdkData.packages?.[0].name).toBe('npm:@sentry/angular');
+      expect(sdkData.packages?.[0].version).toBe(SDK_VERSION);
       expect(sdkData.version).toBe(SDK_VERSION);
     });
   });