fix(tracing): Performance Tracing should be disabled by default (#3533)

Author: krystofwoldrich

CHANGELOG.md

@@ -25,6 +25,7 @@
 
 - Fix `WITH_ENVIRONMENT` overwrite in `sentry-xcode-debug-files.sh` ([#3525](https://github.com/getsentry/sentry-react-native/pull/3525))
 - Sentry CLI 2.25.1 fixes background debug files uploads during Xcode builds ([#3486](https://github.com/getsentry/sentry-react-native/pull/3486))
+- Performance Tracing should be disabled by default ([#3533](https://github.com/getsentry/sentry-react-native/pull/3533))
 
 ### Dependencies
 

src/js/integrations/default.ts

@@ -1,4 +1,3 @@
-import { hasTracingEnabled } from '@sentry/core';
 import { HttpClient } from '@sentry/integrations';
 import { Integrations as BrowserReactIntegrations } from '@sentry/react';
 import type { Integration } from '@sentry/types';
@@ -77,7 +76,14 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ
     }
   }
 
-  if (hasTracingEnabled(options) && options.enableAutoPerformanceTracing) {
+  // hasTracingEnabled from `@sentry/core` only check if tracesSampler or tracesSampleRate keys are present
+  // that's different from prev imp here and might lead misconfiguration
+  // `tracesSampleRate: undefined` should not enable tracing
+  const hasTracingEnabled =
+    options.enableTracing ||
+    typeof options.tracesSampleRate === 'number' ||
+    typeof options.tracesSampler === 'function';
+  if (hasTracingEnabled && options.enableAutoPerformanceTracing) {
     integrations.push(new ReactNativeTracing());
   }
   if (options.enableCaptureFailedRequests) {

src/js/sdk.tsx

@@ -76,8 +76,11 @@ export function init(passedOptions: ReactNativeOptions): void {
     stackParser: stackParserFromStackParserOptions(passedOptions.stackParser || defaultStackParser),
     beforeBreadcrumb: safeFactory(passedOptions.beforeBreadcrumb, { loggerMessage: 'The beforeBreadcrumb threw an error' }),
     initialScope: safeFactory(passedOptions.initialScope, { loggerMessage: 'The initialScope threw an error' }),
-    tracesSampler: safeTracesSampler(passedOptions.tracesSampler),
   };
+  if ('tracesSampler' in options) {
+    options.tracesSampler = safeTracesSampler(options.tracesSampler);
+  }
+
   if (!('environment' in options)) {
     options.environment = getDefaultEnvironment();
   }

test/profiling/integration.test.ts

@@ -334,6 +334,7 @@ function initTestClient(
   const transportSendMock = jest.fn<ReturnType<Transport['send']>, Parameters<Transport['send']>>();
   const options: Sentry.ReactNativeOptions = {
     dsn: MOCK_DSN,
+    enableTracing: true,
     _experiments: {
       profilesSampleRate: 1,
     },

test/sdk.test.ts

@@ -115,6 +115,28 @@ describe('Tests the SDK functionality', () => {
         return new ReactNativeTracing({ routingInstrumentation: nav });
       };
 
+      it('Auto Performance is disabled by default', () => {
+        init({});
+
+        expect(autoPerformanceIsEnabled()).toBe(false);
+      });
+
+      it('Auto Performance is disabled when tracesSampleRate is set to undefined', () => {
+        init({
+          tracesSampleRate: undefined,
+        });
+
+        expect(autoPerformanceIsEnabled()).toBe(false);
+      });
+
+      it('Auto Performance is disabled when tracesSampler is set to undefined', () => {
+        init({
+          tracesSampler: undefined,
+        });
+
+        expect(autoPerformanceIsEnabled()).toBe(false);
+      });
+
       it('Auto Performance is enabled when tracing is enabled (tracesSampler)', () => {
         init({
           tracesSampler: () => true,