ref(browser): Temporarily add sentry.previous_trace span attribute

Author: Lms24

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/previous-trace-links/default/test.ts

@@ -49,6 +49,10 @@ sentryTest("navigation spans link back to previous trace's root span", async ({
     },
   ]);
 
+  expect(navigation1TraceContext?.data).toMatchObject({
+    'sentry.previous_trace': `${pageloadTraceId}-${pageloadTraceContext?.span_id}-1`,
+  });
+
   expect(navigation2TraceContext?.links).toEqual([
     {
       trace_id: navigation1TraceId,
@@ -60,6 +64,10 @@ sentryTest("navigation spans link back to previous trace's root span", async ({
     },
   ]);
 
+  expect(navigation2TraceContext?.data).toMatchObject({
+    'sentry.previous_trace': `${navigation1TraceId}-${navigation1TraceContext?.span_id}-1`,
+  });
+
   expect(pageloadTraceId).not.toEqual(navigation1TraceId);
   expect(navigation1TraceId).not.toEqual(navigation2TraceId);
   expect(pageloadTraceId).not.toEqual(navigation2TraceId);

dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

@@ -24,6 +24,11 @@ Sentry.init({
     }),
     browserTracingIntegration({
       router,
+      instrumentPageLoad: false,
+      instrumentNavigation: false,
+      enableInp: false,
+      enableLongTask: false,
+      enableLongAnimationFrame: false,
     }),
   ],
   tunnel: `http://localhost:3031/`, // proxy server

packages/browser/src/tracing/previousTrace.ts

@@ -1,5 +1,11 @@
 import type { Span } from '@sentry/core';
-import { logger, SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE, spanToJSON, type SpanContextData } from '@sentry/core';
+import {
+  logger,
+  SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE,
+  spanIsSampled,
+  spanToJSON,
+  type SpanContextData,
+} from '@sentry/core';
 import { WINDOW } from '../exports';
 import { DEBUG_BUILD } from '../debug-build';
 
@@ -21,6 +27,8 @@ export const PREVIOUS_TRACE_MAX_DURATION = 3600;
 // session storage key
 export const PREVIOUS_TRACE_KEY = 'sentry_previous_trace';
 
+export const PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE = 'sentry.previous_trace';
+
 /**
  * Adds a previous_trace span link to the passed span if the passed
  * previousTraceInfo is still valid.
@@ -69,6 +77,15 @@ export function addPreviousTraceSpanLink(
         [SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE]: 'previous_trace',
       },
     });
+
+    // TODO: Remove this once EAP can store span links. We currently only set this attribute so that we
+    // can obtain the previous trace information from the EAP store. Long-term, EAP will handle
+    // span links and then we should remove this again. Also throwing in a TODO(v10), to remind us
+    // to check this at v10 time :)
+    span.setAttribute(
+      PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE,
+      `${previousTraceInfo.spanContext.traceId}-${previousTraceInfo.spanContext.spanId}-${spanIsSampled(span) ? 1 : 0}`,
+    );
   }
 
   return {

packages/browser/test/tracing/previousTrace.test.ts

@@ -5,6 +5,7 @@ import {
   getPreviousTraceFromSessionStorage,
   PREVIOUS_TRACE_KEY,
   PREVIOUS_TRACE_MAX_DURATION,
+  PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE,
 } from '../../src/tracing/previousTrace';
 import { SentrySpan, spanToJSON, timestampInSeconds } from '@sentry/core';
 import { storePreviousTraceInSessionStorage } from '../../src/tracing/previousTrace';
@@ -34,7 +35,9 @@ describe('addPreviousTraceSpanLink', () => {
 
     const updatedPreviousTraceInfo = addPreviousTraceSpanLink(previousTraceInfo, currentSpan);
 
-    expect(spanToJSON(currentSpan).links).toEqual([
+    const spanJson = spanToJSON(currentSpan);
+
+    expect(spanJson.links).toEqual([
       {
         attributes: {
           'sentry.link.type': 'previous_trace',
@@ -45,6 +48,10 @@ describe('addPreviousTraceSpanLink', () => {
       },
     ]);
 
+    expect(spanJson.data).toMatchObject({
+      [PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE]: '123-456-1',
+    });
+
     expect(updatedPreviousTraceInfo).toEqual({
       spanContext: currentSpan.spanContext(),
       startTimestamp: currentSpanStart,
@@ -70,7 +77,11 @@ describe('addPreviousTraceSpanLink', () => {
 
     const updatedPreviousTraceInfo = addPreviousTraceSpanLink(previousTraceInfo, currentSpan);
 
-    expect(spanToJSON(currentSpan).links).toBeUndefined();
+    const spanJson = spanToJSON(currentSpan);
+
+    expect(spanJson.links).toBeUndefined();
+
+    expect(Object.keys(spanJson.data)).not.toContain(PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE);
 
     // but still updates the previousTraceInfo to the current span
     expect(updatedPreviousTraceInfo).toEqual({
@@ -141,7 +152,9 @@ describe('addPreviousTraceSpanLink', () => {
 
     const updatedPreviousTraceInfo = addPreviousTraceSpanLink(undefined, currentSpan);
 
-    expect(spanToJSON(currentSpan).links).toBeUndefined();
+    const spanJson = spanToJSON(currentSpan);
+    expect(spanJson.links).toBeUndefined();
+    expect(Object.keys(spanJson.data)).not.toContain(PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE);
 
     expect(updatedPreviousTraceInfo).toEqual({
       spanContext: currentSpan.spanContext(),
@@ -169,7 +182,9 @@ describe('addPreviousTraceSpanLink', () => {
 
     const updatedPreviousTraceInfo = addPreviousTraceSpanLink(previousTraceInfo, currentSpan);
 
-    expect(spanToJSON(currentSpan).links).toBeUndefined();
+    const spanJson = spanToJSON(currentSpan);
+    expect(spanJson.links).toBeUndefined();
+    expect(Object.keys(spanJson.data)).not.toContain(PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE);
 
     expect(updatedPreviousTraceInfo).toBe(previousTraceInfo);
   });