feat(core): Ensure trace context only includes relevant data

Author: mydea

dev-packages/browser-integration-tests/suites/tracing/trace-lifetime/navigation/test.ts

@@ -161,14 +161,6 @@ sentryTest('error during navigation has new navigation traceId', async ({ getLoc
 
   const errorTraceContext = errorEvent?.contexts?.trace;
   expect(errorTraceContext).toEqual({
-    data: {
-      'sentry.op': 'navigation',
-      'sentry.origin': 'auto.navigation.browser',
-      'sentry.sample_rate': 1,
-      'sentry.source': 'url',
-    },
-    op: 'navigation',
-    origin: 'auto.navigation.browser',
     trace_id: navigationTraceContext?.trace_id,
     span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
   });

dev-packages/browser-integration-tests/suites/tracing/trace-lifetime/pageload-meta/test.ts

@@ -168,14 +168,6 @@ sentryTest('error during <meta> tag pageload has pageload traceId', async ({ get
   });
 
   expect(errorEvent?.contexts?.trace).toEqual({
-    data: {
-      'sentry.op': 'pageload',
-      'sentry.origin': 'auto.pageload.browser',
-      'sentry.sample_rate': 1,
-      'sentry.source': 'url',
-    },
-    op: 'pageload',
-    origin: 'auto.pageload.browser',
     trace_id: META_TAG_TRACE_ID,
     parent_span_id: META_TAG_PARENT_SPAN_ID,
     span_id: expect.stringMatching(/^[0-9a-f]{16}$/),

dev-packages/browser-integration-tests/suites/tracing/trace-lifetime/pageload/test.ts

@@ -158,14 +158,6 @@ sentryTest('error during pageload has pageload traceId', async ({ getLocalTestPa
 
   const errorTraceContext = errorEvent?.contexts?.trace;
   expect(errorTraceContext).toEqual({
-    data: {
-      'sentry.op': 'pageload',
-      'sentry.origin': 'auto.pageload.browser',
-      'sentry.sample_rate': 1,
-      'sentry.source': 'url',
-    },
-    op: 'pageload',
-    origin: 'auto.pageload.browser',
     trace_id: pageloadTraceContext?.trace_id,
     span_id: expect.stringMatching(/^[0-9a-f]{16}$/),
   });

packages/core/src/server-runtime-client.ts

@@ -257,7 +257,7 @@ export class ServerRuntimeClient<
     if (span) {
       const rootSpan = getRootSpan(span);
       const samplingContext = getDynamicSamplingContextFromSpan(rootSpan);
-      return [samplingContext, spanToTraceContext(rootSpan)];
+      return [samplingContext, spanToTraceContext(rootSpan, false)];
     }
 
     const { traceId, spanId, parentSpanId, dsc } = scope.getPropagationContext();

packages/core/src/tracing/sentrySpan.ts

@@ -270,7 +270,7 @@ export class SentrySpan implements Span {
 
     const transaction: TransactionEvent = {
       contexts: {
-        trace: spanToTraceContext(this),
+        trace: spanToTraceContext(this, true),
       },
       spans,
       start_timestamp: this._startTime,

packages/core/src/utils/applyScopeDataToEvent.ts

@@ -161,7 +161,10 @@ function applySdkMetadataToEvent(event: Event, sdkProcessingMetadata: ScopeData[
 }
 
 function applySpanToEvent(event: Event, span: Span): void {
-  event.contexts = { trace: spanToTraceContext(span), ...event.contexts };
+  event.contexts = {
+    trace: spanToTraceContext(span, false),
+    ...event.contexts,
+  };
 
   event.sdkProcessingMetadata = {
     dynamicSamplingContext: getDynamicSamplingContextFromSpan(span),

packages/core/src/utils/spanUtils.ts

@@ -31,20 +31,18 @@ export const TRACE_FLAG_SAMPLED = 0x1;
 
 /**
  * Convert a span to a trace context, which can be sent as the `trace` context in an event.
+ * By default, this will only include trace_id, span_id & parent_span_id.
+ * If `includeAllData` is true, it will also include data, op, status & origin.
  */
-export function spanToTraceContext(span: Span): TraceContext {
+export function spanToTraceContext(span: Span, includeAllData = false): TraceContext {
   const { spanId: span_id, traceId: trace_id } = span.spanContext();
   const { data, op, parent_span_id, status, origin } = spanToJSON(span);
 
-  return dropUndefinedKeys({
-    data,
-    op,
-    parent_span_id,
-    span_id,
-    status,
-    trace_id,
-    origin,
-  });
+  const reqFields = { parent_span_id, span_id, trace_id };
+  // These are only included if `includeAllData` is true
+  const optFields = { data, op, status, origin };
+
+  return dropUndefinedKeys(includeAllData ? { ...reqFields, ...optFields } : reqFields);
 }
 
 /**

packages/core/test/lib/tracing/sentrySpan.test.ts

@@ -1,7 +1,7 @@
 import { timestampInSeconds } from '@sentry/utils';
 import { SentrySpan } from '../../../src/tracing/sentrySpan';
 import { SPAN_STATUS_ERROR } from '../../../src/tracing/spanstatus';
-import { TRACE_FLAG_NONE, TRACE_FLAG_SAMPLED, spanToJSON, spanToTraceContext } from '../../../src/utils/spanUtils';
+import { TRACE_FLAG_NONE, TRACE_FLAG_SAMPLED, spanToJSON } from '../../../src/utils/spanUtils';
 
 describe('SentrySpan', () => {
   describe('name', () => {
@@ -33,7 +33,7 @@ describe('SentrySpan', () => {
     test('setStatus', () => {
       const span = new SentrySpan({});
       span.setStatus({ code: SPAN_STATUS_ERROR, message: 'permission_denied' });
-      expect(spanToTraceContext(span).status).toBe('permission_denied');
+      expect(spanToJSON(span).status).toBe('permission_denied');
     });
   });