cleanup, fix test, fix colon bug in string->array header conversion

Author: Lms24

dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-other-vendors-with-sentry-entries/test.ts

@@ -13,7 +13,7 @@ test('should ignore sentry-values in `baggage` header of a third party vendor an
   const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
     headers: {
       'sentry-trace': '12312012123120121231201212312012-1121201211212012-1',
-      baggage: 'sentry-release=2.1.0,sentry-environment=myEnv,sentry-sample_rate=0.54',
+      baggage: 'sentry-release=2.1.0,sentry-environment=myEnv',
     },
   });
 
@@ -34,7 +34,6 @@ test('should ignore sentry-values in `baggage` header of a third party vendor an
     'sentry-environment=myEnv',
     'sentry-release=2.1.0',
     expect.stringMatching(/sentry-sample_rand=\d+/),
-    'sentry-sample_rate=0.54',
     'third=party',
   ]);
 });

dev-packages/node-integration-tests/suites/tracing/double-baggage-no-spans/test.ts

@@ -0,0 +1,37 @@
+import { expect } from 'vitest';
+import { extractTraceparentData, parseBaggageHeader, TRACEPARENT_REGEXP } from '@sentry/core';
+
+export function expectNoDuplicateSentryBaggageKeys(baggage: string | string[] | undefined): void {
+  expect(baggage).toBeDefined();
+  const baggageStr = Array.isArray(baggage) ? baggage.join(',') : (baggage as string);
+  const sentryEntries = baggageStr.split(',').filter(entry => entry.trim().startsWith('sentry-'));
+  const sentryKeyNames = sentryEntries.map(entry => entry.trim().split('=')[0]);
+  const uniqueKeyNames = [...new Set(sentryKeyNames)];
+  expect(sentryKeyNames).toEqual(uniqueKeyNames);
+}
+
+export function expectConsistentTraceId(headers: Record<string, string | string[] | undefined>): void {
+  const sentryTrace = headers['sentry-trace'];
+  expect(sentryTrace).toMatch(TRACEPARENT_REGEXP);
+
+  const sentryTraceData = extractTraceparentData(sentryTrace as string)!;
+  expect(sentryTraceData.traceId).toMatch(/^[a-f\d]{32}$/);
+
+  const baggage = parseBaggageHeader(headers['baggage']);
+
+  const baggageTraceId = baggage!['sentry-trace_id'];
+  expect(baggageTraceId).toBeDefined();
+  expect(baggageTraceId).toMatch(/^[a-f\d]{32}$/);
+
+  expect(sentryTraceData.traceId).toEqual(baggageTraceId);
+}
+
+export function expectUserSetTraceId(headers: Record<string, string | string[] | undefined>): void {
+  const xSentryTrace = extractTraceparentData(headers['x-tracedata-sentry-trace'] as string);
+  const sentryTrace = extractTraceparentData(headers['sentry-trace'] as string);
+  expect(xSentryTrace?.traceId).toBe(sentryTrace?.traceId);
+
+  const xBaggage = parseBaggageHeader(headers['x-tracedata-baggage']);
+  const baggage = parseBaggageHeader(headers['baggage']);
+  expect(xBaggage).toEqual(baggage);
+}

dev-packages/node-integration-tests/suites/tracing/double-baggage/expects.ts

@@ -0,0 +1,47 @@
+import { createTestServer } from '@sentry-internal/test-utils';
+import { describe, expect } from 'vitest';
+import { createEsmAndCjsTests } from '../../../../utils/runner';
+import { expectConsistentTraceId, expectNoDuplicateSentryBaggageKeys, expectUserSetTraceId } from '../expects';
+
+describe('double baggage prevention', () => {
+  createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
+    test('fetch with manual getTraceData() does not duplicate sentry baggage entries', async () => {
+      const [SERVER_URL, closeTestServer] = await createTestServer()
+        .get('/api/fetch-custom-headers', headers => {
+          // fetch with manual getTraceData() headers
+          expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^[a-f\d]{32}-[a-f\d]{16}$/));
+          expectNoDuplicateSentryBaggageKeys(headers['baggage']);
+          expectConsistentTraceId(headers);
+          expectUserSetTraceId(headers);
+        })
+        .get('/api/fetch', headers => {
+          // fetch without manual headers (baseline)
+          expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^[a-f\d]{32}-[a-f\d]{16}$/));
+          expectNoDuplicateSentryBaggageKeys(headers['baggage']);
+          expectConsistentTraceId(headers);
+        })
+        .get('/api/http-custom-headers', headers => {
+          // http.request with manual getTraceData() headers
+          expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^[a-f\d]{32}-[a-f\d]{16}$/));
+          expectNoDuplicateSentryBaggageKeys(headers['baggage']);
+          expectConsistentTraceId(headers);
+          expectUserSetTraceId(headers);
+        })
+        .start();
+
+      await createRunner()
+        .withEnv({ SERVER_URL })
+        .ignore('transaction')
+        .expect({
+          event: {
+            exception: {
+              values: [{ type: 'Error', value: 'done' }],
+            },
+          },
+        })
+        .start()
+        .completed();
+      closeTestServer();
+    });
+  });
+});

