feat(v7/types): Deprecate Hub interface

getsentry · Apr 10, 2024 · 376d33f · 376d33f
1 parent 8639fa6
commit 376d33f
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 5 deletions.
diff --git a/packages/core/src/hub.ts b/packages/core/src/hub.ts
@@ -115,6 +115,7 @@ export interface Carrier {
  * 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)
  */
+// eslint-disable-next-line deprecation/deprecation
 export class Hub implements HubInterface {
   /** Is a {@link Layer}[] containing the client and scope */
   private readonly _stack: Layer[];

diff --git a/packages/core/src/utils/isSentryRequestUrl.ts b/packages/core/src/utils/isSentryRequestUrl.ts
@@ -6,6 +6,7 @@ import type { Client, DsnComponents, Hub } from '@sentry/types';
  *
  * TODO(v8): Remove Hub fallback type
  */
+// eslint-disable-next-line deprecation/deprecation
 export function isSentryRequestUrl(url: string, hubOrClient: Hub | Client | undefined): boolean {
   const client =
     hubOrClient && isHub(hubOrClient)
@@ -34,6 +35,7 @@ function removeTrailingSlash(str: string): string {
   return str[str.length - 1] === '/' ? str.slice(0, -1) : str;
 }
 
+// eslint-disable-next-line deprecation/deprecation
 function isHub(hubOrClient: Hub | Client | undefined): hubOrClient is Hub {
   // eslint-disable-next-line deprecation/deprecation
   return (hubOrClient as Hub).getClient !== undefined;

diff --git a/packages/core/test/lib/utils/isSentryRequestUrl.test.ts b/packages/core/test/lib/utils/isSentryRequestUrl.test.ts
@@ -21,6 +21,7 @@ describe('isSentryRequestUrl', () => {
       getClient: () => {
         return client;
       },
+      // eslint-disable-next-line deprecation/deprecation
     } as unknown as Hub;
 
     // Works with hub passed

diff --git a/packages/integrations/test/reportingobserver.test.ts b/packages/integrations/test/reportingobserver.test.ts
@@ -14,6 +14,7 @@ const withScope = jest.fn(callback => {
 
 const captureMessage = jest.fn();
 
+// eslint-disable-next-line deprecation/deprecation
 const mockHub = {} as unknown as Hub;
 
 const mockReportingObserverConstructor = jest.fn();

diff --git a/packages/profiling-node/src/hubextensions.ts b/packages/profiling-node/src/hubextensions.ts
@@ -10,6 +10,7 @@ import { isValidSampleRate } from './utils';
 export const MAX_PROFILE_DURATION_MS = 30 * 1000;
 
 type StartTransaction = (
+  // eslint-disable-next-line deprecation/deprecation
   this: Hub,
   transactionContext: TransactionContext,
   customSamplingContext?: CustomSamplingContext,
@@ -142,6 +143,7 @@ export function stopTransactionProfile(
  */
 export function __PRIVATE__wrapStartTransactionWithProfiling(startTransaction: StartTransaction): StartTransaction {
   return function wrappedStartTransaction(
+    // eslint-disable-next-line deprecation/deprecation
     this: Hub,
     transactionContext: TransactionContext,
     customSamplingContext?: CustomSamplingContext,

diff --git a/packages/profiling-node/src/integration.ts b/packages/profiling-node/src/integration.ts
@@ -55,6 +55,7 @@ export class ProfilingIntegration implements Integration {
    * @inheritDoc
    */
   public readonly name: string;
+  // eslint-disable-next-line deprecation/deprecation
   public getCurrentHub?: () => Hub;
 
   public constructor() {
@@ -64,6 +65,7 @@ export class ProfilingIntegration implements Integration {
   /**
    * @inheritDoc
    */
+  // eslint-disable-next-line deprecation/deprecation
   public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
     this.getCurrentHub = getCurrentHub;
     // eslint-disable-next-line deprecation/deprecation

diff --git a/packages/profiling-node/test/hubextensions.test.ts b/packages/profiling-node/test/hubextensions.test.ts
@@ -47,6 +47,7 @@ function makeHubMock({
 }: {
   profilesSampleRate: number | undefined;
   client?: Partial<NodeClient>;
+  // eslint-disable-next-line deprecation/deprecation
 }): Hub {
   return {
     getClient: jest.fn().mockImplementation(() => {
@@ -59,6 +60,7 @@ function makeHubMock({
         ...(client ?? {}),
       };
     }),
+    // eslint-disable-next-line deprecation/deprecation
   } as unknown as Hub;
 }
 

diff --git a/packages/profiling-node/test/integration.test.ts b/packages/profiling-node/test/integration.test.ts
@@ -71,6 +71,7 @@ describe('ProfilingIntegration', () => {
       // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
@@ -86,6 +87,7 @@ describe('ProfilingIntegration', () => {
               getTransport: () => transport,
             };
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
       const addGlobalEventProcessor = () => void 0;
@@ -106,7 +108,9 @@ describe('ProfilingIntegration', () => {
       // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
+        // eslint-disable-next-line deprecation/deprecation
         return { getClient: () => undefined } as Hub;
       });
       const addGlobalEventProcessor = () => void 0;
@@ -122,13 +126,15 @@ describe('ProfilingIntegration', () => {
       // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
             return {
               getDsn: () => undefined,
             };
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
       const addGlobalEventProcessor = () => void 0;
@@ -144,6 +150,7 @@ describe('ProfilingIntegration', () => {
       // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
@@ -154,6 +161,7 @@ describe('ProfilingIntegration', () => {
               getTransport: () => undefined,
             };
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
       const addGlobalEventProcessor = () => void 0;
@@ -174,6 +182,7 @@ describe('ProfilingIntegration', () => {
       // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
@@ -189,6 +198,7 @@ describe('ProfilingIntegration', () => {
               getTransport: () => transport,
             };
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
       const addGlobalEventProcessor = () => void 0;
@@ -209,6 +219,7 @@ describe('ProfilingIntegration', () => {
       const integration = new ProfilingIntegration();
       const emitter = new EventEmitter();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
@@ -226,6 +237,7 @@ describe('ProfilingIntegration', () => {
               getTransport: () => transport,
             } as any;
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
 
@@ -245,6 +257,7 @@ describe('ProfilingIntegration', () => {
       const integration = new ProfilingIntegration();
       const emitter = new EventEmitter();
 
+      // eslint-disable-next-line deprecation/deprecation
       const getCurrentHub = jest.fn((): Hub => {
         return {
           getClient: () => {
@@ -262,6 +275,7 @@ describe('ProfilingIntegration', () => {
               getTransport: () => transport,
             } as any;
           },
+          // eslint-disable-next-line deprecation/deprecation
         } as Hub;
       });
 

diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -13,6 +13,12 @@ import type { User } from './user';
 /**
  * Internal class used to make sure we always have the latest internal functions
  * working in case we have a version conflict.
+ *
+ * @deprecated The `Hub` interface will be removed in a future major version of the SDK in favour of
+ * `Scope` and `Client` objects and APIs.
+ *
+ * Most APIs referencing `Hub` are themselves and will be removed in version 8 of the SDK. More information:
+ * - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
  */
 export interface Hub {
   /**
@@ -226,6 +232,7 @@ export interface Hub {
    *
    * TODO v8: This will be merged with `withScope()`
    */
+  // eslint-disable-next-line deprecation/deprecation
   run(callback: (hub: Hub) => void): void;
 
   /**

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -53,6 +53,7 @@ export type { Event, EventHint, EventType, ErrorEvent, TransactionEvent, Seriali
 export type { EventProcessor } from './eventprocessor';
 export type { Exception } from './exception';
 export type { Extra, Extras } from './extra';
+// eslint-disable-next-line deprecation/deprecation
 export type { Hub } from './hub';
 export type { Integration, IntegrationClass, IntegrationFn, IntegrationFnResult } from './integration';
 export type { Mechanism } from './mechanism';
@@ -153,9 +154,5 @@ export type {
 
 export type { BrowserClientReplayOptions, BrowserClientProfilingOptions } from './browseroptions';
 export type { CheckIn, MonitorConfig, FinishedCheckIn, InProgressCheckIn, SerializedCheckIn } from './checkin';
-export type {
-  MetricsAggregator,
-  MetricBucketItem,
-  MetricInstance,
-} from './metrics';
+export type { MetricsAggregator, MetricBucketItem, MetricInstance } from './metrics';
 export type { ParameterizedString } from './parameterize';
diff --git a/packages/types/src/integration.ts b/packages/types/src/integration.ts
@@ -77,6 +77,7 @@ export interface Integration {
    *
    * NOTE: In v8, this will become optional, and not receive any arguments anymore.
    */
+  // eslint-disable-next-line deprecation/deprecation
   setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void;
 
   /**

diff --git a/packages/utils/src/eventbuilder.ts b/packages/utils/src/eventbuilder.ts
@@ -69,6 +69,7 @@ function getMessageForObject(exception: object): string {
  * @hidden
  */
 export function eventFromUnknownInput(
+  // eslint-disable-next-line deprecation/deprecation
   getHubOrClient: (() => Hub) | Client | undefined,
   stackParser: StackParser,
   exception: unknown,

diff --git a/packages/utils/test/eventbuilder.test.ts b/packages/utils/test/eventbuilder.test.ts
@@ -2,6 +2,7 @@ import type { Hub, Scope } from '@sentry/types';
 
 import { createStackParser, eventFromUnknownInput, nodeStackLineParser } from '../src';
 
+// eslint-disable-next-line deprecation/deprecation
 function getCurrentHub(): Hub {
   // Some fake hub to get us through
   return {
@@ -11,6 +12,7 @@ function getCurrentHub(): Hub {
         setExtra: () => {},
       } as unknown as Scope;
     },
+    // eslint-disable-next-line deprecation/deprecation
   } as unknown as Hub;
 }