fix hub & scope types

Author: mydea

packages/core/src/exports.ts

@@ -158,7 +158,9 @@ export function withScope<T>(scope: ScopeInterface | undefined, callback: (scope
  * Either creates a new active scope, or sets the given scope as active scope in the given callback.
  */
 export function withScope<T>(
-  ...rest: [callback: (scope: Scope) => T] | [scope: ScopeInterface | undefined, callback: (scope: ScopeInterface) => T]
+  ...rest:
+    | [callback: (scope: ScopeInterface) => T]
+    | [scope: ScopeInterface | undefined, callback: (scope: ScopeInterface) => T]
 ): T {
   // eslint-disable-next-line deprecation/deprecation
   const hub = getCurrentHub() as Hub;

packages/core/src/hub.ts

@@ -12,6 +12,7 @@ import type {
   Integration,
   IntegrationClass,
   Primitive,
+  Scope as ScopeInterface,
   Session,
   SessionContext,
   SeverityLevel,
@@ -51,7 +52,7 @@ const DEFAULT_BREADCRUMBS = 100;
  */
 export interface Layer {
   client?: Client;
-  scope: Scope;
+  scope: ScopeInterface;
 }
 
 /**
@@ -61,7 +62,7 @@ export class Hub implements HubInterface {
   /** Is a {@link Layer}[] containing the client and scope */
   private readonly _stack: Layer[];
 
-  private _isolationScope: Scope;
+  private _isolationScope: ScopeInterface;
 
   /**
    * Creates a new instance of the hub, will push one {@link Layer} into the
@@ -113,8 +114,8 @@ export class Hub implements HubInterface {
    */
   public constructor(
     client?: Client,
-    scope?: Scope,
-    isolationScope?: Scope,
+    scope?: ScopeInterface,
+    isolationScope?: ScopeInterface,
     private readonly _version: number = API_VERSION,
   ) {
     let assignedScope;
@@ -178,7 +179,7 @@ export class Hub implements HubInterface {
    *
    * @deprecated Use `withScope` instead.
    */
-  public pushScope(): Scope {
+  public pushScope(): ScopeInterface {
     // We want to clone the content of prev scope
     // eslint-disable-next-line deprecation/deprecation
     const scope = this.getScope().clone();
@@ -208,7 +209,7 @@ export class Hub implements HubInterface {
    *
    * @deprecated Use `Sentry.withScope()` instead.
    */
-  public withScope<T>(callback: (scope: Scope) => T): T {
+  public withScope<T>(callback: (scope: ScopeInterface) => T): T {
     // eslint-disable-next-line deprecation/deprecation
     const scope = this.pushScope();
 
@@ -257,15 +258,15 @@ export class Hub implements HubInterface {
    *
    * @deprecated Use `Sentry.getCurrentScope()` instead.
    */
-  public getScope(): Scope {
+  public getScope(): ScopeInterface {
     // eslint-disable-next-line deprecation/deprecation
     return this.getStackTop().scope;
   }
 
   /**
    * @deprecated Use `Sentry.getIsolationScope()` instead.
    */
-  public getIsolationScope(): Scope {
+  public getIsolationScope(): ScopeInterface {
     return this._isolationScope;
   }
 

packages/core/src/sdk.ts

@@ -3,7 +3,7 @@ import { consoleSandbox, logger } from '@sentry/utils';
 import { getCurrentScope } from './currentScopes';
 
 import { DEBUG_BUILD } from './debug-build';
-import type { Hub} from './hub';
+import type { Hub } from './hub';
 import { getCurrentHub } from './hub';
 
 /** A class object that can instantiate Client objects. */

packages/core/src/tracing/hubextensions.ts

@@ -1,9 +1,8 @@
-import type { ClientOptions, CustomSamplingContext, TransactionContext } from '@sentry/types';
+import type { ClientOptions, CustomSamplingContext, Hub, TransactionContext } from '@sentry/types';
 import { logger } from '@sentry/utils';
 import { getMainCarrier } from '../asyncContext';
 
 import { DEBUG_BUILD } from '../debug-build';
-import type { Hub } from '../hub';
 import { spanToTraceHeader } from '../utils/spanUtils';
 import { registerErrorInstrumentation } from './errors';
 import { IdleTransaction } from './idletransaction';

packages/core/src/tracing/idletransaction.ts

@@ -1,9 +1,8 @@
 /* eslint-disable max-lines */
-import type { SpanTimeInput, TransactionContext } from '@sentry/types';
+import type { Hub, SpanTimeInput, TransactionContext } from '@sentry/types';
 import { logger, timestampInSeconds } from '@sentry/utils';
 
 import { DEBUG_BUILD } from '../debug-build';
-import type { Hub } from '../hub';
 import { spanTimeInputToSeconds, spanToJSON } from '../utils/spanUtils';
 import type { Span } from './span';
 import { SpanRecorder } from './span';

packages/core/src/tracing/transaction.ts

@@ -2,7 +2,7 @@ import type {
   Context,
   Contexts,
   DynamicSamplingContext,
-  Hub as HubInterface,
+  Hub,
   MeasurementUnit,
   Measurements,
   SpanTimeInput,
@@ -14,7 +14,6 @@ import type {
 import { dropUndefinedKeys, logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from '../debug-build';
-import type { Hub } from '../hub';
 import { getCurrentHub } from '../hub';
 import { getMetricSummaryJsonForSpan } from '../metrics/metric-summary';
 import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
@@ -28,7 +27,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
   /**
    * The reference to the current hub.
    */
-  public _hub: HubInterface;
+  public _hub: Hub;
 
   protected _name: string;
 

packages/core/src/utils/prepareEvent.ts

@@ -48,7 +48,7 @@ export function prepareEvent(
   options: ClientOptions,
   event: Event,
   hint: EventHint,
-  scope?: Scope,
+  scope?: ScopeInterface,
   client?: Client,
   isolationScope?: ScopeInterface,
 ): PromiseLike<Event | null> {
@@ -343,7 +343,10 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):
   return normalized;
 }
 
-function getFinalScope(scope: Scope | undefined, captureContext: CaptureContext | undefined): Scope | undefined {
+function getFinalScope(
+  scope: ScopeInterface | undefined,
+  captureContext: CaptureContext | undefined,
+): ScopeInterface | undefined {
   if (!captureContext) {
     return scope;
   }

packages/feedback/src/util/prepareFeedbackEvent.ts

@@ -1,7 +1,6 @@
-import type { Scope } from '@sentry/core';
 import { getIsolationScope } from '@sentry/core';
 import { prepareEvent } from '@sentry/core';
-import type { Client, FeedbackEvent } from '@sentry/types';
+import type { Client, FeedbackEvent, Scope } from '@sentry/types';
 
 interface PrepareFeedbackEventParams {
   client: Client;

packages/node-experimental/src/sdk/hub.ts

@@ -58,7 +58,7 @@ export function getCurrentHub(): Hub {
     },
 
     withScope,
-    getClient,
+    getClient: <C extends Client>() => getClient() as C | undefined,
     getScope: getCurrentScope,
     getIsolationScope,
     captureException: (exception: unknown, hint?: EventHint) => {

packages/node/src/async/domain.ts

@@ -1,6 +1,7 @@
 import * as domain from 'domain';
-import type { Carrier, Hub, RunWithAsyncContextOptions } from '@sentry/core';
+import type { Carrier, RunWithAsyncContextOptions } from '@sentry/core';
 import { ensureHubOnCarrier, getHubFromCarrier, setAsyncContextStrategy, setHubOnCarrier } from '@sentry/core';
+import type { Hub } from '@sentry/types';
 
 function getActiveDomain<T>(): T | undefined {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any

packages/node/src/async/hooks.ts

@@ -1,5 +1,6 @@
-import type { Carrier, Hub, RunWithAsyncContextOptions } from '@sentry/core';
+import type { Carrier, RunWithAsyncContextOptions } from '@sentry/core';
 import { ensureHubOnCarrier, getHubFromCarrier, setAsyncContextStrategy } from '@sentry/core';
+import type { Hub } from '@sentry/types';
 import * as async_hooks from 'async_hooks';
 
 interface AsyncLocalStorage<T> {

packages/opentelemetry/src/contextManager.ts

@@ -1,11 +1,12 @@
 import type { Context, ContextManager } from '@opentelemetry/api';
 import { Hub } from '@sentry/core';
 import { getCurrentHub } from '@sentry/core';
+import type { Hub as HubInterface } from '@sentry/types';
 import { SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY } from './constants';
 
 import { setHubOnContext } from './utils/contextData';
 
-function createNewHub(parent: Hub | undefined, shouldForkIsolationScope: boolean): Hub {
+function createNewHub(parent: HubInterface | undefined, shouldForkIsolationScope: boolean): Hub {
   if (parent) {
     // eslint-disable-next-line deprecation/deprecation
     const client = parent.getClient();

packages/react/src/errorboundary.tsx

@@ -1,5 +1,6 @@
-import type { ReportDialogOptions, Scope } from '@sentry/browser';
+import type { ReportDialogOptions } from '@sentry/browser';
 import { captureException, getClient, showReportDialog, withScope } from '@sentry/browser';
+import type { Scope } from '@sentry/types';
 import { isError, logger } from '@sentry/utils';
 import hoistNonReactStatics from 'hoist-non-react-statics';
 import * as React from 'react';

packages/remix/src/utils/instrumentServer.ts

@@ -12,9 +12,8 @@ import {
   spanToJSON,
   spanToTraceHeader,
 } from '@sentry/core';
-import type { Hub } from '@sentry/node';
 import { captureException, getCurrentHub } from '@sentry/node';
-import type { Transaction, TransactionSource, WrappedFunction } from '@sentry/types';
+import type { Hub, Transaction, TransactionSource, WrappedFunction } from '@sentry/types';
 import {
   addExceptionMechanism,
   dynamicSamplingContextToSentryBaggageHeader,

packages/replay/src/util/prepareReplayEvent.ts

@@ -1,7 +1,6 @@
-import type { IntegrationIndex, Scope } from '@sentry/core';
-import { getIsolationScope } from '@sentry/core';
-import { prepareEvent } from '@sentry/core';
-import type { Client, EventHint, ReplayEvent } from '@sentry/types';
+import type { IntegrationIndex } from '@sentry/core';
+import { getIsolationScope, prepareEvent } from '@sentry/core';
+import type { Client, EventHint, ReplayEvent, Scope } from '@sentry/types';
 
 /**
  * Prepare a replay event & enrich it with the SDK metadata.

packages/serverless/src/awslambda.ts

@@ -2,7 +2,7 @@ import { existsSync } from 'fs';
 import { hostname } from 'os';
 import { basename, resolve } from 'path';
 import { types } from 'util';
-import type { NodeOptions, Scope } from '@sentry/node';
+import type { NodeOptions } from '@sentry/node';
 import { SDK_VERSION } from '@sentry/node';
 import {
   captureException,
@@ -16,7 +16,7 @@ import {
   startSpanManual,
   withScope,
 } from '@sentry/node';
-import type { Integration, Options, SdkMetadata, Span } from '@sentry/types';
+import type { Integration, Options, Scope, SdkMetadata, Span } from '@sentry/types';
 import { isString, logger } from '@sentry/utils';
 import type { Context, Handler } from 'aws-lambda';
 import { performance } from 'perf_hooks';

packages/types/src/scope.ts

@@ -59,7 +59,7 @@ export interface Scope {
    *
    * It is generally recommended to use the global function `Sentry.getClient()` instead, unless you know what you are doing.
    */
-  getClient(): Client | undefined;
+  getClient<C extends Client>(): C | undefined;
 
   /** Add new event processor that will be called after {@link applyToEvent}. */
   addEventProcessor(callback: EventProcessor): this;

packages/vercel-edge/src/async.ts

@@ -1,5 +1,6 @@
-import type { Carrier, Hub, RunWithAsyncContextOptions } from '@sentry/core';
+import type { Carrier, RunWithAsyncContextOptions } from '@sentry/core';
 import { ensureHubOnCarrier, getHubFromCarrier, setAsyncContextStrategy } from '@sentry/core';
+import type { Hub } from '@sentry/types';
 import { GLOBAL_OBJ, logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from './debug-build';