ref(core): Remove scope.setSpan() and scope.getSpan() methods (#11051)

Instead, we have an internal utility for this now.

Author: mydea

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js

@@ -4,6 +4,12 @@ window.Sentry = Sentry;
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
-  integrations: [Sentry.browserTracingIntegration({ idleTimeout: 9000, instrumentPageLoad: false })],
+  integrations: [
+    Sentry.browserTracingIntegration({
+      idleTimeout: 9000,
+      instrumentPageLoad: false,
+      instrumentNavigation: false,
+    }),
+  ],
   tracesSampleRate: 1,
 });

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/subject.js

@@ -6,9 +6,8 @@ document.getElementById('go-background').addEventListener('click', () => {
 });
 
 document.getElementById('start-span').addEventListener('click', () => {
-  const span = Sentry.startInactiveSpan({ name: 'test-span' });
+  const span = Sentry.startBrowserTracingNavigationSpan(Sentry.getClient(), { name: 'test-span' });
   window.span = span;
-  Sentry.getCurrentScope().setSpan(span);
 });
 
 window.getSpanJson = () => {

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/test.ts

@@ -10,7 +10,7 @@ sentryTest('should finish a custom transaction when the page goes background', a
   }
 
   const url = await getLocalTestPath({ testDir: __dirname });
-  page.goto(url);
+  await page.goto(url);
 
   await page.locator('#start-span').click();
   const spanJsonBefore: SpanJSON = await page.evaluate('window.getSpanJson()');

dev-packages/e2e-tests/test-applications/nextjs-app-dir/components/span-context.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-import { getCurrentScope, startInactiveSpan } from '@sentry/nextjs';
+import { startInactiveSpan } from '@sentry/nextjs';
 import { Span } from '@sentry/types';
 import { PropsWithChildren, createContext, useState } from 'react';
 
@@ -29,7 +29,6 @@ export function SpanContextProvider({ children }: PropsWithChildren) {
               spanActive: false,
               start: (spanName: string) => {
                 const span = startInactiveSpan({ name: spanName });
-                getCurrentScope().setSpan(span);
                 setSpan(span);
               },
             }

dev-packages/rollup-utils/plugins/bundlePlugins.mjs

@@ -124,9 +124,12 @@ export function makeTerserPlugin() {
           // For v7 backwards-compatibility we need to access txn._frozenDynamicSamplingContext
           // TODO (v8): Remove this reserved word
           '_frozenDynamicSamplingContext',
-          // These are used to keep span relationships
+          // These are used to keep span & scope relationships
           '_sentryRootSpan',
           '_sentryChildSpans',
+          '_sentrySpan',
+          '_sentryScope',
+          '_sentryIsolationScope',
         ],
       },
     },

packages/browser/src/index.bundle.tracing.replay.feedback.ts

@@ -1,6 +1,10 @@
 import { feedbackIntegration } from '@sentry-internal/feedback';
 import { replayIntegration } from '@sentry-internal/replay';
-import { browserTracingIntegration } from '@sentry-internal/tracing';
+import {
+  browserTracingIntegration,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
+} from '@sentry-internal/tracing';
 import { addTracingExtensions } from '@sentry/core';
 
 // We are patching the global object with our hub extension methods
@@ -16,6 +20,13 @@ export {
   getSpanDescendants,
 } from '@sentry/core';
 
-export { feedbackIntegration, replayIntegration, browserTracingIntegration, addTracingExtensions };
+export {
+  feedbackIntegration,
+  replayIntegration,
+  browserTracingIntegration,
+  addTracingExtensions,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
+};
 
 export * from './index.bundle.base';

packages/browser/src/index.bundle.tracing.replay.ts

@@ -1,6 +1,10 @@
 import { feedbackIntegrationShim } from '@sentry-internal/integration-shims';
 import { replayIntegration } from '@sentry-internal/replay';
-import { browserTracingIntegration } from '@sentry-internal/tracing';
+import {
+  browserTracingIntegration,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
+} from '@sentry-internal/tracing';
 import { addTracingExtensions } from '@sentry/core';
 
 // We are patching the global object with our hub extension methods
@@ -21,6 +25,8 @@ export {
   feedbackIntegrationShim as feedbackIntegration,
   browserTracingIntegration,
   addTracingExtensions,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
 };
 
 export * from './index.bundle.base';

packages/browser/src/index.bundle.tracing.ts

@@ -1,6 +1,10 @@
 // This is exported so the loader does not fail when switching off Replay
 import { feedbackIntegrationShim, replayIntegrationShim } from '@sentry-internal/integration-shims';
-import { browserTracingIntegration } from '@sentry-internal/tracing';
+import {
+  browserTracingIntegration,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
+} from '@sentry-internal/tracing';
 import { addTracingExtensions } from '@sentry/core';
 
 // We are patching the global object with our hub extension methods
@@ -21,6 +25,8 @@ export {
   replayIntegrationShim as replayIntegration,
   browserTracingIntegration,
   addTracingExtensions,
+  startBrowserTracingPageLoadSpan,
+  startBrowserTracingNavigationSpan,
 };
 
 export * from './index.bundle.base';

packages/core/src/fetch.ts

@@ -127,11 +127,8 @@ export function addTracingHeadersToFetchRequest(
         }
       | PolymorphicRequestHeaders;
   },
