feat(core): Deprecate addTracingExtensions (#11579)

Instead, users can use `registerSpanErrorInstrumentation` which is now
does much less things than before.

I opted to not fully remove this yet because I guess the chance that
somebody may have been using this is somewhat high, and we can easily
continue to have it with no bundle size hit for those who don't need it.
We also couldn't really deprecate this in v7 so I think it's OK to leave
this in for now.

Author: mydea

MIGRATION.md

@@ -65,7 +65,7 @@ We've removed the following packages:
 `@sentry/tracing` has been removed and will no longer be published. See
 [below](./MIGRATION.md/#3-removal-of-deprecated-apis) for more details.
 
-For Browser SDKs you can import `BrowserTracing` from the SDK directly:
+For Browser SDKs you can import `browserTracingIntegration` from the SDK directly:
 
 ```js
 // v7
@@ -86,12 +86,13 @@ import * as Sentry from '@sentry/browser';
 Sentry.init({
   dsn: '__DSN__',
   tracesSampleRate: 1.0,
-  integrations: [new Sentry.BrowserTracing()],
+  integrations: [Sentry.browserTracingIntegration()],
 });
 ```
 
-If you were importing `@sentry/tracing` for the side effect, you can now use `Sentry.addTracingExtensions()` to add the
-tracing extensions to the SDK. `addTracingExtensions` replaces the `addExtensionMethods` method from `@sentry/tracing`.
+If you don't want to use `browserTracingIntegration` but still manually start spans, you can now use
+`Sentry.registerSpanErrorInstrumentation()` to setup handlers for span instrumentation.
+`registerSpanErrorInstrumentation` replaces the `addExtensionMethods` method from `@sentry/tracing`.
 
 ```js
 // v7
@@ -108,7 +109,7 @@ Sentry.init({
 // v8
 import * as Sentry from '@sentry/browser';
 
-Sentry.addTracingExtensions();
+Sentry.registerSpanErrorInstrumentation();
 
 Sentry.init({
   dsn: '__DSN__',

dev-packages/browser-integration-tests/suites/public-api/startSpan/init.js

@@ -2,8 +2,6 @@ import * as Sentry from '@sentry/browser';
 
 window.Sentry = Sentry;
 
-Sentry.addTracingExtensions();
-
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   tracesSampleRate: 1.0,

packages/browser-utils/test/browser/utils.test.ts

@@ -1,18 +1,9 @@
-import {
-  SentrySpan,
-  addTracingExtensions,
-  getCurrentScope,
-  getIsolationScope,
-  setCurrentClient,
-  spanToJSON,
-} from '@sentry/core';
+import { SentrySpan, getCurrentScope, getIsolationScope, setCurrentClient, spanToJSON } from '@sentry/core';
 import { startAndEndSpan } from '../../src/metrics/utils';
 import { TestClient, getDefaultClientOptions } from '../utils/TestClient';
 
 describe('startAndEndSpan()', () => {
   beforeEach(() => {
-    addTracingExtensions();
-
     getCurrentScope().clear();
     getIsolationScope().clear();
 

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

@@ -1,9 +1,4 @@
-// This is exported so the loader does not fail when switching off Replay/Tracing
-import {
-  addTracingExtensionsShim,
-  browserTracingIntegrationShim,
-  replayIntegrationShim,
-} from '@sentry-internal/integration-shims';
+import { browserTracingIntegrationShim, replayIntegrationShim } from '@sentry-internal/integration-shims';
 
 export * from './index.bundle.base';
 
@@ -14,8 +9,4 @@ export {
   getFeedback,
 } from '@sentry-internal/feedback';
 
-export {
-  browserTracingIntegrationShim as browserTracingIntegration,
-  addTracingExtensionsShim as addTracingExtensions,
-  replayIntegrationShim as replayIntegration,
-};
+export { browserTracingIntegrationShim as browserTracingIntegration, replayIntegrationShim as replayIntegration };

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

@@ -1,6 +1,4 @@
-// This is exported so the loader does not fail when switching off Replay/Tracing
 import {
-  addTracingExtensionsShim,
   browserTracingIntegrationShim,
   feedbackIntegrationShim,
   feedbackModalIntegrationShim,
@@ -13,7 +11,6 @@ export { replayIntegration } from '@sentry-internal/replay';
 
 export {
   browserTracingIntegrationShim as browserTracingIntegration,
-  addTracingExtensionsShim as addTracingExtensions,
   feedbackIntegrationShim as feedbackIntegration,
   feedbackModalIntegrationShim as feedbackModalIntegration,
   feedbackScreenshotIntegrationShim as feedbackScreenshotIntegration,

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

@@ -1,7 +1,6 @@
-import { addTracingExtensions } from '@sentry/core';
+import { registerSpanErrorInstrumentation } from '@sentry/core';
 
-// We are patching the global object with our hub extension methods
-addTracingExtensions();
+registerSpanErrorInstrumentation();
 
 export * from './index.bundle.base';
 
@@ -14,7 +13,6 @@ export {
   withActiveSpan,
   getSpanDescendants,
   setMeasurement,
-  addTracingExtensions,
 } from '@sentry/core';
 
 export {

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

@@ -3,10 +3,9 @@ import {
   feedbackModalIntegrationShim,
   feedbackScreenshotIntegrationShim,
 } from '@sentry-internal/integration-shims';
-import { addTracingExtensions } from '@sentry/core';
+import { registerSpanErrorInstrumentation } from '@sentry/core';
 
-// We are patching the global object with our hub extension methods
-addTracingExtensions();
+registerSpanErrorInstrumentation();
 
 export * from './index.bundle.base';
 
@@ -19,7 +18,6 @@ export {
   withActiveSpan,
   getSpanDescendants,
   setMeasurement,
-  addTracingExtensions,
 } from '@sentry/core';
 
 export {

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

@@ -1,14 +1,12 @@
-// This is exported so the loader does not fail when switching off Replay
 import {
   feedbackIntegrationShim,
   feedbackModalIntegrationShim,
   feedbackScreenshotIntegrationShim,
   replayIntegrationShim,
 } from '@sentry-internal/integration-shims';
-import { addTracingExtensions } from '@sentry/core';
+import { registerSpanErrorInstrumentation } from '@sentry/core';
 
-// We are patching the global object with our hub extension methods
-addTracingExtensions();
+registerSpanErrorInstrumentation();
 
 export * from './index.bundle.base';
 
@@ -21,7 +19,6 @@ export {
   withActiveSpan,
   getSpanDescendants,
   setMeasurement,
-  addTracingExtensions,
 } from '@sentry/core';
 
 export {

packages/browser/src/index.bundle.ts

@@ -1,6 +1,4 @@
-// This is exported so the loader does not fail when switching off Replay/Tracing
 import {
-  addTracingExtensionsShim,
   browserTracingIntegrationShim,
   feedbackIntegrationShim,
   feedbackModalIntegrationShim,
@@ -11,7 +9,6 @@ import {
 export * from './index.bundle.base';
 
 export {
-  addTracingExtensionsShim as addTracingExtensions,
   browserTracingIntegrationShim as browserTracingIntegration,
   feedbackIntegrationShim as feedbackIntegration,
   feedbackModalIntegrationShim as feedbackModalIntegration,

packages/browser/src/index.ts

@@ -49,7 +49,9 @@ export {
 } from './tracing/browserTracingIntegration';
 export type { RequestInstrumentationOptions } from './tracing/request';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   addTracingExtensions,
+  registerSpanErrorInstrumentation,
   getActiveSpan,
   getRootSpan,
   startSpan,

packages/browser/src/tracing/browserTracingIntegration.ts

@@ -10,13 +10,13 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   TRACING_DEFAULTS,
-  addTracingExtensions,
   continueTrace,
   getActiveSpan,
   getClient,
   getCurrentScope,
   getIsolationScope,
   getRootSpan,
+  registerSpanErrorInstrumentation,
   spanToJSON,
   startIdleSpan,
   withScope,
@@ -153,7 +153,7 @@ const DEFAULT_BROWSER_TRACING_OPTIONS: BrowserTracingOptions = {
  * We explicitly export the proper type here, as this has to be extended in some cases.
  */
 export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptions> = {}) => {
-  addTracingExtensions();
+  registerSpanErrorInstrumentation();
 
   const options = {
     ...DEFAULT_BROWSER_TRACING_OPTIONS,

packages/browser/test/unit/tracing/backgroundtab.test.ts

@@ -1,4 +1,4 @@
-import { addTracingExtensions, getCurrentScope } from '@sentry/core';
+import { getCurrentScope } from '@sentry/core';
 import { setCurrentClient } from '@sentry/core';
 
 import { TextDecoder, TextEncoder } from 'util';
@@ -30,8 +30,6 @@ describe('registerBackgroundTabDetection', () => {
     setCurrentClient(client);
     client.init();
 
-    addTracingExtensions();
-
     global.document.addEventListener = jest.fn((event, callback) => {
       events[event] = callback;
     });

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

@@ -20,9 +20,9 @@ import { DEBUG_BUILD } from './debug-build';
 import type { Scope } from './scope';
 import { SessionFlusher } from './sessionflusher';
 import {
-  addTracingExtensions,
   getDynamicSamplingContextFromClient,
   getDynamicSamplingContextFromSpan,
+  registerSpanErrorInstrumentation,
 } from './tracing';
 import { _getSpanForScope } from './utils/spanOnScope';
 import { getRootSpan, spanToTraceContext } from './utils/spanUtils';
@@ -47,7 +47,7 @@ export class ServerRuntimeClient<
    */
   public constructor(options: O) {
     // Server clients always support tracing
-    addTracingExtensions();
+    registerSpanErrorInstrumentation();
 
     super(options);
   }

packages/core/src/tracing/errors.ts

@@ -16,9 +16,9 @@ export function _resetErrorsInstrumented(): void {
 }
 
 /**
- * Configures global error listeners
+ * Ensure that global errors automatically set the active span status.
  */
-export function registerErrorInstrumentation(): void {
+export function registerSpanErrorInstrumentation(): void {
   if (errorsInstrumented) {
     return;
   }

packages/core/src/tracing/hubextensions.ts

@@ -1,9 +1,8 @@
-import { registerErrorInstrumentation } from './errors';
+import { registerSpanErrorInstrumentation } from './errors';
 
 /**
- * Adds tracing extensions.
- * TODO (v8): Do we still need this?? Can we solve this differently?
+ * @deprecated Use `registerSpanErrorInstrumentation()` instead. In v9, this function will be removed. Note that you don't need to call this in Node-based SDKs or when using `browserTracingIntegration`.
  */
 export function addTracingExtensions(): void {
-  registerErrorInstrumentation();
+  registerSpanErrorInstrumentation();
 }

packages/core/src/tracing/index.ts

@@ -1,4 +1,6 @@
+export { registerSpanErrorInstrumentation } from './errors';
 export { setCapturedScopesOnSpan, getCapturedScopesOnSpan } from './utils';
+// eslint-disable-next-line deprecation/deprecation
 export { addTracingExtensions } from './hubextensions';
 export { startIdleSpan, TRACING_DEFAULTS } from './idleSpan';
 export { SentrySpan } from './sentrySpan';

packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

@@ -4,12 +4,7 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   setCurrentClient,
 } from '../../../src';
-import {
-  SentrySpan,
-  addTracingExtensions,
-  getDynamicSamplingContextFromSpan,
-  startInactiveSpan,
-} from '../../../src/tracing';
+import { SentrySpan, getDynamicSamplingContextFromSpan, startInactiveSpan } from '../../../src/tracing';
 import { freezeDscOnSpan } from '../../../src/tracing/dynamicSamplingContext';
 import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';
 
@@ -19,7 +14,6 @@ describe('getDynamicSamplingContextFromSpan', () => {
     const client = new TestClient(options);
     setCurrentClient(client);
     client.init();
-    addTracingExtensions();
   });
 
   afterEach(() => {

packages/core/test/lib/tracing/errors.test.ts

@@ -1,7 +1,7 @@
 import type { HandlerDataError, HandlerDataUnhandledRejection } from '@sentry/types';
-import { addTracingExtensions, setCurrentClient, spanToJSON, startInactiveSpan, startSpan } from '../../../src';
+import { setCurrentClient, spanToJSON, startInactiveSpan, startSpan } from '../../../src';
 
-import { _resetErrorsInstrumented, registerErrorInstrumentation } from '../../../src/tracing/errors';
+import { _resetErrorsInstrumented, registerSpanErrorInstrumentation } from '../../../src/tracing/errors';
 import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';
 
 const mockAddGlobalErrorInstrumentationHandler = jest.fn();
@@ -25,10 +25,6 @@ jest.mock('@sentry/utils', () => {
   };
 });
 
-beforeAll(() => {
-  addTracingExtensions();
-});
-
 describe('registerErrorHandlers()', () => {
   beforeEach(() => {
     mockAddGlobalErrorInstrumentationHandler.mockClear();
@@ -41,15 +37,15 @@ describe('registerErrorHandlers()', () => {
   });
 
   it('registers error instrumentation', () => {
-    registerErrorInstrumentation();
+    registerSpanErrorInstrumentation();
     expect(mockAddGlobalErrorInstrumentationHandler).toHaveBeenCalledTimes(1);
     expect(mockAddGlobalUnhandledRejectionInstrumentationHandler).toHaveBeenCalledTimes(1);
     expect(mockAddGlobalErrorInstrumentationHandler).toHaveBeenCalledWith(expect.any(Function));
     expect(mockAddGlobalUnhandledRejectionInstrumentationHandler).toHaveBeenCalledWith(expect.any(Function));
   });
 
   it('does not set status if transaction is not on scope', () => {
-    registerErrorInstrumentation();
+    registerSpanErrorInstrumentation();
 
     const transaction = startInactiveSpan({ name: 'test' })!;
     expect(spanToJSON(transaction).status).toBe(undefined);
@@ -64,7 +60,7 @@ describe('registerErrorHandlers()', () => {
   });
 
   it('sets status for transaction on scope on error', () => {
-    registerErrorInstrumentation();
+    registerSpanErrorInstrumentation();
 
     startSpan({ name: 'test' }, span => {
       mockErrorCallback({} as HandlerDataError);
@@ -73,7 +69,7 @@ describe('registerErrorHandlers()', () => {
   });
 
   it('sets status for transaction on scope on unhandledrejection', () => {
-    registerErrorInstrumentation();
+    registerSpanErrorInstrumentation();
 
     startSpan({ name: 'test' }, span => {
       mockUnhandledRejectionCallback({});

packages/core/test/lib/tracing/idleSpan.test.ts

@@ -5,7 +5,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON,
   SentryNonRecordingSpan,
   SentrySpan,
-  addTracingExtensions,
   getActiveSpan,
   getClient,
   getCurrentScope,
@@ -24,7 +23,6 @@ const dsn = 'https://123@sentry.io/42';
 describe('startIdleSpan', () => {
   beforeEach(() => {
     jest.useFakeTimers();
-    addTracingExtensions();
 
     getCurrentScope().clear();
     getIsolationScope().clear();