stuff

Author: Luca Forstner

dev-packages/browser-integration-tests/suites/tracing/browsertracing/init.js

@@ -1,10 +1,9 @@
 import * as Sentry from '@sentry/browser';
-import { Integrations } from '@sentry/tracing';
 
 window.Sentry = Sentry;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [new Integrations.BrowserTracing()],
+  integrations: [Sentry.browserTracingIntegration()],
   tracesSampleRate: 1,
 });

packages/remix/test/integration/app_v2/entry.client.tsx

@@ -7,8 +7,10 @@ Sentry.init({
   dsn: 'https://[email protected]/1337',
   tracesSampleRate: 1,
   integrations: [
-    new Sentry.BrowserTracing({
-      routingInstrumentation: Sentry.remixRouterInstrumentation(useEffect, useLocation, useMatches),
+    Sentry.browserTracingIntegration({
+      useEffect,
+      useLocation,
+      useMatches,
     }),
   ],
 });

packages/sveltekit/src/client/sdk.ts

@@ -1,13 +1,10 @@
 import { applySdkMetadata, hasTracingEnabled, setTag } from '@sentry/core';
-import type { BrowserOptions, browserTracingIntegration } from '@sentry/svelte';
+import type { BrowserOptions } from '@sentry/svelte';
 import { getDefaultIntegrations as getDefaultSvelteIntegrations } from '@sentry/svelte';
 import { WINDOW, init as initSvelteSdk } from '@sentry/svelte';
 import type { Integration } from '@sentry/types';
 
-import {
-  BrowserTracing,
-  browserTracingIntegration as svelteKitBrowserTracingIntegration,
-} from './browserTracingIntegration';
+import { browserTracingIntegration as svelteKitBrowserTracingIntegration } from './browserTracingIntegration';
 
 type WindowWithSentryFetchProxy = typeof WINDOW & {
   _sentryFetchProxy?: typeof fetch;
@@ -29,8 +26,6 @@ export function init(options: BrowserOptions): void {
 
   applySdkMetadata(opts, 'sveltekit', ['sveltekit', 'svelte']);
 
-  fixBrowserTracingIntegration(opts);
-
   // 1. Switch window.fetch to our fetch proxy we injected earlier
   const actualFetch = switchToFetchProxy();
 
@@ -45,61 +40,6 @@ export function init(options: BrowserOptions): void {
   setTag('runtime', 'browser');
 }
 
-// TODO v8: Remove this again
-// We need to handle BrowserTracing passed to `integrations` that comes from `@sentry/tracing`, not `@sentry/sveltekit` :(
-function fixBrowserTracingIntegration(options: BrowserOptions): void {
-  const { integrations } = options;
-  if (!integrations) {
-    return;
-  }
-
-  if (Array.isArray(integrations)) {
-    options.integrations = maybeUpdateBrowserTracingIntegration(integrations);
-  } else {
-    options.integrations = defaultIntegrations => {
-      const userFinalIntegrations = integrations(defaultIntegrations);
-
-      return maybeUpdateBrowserTracingIntegration(userFinalIntegrations);
-    };
-  }
-}
-
-function isNewBrowserTracingIntegration(
-  integration: Integration,
-): integration is Integration & { options?: Parameters<typeof browserTracingIntegration>[0] } {
-  // eslint-disable-next-line deprecation/deprecation
-  return !!integration.afterAllSetup && !!(integration as BrowserTracing).options;
-}
-
-function maybeUpdateBrowserTracingIntegration(integrations: Integration[]): Integration[] {
-  const browserTracing = integrations.find(integration => integration.name === 'BrowserTracing');
-
-  if (!browserTracing) {
-    return integrations;
-  }
-
-  // If `browserTracingIntegration()` was added, we need to force-convert it to our custom one
-  if (isNewBrowserTracingIntegration(browserTracing)) {
-    const { options } = browserTracing;
-    // eslint-disable-next-line deprecation/deprecation
-    integrations[integrations.indexOf(browserTracing)] = new BrowserTracing(options);
-  }
-
-  // If BrowserTracing was added, but it is not our forked version,
-  // replace it with our forked version with the same options
-  // eslint-disable-next-line deprecation/deprecation
-  if (!(browserTracing instanceof BrowserTracing)) {
-    // eslint-disable-next-line deprecation/deprecation
-    const options: ConstructorParameters<typeof BrowserTracing>[0] = (browserTracing as BrowserTracing).options;
-    // This option is overwritten by the custom integration
-    delete options.routingInstrumentation;
-    // eslint-disable-next-line deprecation/deprecation
-    integrations[integrations.indexOf(browserTracing)] = new BrowserTracing(options);
-  }
-
-  return integrations;
-}
-
 function getDefaultIntegrations(options: BrowserOptions): Integration[] | undefined {
   // This evaluates to true unless __SENTRY_TRACING__ is text-replaced with "false", in which case everything inside
   // will get treeshaken away

packages/sveltekit/test/client/sdk.test.ts

@@ -61,7 +61,7 @@ describe('Sentry client SDK', () => {
         ['tracesSampleRate', { tracesSampleRate: 0 }],
         ['tracesSampler', { tracesSampler: () => 1.0 }],
         ['enableTracing', { enableTracing: true }],
-      ])('adds the BrowserTracing integration if tracing is enabled via %s', (_, tracingOptions) => {
+      ])('adds a browserTracingIntegration if tracing is enabled via %s', (_, tracingOptions) => {
         init({
           dsn: 'https://[email protected]/1337',
           ...tracingOptions,
@@ -74,7 +74,7 @@ describe('Sentry client SDK', () => {
       it.each([
         ['enableTracing', { enableTracing: false }],
         ['no tracing option set', {}],
-      ])("doesn't add the BrowserTracing integration if tracing is disabled via %s", (_, tracingOptions) => {
+      ])("doesn't add a browserTracingIntegration integration if tracing is disabled via %s", (_, tracingOptions) => {
         init({
           dsn: 'https://[email protected]/1337',
           ...tracingOptions,
@@ -84,7 +84,7 @@ describe('Sentry client SDK', () => {
         expect(browserTracing).toBeUndefined();
       });
 
-      it("doesn't add the BrowserTracing integration if `__SENTRY_TRACING__` is set to false", () => {
+      it("doesn't add a browserTracingIntegration if `__SENTRY_TRACING__` is set to false", () => {
         // This is the closest we can get to unit-testing the `__SENTRY_TRACING__` tree-shaking guard
         // IRL, the code to add the integration would most likely be removed by the bundler.
 
@@ -100,49 +100,6 @@ describe('Sentry client SDK', () => {
 
         delete globalThis.__SENTRY_TRACING__;
       });
-
-      it('Merges a user-provided BrowserTracing integration with the automatically added one', () => {
-        init({
-          dsn: 'https://[email protected]/1337',
-          // eslint-disable-next-line deprecation/deprecation
-          integrations: [new BrowserTracing({ finalTimeout: 10 })],
-          enableTracing: true,
-        });
-
-        // eslint-disable-next-line deprecation/deprecation
-        const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
-        const options = browserTracing.options;
-
-        expect(browserTracing).toBeDefined();
-
-        // This shows that the user-configured options are still here
-        expect(options.finalTimeout).toEqual(10);
-
-        // But we force the routing instrumentation to be ours
-        // eslint-disable-next-line deprecation/deprecation
-        expect(options.routingInstrumentation).toEqual(svelteKitRoutingInstrumentation);
-      });
-
-      it('Merges a user-provided browserTracingIntegration with the automatically added one', () => {
-        init({
-          dsn: 'https://[email protected]/1337',
-          integrations: [browserTracingIntegration({ finalTimeout: 10 })],
-          enableTracing: true,
-        });
-
-        // eslint-disable-next-line deprecation/deprecation
-        const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
-        const options = browserTracing.options;
-
-        expect(browserTracing).toBeDefined();
-
-        // This shows that the user-configured options are still here
-        expect(options.finalTimeout).toEqual(10);
-
-        // But we force the routing instrumentation to be ours
-        // eslint-disable-next-line deprecation/deprecation
-        expect(options.routingInstrumentation).toEqual(svelteKitRoutingInstrumentation);
-      });
     });
   });
 });

packages/tracing-internal/src/browser/browserTracingIntegration.ts

@@ -380,9 +380,6 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
         enableHTTPTimings,
       });
     },
-    // TODO v8: Remove this again
-    // This is private API that we use to fix converted BrowserTracing integrations in Next.js & SvelteKit
-    options,
   };
 }) satisfies IntegrationFn;
 

packages/tracing-internal/test/browser/browsertracing.test.ts

@@ -3,20 +3,21 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   TRACING_DEFAULTS,
   getClient,
-  getCurrentHub,
   setCurrentClient,
   spanToJSON,
 } from '@sentry/core';
 import * as hubExtensions from '@sentry/core';
 import type { BaseTransportOptions, ClientOptions, DsnComponents, HandlerDataHistory } from '@sentry/types';
 import { JSDOM } from 'jsdom';
 
+import { BrowserClient } from '@sentry/browser';
 import { timestampInSeconds } from '@sentry/utils';
 import type { IdleTransaction } from '../../../tracing/src';
 import { getActiveTransaction } from '../../../tracing/src';
 import { getDefaultBrowserClientOptions } from '../../../tracing/test/testutils';
+import { browserTracingIntegration } from '../../build/types';
 import type { BrowserTracingOptions } from '../../src/browser/browsertracing';
-import { BrowserTracing, getMetaContent } from '../../src/browser/browsertracing';
+import { getMetaContent } from '../../src/browser/browsertracing';
 import { defaultRequestInstrumentationOptions } from '../../src/browser/request';
 import { instrumentRoutingWithDefaults } from '../../src/browser/router';
 import { WINDOW } from '../../src/browser/types';
@@ -82,11 +83,10 @@ describe('BrowserTracing', () => {
     }
   });
 
-  function createBrowserTracing(setup?: boolean, _options?: Partial<BrowserTracingOptions>): BrowserTracing {
-    const instance = new BrowserTracing(_options);
+  function createBrowserTracing(setup?: boolean, options?: Partial<BrowserTracingOptions>) {
+    const instance = browserTracingIntegration(options);
     if (setup) {
-      const processor = () => undefined;
-      instance.setupOnce(processor, () => getCurrentHub() as hubExtensions.Hub);
+      instance.afterAllSetup(new BrowserClient());
     }
 
     return instance;

packages/tracing/test/hub.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable deprecation/deprecation */
 /* eslint-disable @typescript-eslint/unbound-method */
-import { BrowserClient } from '@sentry/browser';
+import { BrowserClient, browserTracingIntegration } from '@sentry/browser';
 import { Hub, SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, makeMain } from '@sentry/core';
 import * as utilsModule from '@sentry/utils'; // for mocking
 import { extractTraceparentData, logger } from '@sentry/utils';
@@ -457,7 +457,7 @@ The transaction will not be sampled. Please use the otel instrumentation to star
           const options = getDefaultBrowserClientOptions({
             dsn: 'https://[email protected]/1121',
             tracesSampleRate: 1,
-            integrations: [new BrowserTracing()],
+            integrations: [browserTracingIntegration()],
           });
           const hub = new Hub(new BrowserClient(options));
           makeMain(hub);
@@ -496,7 +496,7 @@ The transaction will not be sampled. Please use the otel instrumentation to star
           const options = getDefaultBrowserClientOptions({
             dsn: 'https://[email protected]/1121',
             tracesSampleRate: 1,
-            integrations: [new BrowserTracing()],
+            integrations: [browserTracingIntegration()],
           });
           const hub = new Hub(new BrowserClient(options));
           makeMain(hub);