feat(core): Deprecate Hub class

Author: Lms24

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,

packages/core/src/tracing/transaction.ts

@@ -26,6 +26,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
   /**
    * The reference to the current hub.
    */
+  // eslint-disable-next-line deprecation/deprecation
   public _hub: Hub;
 
   protected _name: string;
@@ -48,6 +49,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
    *
    * @deprecated Transactions will be removed in v8. Use spans instead.
    */
+  // eslint-disable-next-line deprecation/deprecation
   public constructor(transactionContext: TransactionContext, hub?: Hub) {
     super(transactionContext);
     this._contexts = {};
@@ -250,6 +252,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
    *
    * @internal
    */
+  // eslint-disable-next-line deprecation/deprecation
   public setHub(hub: Hub): void {
     this._hub = hub;
   }

packages/core/src/tracing/utils.ts

@@ -9,6 +9,7 @@ import { getCurrentHub } from '../hub';
  *
  * @deprecated You should not rely on the transaction, but just use `startSpan()` APIs instead.
  */
+// eslint-disable-next-line deprecation/deprecation
 export function getActiveTransaction<T extends Transaction>(maybeHub?: Hub): T | undefined {
   // eslint-disable-next-line deprecation/deprecation
   const hub = maybeHub || getCurrentHub();

packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

@@ -5,6 +5,7 @@ import { addTracingExtensions } from '../../../src/tracing';
 import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';
 
 describe('getDynamicSamplingContextFromSpan', () => {
+  // eslint-disable-next-line deprecation/deprecation
   let hub: Hub;
   beforeEach(() => {
     const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, release: '1.0.1' });

packages/core/test/lib/tracing/trace.test.ts

@@ -29,6 +29,7 @@ const enum Type {
   Async = 'async',
 }
 
+// eslint-disable-next-line deprecation/deprecation
 let hub: Hub;
 let client: TestClient;
 

packages/hub/src/index.ts

@@ -31,6 +31,7 @@ import {
 /**
  * @deprecated This export has moved to @sentry/core. The @sentry/hub package will be removed in v8
  */
+// eslint-disable-next-line deprecation/deprecation
 export class Hub extends HubCore {}
 
 /**

packages/node-experimental/src/index.ts

@@ -75,6 +75,7 @@ export {
   // eslint-disable-next-line deprecation/deprecation
   extractTraceparentData,
   flush,
+  // eslint-disable-next-line deprecation/deprecation
   Hub,
   runWithAsyncContext,
   SDK_VERSION,

packages/node/src/async/domain.ts

@@ -7,6 +7,7 @@ function getActiveDomain<T>(): T | undefined {
   return (domain as any).active as T | undefined;
 }
 
+// eslint-disable-next-line deprecation/deprecation
 function getCurrentHub(): Hub | undefined {
   const activeDomain = getActiveDomain<Carrier>();
 
@@ -20,6 +21,7 @@ function getCurrentHub(): Hub | undefined {
   return getHubFromCarrier(activeDomain);
 }
 
+// eslint-disable-next-line deprecation/deprecation
 function createNewHub(parent: Hub | undefined): Hub {
   const carrier: Carrier = {};
   ensureHubOnCarrier(carrier, parent);

packages/node/src/async/hooks.ts

@@ -12,20 +12,24 @@ type AsyncLocalStorageConstructor = { new <T>(): AsyncLocalStorage<T> };
 // AsyncLocalStorage only exists in async_hook after Node v12.17.0 or v13.10.0
 type NewerAsyncHooks = typeof async_hooks & { AsyncLocalStorage: AsyncLocalStorageConstructor };
 
+// eslint-disable-next-line deprecation/deprecation
 let asyncStorage: AsyncLocalStorage<Hub>;
 
 /**
  * Sets the async context strategy to use AsyncLocalStorage which requires Node v12.17.0 or v13.10.0.
  */
 export function setHooksAsyncContextStrategy(): void {
   if (!asyncStorage) {
+    // eslint-disable-next-line deprecation/deprecation
     asyncStorage = new (async_hooks as NewerAsyncHooks).AsyncLocalStorage<Hub>();
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   function getCurrentHub(): Hub | undefined {
     return asyncStorage.getStore();
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   function createNewHub(parent: Hub | undefined): Hub {
     const carrier: Carrier = {};
     ensureHubOnCarrier(carrier, parent);

packages/node/src/index.ts

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

packages/node/src/integrations/http.ts

@@ -171,6 +171,7 @@ export class Http implements Integration {
    */
   public setupOnce(
     _addGlobalEventProcessor: (callback: EventProcessor) => void,
+    // eslint-disable-next-line deprecation/deprecation
     setupOnceGetCurrentHub: () => Hub,
   ): void {
     // eslint-disable-next-line deprecation/deprecation

packages/node/test/handlers.test.ts

@@ -17,11 +17,14 @@ import { NodeClient } from '../src/client';
 import { errorHandler, requestHandler, tracingHandler } from '../src/handlers';
 import { getDefaultNodeClientOptions } from './helper/node-client-options';
 
+// eslint-disable-next-line deprecation/deprecation
 function mockAsyncContextStrategy(getHub: () => Hub): void {
+  // eslint-disable-next-line deprecation/deprecation
   function getCurrentHub(): Hub | undefined {
     return getHub();
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   function runWithAsyncContext<T>(fn: (hub: Hub) => T): T {
     return fn(getHub());
   }
@@ -195,6 +198,7 @@ describe('tracingHandler', () => {
 
   const sentryTracingMiddleware = tracingHandler();
 
+  // eslint-disable-next-line deprecation/deprecation
   let hub: Hub, req: http.IncomingMessage, res: http.ServerResponse, next: () => undefined;
 
   function createNoOpSpy() {

packages/node/test/integrations/undici.test.ts

@@ -12,6 +12,7 @@ import { conditionalTest } from '../utils';
 
 const SENTRY_DSN = 'https://0@0.ingest.sentry.io/0';
 
+// eslint-disable-next-line deprecation/deprecation
 let hub: Hub;
 let fetch: typeof FetchType;