add outgoing request baggage propagation to node Http integration

Author: Lms24

packages/node/src/integrations/http.ts

@@ -1,6 +1,6 @@
 import { getCurrentHub } from '@sentry/core';
 import { Integration, Span } from '@sentry/types';
-import { fill, logger, parseSemver } from '@sentry/utils';
+import { fill, logger, mergeAndSerializeBaggage, parseSemver } from '@sentry/utils';
 import * as http from 'http';
 import * as https from 'https';
 
@@ -123,7 +123,14 @@ function _createWrappedRequestMethodFactory(
             logger.log(
               `[Tracing] Adding sentry-trace header ${sentryTraceHeader} to outgoing request to ${requestUrl}: `,
             );
-          requestOptions.headers = { ...requestOptions.headers, 'sentry-trace': sentryTraceHeader };
+
+          const headerBaggageString = requestOptions.headers && (requestOptions.headers.baggage as string);
+
+          requestOptions.headers = {
+            ...requestOptions.headers,
+            'sentry-trace': sentryTraceHeader,
+            baggage: mergeAndSerializeBaggage(span.getBaggage(), headerBaggageString),
+          };
         }
       }
 

packages/tracing/src/browser/request.ts

@@ -1,14 +1,10 @@
 /* eslint-disable max-lines */
-import { Baggage } from '@sentry/types';
 import {
   addInstrumentationHandler,
   BAGGAGE_HEADER_NAME,
-  createBaggage,
-  getThirdPartyBaggage,
   isInstanceOf,
   isMatchingPattern,
-  parseBaggageString,
-  serializeBaggage,
+  mergeAndSerializeBaggage,
 } from '@sentry/utils';
 
 import { Span } from '../span';
@@ -314,30 +310,3 @@ export function xhrCallback(
     }
   }
 }
-
-/**
- * Merges the baggage header we saved from the incoming request (or meta tag) with
- * a possibly created or modified baggage header by a third party that's been added
- * to the outgoing request header.
- *
- * In case @param headerBaggage exists, we can safely add the the 3rd party part of @param headerBaggage
- * with our @param incomingBaggage. This is possible because if we modified anything beforehand,
- * it would only affect parts of the sentry baggage (@see Baggage interface).
- *
- * @param incomingBaggage the baggage header of the incoming request that might contain sentry entries
- * @param headerBaggageString possibly existing baggage header string added from a third party to request headers
- *
- * @return a merged and serialized baggage string to be propagated with the outgoing request
- */
-function mergeAndSerializeBaggage(incomingBaggage?: Baggage, headerBaggageString?: string): string {
-  if (!incomingBaggage && !headerBaggageString) {
-    return '';
-  }
-
-  const headerBaggage = (headerBaggageString && parseBaggageString(headerBaggageString)) || undefined;
-  const thirdPartyHeaderBaggage = headerBaggage && getThirdPartyBaggage(headerBaggage);
-
-  const finalBaggage = createBaggage((incomingBaggage && incomingBaggage[0]) || {}, thirdPartyHeaderBaggage || '');
-
-  return serializeBaggage(finalBaggage);
-}

packages/utils/src/baggage.ts

@@ -81,3 +81,30 @@ export function parseBaggageString(inputBaggageString: string): Baggage {
     [{}, ''],
   );
 }
+
+/**
+ * Merges the baggage header we saved from the incoming request (or meta tag) with
+ * a possibly created or modified baggage header by a third party that's been added
+ * to the outgoing request header.
+ *
+ * In case @param headerBaggage exists, we can safely add the the 3rd party part of @param headerBaggage
+ * with our @param incomingBaggage. This is possible because if we modified anything beforehand,
+ * it would only affect parts of the sentry baggage (@see Baggage interface).
+ *
+ * @param incomingBaggage the baggage header of the incoming request that might contain sentry entries
+ * @param headerBaggageString possibly existing baggage header string added from a third party to request headers
+ *
+ * @return a merged and serialized baggage string to be propagated with the outgoing request
+ */
+export function mergeAndSerializeBaggage(incomingBaggage?: Baggage, headerBaggageString?: string): string {
+  if (!incomingBaggage && !headerBaggageString) {
+    return '';
+  }
+
+  const headerBaggage = (headerBaggageString && parseBaggageString(headerBaggageString)) || undefined;
+  const thirdPartyHeaderBaggage = headerBaggage && getThirdPartyBaggage(headerBaggage);
+
+  const finalBaggage = createBaggage((incomingBaggage && incomingBaggage[0]) || {}, thirdPartyHeaderBaggage || '');
+
+  return serializeBaggage(finalBaggage);
+}