more correct

Author: AbhiPrasad

packages/node/src/integrations/http.ts

@@ -249,10 +249,8 @@ function _createWrappedRequestMethodFactory(
               `[Tracing] Adding sentry-trace header ${sentryTraceHeader} to outgoing request to "${requestUrl}": `,
             );
           const dynamicSamplingContext = requestSpan?.transaction?.getDynamicSamplingContext();
-          const sentryBaggageHeader = normalizeBaggageHeader(
-            requestOptions,
-            dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext),
-          );
+          const sentryBaggage = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
+          const sentryBaggageHeader = normalizeBaggageHeader(requestOptions, sentryBaggage);
 
           requestOptions.headers = {
             ...requestOptions.headers,
@@ -274,7 +272,8 @@ function _createWrappedRequestMethodFactory(
           const client = hub.getClient();
           if (client) {
             const dynamicSamplingContext = dsc || getDynamicSamplingContextFromClient(traceId, client, scope);
-            const sentryBaggageHeader = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
+            const sentryBaggage = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
+            const sentryBaggageHeader = normalizeBaggageHeader(requestOptions, sentryBaggage);
             requestOptions.headers = {
               ...requestOptions.headers,
               // Setting a header to `undefined` will crash in node so we only set the baggage header when it's defined
@@ -343,11 +342,11 @@ function getRequestSpanData(requestUrl: string, requestOptions: RequestOptions):
 function normalizeBaggageHeader(
   requestOptions: RequestOptions,
   sentryBaggageHeader: string | undefined,
-): string | number | string[] | undefined {
+): string | string[] | undefined {
   if (!requestOptions.headers || !requestOptions.headers.baggage) {
     return sentryBaggageHeader;
   } else if (!sentryBaggageHeader) {
-    return requestOptions.headers.baggage;
+    return requestOptions.headers.baggage as string | string[];
   } else if (Array.isArray(requestOptions.headers.baggage)) {
     return [...requestOptions.headers.baggage, sentryBaggageHeader];
   }

packages/node/test/integrations/http.test.ts

@@ -54,6 +54,21 @@ describe('tracing', () => {
     return transaction;
   }
 
+  function getHub(customOptions: Partial<NodeClientOptions> = {}) {
+    const options = getDefaultNodeClientOptions({
+      dsn: 'https://[email protected]/12312012',
+      tracesSampleRate: 1.0,
+      integrations: [new HttpIntegration({ tracing: true })],
+      release: '1.0.0',
+      environment: 'production',
+      ...customOptions,
+    });
+    const hub = new Hub(new NodeClient(options));
+    jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
+
+    return hub;
+  }
+
   it("creates a span for each outgoing non-sentry request when there's a transaction on the scope", () => {
     nock('http://dogs.are.great').get('/').reply(200);
 
@@ -162,6 +177,51 @@ describe('tracing', () => {
     ]);
   });
 
+  it('generates and uses propagation context to attach baggage and sentry-trace header', async () => {
+    nock('http://dogs.are.great').get('/').reply(200);
+
+    const request = http.get('http://dogs.are.great/');
+    const sentryTraceHeader = request.getHeader('sentry-trace') as string;
+    const baggageHeader = request.getHeader('baggage') as string;
+
+    const parts = sentryTraceHeader.split('-');
+    expect(parts.length).toEqual(3);
+    expect(parts[0]).toEqual('12312012123120121231201212312012');
+    expect(parts[1]).toEqual(expect.any(String));
+    expect(parts[2]).toEqual('1');
+
+    expect(baggageHeader).toEqual(
+      'sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
+    );
+  });
+
+  it('uses incoming propagation context to attach baggage and sentry-trace', async () => {
+    nock('http://dogs.are.great').get('/').reply(200);
+
+    const hub = getHub();
+    hub.getScope().setPropagationContext({
+      traceId: '86f39e84263a4de99c326acab3bfe3bd',
+      spanId: '86f39e84263a4de9',
+      sampled: true,
+      dsc: {
+        trace_id: '86f39e84263a4de99c326acab3bfe3bd',
+        public_key: 'test-public-key',
+      },
+    });
+
+    const request = http.get('http://dogs.are.great/');
+    const sentryTraceHeader = request.getHeader('sentry-trace') as string;
+    const baggageHeader = request.getHeader('baggage') as string;
+
+    const parts = sentryTraceHeader.split('-');
+    expect(parts.length).toEqual(3);
+    expect(parts[0]).toEqual('86f39e84263a4de99c326acab3bfe3bd');
+    expect(parts[1]).toEqual(expect.any(String));
+    expect(parts[2]).toEqual('1');
+
+    expect(baggageHeader).toEqual('sentry-trace_id=86f39e84263a4de99c326acab3bfe3bd,sentry-public_key=test-public-key');
+  });
+
   it("doesn't attach the sentry-trace header to outgoing sentry requests", () => {
     nock('http://squirrelchasers.ingest.sentry.io').get('/api/12312012/store/').reply(200);