add shouldContinueTrace util function

Author: s1gr1d

packages/core/src/index.ts

@@ -216,6 +216,7 @@ export {
   extractTraceparentData,
   generateSentryTraceHeader,
   propagationContextFromHeaders,
+  shouldContinueTrace,
 } from './utils-hoist/tracing';
 export { getSDKSource, isBrowserBundle } from './utils-hoist/env';
 export type { SdkSource } from './utils-hoist/env';

packages/core/src/tracing/trace.ts

@@ -19,7 +19,7 @@ import { addChildSpanToSpan, getRootSpan, spanIsSampled, spanTimeInputToSeconds,
 import { baggageHeaderToDynamicSamplingContext } from '../utils-hoist/baggage';
 import { logger } from '../utils-hoist/logger';
 import { generateTraceId } from '../utils-hoist/propagationContext';
-import { propagationContextFromHeaders } from '../utils-hoist/tracing';
+import { propagationContextFromHeaders, shouldContinueTrace } from '../utils-hoist/tracing';
 import { freezeDscOnSpan, getDynamicSamplingContextFromSpan } from './dynamicSamplingContext';
 import { logSpanStart } from './logSpans';
 import { sampleSpan } from './sampling';
@@ -216,41 +216,10 @@ export const continueTrace = <V>(
   }
 
   const { sentryTrace, baggage } = options;
-  const client = getClient();
-
-  const clientOptions = client?.getOptions();
-  const strictTraceContinuation = clientOptions?.strictTraceContinuation || false; // default for `strictTraceContinuation` is `false` todo(v10): set default to `true`
 
   const incomingDsc = baggageHeaderToDynamicSamplingContext(baggage);
-  const baggageOrgId = incomingDsc?.org_id;
-
-  const sdkOrgId = deriveOrgIdFromClient(client);
-
-  const shouldStartNewTrace = (): boolean => {
-    // Case: baggage org ID and SDK org ID don't match - always start new trace
-    if (baggageOrgId && sdkOrgId && baggageOrgId !== sdkOrgId) {
-      DEBUG_BUILD &&
-        logger.info(`Starting a new trace because org IDs don't match (incoming: ${baggageOrgId}, sdk: ${sdkOrgId})`);
-      return true;
-    }
-
-    if (strictTraceContinuation) {
-      // With strict continuation enabled, start new trace if:
-      // - Baggage has org ID but SDK doesn't have one
-      // - SDK has org ID but baggage doesn't have one
-      if ((baggageOrgId && !sdkOrgId) || (!baggageOrgId && sdkOrgId)) {
-        DEBUG_BUILD &&
-          logger.info(
-            `Starting a new trace because strict trace continuation is enabled and one org ID is missing (incoming: ${baggageOrgId}, sdk: ${sdkOrgId})`,
-          );
-        return true;
-      }
-    }
-
-    return false;
-  };
 
-  if (shouldStartNewTrace()) {
+  if (shouldContinueTrace(getClient(), incomingDsc?.org_id)) {
     return startNewTrace(callback);
   }
 

packages/core/src/utils-hoist/tracing.ts

@@ -1,7 +1,11 @@
+import type { Client } from '../client';
+import { DEBUG_BUILD } from '../debug-build';
+import { deriveOrgIdFromClient } from '../tracing/utils';
 import type { DynamicSamplingContext } from '../types-hoist/envelope';
 import type { PropagationContext } from '../types-hoist/tracing';
 import type { TraceparentData } from '../types-hoist/transaction';
 import { parseSampleRate } from '../utils/parseSampleRate';
+import { logger } from '../utils-hoist/logger';
 import { baggageHeaderToDynamicSamplingContext } from './baggage';
 import { generateSpanId, generateTraceId } from './propagationContext';
 
@@ -124,3 +128,40 @@ function getSampleRandFromTraceparentAndDsc(
     return Math.random();
   }
 }
+
+/**
+ * Determines whether a new trace should be continued based on the provided client and baggage org ID.
+ * If the trace should not be continued, a new trace will be started.
+ *
+ * The result is dependent on the `strictTraceContinuation` option in the client.
+ * See https://develop.sentry.dev/sdk/telemetry/traces/#stricttracecontinuation
+ */
+export function shouldContinueTrace(client: Client | undefined, baggageOrgId?: string): boolean {
+  const sdkOptionOrgId = deriveOrgIdFromClient(client);
+
+  // Case: baggage org ID and SDK org ID don't match - always start new trace
+  if (baggageOrgId && sdkOptionOrgId && baggageOrgId !== sdkOptionOrgId) {
+    DEBUG_BUILD &&
+      logger.info(
+        `Starting a new trace because org IDs don't match (incoming baggage: ${baggageOrgId}, SDK options: ${sdkOptionOrgId})`,
+      );
+    return false;
+  }
+
+  const strictTraceContinuation = client?.getOptions()?.strictTraceContinuation || false; // default for `strictTraceContinuation` is `false` todo(v10): set default to `true`
+
+  if (strictTraceContinuation) {
+    // With strict continuation enabled, start new trace if:
+    // - Baggage has org ID but SDK doesn't have one
+    // - SDK has org ID but baggage doesn't have one
+    if ((baggageOrgId && !sdkOptionOrgId) || (!baggageOrgId && sdkOptionOrgId)) {
+      DEBUG_BUILD &&
+        logger.info(
+          `Starting a new trace because strict trace continuation is enabled and one org ID is missing (incoming baggage: ${baggageOrgId}, SDK options: ${sdkOptionOrgId})`,
+        );
+      return false;
+    }
+  }
+
+  return true;
+}

packages/core/test/utils-hoist/tracing.test.ts

@@ -1,5 +1,10 @@
 import { describe, expect, it, test } from 'vitest';
-import { extractTraceparentData, propagationContextFromHeaders } from '../../src/utils-hoist/tracing';
+import {
+  extractTraceparentData,
+  propagationContextFromHeaders,
+  shouldContinueTrace,
+} from '../../src/utils-hoist/tracing';
+import { getDefaultTestClientOptions, TestClient } from '../mocks/client';
 
 const EXAMPLE_SENTRY_TRACE = '12312012123120121231201212312012-1121201211212012-1';
 const EXAMPLE_BAGGAGE = 'sentry-release=1.2.3,sentry-foo=bar,other=baz,sentry-sample_rand=0.42';
@@ -124,3 +129,65 @@ describe('extractTraceparentData', () => {
     expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
   });
 });
