fix(tracing): Drop app start data older than one minute (#3974)

Author: krystofwoldrich

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Drop app start data older than one minute ([#3974](https://github.com/getsentry/sentry-react-native/pull/3974))
+
 ### Dependencies
 
 - Bump Android SDK from v7.12.0 to v7.12.1 ([#3970](https://github.com/getsentry/sentry-react-native/pull/3970))

src/js/tracing/reactnativetracing.ts

@@ -2,7 +2,7 @@
 import type { RequestInstrumentationOptions } from '@sentry/browser';
 import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from '@sentry/browser';
 import type { Hub, IdleTransaction, Transaction } from '@sentry/core';
-import { getActiveTransaction, getCurrentHub, startIdleTransaction } from '@sentry/core';
+import { getActiveTransaction, getCurrentHub, spanToJSON, startIdleTransaction } from '@sentry/core';
 import type {
   Event,
   EventProcessor,
@@ -134,6 +134,8 @@ export class ReactNativeTracing implements Integration {
   public static id: string = 'ReactNativeTracing';
   /** We filter out App starts more than 60s */
   private static _maxAppStart: number = 60000;
+  /** We filter out App starts which timestamp is 60s and more before the transaction start */
+  private static _maxAppStartBeforeTransactionMs: number = 60000;
   /**
    * @inheritDoc
    */
@@ -477,6 +479,14 @@ export class ReactNativeTracing implements Integration {
       return;
     }
 
+    const isAppStartWithinBounds =
+      appStartTimestampMs >=
+      getTransactionStartTimestampMs(transaction) - ReactNativeTracing._maxAppStartBeforeTransactionMs;
+    if (!__DEV__ && !isAppStartWithinBounds) {
+      logger.warn('[ReactNativeTracing] App start timestamp is too far in the past to be used for app start span.');
+      return;
+    }
+
     const appStartDurationMilliseconds = this._getAppStartDurationMilliseconds(appStartTimestampMs);
     if (!appStartDurationMilliseconds) {
       logger.warn('[ReactNativeTracing] App start end has not been recorded, not adding app start span.');
@@ -711,3 +721,11 @@ export class ReactNativeTracing implements Integration {
     return tx;
   }
 }
+
+/**
+ * Returns transaction start timestamp in milliseconds.
+ * If start timestamp is not available, returns 0.
+ */
+function getTransactionStartTimestampMs(transaction: Transaction): number {
+  return (spanToJSON(transaction).start_timestamp || 0) * 1000;
+}

test/tracing/reactnativetracing.test.ts

@@ -26,6 +26,15 @@ jest.mock('../../src/js/tracing/utils', () => {
   };
 });
 
+jest.mock('@sentry/utils', () => {
+  const originalUtils = jest.requireActual('@sentry/utils');
+
+  return {
+    ...originalUtils,
+    timestampInSeconds: jest.fn(originalUtils.timestampInSeconds),
+  };
+});
+
 type MockAppState = {
   setState: (state: AppStateStatus) => void;
   listener: (newState: AppStateStatus) => void;
@@ -51,6 +60,7 @@ jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState);
 
 import { getActiveSpan, startSpanManual } from '@sentry/browser';
 import { addGlobalEventProcessor, getCurrentHub, getCurrentScope, spanToJSON, startInactiveSpan } from '@sentry/core';
+import { timestampInSeconds } from '@sentry/utils';
 import type { AppState, AppStateStatus } from 'react-native';
 
 import { APP_START_COLD, APP_START_WARM } from '../../src/js/measurements';
@@ -70,6 +80,8 @@ import { mockFunction } from '../testutils';
 import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention';
 import { createMockedRoutingInstrumentation } from './mockedrountinginstrumention';
 
+const originalTimestampInSeconds = mockFunction(timestampInSeconds).getMockImplementation();
+
 const DEFAULT_IDLE_TIMEOUT = 1000;
 
 describe('ReactNativeTracing', () => {
@@ -317,6 +329,65 @@ describe('ReactNativeTracing', () => {
         expect(transaction?.start_timestamp).toBeGreaterThanOrEqual(timeOriginMilliseconds / 1000);
       });
 
+      describe('old app starts', () => {
+        let integration: ReactNativeTracing;
+        let timeOriginMilliseconds: number;
+
+        beforeEach(() => {
+          integration = new ReactNativeTracing();
+
+          timeOriginMilliseconds = Date.now();
+          const appStartTimeMilliseconds = timeOriginMilliseconds - 65000;
+          const mockAppStartResponse: NativeAppStartResponse = {
+            type: 'warm',
+            app_start_timestamp_ms: appStartTimeMilliseconds,
+            has_fetched: false,
+            spans: [],
+          };
+
+          // App start finish timestamp
+          mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds - 64000);
+          mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse);
+          // Transaction start timestamp
+          mockFunction(timestampInSeconds).mockReturnValue(timeOriginMilliseconds / 1000 + 65);
+        });
+
+        afterEach(() => {
+          mockFunction(timestampInSeconds).mockReset().mockImplementation(originalTimestampInSeconds);
+          set__DEV__(true);
+        });
+
+        it('Does not add app start span older than than 60s in production', async () => {
+          set__DEV__(false);
+
+          setup(integration);
+
+          await jest.advanceTimersByTimeAsync(500);
+          await jest.runOnlyPendingTimersAsync();
+
+          const transaction = client.event;
+
+          expect(transaction).toBeDefined();
+          expect(transaction?.spans?.some(span => span.op == APP_SPAN_START_WARM)).toBeFalse();
+          expect(transaction?.start_timestamp).toBeGreaterThanOrEqual(timeOriginMilliseconds / 1000);
+        });
+
+        it('Does add app start span older than than 60s in development builds', async () => {
+          set__DEV__(true);
+
+          setup(integration);
+
+          await jest.advanceTimersByTimeAsync(500);
+          await jest.runOnlyPendingTimersAsync();
+
+          const transaction = client.event;
+
+          expect(transaction).toBeDefined();
+          expect(transaction?.spans?.some(span => span.op == APP_SPAN_START_WARM)).toBeTrue();
+          expect(transaction?.start_timestamp).toBeGreaterThanOrEqual((timeOriginMilliseconds - 65000) / 1000);
+        });
+      });
+
       it('Does not create app start transaction if has_fetched == true', async () => {
         const integration = new ReactNativeTracing();
 
@@ -1195,3 +1266,10 @@ function clearReactNativeBundleExecutionStartTimestamp() {
   delete RN_GLOBAL_OBJ.nativePerformanceNow;
   delete RN_GLOBAL_OBJ.__BUNDLE_START_TIME__;
 }
+
+function set__DEV__(value: boolean) {
+  Object.defineProperty(globalThis, '__DEV__', {
+    value,
+    writable: true,
+  });
+}