use baggage header util

Author: mydea

packages/opentelemetry/src/propagator.ts

@@ -15,6 +15,7 @@ import {
   dynamicSamplingContextToSentryBaggageHeader,
   generateSentryTraceHeader,
   logger,
+  parseBaggageHeader,
   propagationContextFromHeaders,
   stringMatchesSomePattern,
 } from '@sentry/utils';
@@ -101,9 +102,12 @@ export class SentryPropagator extends W3CBaggagePropagator {
     const { dynamicSamplingContext, traceId, spanId, sampled } = getInjectionData(context);
 
     if (existingBaggageHeader) {
-      const baggageEntries = parseBaggageHeaderString(existingBaggageHeader);
-      for (const [key, value] of baggageEntries) {
-        baggage = baggage.setEntry(key, { value });
+      const baggageEntries = parseBaggageHeader(existingBaggageHeader);
+
+      if (baggageEntries) {
+        Object.entries(baggageEntries).forEach(([key, value]) => {
+          baggage = baggage.setEntry(key, { value });
+        });
       }
     }
 
@@ -329,14 +333,3 @@ function getExistingBaggage(carrier: unknown): string | undefined {
     return undefined;
   }
 }
-
-/**
- * Will parse a baggage header into an array of tuples,
- *  where the first item is the baggage name, the second the baggage value.
- */
-function parseBaggageHeaderString(baggageHeader: string): [string, string][] {
-  return baggageHeader.split(',').map(baggageEntry => {
-    const [key, value] = baggageEntry.split('=');
-    return [decodeURIComponent(key.trim()), decodeURIComponent(value.trim())];
-  });
-}

packages/utils/src/baggage.ts

@@ -28,31 +28,10 @@ export function baggageHeaderToDynamicSamplingContext(
   // Very liberal definition of what any incoming header might look like
   baggageHeader: string | string[] | number | null | undefined | boolean,
 ): Partial<DynamicSamplingContext> | undefined {
-  if (!isString(baggageHeader) && !Array.isArray(baggageHeader)) {
-    return undefined;
-  }
-
-  // Intermediary object to store baggage key value pairs of incoming baggage headers on.
-  // It is later used to read Sentry-DSC-values from.
-  let baggageObject: Readonly<Record<string, string>> = {};
+  const baggageObject = parseBaggageHeader(baggageHeader);
 
-  if (Array.isArray(baggageHeader)) {
-    // Combine all baggage headers into one object containing the baggage values so we can later read the Sentry-DSC-values from it
-    baggageObject = baggageHeader.reduce<Record<string, string>>((acc, curr) => {
-      const currBaggageObject = baggageHeaderToObject(curr);
-      for (const key of Object.keys(currBaggageObject)) {
-        acc[key] = currBaggageObject[key];
-      }
-      return acc;
-    }, {});
-  } else {
-    // Return undefined if baggage header is an empty string (technically an empty baggage header is not spec conform but
-    // this is how we choose to handle it)
-    if (!baggageHeader) {
-      return undefined;
-    }
-
-    baggageObject = baggageHeaderToObject(baggageHeader);
+  if (!baggageObject) {
+    return undefined;
   }
 
   // Read all "sentry-" prefixed values out of the baggage object and put it onto a dynamic sampling context object.
@@ -104,6 +83,30 @@ export function dynamicSamplingContextToSentryBaggageHeader(
   return objectToBaggageHeader(sentryPrefixedDSC);
 }
 
+/**
+ * Take a baggage header and parse it into an object.
+ */
+export function parseBaggageHeader(
+  baggageHeader: string | string[] | number | null | undefined | boolean,
+): Record<string, string> | undefined {
+  if (!baggageHeader || (!isString(baggageHeader) && !Array.isArray(baggageHeader))) {
+    return undefined;
+  }
+
+  if (Array.isArray(baggageHeader)) {
+    // Combine all baggage headers into one object containing the baggage values so we can later read the Sentry-DSC-values from it
+    return baggageHeader.reduce<Record<string, string>>((acc, curr) => {
+      const currBaggageObject = baggageHeaderToObject(curr);
+      for (const key of Object.keys(currBaggageObject)) {
+        acc[key] = currBaggageObject[key];
+      }
+      return acc;
+    }, {});
+  }
+
+  return baggageHeaderToObject(baggageHeader);
+}
+
 /**
  * Will parse a baggage header, which is a simple key-value map, into a flat object.
  *