+
+describe('shouldContinueTrace', () => {
+  test('returns true when both baggage and SDK org IDs are undefined', () => {
+    const client = new TestClient(getDefaultTestClientOptions({}));
+
+    const result = shouldContinueTrace(client, undefined);
+    expect(result).toBe(true);
+  });
+
+  test('returns true when org IDs match', () => {
+    const orgId = '123456';
+    const client = new TestClient(getDefaultTestClientOptions({ orgId }));
+
+    const result = shouldContinueTrace(client, orgId);
+    expect(result).toBe(true);
+  });
+
+  test('returns false when org IDs do not match', () => {
+    const client = new TestClient(getDefaultTestClientOptions({ orgId: '123456' }));
+
+    const result = shouldContinueTrace(client, '654321');
+    expect(result).toBe(false);
+  });
+
+  test('returns true when baggage org ID is undefined and strictTraceContinuation is false', () => {
+    const client = new TestClient(getDefaultTestClientOptions({ orgId: '123456', strictTraceContinuation: false }));
+
+    const result = shouldContinueTrace(client, undefined);
+    expect(result).toBe(true);
+  });
+
+  test('returns true when SDK org ID is undefined and strictTraceContinuation is false', () => {
+    const client = new TestClient(getDefaultTestClientOptions({ strictTraceContinuation: false }));
+
+    const result = shouldContinueTrace(client, '123456');
+    expect(result).toBe(true);
+  });
+
+  test('returns false when baggage org ID is undefined and strictTraceContinuation is true', () => {
+    const client = new TestClient(getDefaultTestClientOptions({ orgId: '123456', strictTraceContinuation: true }));
+
+    const result = shouldContinueTrace(client, undefined);
+    expect(result).toBe(false);
+  });
+
+  test('returns false when SDK org ID is undefined and strictTraceContinuation is true', () => {
+    const client = new TestClient(getDefaultTestClientOptions({ strictTraceContinuation: true }));
+
+    const result = shouldContinueTrace(client, '123456');
+    expect(result).toBe(false);
+  });
+
+  test('returns true when client is undefined', () => {
+    const result = shouldContinueTrace(undefined, '123456');
+    expect(result).toBe(true);
+  });
+
+  test('returns true when both org IDs and client are undefined', () => {
+    const result = shouldContinueTrace(undefined, undefined);
+    expect(result).toBe(true);
+  });
+});