…g/double-baggage-no-spans/instrument.mjs …g/double-baggage/no-spans/instrument.mjsdev-packages/node-integration-tests/suites/tracing/double-baggage-no-spans/instrument.mjs renamed to dev-packages/node-integration-tests/suites/tracing/double-baggage/no-spans/instrument.mjs dev-packages/node-integration-tests/suites/tracing/double-baggage-no-spans/instrument.mjs renamed to dev-packages/node-integration-tests/suites/tracing/double-baggage/no-spans/instrument.mjs

@@ -1,41 +1,7 @@
 import { createTestServer } from '@sentry-internal/test-utils';
 import { describe, expect } from 'vitest';
-import { createEsmAndCjsTests } from '../../../utils/runner';
-import { extractTraceparentData, parseBaggageHeader, TRACEPARENT_REGEXP } from '@sentry/core';
-
-function expectNoDuplicateSentryBaggageKeys(baggage: string | string[] | undefined): void {
-  expect(baggage).toBeDefined();
-  const baggageStr = Array.isArray(baggage) ? baggage.join(',') : (baggage as string);
-  const sentryKeyNames = Object.keys(parseBaggageHeader(baggageStr) || {});
-  const uniqueKeyNames = [...new Set(sentryKeyNames)];
-  expect(sentryKeyNames).toEqual(uniqueKeyNames);
-}
-
-function expectConsistentTraceId(headers: Record<string, string | string[] | undefined>): void {
-  const sentryTrace = headers['sentry-trace'];
-  expect(sentryTrace).toMatch(TRACEPARENT_REGEXP);
-
-  const sentryTraceData = extractTraceparentData(sentryTrace as string)!;
-  expect(sentryTraceData.traceId).toMatch(/^[a-f\d]{32}$/);
-
-  const baggage = parseBaggageHeader(headers['baggage']);
-
-  const baggageTraceId = baggage!['sentry-trace_id'];
-  expect(baggageTraceId).toBeDefined();
-  expect(baggageTraceId).toMatch(/^[a-f\d]{32}$/);
-
-  expect(sentryTraceData.traceId).toEqual(baggageTraceId);
-}
-
-function expectUserSetTraceId(headers: Record<string, string | string[] | undefined>): void {
-  const xSentryTrace = extractTraceparentData(headers['x-tracedata-sentry-trace'] as string);
-  const sentryTrace = extractTraceparentData(headers['sentry-trace'] as string);
-  expect(xSentryTrace?.traceId).toBe(sentryTrace?.traceId);
-
-  const xBaggage = parseBaggageHeader(headers['x-tracedata-baggage']);
-  const baggage = parseBaggageHeader(headers['baggage']);
-  expect(xBaggage).toEqual(baggage);
-}
+import { createEsmAndCjsTests } from '../../../../utils/runner';
+import { expectConsistentTraceId, expectNoDuplicateSentryBaggageKeys, expectUserSetTraceId } from '../expects';
 
 describe('double baggage prevention', () => {
   createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {

…ing/double-baggage-no-spans/scenario.mjs …ing/double-baggage/no-spans/scenario.mjsdev-packages/node-integration-tests/suites/tracing/double-baggage-no-spans/scenario.mjs renamed to dev-packages/node-integration-tests/suites/tracing/double-baggage/no-spans/scenario.mjs dev-packages/node-integration-tests/suites/tracing/double-baggage-no-spans/scenario.mjs renamed to dev-packages/node-integration-tests/suites/tracing/double-baggage/no-spans/scenario.mjs

@@ -6,5 +6,4 @@ Sentry.init({
   release: '1.0',
   tracesSampleRate: 1.0,
   transport: loggingTransport,
-  debug: true,
 });