feat(v7/core): Deprecate Hub class (#11528)

Deprecate the `Hub` class which we'll remove in a follow-up PR
in v8. The replacement is to mostly use the scope-centered APIs. Most
APIs that relied on the `Hub` class (unfortunately quite a lot - looks
like we weren't really consistent in using the Hub interface instead of
the class) are already deprecated and already removed in v8.

Author: Lms24

packages/astro/src/index.server.ts

@@ -32,6 +32,7 @@ export {
   getCurrentScope,
   getGlobalScope,
   getIsolationScope,
+  // eslint-disable-next-line deprecation/deprecation
   Hub,
   // eslint-disable-next-line deprecation/deprecation
   makeMain,

packages/browser/src/exports.ts

@@ -42,6 +42,7 @@ export {
   getClient,
   isInitialized,
   getCurrentScope,
+  // eslint-disable-next-line deprecation/deprecation
   Hub,
   // eslint-disable-next-line deprecation/deprecation
   lastEventId,

packages/bun/src/index.ts

@@ -49,6 +49,7 @@ export {
   getCurrentScope,
   getGlobalScope,
   getIsolationScope,
+  // eslint-disable-next-line deprecation/deprecation
   Hub,
   // eslint-disable-next-line deprecation/deprecation
   lastEventId,

packages/bun/test/integrations/bunserver.test.ts

@@ -9,6 +9,7 @@ import { getDefaultBunClientOptions } from '../helpers';
 const DEFAULT_PORT = 22114;
 
 describe('Bun Serve Integration', () => {
+  // eslint-disable-next-line deprecation/deprecation
   let hub: Hub;
   let client: BunClient;
 

packages/core/src/exports.ts

@@ -87,6 +87,7 @@ export function captureEvent(event: Event, hint?: EventHint): string {
  *
  * @deprecated Use getCurrentScope() directly.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub['configureScope']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().configureScope(callback);
@@ -100,6 +101,7 @@ export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub
  *
  * @param breadcrumb The breadcrumb to record.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): ReturnType<Hub['addBreadcrumb']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().addBreadcrumb(breadcrumb, hint);
@@ -110,7 +112,7 @@ export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): Re
  * @param name of the context
  * @param context Any kind of data. This data will be normalized.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, deprecation/deprecation
 export function setContext(name: string, context: { [key: string]: any } | null): ReturnType<Hub['setContext']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setContext(name, context);
@@ -120,6 +122,7 @@ export function setContext(name: string, context: { [key: string]: any } | null)
  * Set an object that will be merged sent as extra data with the event.
  * @param extras Extras object to merge into current context.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setExtras(extras: Extras): ReturnType<Hub['setExtras']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setExtras(extras);
@@ -130,6 +133,7 @@ export function setExtras(extras: Extras): ReturnType<Hub['setExtras']> {
  * @param key String of extra
  * @param extra Any kind of data. This data will be normalized.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setExtra(key: string, extra: Extra): ReturnType<Hub['setExtra']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setExtra(key, extra);
@@ -139,6 +143,7 @@ export function setExtra(key: string, extra: Extra): ReturnType<Hub['setExtra']>
  * Set an object that will be merged sent as tags data with the event.
  * @param tags Tags context object to merge into current context.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setTags(tags: { [key: string]: Primitive }): ReturnType<Hub['setTags']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setTags(tags);
@@ -152,6 +157,7 @@ export function setTags(tags: { [key: string]: Primitive }): ReturnType<Hub['set
  * @param key String key of tag
  * @param value Value of tag
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setTag(key: string, value: Primitive): ReturnType<Hub['setTag']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setTag(key, value);
@@ -162,6 +168,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.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setUser(user: User | null): ReturnType<Hub['setUser']> {
   // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().setUser(user);
@@ -272,6 +279,7 @@ export function withActiveSpan<T>(span: Span, callback: (scope: Scope) => T): T
 export function startTransaction(
   context: TransactionContext,
   customSamplingContext?: CustomSamplingContext,
+  // eslint-disable-next-line deprecation/deprecation
 ): ReturnType<Hub['startTransaction']> {
   // eslint-disable-next-line deprecation/deprecation
   return getCurrentHub().startTransaction({ ...context }, customSamplingContext);

packages/core/src/hub.ts

@@ -66,6 +66,7 @@ export interface AsyncContextStrategy {
   /**
    * Gets the current async context. Returns undefined if there is no current async context.
    */
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub: () => Hub | undefined;
   /**
    * Runs the supplied callback in its own async context.
@@ -88,6 +89,7 @@ export interface Layer {
  */
 export interface Carrier {
   __SENTRY__?: {
+    // eslint-disable-next-line deprecation/deprecation
     hub?: Hub;
     acs?: AsyncContextStrategy;
     /**
@@ -103,7 +105,15 @@ export interface Carrier {
 }
 
 /**
- * @inheritDoc
+ * @deprecated The `Hub` class will be removed in version 8 of the SDK in favour of `Scope` and `Client` objects.
+ *
+ * If you previously used the `Hub` class directly, replace it with `Scope` and `Client` objects. More information:
+ * - [Multiple Sentry Instances](https://docs.sentry.io/platforms/javascript/best-practices/multiple-sentry-instances/)
+ * - [Browser Extensions](https://docs.sentry.io/platforms/javascript/best-practices/browser-extensions/)
+ *
+ * Some of our APIs are typed with the Hub class instead of the interface (e.g. `getCurrentHub`). Most of them are deprecated
+ * themselves and will also be removed in version 8. More information:
+ * - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
  */
 export class Hub implements HubInterface {
   /** Is a {@link Layer}[] containing the client and scope */
@@ -531,6 +541,7 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
+  // eslint-disable-next-line deprecation/deprecation
   public run(callback: (hub: Hub) => void): void {
     // eslint-disable-next-line deprecation/deprecation
     const oldHub = makeMain(this);
@@ -739,6 +750,7 @@ export function getMainCarrier(): Carrier {
  *
  * @deprecated Use `setCurrentClient()` instead.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function makeMain(hub: Hub): Hub {
   const registry = getMainCarrier();
   const oldHub = getHubFromCarrier(registry);
@@ -755,6 +767,7 @@ export function makeMain(hub: Hub): Hub {
  *
  * @deprecated Use the respective replacement method directly instead.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function getCurrentHub(): Hub {
   // Get main carrier (global for every environment)
   const registry = getMainCarrier();
@@ -781,6 +794,7 @@ export function getIsolationScope(): Scope {
   return getCurrentHub().getIsolationScope();
 }
 
+// eslint-disable-next-line deprecation/deprecation
 function getGlobalHub(registry: Carrier = getMainCarrier()): Hub {
   // If there's no hub, or its an old API, assign a new one
 
@@ -802,6 +816,7 @@ function getGlobalHub(registry: Carrier = getMainCarrier()): Hub {
  *
  * If the carrier does not contain a hub, a new hub is created with the global hub client and scope.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function ensureHubOnCarrier(carrier: Carrier, parent: Hub = getGlobalHub()): void {
   // If there's no hub on current domain, or it's an old API, assign a new one
   if (
@@ -864,6 +879,7 @@ function hasHubOnCarrier(carrier: Carrier): boolean {
  * @param carrier object
  * @hidden
  */
+// eslint-disable-next-line deprecation/deprecation
 export function getHubFromCarrier(carrier: Carrier): Hub {
   // eslint-disable-next-line deprecation/deprecation
   return getGlobalSingleton<Hub>('hub', () => new Hub(), carrier);
@@ -875,6 +891,7 @@ export function getHubFromCarrier(carrier: Carrier): Hub {
  * @param hub Hub
  * @returns A boolean indicating success or failure
  */
+// eslint-disable-next-line deprecation/deprecation
 export function setHubOnCarrier(carrier: Carrier, hub: Hub): boolean {
   if (!carrier) return false;
   const __SENTRY__ = (carrier.__SENTRY__ = carrier.__SENTRY__ || {});

packages/core/src/index.ts

@@ -44,6 +44,7 @@ export {
   getCurrentHub,
   getIsolationScope,
   getHubFromCarrier,
+  // eslint-disable-next-line deprecation/deprecation
   Hub,
   // eslint-disable-next-line deprecation/deprecation
   makeMain,
@@ -84,12 +85,7 @@ export { hasTracingEnabled } from './utils/hasTracingEnabled';
 export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
 export { handleCallbackErrors } from './utils/handleCallbackErrors';
 export { parameterize } from './utils/parameterize';
-export {
-  spanToTraceHeader,
-  spanToJSON,
-  spanIsSampled,
-  spanToTraceContext,
-} from './utils/spanUtils';
+export { spanToTraceHeader, spanToJSON, spanIsSampled, spanToTraceContext } from './utils/spanUtils';
 export { getRootSpan } from './utils/getRootSpan';
 export { applySdkMetadata } from './utils/sdkMetadata';
 export { DEFAULT_ENVIRONMENT } from './constants';

packages/core/src/tracing/hubextensions.ts

@@ -11,6 +11,7 @@ import { sampleTransaction } from './sampling';
 import { Transaction } from './transaction';
 
 /** Returns all trace headers that are currently on the top scope. */
+// eslint-disable-next-line deprecation/deprecation
 function traceHeaders(this: Hub): { [key: string]: string } {
   // eslint-disable-next-line deprecation/deprecation
   const scope = this.getScope();
@@ -40,6 +41,7 @@ function traceHeaders(this: Hub): { [key: string]: string } {
  * @see {@link Hub.startTransaction}
  */
 function _startTransaction(
+  // eslint-disable-next-line deprecation/deprecation
   this: Hub,
   transactionContext: TransactionContext,
   customSamplingContext?: CustomSamplingContext,
@@ -88,6 +90,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
  * Create new idle transaction.
  */
 export function startIdleTransaction(
+  // eslint-disable-next-line deprecation/deprecation
   hub: Hub,
   transactionContext: TransactionContext,
   idleTimeout: number,

packages/core/src/tracing/idletransaction.ts

@@ -102,6 +102,7 @@ export class IdleTransaction extends Transaction {
    */
   public constructor(
     transactionContext: TransactionContext,
+    // eslint-disable-next-line deprecation/deprecation
     private readonly _idleHub: Hub,
     /**
      * The time to wait in ms until the idle transaction will be finished. This timer is started each time

packages/core/src/tracing/trace.ts

@@ -330,6 +330,7 @@ export const continueTrace: ContinueTrace = <V>(
 };
 
 function createChildSpanOrTransaction(
+  // eslint-disable-next-line deprecation/deprecation
   hub: Hub,
   {
     parentSpan,