WIP better scope type

Author: mydea

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

@@ -44,7 +44,7 @@ export function getClient<C extends Client>(): C {
 
 /** Get the current scope. */
 export function getCurrentScope(): Scope {
-  return getScopes().scope;
+  return getScopes().scope as Scope;
 }
 
 /**
@@ -63,12 +63,12 @@ export function getGlobalScope(): Scope {
     carrier.globalScope = new Scope();
   }
 
-  return carrier.globalScope;
+  return carrier.globalScope as Scope;
 }
 
 /** Get the currently active isolation scope. */
 export function getIsolationScope(): Scope {
-  return getScopes().isolationScope;
+  return getScopes().isolationScope as Scope;
 }
 
 /**

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

@@ -1,41 +1,13 @@
 import { notifyEventProcessors } from '@sentry/core';
 import { OpenTelemetryScope } from '@sentry/opentelemetry';
-import type {
-  Attachment,
-  Breadcrumb,
-  Client,
-  Contexts,
-  Event,
-  EventHint,
-  EventProcessor,
-  Extras,
-  Primitive,
-  PropagationContext,
-  Severity,
-  SeverityLevel,
-  User,
-} from '@sentry/types';
+import type { Breadcrumb, Client, Event, EventHint, EventProcessor, Severity, SeverityLevel } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
 import { getClient, getGlobalScope, getIsolationScope } from './api';
-
-interface ScopeData {
-  eventProcessors: EventProcessor[];
-  breadcrumbs: Breadcrumb[];
-  user: User;
-  tags: { [key: string]: Primitive };
-  extra: Extras;
-  contexts: Contexts;
-  attachments: Attachment[];
-  propagationContext: PropagationContext;
-  sdkProcessingMetadata: { [key: string]: unknown };
-  fingerprint: string[];
-  // eslint-disable-next-line deprecation/deprecation
-  level?: Severity | SeverityLevel;
-}
+import type { Scope as ScopeInterface, ScopeData } from './types';
 
 /** A fork of the classic scope with some otel specific stuff. */
-export class Scope extends OpenTelemetryScope {
+export class Scope extends OpenTelemetryScope implements ScopeInterface {
   // Overwrite this if you want to use a specific isolation scope here
   public isolationScope: Scope | undefined;
 

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

@@ -1,5 +1,54 @@
-import type { Hub, Integration } from '@sentry/types';
-import type { Scope } from './scope';
+import type {
+  Attachment,
+  Breadcrumb,
+  Client,
+  Contexts,
+  Event,
+  EventHint,
+  EventProcessor,
+  Extras,
+  Hub,
+  Integration,
+  Primitive,
+  PropagationContext,
+  Scope as BaseScope,
+  Severity,
+  SeverityLevel,
+  User,
+} from '@sentry/types';
+
+export interface ScopeData {
+  eventProcessors: EventProcessor[];
+  breadcrumbs: Breadcrumb[];
+  user: User;
+  tags: { [key: string]: Primitive };
+  extra: Extras;
+  contexts: Contexts;
+  attachments: Attachment[];
+  propagationContext: PropagationContext;
+  sdkProcessingMetadata: { [key: string]: unknown };
+  fingerprint: string[];
+  level?: SeverityLevel;
+}
+
+export interface Scope extends BaseScope {
+  // @ts-expect-error typeof this is what we want here
+  isolationScope: typeof this | undefined;
+  // @ts-expect-error typeof this is what we want here
+  clone(scope?: Scope): typeof this;
+  setClient(client: Client): void;
+  getClient(): Client | undefined;
+  captureException(exception: unknown, hint?: EventHint): string;
+  captureMessage(
+    message: string,
+    // eslint-disable-next-line deprecation/deprecation
+    level?: Severity | SeverityLevel,
+    hint?: EventHint,
+  ): string;
+  captureEvent(event: Event, hint?: EventHint): string;
+  lastEventId(): string | undefined;
+  getScopeData(): ScopeData;
+}
 
 export interface CurrentScopes {
   scope: Scope;