ref(core): Replace Scope.clone() with non-static scope.clone() (#9801)

To avoid this static method there. It is deprecated to use
`Scope.clone()` (but still works), but better to just use
`scope.clone()` or `new Scope()` directly.

Author: mydea

packages/core/src/hub.ts

@@ -142,7 +142,7 @@ export class Hub implements HubInterface {
    */
   public pushScope(): Scope {
     // We want to clone the content of prev scope
-    const scope = Scope.clone(this.getScope());
+    const scope = this.getScope().clone();
     this.getStack().push({
       client: this.getClient(),
       scope,
@@ -578,7 +578,7 @@ export function ensureHubOnCarrier(carrier: Carrier, parent: Hub = getGlobalHub(
   // If there's no hub on current domain, or it's an old API, assign a new one
   if (!hasHubOnCarrier(carrier) || getHubFromCarrier(carrier).isOlderThan(API_VERSION)) {
     const globalHubTopStack = parent.getStackTop();
-    setHubOnCarrier(carrier, new Hub(globalHubTopStack.client, Scope.clone(globalHubTopStack.scope)));
+    setHubOnCarrier(carrier, new Hub(globalHubTopStack.client, globalHubTopStack.scope.clone()));
   }
 }
 

packages/core/src/scope.ts

@@ -110,27 +110,33 @@ export class Scope implements ScopeInterface {
 
   /**
    * Inherit values from the parent scope.
-   * @param scope to clone.
+   * @deprecated Use `scope.clone()` and `new Scope()` instead.
    */
   public static clone(scope?: Scope): Scope {
+    return scope ? scope.clone() : new Scope();
+  }
+
+  /**
+   * Clone this scope instance.
+   */
+  public clone(): Scope {
     const newScope = new Scope();
-    if (scope) {
-      newScope._breadcrumbs = [...scope._breadcrumbs];
-      newScope._tags = { ...scope._tags };
-      newScope._extra = { ...scope._extra };
-      newScope._contexts = { ...scope._contexts };
-      newScope._user = scope._user;
-      newScope._level = scope._level;
-      newScope._span = scope._span;
-      newScope._session = scope._session;
-      newScope._transactionName = scope._transactionName;
-      newScope._fingerprint = scope._fingerprint;
-      newScope._eventProcessors = [...scope._eventProcessors];
-      newScope._requestSession = scope._requestSession;
-      newScope._attachments = [...scope._attachments];
-      newScope._sdkProcessingMetadata = { ...scope._sdkProcessingMetadata };
-      newScope._propagationContext = { ...scope._propagationContext };
-    }
+    newScope._breadcrumbs = [...this._breadcrumbs];
+    newScope._tags = { ...this._tags };
+    newScope._extra = { ...this._extra };
+    newScope._contexts = { ...this._contexts };
+    newScope._user = this._user;
+    newScope._level = this._level;
+    newScope._span = this._span;
+    newScope._session = this._session;
+    newScope._transactionName = this._transactionName;
+    newScope._fingerprint = this._fingerprint;
+    newScope._eventProcessors = [...this._eventProcessors];
+    newScope._requestSession = this._requestSession;
+    newScope._attachments = [...this._attachments];
+    newScope._sdkProcessingMetadata = { ...this._sdkProcessingMetadata };
+    newScope._propagationContext = { ...this._propagationContext };
+
     return newScope;
   }
 

packages/core/src/utils/prepareEvent.ts

@@ -74,10 +74,7 @@ export function prepareEvent(
 
   // If we have scope given to us, use it as the base for further modifications.
   // This allows us to prevent unnecessary copying of data if `captureContext` is not provided.
-  let finalScope = scope;
-  if (hint.captureContext) {
-    finalScope = Scope.clone(finalScope).update(hint.captureContext);
-  }
+  const finalScope = getFinalScope(scope, hint.captureContext);
 
   if (hint.mechanism) {
     addExceptionMechanism(prepared, hint.mechanism);
@@ -349,6 +346,16 @@ function normalizeEvent(event: Event | null, depth: number, maxBreadth: number):
   return normalized;
 }
 
+function getFinalScope(scope: Scope | undefined, captureContext: CaptureContext | undefined): Scope | undefined {
+  if (!captureContext) {
+    return scope;
+  }
+
+  const finalScope = scope ? scope.clone() : new Scope();
+  finalScope.update(captureContext);
+  return finalScope;
+}
+
 /**
  * Parse either an `EventHint` directly, or convert a `CaptureContext` to an `EventHint`.
  * This is used to allow to update method signatures that used to accept a `CaptureContext` but should now accept an `EventHint`.

packages/opentelemetry-node/test/spanprocessor.test.ts

@@ -5,15 +5,7 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { SemanticAttributes, SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 import type { SpanStatusType } from '@sentry/core';
-import {
-  Hub,
-  Scope,
-  Span as SentrySpan,
-  Transaction,
-  addTracingExtensions,
-  createTransport,
-  makeMain,
-} from '@sentry/core';
+import { Hub, Span as SentrySpan, Transaction, addTracingExtensions, createTransport, makeMain } from '@sentry/core';
 import { NodeClient } from '@sentry/node';
 import { resolvedSyncPromise } from '@sentry/utils';
 
@@ -973,7 +965,7 @@ describe('SentrySpanProcessor', () => {
     hub = new Hub(client);
     makeMain(hub);
 
-    const newHub = new Hub(client, Scope.clone(hub.getScope()));
+    const newHub = new Hub(client, hub.getScope().clone());
     newHub.configureScope(scope => {
       scope.setTag('foo', 'bar');
     });

packages/opentelemetry/src/contextManager.ts

@@ -1,7 +1,8 @@
 import type { Context, ContextManager } from '@opentelemetry/api';
 import type { Carrier, Hub } from '@sentry/core';
+import { ensureHubOnCarrier } from '@sentry/core';
 
-import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from './custom/hub';
+import { getCurrentHub, getHubFromCarrier } from './custom/hub';
 import { setHubOnContext } from './utils/contextData';
 
 function createNewHub(parent: Hub | undefined): Hub {

packages/opentelemetry/src/custom/client.ts

@@ -3,7 +3,7 @@ import { trace } from '@opentelemetry/api';
 import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 import type { BaseClient, Scope } from '@sentry/core';
 import { SDK_VERSION } from '@sentry/core';
-import type { Client, Event, EventHint } from '@sentry/types';
+import type { CaptureContext, Client, Event, EventHint } from '@sentry/types';
 
 import type { OpenTelemetryClient as OpenTelemetryClientInterface } from '../types';
 import { OpenTelemetryScope } from './scope';
@@ -65,14 +65,14 @@ export function wrapClientClass<
 
     /**
      * Extends the base `_prepareEvent` so that we can properly handle `captureContext`.
-     * This uses `Scope.clone()`, which we need to replace with `NodeExperimentalScope.clone()` for this client.
+     * This uses `Scope.clone()`, which we need to replace with `OpenTelemetryScope.clone()` for this client.
      */
     protected _prepareEvent(event: Event, hint: EventHint, scope?: Scope): PromiseLike<Event | null> {
       let actualScope = scope;
 
       // Remove `captureContext` hint and instead clone already here
       if (hint && hint.captureContext) {
-        actualScope = OpenTelemetryScope.clone(scope);
+        actualScope = getFinalScope(scope, hint.captureContext);
         delete hint.captureContext;
       }
 
@@ -83,3 +83,9 @@ export function wrapClientClass<
   return OpenTelemetryClient as unknown as WrappedClassConstructor;
 }
 /* eslint-enable @typescript-eslint/no-explicit-any */
+
+function getFinalScope(scope: Scope | undefined, captureContext: CaptureContext): Scope | undefined {
+  const finalScope = scope ? scope.clone() : new OpenTelemetryScope();
+  finalScope.update(captureContext);
+  return finalScope;
+}

packages/opentelemetry/src/custom/hub.ts

@@ -13,19 +13,6 @@ export class OpenTelemetryHub extends Hub {
   public constructor(client?: Client, scope: Scope = new OpenTelemetryScope()) {
     super(client, scope);
   }
-
-  /**
-   * @inheritDoc
-   */
-  public pushScope(): Scope {
-    // We want to clone the content of prev scope
-    const scope = OpenTelemetryScope.clone(this.getScope());
-    this.getStack().push({
-      client: this.getClient(),
-      scope,
-    });
-    return scope;
-  }
 }
 
 /** Custom getClient method that uses the custom hub. */
@@ -110,10 +97,7 @@ export function ensureHubOnCarrier(carrier: Carrier, parent: Hub = getGlobalHub(
   // If there's no hub on current domain, or it's an old API, assign a new one
   if (!hasHubOnCarrier(carrier) || getHubFromCarrier(carrier).isOlderThan(API_VERSION)) {
     const globalHubTopStack = parent.getStackTop();
-    setHubOnCarrier(
-      carrier,
-      new OpenTelemetryHub(globalHubTopStack.client, OpenTelemetryScope.clone(globalHubTopStack.scope)),
-    );
+    setHubOnCarrier(carrier, new OpenTelemetryHub(globalHubTopStack.client, globalHubTopStack.scope.clone()));
   }
 }
 

packages/opentelemetry/src/custom/scope.ts

@@ -23,24 +23,30 @@ export class OpenTelemetryScope extends Scope {
    * @inheritDoc
    */
   public static clone(scope?: Scope): Scope {
+    return scope ? scope.clone() : new OpenTelemetryScope();
+  }
+
+  /**
+   * Clone this scope instance.
+   */
+  public clone(): OpenTelemetryScope {
     const newScope = new OpenTelemetryScope();
-    if (scope) {
-      newScope._breadcrumbs = [...scope['_breadcrumbs']];
-      newScope._tags = { ...scope['_tags'] };
-      newScope._extra = { ...scope['_extra'] };
-      newScope._contexts = { ...scope['_contexts'] };
-      newScope._user = scope['_user'];
-      newScope._level = scope['_level'];
-      newScope._span = scope['_span'];
-      newScope._session = scope['_session'];
-      newScope._transactionName = scope['_transactionName'];
-      newScope._fingerprint = scope['_fingerprint'];
-      newScope._eventProcessors = [...scope['_eventProcessors']];
-      newScope._requestSession = scope['_requestSession'];
-      newScope._attachments = [...scope['_attachments']];
-      newScope._sdkProcessingMetadata = { ...scope['_sdkProcessingMetadata'] };
-      newScope._propagationContext = { ...scope['_propagationContext'] };
-    }
+    newScope._breadcrumbs = [...this['_breadcrumbs']];
+    newScope._tags = { ...this['_tags'] };
+    newScope._extra = { ...this['_extra'] };
+    newScope._contexts = { ...this['_contexts'] };
+    newScope._user = this['_user'];
+    newScope._level = this['_level'];
+    newScope._span = this['_span'];
+    newScope._session = this['_session'];
+    newScope._transactionName = this['_transactionName'];
+    newScope._fingerprint = this['_fingerprint'];
+    newScope._eventProcessors = [...this['_eventProcessors']];
+    newScope._requestSession = this['_requestSession'];
+    newScope._attachments = [...this['_attachments']];
+    newScope._sdkProcessingMetadata = { ...this['_sdkProcessingMetadata'] };
+    newScope._propagationContext = { ...this['_propagationContext'] };
+
     return newScope;
   }
 

packages/opentelemetry/src/spanExporter.ts

@@ -112,8 +112,8 @@ function maybeSend(spans: ReadableSpan[]): ReadableSpan[] {
 
     // Now finish the transaction, which will send it together with all the spans
     // We make sure to use the current span as the activeSpan for this transaction
-    const scope = getSpanScope(span);
-    const forkedScope = OpenTelemetryScope.clone(scope as OpenTelemetryScope | undefined) as OpenTelemetryScope;
+    const scope = getSpanScope(span) as OpenTelemetryScope | undefined;
+    const forkedScope = scope ? scope.clone() : new OpenTelemetryScope();
     forkedScope.activeSpan = span as unknown as Span;
 
     transaction.finishWithScope(convertOtelTimeToSeconds(span.endTime), forkedScope);

packages/opentelemetry/test/custom/scope.test.ts

@@ -30,6 +30,7 @@ describe('NodeExperimentalScope', () => {
     scope['_attachments'] = [{ data: '123', filename: 'test.txt' }];
     scope['_sdkProcessingMetadata'] = { sdk: 'bar' };
 
+    // eslint-disable-next-line deprecation/deprecation
     const scope2 = OpenTelemetryScope.clone(scope);
 
     expect(scope2).toBeInstanceOf(OpenTelemetryScope);
@@ -68,6 +69,7 @@ describe('NodeExperimentalScope', () => {
   });
 
   it('clone() works without existing scope', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const scope = OpenTelemetryScope.clone(undefined);
 
     expect(scope).toBeInstanceOf(OpenTelemetryScope);