fix(nextjs|sveltekit): Ensure we can pass browserTracingIntegration

Author: mydea

packages/nextjs/src/client/browserTracingIntegration.ts

@@ -5,7 +5,7 @@ import {
   startBrowserTracingNavigationSpan,
   startBrowserTracingPageLoadSpan,
 } from '@sentry/react';
-import type { Integration, StartSpanOptions } from '@sentry/types';
+import type { StartSpanOptions } from '@sentry/types';
 import { nextRouterInstrumentation } from '../index.client';
 
 /**
@@ -42,7 +42,7 @@ export class BrowserTracing extends OriginalBrowserTracing {
  */
 export function browserTracingIntegration(
   options?: Parameters<typeof originalBrowserTracingIntegration>[0],
-): Integration {
+): ReturnType<typeof originalBrowserTracingIntegration> {
   const browserTracingIntegrationInstance = originalBrowserTracingIntegration({
     // eslint-disable-next-line deprecation/deprecation
     tracingOrigins:
@@ -63,6 +63,10 @@ export function browserTracingIntegration(
 
   return {
     ...browserTracingIntegrationInstance,
+    options: {
+      ...browserTracingIntegrationInstance.options,
+      ...options,
+    },
     afterAllSetup(client) {
       const startPageloadCallback = (startSpanOptions: StartSpanOptions): void => {
         startBrowserTracingPageLoadSpan(client, startSpanOptions);

packages/nextjs/test/clientSdk.test.ts

@@ -143,7 +143,7 @@ describe('Client init()', () => {
     it('forces correct router instrumentation if user provides `browserTracingIntegration`', () => {
       init({
         dsn: TEST_DSN,
-        integrations: [browserTracingIntegration({ finalTimeout: 10 })],
+        integrations: [browserTracingIntegration({ finalTimeout: 10, instrumentNavigation: false })],
         enableTracing: true,
       });
 
@@ -158,6 +158,8 @@ describe('Client init()', () => {
 
       // This shows that the user-configured options are still here
       expect(integration?.options?.finalTimeout).toEqual(10);
+      expect(integration?.options.instrumentNavigation).toBe(false);
+      expect(integration?.options.instrumentPageLoad).toBe(true);
 
       // it is the svelte kit variety
       expect(getActiveSpan()).toBeDefined();
@@ -187,10 +189,10 @@ describe('Client init()', () => {
 
       expect(browserTracingIntegration?.options).toEqual(
         expect.objectContaining({
+          startTransactionOnPageLoad: true,
+          startTransactionOnLocationChange: false,
           // eslint-disable-next-line deprecation/deprecation
           routingInstrumentation: nextRouterInstrumentation,
-          // This proves it's still the user's copy
-          startTransactionOnLocationChange: false,
         }),
       );
     });

packages/sveltekit/src/client/browserTracingIntegration.ts

@@ -9,7 +9,7 @@ import {
   startBrowserTracingPageLoadSpan,
   startInactiveSpan,
 } from '@sentry/svelte';
-import type { Client, Integration, Span } from '@sentry/types';
+import type { Client, Span } from '@sentry/types';
 import { svelteKitRoutingInstrumentation } from './router';
 
 /**
@@ -36,7 +36,7 @@ export class BrowserTracing extends OriginalBrowserTracing {
  */
 export function browserTracingIntegration(
   options: Parameters<typeof originalBrowserTracingIntegration>[0] = {},
-): Integration {
+): ReturnType<typeof originalBrowserTracingIntegration> {
   const integration = {
     ...originalBrowserTracingIntegration({
       ...options,
@@ -47,6 +47,10 @@ export function browserTracingIntegration(
 
   return {
     ...integration,
+    options: {
+      ...integration.options,
+      ...options,
+    },
     afterAllSetup: client => {
       integration.afterAllSetup(client);
 

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

@@ -99,7 +99,7 @@ describe('Sentry client SDK', () => {
         init({
           dsn: 'https://[email protected]/1337',
           // eslint-disable-next-line deprecation/deprecation
-          integrations: [new BrowserTracing({ finalTimeout: 10 })],
+          integrations: [new BrowserTracing({ finalTimeout: 10, startTransactionOnLocationChange: false })],
           enableTracing: true,
         });
 
@@ -118,12 +118,14 @@ describe('Sentry client SDK', () => {
         // But we force the routing instrumentation to be ours
         // eslint-disable-next-line deprecation/deprecation
         expect(options.routingInstrumentation).toEqual(svelteKitRoutingInstrumentation);
+        expect(options.startTransactionOnPageLoad).toEqual(true);
+        expect(options.startTransactionOnLocationChange).toEqual(false);
       });
 
       it('Merges a user-provided browserTracingIntegration with the automatically added one', () => {
         init({
           dsn: 'https://[email protected]/1337',
-          integrations: [browserTracingIntegration({ finalTimeout: 10 })],
+          integrations: [browserTracingIntegration({ finalTimeout: 10, instrumentNavigation: false })],
           enableTracing: true,
         });
 
@@ -140,6 +142,8 @@ describe('Sentry client SDK', () => {
 
         // This shows that the user-configured options are still here
         expect(options?.finalTimeout).toEqual(10);
+        expect(options?.instrumentPageLoad).toEqual(true);
+        expect(options?.instrumentNavigation).toEqual(false);
 
         // it is the svelte kit variety
         expect(getActiveSpan()).toBeDefined();