fix(opentelemetry): Use scope span capturing from core (#11475)

To ensure we can use this in an isomorphic way.

This means we do not rely on this being a mutable object anymore, but we
need to ensure to update it (in http integration) on both the span _and_
for the current context.

Author: mydea

packages/core/src/tracing/index.ts

@@ -1,3 +1,4 @@
+export { setCapturedScopesOnSpan, getCapturedScopesOnSpan } from './utils';
 export { addTracingExtensions } from './hubextensions';
 export { startIdleSpan, TRACING_DEFAULTS } from './idleSpan';
 export { SentrySpan } from './sentrySpan';

packages/node/src/integrations/http.ts

@@ -4,7 +4,16 @@ import { SpanKind } from '@opentelemetry/api';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 
-import { addBreadcrumb, defineIntegration, getIsolationScope, isSentryRequestUrl, spanToJSON } from '@sentry/core';
+import {
+  addBreadcrumb,
+  defineIntegration,
+  getCapturedScopesOnSpan,
+  getCurrentScope,
+  getIsolationScope,
+  isSentryRequestUrl,
+  setCapturedScopesOnSpan,
+  spanToJSON,
+} from '@sentry/core';
 import { _INTERNAL, getClient, getSpanKind } from '@sentry/opentelemetry';
 import type { IntegrationFn } from '@sentry/types';
 
@@ -88,15 +97,20 @@ const _httpIntegration = ((options: HttpOptions = {}) => {
               return;
             }
 
+            const scopes = getCapturedScopesOnSpan(span);
+
             // Update the isolation scope, isolate this request
-            const isolationScope = getIsolationScope().clone();
+            const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();
+            const scope = scopes.scope || getCurrentScope();
+
             isolationScope.setSDKProcessingMetadata({ request: req });
 
             const client = getClient<NodeClient>();
             if (client && client.getOptions().autoSessionTracking) {
               isolationScope.setRequestSession({ status: 'ok' });
             }
             setIsolationScope(isolationScope);
+            setCapturedScopesOnSpan(span, scope, isolationScope);
 
             // attempt to update the scope's `transactionName` based on the request URL
             // Ideally, framework instrumentations coming after the HttpInstrumentation

packages/node/test/integration/scope.test.ts

@@ -1,5 +1,5 @@
-import { getCurrentScope } from '@sentry/core';
-import { getClient, getSpanScopes } from '@sentry/opentelemetry';
+import { getCapturedScopesOnSpan, getCurrentScope } from '@sentry/core';
+import { getClient } from '@sentry/opentelemetry';
 import { clearGlobalScope } from '../../../core/test/lib/clear-global-scope';
 
 import * as Sentry from '../../src/';
@@ -42,7 +42,7 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3');
 
           Sentry.startSpan({ name: 'outer' }, span => {
-            expect(getSpanScopes(span)?.scope).toBe(enableTracing ? scope2 : undefined);
+            expect(getCapturedScopesOnSpan(span)?.scope).toBe(enableTracing ? scope2 : undefined);
 
             spanId = span.spanContext().spanId;
             traceId = span.spanContext().traceId;

packages/opentelemetry/src/index.ts

@@ -4,7 +4,6 @@ export type { OpenTelemetryClient } from './types';
 export { wrapClientClass } from './custom/client';
 
 export { getSpanKind } from './utils/getSpanKind';
-export { getSpanScopes } from './utils/spanData';
 
 export { getScopesFromContext } from './utils/contextData';
 

packages/opentelemetry/src/spanExporter.ts

@@ -2,7 +2,12 @@ import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
-import { captureEvent, getMetricSummaryJsonForSpan, timedEventsToMeasurements } from '@sentry/core';
+import {
+  captureEvent,
+  getCapturedScopesOnSpan,
+  getMetricSummaryJsonForSpan,
+  timedEventsToMeasurements,
+} from '@sentry/core';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
@@ -23,7 +28,6 @@ import { getLocalParentId } from './utils/groupSpansWithParents';
 import { groupSpansWithParents } from './utils/groupSpansWithParents';
 import { mapStatus } from './utils/mapStatus';
 import { parseSpanDescription } from './utils/parseSpanDescription';
-import { getSpanScopes } from './utils/spanData';
 
 type SpanNodeCompleted = SpanNode & { span: ReadableSpan };
 
@@ -176,7 +180,7 @@ function parseSpan(span: ReadableSpan): { op?: string; origin?: SpanOrigin; sour
 
 function createTransactionForOtelSpan(span: ReadableSpan): TransactionEvent {
   const { op, description, data, origin = 'manual', source } = getSpanData(span);
-  const capturedSpanScopes = getSpanScopes(span);
+  const capturedSpanScopes = getCapturedScopesOnSpan(span as unknown as Span);
 
   const sampleRate = span.attributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE] as number | undefined;
 
@@ -220,8 +224,8 @@ function createTransactionForOtelSpan(span: ReadableSpan): TransactionEvent {
     type: 'transaction',
     sdkProcessingMetadata: {
       ...dropUndefinedKeys({
-        capturedSpanScope: capturedSpanScopes?.scope,
-        capturedSpanIsolationScope: capturedSpanScopes?.isolationScope,
+        capturedSpanScope: capturedSpanScopes.scope,
+        capturedSpanIsolationScope: capturedSpanScopes.isolationScope,
         sampleRate,
         dynamicSamplingContext: getDynamicSamplingContextFromSpan(span),
       }),

packages/opentelemetry/src/spanProcessor.ts

@@ -8,12 +8,12 @@ import {
   getDefaultIsolationScope,
   logSpanEnd,
   logSpanStart,
+  setCapturedScopesOnSpan,
 } from '@sentry/core';
 import { SEMANTIC_ATTRIBUTE_SENTRY_PARENT_IS_REMOTE } from './semanticAttributes';
 import { SentrySpanExporter } from './spanExporter';
 import { getScopesFromContext } from './utils/contextData';
 import { setIsSetup } from './utils/setupCheck';
-import { setSpanScopes } from './utils/spanData';
 
 function onSpanStart(span: Span, parentContext: Context): void {
   // This is a reliable way to get the parent span - because this is exactly how the parent is identified in the OTEL SDK
@@ -42,7 +42,7 @@ function onSpanStart(span: Span, parentContext: Context): void {
 
   // We need the scope at time of span creation in order to apply it to the event when the span is finished
   if (scopes) {
-    setSpanScopes(span, scopes);
+    setCapturedScopesOnSpan(span, scopes.scope, scopes.isolationScope);
   }
 
   logSpanStart(span);

packages/opentelemetry/src/utils/spanData.ts

@@ -1,5 +1,6 @@
 import {
   captureException,
+  getCapturedScopesOnSpan,
   getClient,
   getCurrentScope,
   getIsolationScope,
@@ -9,7 +10,6 @@ import {
 } from '@sentry/core';
 
 import { startSpan } from '../../src/trace';
-import { getSpanScopes } from '../../src/utils/spanData';
 import type { TestClientInterface } from '../helpers/TestClient';
 import { cleanupOtel, mockSdkInit } from '../helpers/mockSdkInit';
 
@@ -49,7 +49,7 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3');
 
           startSpan({ name: 'outer' }, span => {
-            expect(getSpanScopes(span)?.scope).toBe(enableTracing ? scope2 : undefined);
+            expect(getCapturedScopesOnSpan(span)?.scope).toBe(enableTracing ? scope2 : undefined);
 
             spanId = span.spanContext().spanId;
             traceId = span.spanContext().traceId;