-  requestSpan?: Span,
+  span?: Span,
 ): PolymorphicRequestHeaders | undefined {
-  // eslint-disable-next-line deprecation/deprecation
-  const span = requestSpan || scope.getSpan();
-
   const isolationScope = getIsolationScope();
 
   const { traceId, spanId, sampled, dsc } = {

packages/core/src/scope.ts

@@ -19,14 +19,14 @@ import type {
   ScopeData,
   Session,
   SeverityLevel,
-  Span,
   Transaction,
   User,
 } from '@sentry/types';
 import { dateTimestampInSeconds, isPlainObject, logger, uuid4 } from '@sentry/utils';
 
 import { updateSession } from './session';
 import type { SentrySpan } from './tracing/sentrySpan';
+import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
 
 /**
  * Default value for maximum number of breadcrumbs added to an event.
@@ -87,9 +87,6 @@ export class Scope implements ScopeInterface {
    */
   protected _transactionName?: string;
 
-  /** Span */
-  protected _span?: Span;
-
   /** Session */
   protected _session?: Session;
 
@@ -134,7 +131,6 @@ export class Scope implements ScopeInterface {
     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;
@@ -145,6 +141,8 @@ export class Scope implements ScopeInterface {
     newScope._propagationContext = { ...this._propagationContext };
     newScope._client = this._client;
 
+    _setSpanForScope(newScope, _getSpanForScope(this));
+
     return newScope;
   }
 
@@ -304,33 +302,14 @@ export class Scope implements ScopeInterface {
     return this;
   }
 
-  /**
-   * Sets the Span on the scope.
-   * @param span Span
-   * @deprecated Instead of setting a span on a scope, use `startSpan()`/`startSpanManual()` instead.
-   */
-  public setSpan(span?: Span): this {
-    this._span = span;
-    this._notifyScopeListeners();
-    return this;
-  }
-
-  /**
-   * Returns the `Span` if there is one.
-   * @deprecated Use `getActiveSpan()` instead.
-   */
-  public getSpan(): Span | undefined {
-    return this._span;
-  }
-
   /**
    * Returns the `Transaction` attached to the scope (if there is one).
    * @deprecated You should not rely on the transaction, but just use `startSpan()` APIs instead.
    */
   public getTransaction(): Transaction | undefined {
     // Often, this span (if it exists at all) will be a transaction, but it's not guaranteed to be. Regardless, it will
     // have a pointer to the currently-active transaction.
-    const span = this._span;
+    const span = _getSpanForScope(this);
 
     // Cannot replace with getRootSpan because getRootSpan returns a span, not a transaction
     // Also, this method will be removed anyway.
@@ -432,11 +411,12 @@ export class Scope implements ScopeInterface {
     this._transactionName = undefined;
     this._fingerprint = undefined;
     this._requestSession = undefined;
-    this._span = undefined;
     this._session = undefined;
-    this._notifyScopeListeners();
+    _setSpanForScope(this, undefined);
     this._attachments = [];
     this._propagationContext = generatePropagationContext();
+
+    this._notifyScopeListeners();
     return this;
   }
 
@@ -522,7 +502,6 @@ export class Scope implements ScopeInterface {
       _propagationContext,
       _sdkProcessingMetadata,
       _transactionName,
-      _span,
     } = this;
 
     return {
@@ -538,7 +517,7 @@ export class Scope implements ScopeInterface {
       propagationContext: _propagationContext,
       sdkProcessingMetadata: _sdkProcessingMetadata,
       transactionName: _transactionName,
-      span: _span,
+      span: _getSpanForScope(this),
     };
   }
 

packages/core/src/server-runtime-client.ts

@@ -24,6 +24,7 @@ import {
   getDynamicSamplingContextFromClient,
   getDynamicSamplingContextFromSpan,
 } from './tracing';
+import { _getSpanForScope } from './utils/spanOnScope';
 import { getRootSpan, spanToTraceContext } from './utils/spanUtils';
 
 export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
@@ -252,8 +253,7 @@ export class ServerRuntimeClient<
       return [undefined, undefined];
     }
 
-    // eslint-disable-next-line deprecation/deprecation
-    const span = scope.getSpan();
+    const span = _getSpanForScope(scope);
     if (span) {
       const rootSpan = getRootSpan(span);
       const samplingContext = getDynamicSamplingContextFromSpan(rootSpan);

packages/core/src/tracing/idleSpan.ts

@@ -5,6 +5,7 @@ import { getClient, getCurrentScope } from '../currentScopes';
 import { DEBUG_BUILD } from '../debug-build';
 import { SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON } from '../semanticAttributes';
 import { hasTracingEnabled } from '../utils/hasTracingEnabled';
+import { _setSpanForScope } from '../utils/spanOnScope';
 import {
   getActiveSpan,
   getSpanDescendants,
@@ -232,8 +233,7 @@ export function startIdleSpan(startSpanOptions: StartSpanOptions, options: Parti
       beforeSpanEnd(span);
     }
 
-    // eslint-disable-next-line deprecation/deprecation
-    scope.setSpan(previousActiveSpan);
+    _setSpanForScope(scope, previousActiveSpan);
 
     const spanJSON = spanToJSON(span);
 
@@ -347,8 +347,7 @@ export function startIdleSpan(startSpanOptions: StartSpanOptions, options: Parti
 function _startIdleSpan(options: StartSpanOptions): Span {
   const span = startInactiveSpan(options);
 
-  // eslint-disable-next-line deprecation/deprecation
-  getCurrentScope().setSpan(span);
+  _setSpanForScope(getCurrentScope(), span);
 
   DEBUG_BUILD && logger.log(`Setting idle span on scope. Span ID: ${span.spanContext().spanId}`);