fix(tracing): Baggage parsing fails when input is not of type string

packages/utils/src/baggage.ts

@@ -1,5 +1,6 @@
 import { Baggage, BaggageObj, TraceparentData } from '@sentry/types';
 
+import { isString } from './is';
 import { logger } from './logger';
 
 export const BAGGAGE_HEADER_NAME = 'baggage';
@@ -89,9 +90,28 @@ export function serializeBaggage(baggage: Baggage): string {
   }, baggage[1]);
 }
 
-/** Parse a baggage header from a string and return a Baggage object */
-export function parseBaggageString(inputBaggageString: string): Baggage {
-  return inputBaggageString.split(',').reduce(
+/** Parse a baggage header from a string or a string array and return a Baggage object */
+export function parseBaggageString(inputBaggageValue: string | string[]): Baggage {
+  // Adding this check here because we got reports of this function failing due to the input value
+  // not being a string. This debug log might help us determine what's going on here.
+  if (!Array.isArray(inputBaggageValue) && !isString(inputBaggageValue)) {
+    __DEBUG_BUILD__ &&
+      logger.warn(
+        '[parseBaggageString] Received input value of unknown type: ',
+        typeof inputBaggageValue,
+        inputBaggageValue,
+      );
+
+    // Gonna early-return an empty baggage object so that we don't fail later on
+    return createBaggage({}, '');
+  }
+
+  const baggageEntries = (isString(inputBaggageValue) ? inputBaggageValue : inputBaggageValue.join(','))
+    .split(',')
+    .map(entry => entry.trim())
+    .filter(entry => entry !== '');
+
+  return baggageEntries.reduce(
     ([baggageObj, baggageString], curr) => {
       const [key, val] = curr.split('=');
       if (SENTRY_BAGGAGE_KEY_PREFIX_REGEX.test(key)) {

packages/utils/test/baggage.test.ts

@@ -100,6 +100,7 @@ describe('Baggage', () => {
   describe('parseBaggageString', () => {
     it.each([
       ['parses an empty string', '', createBaggage({})],
+      ['parses a blank string', '     ', createBaggage({})],
       [
         'parses sentry values into baggage',
         'sentry-environment=production,sentry-release=10.0.2',
@@ -113,6 +114,29 @@ describe('Baggage', () => {
           'userId=alice,serverNode=DF%2028,isProduction=false',
         ),
       ],
+      [
+        'parses arbitrary baggage headers from string with empty and blank entries',
+        'userId=alice,    serverNode=DF%2028   , isProduction=false,   ,,sentry-environment=production,,sentry-release=10.0.2',
+        createBaggage(
+          { environment: 'production', release: '10.0.2' },
+          'userId=alice,serverNode=DF%2028,isProduction=false',
+        ),
+      ],
+      [
+        'parses a string array',
+        ['userId=alice', 'sentry-environment=production', 'foo=bar'],
+        createBaggage({ environment: 'production' }, 'userId=alice,foo=bar'),
+      ],
+      [
+        'parses a string array with items containing multiple entries',
+        ['userId=alice,   userName=bob', 'sentry-environment=production,sentry-release=1.0.1', 'foo=bar'],
+        createBaggage({ environment: 'production', release: '1.0.1' }, 'userId=alice,userName=bob,foo=bar'),
+      ],
+      [
+        'parses a string array with empty/blank entries',
+        ['', 'sentry-environment=production,sentry-release=1.0.1', '    ', 'foo=bar'],
+        createBaggage({ environment: 'production', release: '1.0.1' }, 'foo=bar'),
+      ],
     ])('%s', (_: string, baggageString, baggage) => {
       expect(parseBaggageString(baggageString)).toEqual(baggage);
     });