feat(core): Deprecate methods on Hub (#10124)

Except for `bindClient()` which needs a separate replacement. For
everything else we already have a replacement in place!

Then in a follow up we can deprecate `getCurrentHub()` itself.

Author: mydea

dev-packages/browser-integration-tests/loader-suites/loader/noOnLoad/sdkLoadedInMeanwhile/test.ts

@@ -54,7 +54,7 @@ sentryTest('it does not download the SDK if the SDK was loaded in the meanwhile'
   expect(sentryEventCount).toBe(1);
 
   // Ensure loader does not overwrite init/config
-  const options = await page.evaluate(() => (window as any).Sentry.getCurrentHub().getClient()?.getOptions());
+  const options = await page.evaluate(() => (window as any).Sentry.getClient()?.getOptions());
   expect(options?.replaysSessionSampleRate).toBe(0.42);
 
   expect(eventData.exception?.values?.length).toBe(1);

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customBrowserTracing/test.ts

@@ -27,7 +27,7 @@ sentryTest('should handle custom added BrowserTracing integration', async ({ get
   expect(eventData.transaction_info?.source).toEqual('url');
 
   const tracePropagationTargets = await page.evaluate(() => {
-    const browserTracing = (window as any).Sentry.getCurrentHub().getClient().getIntegrationById('BrowserTracing');
+    const browserTracing = (window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
     return browserTracing.options.tracePropagationTargets;
   });
 

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customInit/test.ts

@@ -30,5 +30,5 @@ sentryTest('always calls onLoad init correctly', async ({ getLocalTestUrl, page
 
   expect(await page.evaluate('window.__hadSentry')).toEqual(false);
   expect(await page.evaluate('window.__sentryOnLoad')).toEqual(1);
-  expect(await page.evaluate('Sentry.getCurrentHub().getClient().getOptions().sampleRate')).toEqual(0.5);
+  expect(await page.evaluate('Sentry.getClient().getOptions().sampleRate')).toEqual(0.5);
 });

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrations/test.ts

@@ -24,14 +24,14 @@ sentryTest('should handle custom added integrations & default integrations', asy
   });
 
   const hasCustomIntegration = await page.evaluate(() => {
-    return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('CustomIntegration');
+    return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
   });
 
   const hasReplay = await page.evaluate(() => {
-    return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('Replay');
+    return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
   });
   const hasBrowserTracing = await page.evaluate(() => {
-    return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('BrowserTracing');
+    return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
   });
 
   expect(hasCustomIntegration).toEqual(true);

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customIntegrationsFunction/test.ts

@@ -21,14 +21,14 @@ sentryTest(
     });
 
     const hasCustomIntegration = await page.evaluate(() => {
-      return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('CustomIntegration');
+      return !!(window as any).Sentry.getClient().getIntegrationById('CustomIntegration');
     });
 
     const hasReplay = await page.evaluate(() => {
-      return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('Replay');
+      return !!(window as any).Sentry.getClient().getIntegrationById('Replay');
     });
     const hasBrowserTracing = await page.evaluate(() => {
-      return !!(window as any).Sentry.getCurrentHub().getClient().getIntegrationById('BrowserTracing');
+      return !!(window as any).Sentry.getClient().getIntegrationById('BrowserTracing');
     });
 
     expect(hasCustomIntegration).toEqual(true);

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/customReplay/test.ts

@@ -27,7 +27,7 @@ sentryTest('should handle custom added Replay integration', async ({ getLocalTes
   expect(eventData.segment_id).toBe(0);
 
   const useCompression = await page.evaluate(() => {
-    const replay = (window as any).Sentry.getCurrentHub().getClient().getIntegrationById('Replay');
+    const replay = (window as any).Sentry.getClient().getIntegrationById('Replay');
     return replay._replay.getOptions().useCompression;
   });
 

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoad/test.ts

@@ -11,5 +11,5 @@ sentryTest('sentryOnLoad callback is called before Sentry.onLoad()', async ({ ge
 
   expect(eventData.message).toBe('Test exception');
 
-  expect(await page.evaluate('Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate')).toEqual(0.123);
+  expect(await page.evaluate('Sentry.getClient().getOptions().tracesSampleRate')).toEqual(0.123);
 });

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/init.js

@@ -1,4 +1,4 @@
 Sentry.onLoad(function () {
   // this should be called _after_ window.sentryOnLoad
-  Sentry.captureException(`Test exception: ${Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate}`);
+  Sentry.captureException(`Test exception: ${Sentry.getClient().getOptions().tracesSampleRate}`);
 });

dev-packages/browser-integration-tests/loader-suites/loader/onLoad/sentryOnLoadAndOnLoad/test.ts

@@ -11,5 +11,5 @@ sentryTest('sentryOnLoad callback is used', async ({ getLocalTestUrl, page }) =>
 
   expect(eventData.message).toBe('Test exception: 0.123');
 
-  expect(await page.evaluate('Sentry.getCurrentHub().getClient().getOptions().tracesSampleRate')).toEqual(0.123);
+  expect(await page.evaluate('Sentry.getClient().getOptions().tracesSampleRate')).toEqual(0.123);
 });

dev-packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts

@@ -6,7 +6,7 @@ export default function handler(req: NextApiRequest, res: NextApiResponse) {
   // eslint-disable-next-line deprecation/deprecation
   const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
   // eslint-disable-next-line deprecation/deprecation
-  Sentry.getCurrentHub().getScope().setSpan(transaction);
+  Sentry.getCurrentScope().setSpan(transaction);
 
   // eslint-disable-next-line deprecation/deprecation
   const span = transaction.startChild();

dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts

@@ -27,7 +27,7 @@ app.use(cors());
 
 app.get('/test/express', (_req, res) => {
   // eslint-disable-next-line deprecation/deprecation
-  const transaction = Sentry.getCurrentHub().getScope().getTransaction();
+  const transaction = Sentry.getCurrentScope().getTransaction();
   if (transaction) {
     // eslint-disable-next-line deprecation/deprecation
     transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';

dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts

@@ -31,7 +31,7 @@ app.use(cors());
 
 app.get('/test/express', (_req, res) => {
   // eslint-disable-next-line deprecation/deprecation
-  const transaction = Sentry.getCurrentHub().getScope().getTransaction();
+  const transaction = Sentry.getCurrentScope().getTransaction();
   if (transaction) {
     // eslint-disable-next-line deprecation/deprecation
     transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';

dev-packages/node-integration-tests/suites/sessions/server.ts

@@ -14,7 +14,7 @@ app.use(Sentry.Handlers.requestHandler());
 
 // ### Taken from manual tests ###
 // Hack that resets the 60s default flush interval, and replaces it with just a one second interval
-const flusher = (Sentry.getCurrentHub()?.getClient() as Sentry.NodeClient)['_sessionFlusher'] as SessionFlusher;
+const flusher = (Sentry.getClient() as Sentry.NodeClient)['_sessionFlusher'] as SessionFlusher;
 
 let flusherIntervalId = flusher && flusher['_intervalId'];
 

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

@@ -1,6 +1,7 @@
 import type { BrowserClient } from '@sentry/browser';
+import { getCurrentScope } from '@sentry/browser';
 import * as SentryBrowser from '@sentry/browser';
-import { BrowserTracing, SDK_VERSION, WINDOW, getClient, getCurrentHub } from '@sentry/browser';
+import { BrowserTracing, SDK_VERSION, WINDOW, getClient } from '@sentry/browser';
 import { vi } from 'vitest';
 
 import { init } from '../../../astro/src/client/sdk';
@@ -37,7 +38,7 @@ describe('Sentry client SDK', () => {
     });
 
     it('sets the runtime tag on the scope', () => {
-      const currentScope = getCurrentHub().getScope();
+      const currentScope = getCurrentScope();
 
       // @ts-expect-error need access to protected _tags attribute
       expect(currentScope._tags).toEqual({});

packages/astro/test/server/sdk.test.ts

@@ -1,4 +1,3 @@
-import { getCurrentHub } from '@sentry/core';
 import * as SentryNode from '@sentry/node';
 import { SDK_VERSION } from '@sentry/node';
 import { GLOBAL_OBJ } from '@sentry/utils';
@@ -38,7 +37,7 @@ describe('Sentry server SDK', () => {
     });
 
     it('sets the runtime tag on the scope', () => {
-      const currentScope = getCurrentHub().getScope();
+      const currentScope = SentryNode.getCurrentScope();
 
       // @ts-expect-error need access to protected _tags attribute
       expect(currentScope._tags).toEqual({});

packages/browser/src/sdk.ts

@@ -167,6 +167,7 @@ export const showReportDialog: ShowReportDialogFunction = (
     return;
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   const { client, scope } = hub.getStackTop();
   const dsn = options.dsn || (client && client.getDsn());
   if (!dsn) {

packages/browser/test/unit/profiling/integration.test.ts

@@ -51,7 +51,7 @@ describe('BrowserProfilingIntegration', () => {
     const client = Sentry.getClient<BrowserClient>();
 
     // eslint-disable-next-line deprecation/deprecation
-    const currentTransaction = Sentry.getCurrentHub().getScope().getTransaction();
+    const currentTransaction = Sentry.getCurrentScope().getTransaction();
     expect(currentTransaction?.op).toBe('pageload');
     currentTransaction?.end();
     await client?.flush(1000);

packages/core/src/exports.ts

@@ -99,6 +99,7 @@ export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub
  * @param breadcrumb The breadcrumb to record.
  */
 export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): ReturnType<Hub['addBreadcrumb']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().addBreadcrumb(breadcrumb, hint);
 }
 
@@ -109,6 +110,7 @@ export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): Re
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function setContext(name: string, context: { [key: string]: any } | null): ReturnType<Hub['setContext']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setContext(name, context);
 }
 
@@ -117,6 +119,7 @@ export function setContext(name: string, context: { [key: string]: any } | null)
  * @param extras Extras object to merge into current context.
  */
 export function setExtras(extras: Extras): ReturnType<Hub['setExtras']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setExtras(extras);
 }
 
@@ -126,6 +129,7 @@ export function setExtras(extras: Extras): ReturnType<Hub['setExtras']> {
  * @param extra Any kind of data. This data will be normalized.
  */
 export function setExtra(key: string, extra: Extra): ReturnType<Hub['setExtra']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setExtra(key, extra);
 }
 
@@ -134,6 +138,7 @@ export function setExtra(key: string, extra: Extra): ReturnType<Hub['setExtra']>
  * @param tags Tags context object to merge into current context.
  */
 export function setTags(tags: { [key: string]: Primitive }): ReturnType<Hub['setTags']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setTags(tags);
 }
 
@@ -146,6 +151,7 @@ export function setTags(tags: { [key: string]: Primitive }): ReturnType<Hub['set
  * @param value Value of tag
  */
 export function setTag(key: string, value: Primitive): ReturnType<Hub['setTag']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setTag(key, value);
 }
 
@@ -155,6 +161,7 @@ export function setTag(key: string, value: Primitive): ReturnType<Hub['setTag']>
  * @param user User context object to be set in the current context. Pass `null` to unset the user.
  */
 export function setUser(user: User | null): ReturnType<Hub['setUser']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setUser(user);
 }
 
@@ -184,16 +191,20 @@ export function withScope<T>(
   if (rest.length === 2) {
     const [scope, callback] = rest;
     if (!scope) {
+      // eslint-disable-next-line deprecation/deprecation
       return getCurrentHub().withScope(callback);
     }
 
     const hub = getCurrentHub();
+    // eslint-disable-next-line deprecation/deprecation
     return hub.withScope(() => {
+      // eslint-disable-next-line deprecation/deprecation
       hub.getStackTop().scope = scope as Scope;
       return callback(scope as Scope);
     });
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   return getCurrentHub().withScope(rest[0]);
 }
 
@@ -332,20 +343,23 @@ export async function close(timeout?: number): Promise<boolean> {
  * @deprecated This function will be removed in the next major version of the Sentry SDK.
  */
 export function lastEventId(): string | undefined {
+  // eslint-disable-next-line deprecation/deprecation
   return getCurrentHub().lastEventId();
 }
 
 /**
  * Get the currently active client.
  */
 export function getClient<C extends Client>(): C | undefined {
+  // eslint-disable-next-line deprecation/deprecation
   return getCurrentHub().getClient<C>();
 }
 
 /**
  * Get the currently active scope.
  */
 export function getCurrentScope(): Scope {
+  // eslint-disable-next-line deprecation/deprecation
   return getCurrentHub().getScope();
 }