add comments & tests

mydea · mydea · commit 7cb9c8642ca4 · 2025-01-08T11:03:24.000+01:00
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/init.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/init.js
@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  integrations: integrations => {
+    integrations.push(Sentry.browserTracingIntegration());
+    return integrations.filter(i => i.name !== 'BrowserSession');
+  },
+  tracesSampleRate: 0,
+});
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/subject.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/subject.js
@@ -0,0 +1,2 @@
+Sentry.captureException(new Error('test error'));
+Sentry.captureException(new Error('test error 2'));
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/template.html b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/template.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012" />
+    <meta
+      name="baggage"
+      content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123"
+    />
+  </head>
+</html>
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/test.ts b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors-meta/test.ts
@@ -0,0 +1,35 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/browser';
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest('errors in TwP mode have same trace ID & span IDs', async ({ getLocalTestUrl, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+
+  const traceId = '12312012123120121231201212312012';
+  const spanId = '1121201211212012';
+
+  const url = await getLocalTestUrl({ testDir: __dirname });
+  const [event1, event2] = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });
+
+  // Ensure these are the actual errors we care about
+  expect(event1.exception?.values?.[0].value).toContain('test error');
+  expect(event2.exception?.values?.[0].value).toContain('test error');
+
+  const contexts1 = event1.contexts;
+  const { trace_id: traceId1, span_id: spanId1 } = contexts1?.trace || {};
+  expect(traceId1).toEqual(traceId);
+
+  // Span ID is a virtual span, not the propagated one
+  expect(spanId1).not.toEqual(spanId);
+  expect(spanId1).toMatch(/^[a-f0-9]{16}$/);
+
+  const contexts2 = event2.contexts;
+  const { trace_id: traceId2, span_id: spanId2 } = contexts2?.trace || {};
+  expect(traceId2).toEqual(traceId);
+  expect(spanId2).toMatch(/^[a-f0-9]{16}$/);
+
+  expect(spanId2).toEqual(spanId1);
+});
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/init.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/init.js
@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  integrations: integrations => {
+    integrations.push(Sentry.browserTracingIntegration());
+    return integrations.filter(i => i.name !== 'BrowserSession');
+  },
+  tracesSampleRate: 0,
+});
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/subject.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/subject.js
@@ -0,0 +1,2 @@
+Sentry.captureException(new Error('test error'));
+Sentry.captureException(new Error('test error 2'));
diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/test.ts b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/twp-errors/test.ts
@@ -0,0 +1,30 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/browser';
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest('errors in TwP mode have same trace ID & span IDs', async ({ getLocalTestUrl, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+
+  const url = await getLocalTestUrl({ testDir: __dirname });
+  const [event1, event2] = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });
+
+  // Ensure these are the actual errors we care about
+  expect(event1.exception?.values?.[0].value).toContain('test error');
+  expect(event2.exception?.values?.[0].value).toContain('test error');
+
+  const contexts1 = event1.contexts;
+  const { trace_id: traceId1, span_id: spanId1 } = contexts1?.trace || {};
+  expect(traceId1).toMatch(/^[a-f0-9]{32}$/);
+  expect(spanId1).toMatch(/^[a-f0-9]{16}$/);
+
+  const contexts2 = event2.contexts;
+  const { trace_id: traceId2, span_id: spanId2 } = contexts2?.trace || {};
+  expect(traceId2).toMatch(/^[a-f0-9]{32}$/);
+  expect(spanId2).toMatch(/^[a-f0-9]{16}$/);
+
+  expect(traceId2).toEqual(traceId1);
+  expect(spanId2).toEqual(spanId1);
+});
diff --git a/dev-packages/node-integration-tests/suites/tracing/meta-tags-twp-errors/test.ts b/dev-packages/node-integration-tests/suites/tracing/meta-tags-twp-errors/test.ts
@@ -5,6 +5,7 @@ describe('errors in TwP mode have same trace in trace context and getTraceData()
     cleanupChildProcesses();
   });
 
+  // In a request handler, the spanId is consistent inside of the request
   test('in incoming request', done => {
     createRunner(__dirname, 'server.js')
       .expect({
@@ -30,6 +31,7 @@ describe('errors in TwP mode have same trace in trace context and getTraceData()
       .makeRequest('get', '/test');
   });
 
+  // Outside of a request handler, the spanId is random
   test('outside of a request handler', done => {
     createRunner(__dirname, 'no-server.js')
       .expect({
diff --git a/packages/core/src/utils/spanUtils.ts b/packages/core/src/utils/spanUtils.ts
@@ -7,9 +7,9 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 } from '../semanticAttributes';
-import { getCapturedScopesOnSpan } from '../tracing/utils';
 import type { SentrySpan } from '../tracing/sentrySpan';
 import { SPAN_STATUS_OK, SPAN_STATUS_UNSET } from '../tracing/spanstatus';
+import { getCapturedScopesOnSpan } from '../tracing/utils';
 import type {
   Span,
   SpanAttributes,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Sentry.captureException(new Error('test error'));`
	`2`	`+Sentry.captureException(new Error('test error 2'));`