@uphold/opentelemetry-mutable-baggage 0.0.0

package/.eslintignore

@@ -0,0 +1 @@
+dist

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Uphold
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# @uphold/opentelemetry-mutable-baggage
+
+Package that allows an OpenTelemetry baggage to be mutable.
+
+## Installation
+
+```sh
+npm install @uphold/opentelemetry-mutable-baggage
+```
+
+## Why?
+
+The default OpenTelemetry Baggage is immutable. Any change to it will create a new instance that you will need to save on the context. Because context is also immutable, saving the new baggage on the context will also create a new context. This makes it unsuitable for use-cases in which a piece of code needs to have visibility of items set on the baggage made by other pieces of code.
+
+One common use-case is in frameworks with stack based middleware, such as Koa:
+
+```js
+// 1st middleware:
+const requestLifecycleMiddleware = (context, next) => {
+  const { request } = context;
+  const createdAt = new Date();
+  const startedAt = process.hrtime();
+
+  try {
+    await next();
+  } finally {
+    // This will always be undefined!
+    const userId = api.propagation.getActiveBaggage()?.getEntry('user-id');
+
+    log.info({ userId }, `Request to ${request.method} ${request.path}`);
+  }
+};
+
+// 2nd middleware:
+const authenticationMiddleware = (context, next) => {
+  const baggage = api.propagation.getActiveBaggage();
+  const newBaggage = baggage?.setEntry('user-id', { value: 'faaebf49-c915-43ae-84fc-96c1711d2394' });
+
+  await api.context.with(api.context.setBaggage(baggage), next);
+};
+```
+
+In the example above, `requestLifecycleMiddleware` will never see the `user-id` entry on the active baggage.
+
+## Usage
+
+Replace `W3CBaggagePropagator` with `W3CMutableBaggagePropagator`, since it's a drop-in replacement. Here's how it looks if you are using the NodeSDK:
+
+```js
+import { CompositePropagator, W3CTraceContextPropagator } from '@opentelemetry/core';
+import { W3CMutableBaggagePropagator } from '@uphold/opentelemetry-mutable-baggage';
+
+const textMapPropagator = new CompositePropagator({
+  propagators: [new W3CTraceContextPropagator(), new W3CMutableBaggagePropagator()]
+});
+
+const sdk = new NodeSDK({
+  // ...
+  textMapPropagator
+});
+```
+
+> ⚠️ The `textMapPropagator` option of the SDK will be ignored if both `spanProcessor` or `traceExporter` are not defined in the options. Either define those or call `api.propagation.setGlobalPropagator(textMapPropagator)` manually.
+
+Then, use the regular `propagation` api to interact with the baggage:
+
+```js
+import { propagation } from '@opentelemetry/api';
+
+// `setEntry` will no longer create a new baggage!
+propagation.getActiveBaggage()?.setEntry('foo', 'bar');
+```
+
+## Tests
+
+```sh
+npm test
+```
+
+## License
+
+Licensed under MIT.

package/dist/context-helpers.d.ts

@@ -0,0 +1,7 @@
+import { BaggageEntry, Context } from '@opentelemetry/api';
+import { MutableBaggageImpl } from './mutable-baggage-impl';
+export declare const getActiveMutableBaggage: () => MutableBaggageImpl | undefined;
+export declare const getMutableBaggage: (context: Context) => MutableBaggageImpl | undefined;
+export declare const createMutableBaggage: (entries?: Record<string, BaggageEntry>) => MutableBaggageImpl;
+export declare const setMutableBaggage: (context: Context, baggage: MutableBaggageImpl) => Context;
+//# sourceMappingURL=context-helpers.d.ts.map

package/dist/context-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-helpers.d.ts","sourceRoot":"","sources":["../src/context-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAA6B,MAAM,oBAAoB,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D,eAAO,MAAM,uBAAuB,QAAO,kBAAkB,GAAG,SACsB,CAAC;AAEvF,eAAO,MAAM,iBAAiB,YAAa,OAAO,KAAG,kBAAkB,GAAG,SACG,CAAC;AAE9E,eAAO,MAAM,oBAAoB,aAAa,OAAO,MAAM,EAAE,YAAY,CAAC,KAAQ,kBACxB,CAAC;AAE3D,eAAO,MAAM,iBAAiB,YAAa,OAAO,WAAW,kBAAkB,KAAG,OACjC,CAAC"}

package/dist/context-helpers.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setMutableBaggage = exports.createMutableBaggage = exports.getMutableBaggage = exports.getActiveMutableBaggage = void 0;
+const api_1 = require("@opentelemetry/api");
+const mutable_baggage_impl_1 = require("./mutable-baggage-impl");
+const MUTTABLE_BAGGAGE_KEY = (0, api_1.createContextKey)('OpenTelemetry Mutable Baggage Key');
+const getActiveMutableBaggage = () => api_1.context.active().getValue(MUTTABLE_BAGGAGE_KEY) ?? undefined;
+exports.getActiveMutableBaggage = getActiveMutableBaggage;
+const getMutableBaggage = (context) => context.getValue(MUTTABLE_BAGGAGE_KEY) ?? undefined;
+exports.getMutableBaggage = getMutableBaggage;
+const createMutableBaggage = (entries = {}) => new mutable_baggage_impl_1.MutableBaggageImpl(new Map(Object.entries(entries)));
+exports.createMutableBaggage = createMutableBaggage;
+const setMutableBaggage = (context, baggage) => context.setValue(MUTTABLE_BAGGAGE_KEY, baggage);
+exports.setMutableBaggage = setMutableBaggage;
+//# sourceMappingURL=context-helpers.js.map

package/dist/context-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-helpers.js","sourceRoot":"","sources":["../src/context-helpers.ts"],"names":[],"mappings":";;;AAAA,4CAAsF;AACtF,iEAA4D;AAE5D,MAAM,oBAAoB,GAAG,IAAA,sBAAgB,EAAC,mCAAmC,CAAC,CAAC;AAE5E,MAAM,uBAAuB,GAAG,GAAmC,EAAE,CACzE,aAAO,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAwB,IAAI,SAAS,CAAC;AAD1E,QAAA,uBAAuB,2BACmD;AAEhF,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAkC,EAAE,CACnF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB,IAAI,SAAS,CAAC;AADjE,QAAA,iBAAiB,qBACgD;AAEvE,MAAM,oBAAoB,GAAG,CAAC,UAAwC,EAAE,EAAsB,EAAE,CACrG,IAAI,yCAAkB,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAD9C,QAAA,oBAAoB,wBAC0B;AAEpD,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,OAA2B,EAAW,EAAE,CAC1F,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;AADrC,QAAA,iBAAiB,qBACoB","sourcesContent":["import { BaggageEntry, Context, context, createContextKey } from '@opentelemetry/api';\nimport { MutableBaggageImpl } from './mutable-baggage-impl';\n\nconst MUTTABLE_BAGGAGE_KEY = createContextKey('OpenTelemetry Mutable Baggage Key');\n\nexport const getActiveMutableBaggage = (): MutableBaggageImpl | undefined =>\n  (context.active().getValue(MUTTABLE_BAGGAGE_KEY) as MutableBaggageImpl) ?? undefined;\n\nexport const getMutableBaggage = (context: Context): MutableBaggageImpl | undefined =>\n  (context.getValue(MUTTABLE_BAGGAGE_KEY) as MutableBaggageImpl) ?? undefined;\n\nexport const createMutableBaggage = (entries: Record<string, BaggageEntry> = {}): MutableBaggageImpl =>\n  new MutableBaggageImpl(new Map(Object.entries(entries)));\n\nexport const setMutableBaggage = (context: Context, baggage: MutableBaggageImpl): Context =>\n  context.setValue(MUTTABLE_BAGGAGE_KEY, baggage);\n"]}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { W3CMutableBaggagePropagator } from './w3c-mutable-baggage-propagator';
+export { MutableBaggageImpl } from './mutable-baggage-impl';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableBaggageImpl = exports.W3CMutableBaggagePropagator = void 0;
+var w3c_mutable_baggage_propagator_1 = require("./w3c-mutable-baggage-propagator");
+Object.defineProperty(exports, "W3CMutableBaggagePropagator", { enumerable: true, get: function () { return w3c_mutable_baggage_propagator_1.W3CMutableBaggagePropagator; } });
+var mutable_baggage_impl_1 = require("./mutable-baggage-impl");
+Object.defineProperty(exports, "MutableBaggageImpl", { enumerable: true, get: function () { return mutable_baggage_impl_1.MutableBaggageImpl; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mFAA+E;AAAtE,6IAAA,2BAA2B,OAAA;AACpC,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA","sourcesContent":["export { W3CMutableBaggagePropagator } from './w3c-mutable-baggage-propagator';\nexport { MutableBaggageImpl } from './mutable-baggage-impl';\n"]}

package/dist/mutable-baggage-impl.d.ts

@@ -0,0 +1,12 @@
+import { Baggage, BaggageEntry } from '@opentelemetry/api';
+export declare class MutableBaggageImpl implements Baggage {
+    private entries;
+    constructor(entries?: Map<string, BaggageEntry>);
+    getEntry(key: string): BaggageEntry | undefined;
+    getAllEntries(): [string, BaggageEntry][];
+    setEntry(key: string, entry: BaggageEntry): MutableBaggageImpl;
+    removeEntry(key: string): MutableBaggageImpl;
+    removeEntries(...keys: string[]): MutableBaggageImpl;
+    clear(): MutableBaggageImpl;
+}
+//# sourceMappingURL=mutable-baggage-impl.d.ts.map

package/dist/mutable-baggage-impl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutable-baggage-impl.d.ts","sourceRoot":"","sources":["../src/mutable-baggage-impl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE3D,qBAAa,kBAAmB,YAAW,OAAO;IAChD,OAAO,CAAC,OAAO,CAA4B;gBAE/B,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC;IAI/C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAU/C,aAAa,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE;IAIzC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,kBAAkB;IAM9D,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB;IAM5C,aAAa,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,kBAAkB;IAQpD,KAAK,IAAI,kBAAkB;CAK5B"}

package/dist/mutable-baggage-impl.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableBaggageImpl = void 0;
+class MutableBaggageImpl {
+    entries;
+    constructor(entries) {
+        this.entries = entries ? new Map(entries) : new Map();
+    }
+    getEntry(key) {
+        const entry = this.entries.get(key);
+        if (!entry) {
+            return undefined;
+        }
+        return Object.assign({}, entry);
+    }
+    getAllEntries() {
+        return Array.from(this.entries.entries()).map(([key, value]) => [key, value]);
+    }
+    setEntry(key, entry) {
+        this.entries.set(key, entry);
+        return this;
+    }
+    removeEntry(key) {
+        this.entries.delete(key);
+        return this;
+    }
+    removeEntries(...keys) {
+        for (const key of keys) {
+            this.entries.delete(key);
+        }
+        return this;
+    }
+    clear() {
+        this.entries.clear();
+        return this;
+    }
+}
+exports.MutableBaggageImpl = MutableBaggageImpl;
+//# sourceMappingURL=mutable-baggage-impl.js.map

package/dist/mutable-baggage-impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutable-baggage-impl.js","sourceRoot":"","sources":["../src/mutable-baggage-impl.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;IACrB,OAAO,CAA4B;IAE3C,YAAY,OAAmC;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;IACxD,CAAC;IAED,QAAQ,CAAC,GAAW;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEpC,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,KAAmB;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAE7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,GAAW;QACrB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,GAAG,IAAc;QAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAErB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA9CD,gDA8CC","sourcesContent":["import { Baggage, BaggageEntry } from '@opentelemetry/api';\n\nexport class MutableBaggageImpl implements Baggage {\n  private entries: Map<string, BaggageEntry>;\n\n  constructor(entries?: Map<string, BaggageEntry>) {\n    this.entries = entries ? new Map(entries) : new Map();\n  }\n\n  getEntry(key: string): BaggageEntry | undefined {\n    const entry = this.entries.get(key);\n\n    if (!entry) {\n      return undefined;\n    }\n\n    return Object.assign({}, entry);\n  }\n\n  getAllEntries(): [string, BaggageEntry][] {\n    return Array.from(this.entries.entries()).map(([key, value]) => [key, value]);\n  }\n\n  setEntry(key: string, entry: BaggageEntry): MutableBaggageImpl {\n    this.entries.set(key, entry);\n\n    return this;\n  }\n\n  removeEntry(key: string): MutableBaggageImpl {\n    this.entries.delete(key);\n\n    return this;\n  }\n\n  removeEntries(...keys: string[]): MutableBaggageImpl {\n    for (const key of keys) {\n      this.entries.delete(key);\n    }\n\n    return this;\n  }\n\n  clear(): MutableBaggageImpl {\n    this.entries.clear();\n\n    return this;\n  }\n}\n"]}

package/dist/w3c-mutable-baggage-propagator.d.ts

@@ -0,0 +1,13 @@
+import { Context, TextMapGetter, TextMapPropagator, TextMapSetter } from '@opentelemetry/api';
+/**
+ * Propagates Baggage through Context format propagation.
+ *
+ * Based on the Baggage specification:
+ * https://w3c.github.io/baggage/
+ */
+export declare class W3CMutableBaggagePropagator implements TextMapPropagator {
+    inject(context: Context, carrier: unknown, setter: TextMapSetter): void;
+    extract(context: Context, carrier: unknown, getter: TextMapGetter): Context;
+    fields(): string[];
+}
+//# sourceMappingURL=w3c-mutable-baggage-propagator.d.ts.map

package/dist/w3c-mutable-baggage-propagator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"w3c-mutable-baggage-propagator.d.ts","sourceRoot":"","sources":["../src/w3c-mutable-baggage-propagator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,aAAa,EAEd,MAAM,oBAAoB,CAAC;AAS5B;;;;;GAKG;AAEH,qBAAa,2BAA4B,YAAW,iBAAiB;IACnE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI;IAqBvE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO;IA0B3E,MAAM,IAAI,MAAM,EAAE;CAGnB"}

package/dist/w3c-mutable-baggage-propagator.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W3CMutableBaggagePropagator = void 0;
+const api_1 = require("@opentelemetry/api");
+const mutable_baggage_impl_1 = require("./mutable-baggage-impl");
+const core_1 = require("@opentelemetry/core");
+const BAGGAGE_HEADER = 'baggage';
+const BAGGAGE_ITEMS_SEPARATOR = ',';
+const BAGGAGE_MAX_NAME_VALUE_PAIRS = 180;
+const BAGGAGE_MAX_PER_NAME_VALUE_PAIRS = 4096;
+/**
+ * Propagates Baggage through Context format propagation.
+ *
+ * Based on the Baggage specification:
+ * https://w3c.github.io/baggage/
+ */
+class W3CMutableBaggagePropagator {
+    inject(context, carrier, setter) {
+        const baggage = api_1.propagation.getBaggage(context);
+        if (!baggage || (0, core_1.isTracingSuppressed)(context)) {
+            return;
+        }
+        const keyPairs = core_1.baggageUtils
+            .getKeyPairs(baggage)
+            .filter(pair => {
+            return pair.length <= BAGGAGE_MAX_PER_NAME_VALUE_PAIRS;
+        })
+            .slice(0, BAGGAGE_MAX_NAME_VALUE_PAIRS);
+        const headerValue = core_1.baggageUtils.serializeKeyPairs(keyPairs);
+        if (headerValue.length > 0) {
+            setter.set(carrier, BAGGAGE_HEADER, headerValue);
+        }
+    }
+    extract(context, carrier, getter) {
+        const headerValue = getter.get(carrier, BAGGAGE_HEADER);
+        const baggageString = Array.isArray(headerValue) ? headerValue.join(BAGGAGE_ITEMS_SEPARATOR) : headerValue;
+        const entries = {};
+        const pairs = (baggageString ?? '').split(BAGGAGE_ITEMS_SEPARATOR);
+        pairs.forEach(entry => {
+            const keyPair = core_1.baggageUtils.parsePairKeyValue(entry);
+            if (keyPair) {
+                const baggageEntry = { value: keyPair.value };
+                if (keyPair.metadata) {
+                    baggageEntry.metadata = keyPair.metadata;
+                }
+                entries[keyPair.key] = baggageEntry;
+            }
+        });
+        const baggage = new mutable_baggage_impl_1.MutableBaggageImpl(new Map(Object.entries(entries)));
+        return api_1.propagation.setBaggage(context, baggage);
+    }
+    fields() {
+        return [BAGGAGE_HEADER];
+    }
+}
+exports.W3CMutableBaggagePropagator = W3CMutableBaggagePropagator;
+//# sourceMappingURL=w3c-mutable-baggage-propagator.js.map

package/dist/w3c-mutable-baggage-propagator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"w3c-mutable-baggage-propagator.js","sourceRoot":"","sources":["../src/w3c-mutable-baggage-propagator.ts"],"names":[],"mappings":";;;AAAA,4CAO4B;AAC5B,iEAA4D;AAC5D,8CAAwE;AAExE,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AACpC,MAAM,4BAA4B,GAAG,GAAG,CAAC;AACzC,MAAM,gCAAgC,GAAG,IAAI,CAAC;AAE9C;;;;;GAKG;AAEH,MAAa,2BAA2B;IACtC,MAAM,CAAC,OAAgB,EAAE,OAAgB,EAAE,MAAqB;QAC9D,MAAM,OAAO,GAAG,iBAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IAAI,CAAC,OAAO,IAAI,IAAA,0BAAmB,EAAC,OAAO,CAAC,EAAE;YAC5C,OAAO;SACR;QAED,MAAM,QAAQ,GAAG,mBAAY;aAC1B,WAAW,CAAC,OAAO,CAAC;aACpB,MAAM,CAAC,IAAI,CAAC,EAAE;YACb,OAAO,IAAI,CAAC,MAAM,IAAI,gCAAgC,CAAC;QACzD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAC;QAE1C,MAAM,WAAW,GAAG,mBAAY,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAE7D,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;SAClD;IACH,CAAC;IAED,OAAO,CAAC,OAAgB,EAAE,OAAgB,EAAE,MAAqB;QAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;QAE3G,MAAM,OAAO,GAAG,EAAkC,CAAC;QACnD,MAAM,KAAK,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAEnE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,OAAO,GAAG,mBAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAEtD,IAAI,OAAO,EAAE;gBACX,MAAM,YAAY,GAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAE5D,IAAI,OAAO,CAAC,QAAQ,EAAE;oBACpB,YAAY,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;iBAC1C;gBAED,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,yCAAkB,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEzE,OAAO,iBAAW,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,MAAM;QACJ,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;CACF;AAnDD,kEAmDC","sourcesContent":["import {\n  BaggageEntry,\n  Context,\n  TextMapGetter,\n  TextMapPropagator,\n  TextMapSetter,\n  propagation\n} from '@opentelemetry/api';\nimport { MutableBaggageImpl } from './mutable-baggage-impl';\nimport { baggageUtils, isTracingSuppressed } from '@opentelemetry/core';\n\nconst BAGGAGE_HEADER = 'baggage';\nconst BAGGAGE_ITEMS_SEPARATOR = ',';\nconst BAGGAGE_MAX_NAME_VALUE_PAIRS = 180;\nconst BAGGAGE_MAX_PER_NAME_VALUE_PAIRS = 4096;\n\n/**\n * Propagates Baggage through Context format propagation.\n *\n * Based on the Baggage specification:\n * https://w3c.github.io/baggage/\n */\n\nexport class W3CMutableBaggagePropagator implements TextMapPropagator {\n  inject(context: Context, carrier: unknown, setter: TextMapSetter): void {\n    const baggage = propagation.getBaggage(context);\n\n    if (!baggage || isTracingSuppressed(context)) {\n      return;\n    }\n\n    const keyPairs = baggageUtils\n      .getKeyPairs(baggage)\n      .filter(pair => {\n        return pair.length <= BAGGAGE_MAX_PER_NAME_VALUE_PAIRS;\n      })\n      .slice(0, BAGGAGE_MAX_NAME_VALUE_PAIRS);\n\n    const headerValue = baggageUtils.serializeKeyPairs(keyPairs);\n\n    if (headerValue.length > 0) {\n      setter.set(carrier, BAGGAGE_HEADER, headerValue);\n    }\n  }\n\n  extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {\n    const headerValue = getter.get(carrier, BAGGAGE_HEADER);\n    const baggageString = Array.isArray(headerValue) ? headerValue.join(BAGGAGE_ITEMS_SEPARATOR) : headerValue;\n\n    const entries = {} as Record<string, BaggageEntry>;\n    const pairs = (baggageString ?? '').split(BAGGAGE_ITEMS_SEPARATOR);\n\n    pairs.forEach(entry => {\n      const keyPair = baggageUtils.parsePairKeyValue(entry);\n\n      if (keyPair) {\n        const baggageEntry: BaggageEntry = { value: keyPair.value };\n\n        if (keyPair.metadata) {\n          baggageEntry.metadata = keyPair.metadata;\n        }\n\n        entries[keyPair.key] = baggageEntry;\n      }\n    });\n\n    const baggage = new MutableBaggageImpl(new Map(Object.entries(entries)));\n\n    return propagation.setBaggage(context, baggage);\n  }\n\n  fields(): string[] {\n    return [BAGGAGE_HEADER];\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@uphold/opentelemetry-mutable-baggage",
+  "version": "0.0.0",
+  "description": "Package that allows an OpenTelemetry baggage to be mutable.",
+  "main": "dist/index.js",
+  "author": "Uphold",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/uphold/opentelemetry-js-contrib.git"
+  },
+  "keywords": [
+    "opentelemetry",
+    "instrumentation",
+    "nodejs",
+    "tracing",
+    "baggage"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc",
+    "lint": "eslint --ext .ts,.js .",
+    "postlint": "tsc --noEmit",
+    "test": "vitest",
+    "release": "release-it"
+  },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "eslint --ext .ts,.js"
+    ]
+  },
+  "dependencies": {
+    "@opentelemetry/core": "^1.17.1"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": ">=1 <2"
+  },
+  "devDependencies": {
+    "@opentelemetry/context-async-hooks": "^1.17.1"
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,9 @@
+import * as exports from '.';
+import { expect, it } from 'vitest';
+
+it('should have the correct exports', () => {
+  expect({ ...exports }).toEqual({
+    MutableBaggageImpl: expect.any(Function),
+    W3CMutableBaggagePropagator: expect.any(Function)
+  });
+});

package/src/index.ts

@@ -0,0 +1,2 @@
+export { W3CMutableBaggagePropagator } from './w3c-mutable-baggage-propagator';
+export { MutableBaggageImpl } from './mutable-baggage-impl';

package/src/mutable-baggage-impl.test.ts

@@ -0,0 +1,149 @@
+import { MutableBaggageImpl } from './mutable-baggage-impl';
+import { describe, expect, it } from 'vitest';
+
+describe('constructor()', () => {
+  it('should create an instance with no entries', () => {
+    const mutableBaggageImpl = new MutableBaggageImpl();
+
+    expect(mutableBaggageImpl.getAllEntries().length).toEqual(0);
+  });
+
+  it('should create an instance with a set of entries', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    const allEntries = mutableBaggageImpl.getAllEntries();
+
+    expect(allEntries.length).toEqual(2);
+    expect(allEntries).toEqual([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+  });
+});
+
+describe('getEntry()', () => {
+  const entries = new Map([
+    ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+    ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+  ]);
+  const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+  it('should return undefined if the entry does not exist', () => {
+    expect(mutableBaggageImpl.getEntry('foo')).toBeUndefined();
+  });
+
+  it('should return the correct value if the entry exists', () => {
+    expect(mutableBaggageImpl.getEntry('key1')).toEqual({ value: 'd4cda95b652f4a1592b449d5929fda1b' });
+  });
+});
+
+describe('getAllEntries()', () => {
+  it('should return an empty array', () => {
+    const mutableBaggageImpl = new MutableBaggageImpl();
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([]);
+  });
+
+  it('should return the entries set on the baggage', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+  });
+});
+
+describe('setEntry()', () => {
+  it('should add an entry', () => {
+    const mutableBaggageImpl = new MutableBaggageImpl();
+
+    mutableBaggageImpl.setEntry('foo', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' });
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([['foo', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]]);
+  });
+
+  it('should update an entry', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    mutableBaggageImpl.setEntry('key1', { value: 'foo' });
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([
+      ['key1', { value: 'foo' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+  });
+});
+
+describe('removeEntry()', () => {
+  it('should not remove an entry if does not exist', () => {
+    const mutableBaggageImpl = new MutableBaggageImpl();
+
+    mutableBaggageImpl.removeEntry('foo');
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([]);
+  });
+
+  it('should remove an entry', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    mutableBaggageImpl.removeEntry('key1');
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]]);
+  });
+});
+
+describe('removeEntries()', () => {
+  it('should not remove entries if they do not exist', () => {
+    const mutableBaggageImpl = new MutableBaggageImpl();
+
+    mutableBaggageImpl.removeEntries('foo', 'biz');
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([]);
+  });
+
+  it('should remove an entry', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }],
+      ['key3', { value: 'biz' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    mutableBaggageImpl.removeEntries('key1', 'key2');
+
+    expect(mutableBaggageImpl.getAllEntries()).toEqual([['key3', { value: 'biz' }]]);
+  });
+});
+
+describe('clear()', () => {
+  it('should clear all entries', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key2', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }]
+    ]);
+    const mutableBaggageImpl = new MutableBaggageImpl(entries);
+
+    expect(mutableBaggageImpl.getAllEntries()).toHaveLength(2);
+
+    mutableBaggageImpl.clear();
+
+    expect(mutableBaggageImpl.getAllEntries()).toHaveLength(0);
+  });
+});

package/src/mutable-baggage-impl.ts

@@ -0,0 +1,49 @@
+import { Baggage, BaggageEntry } from '@opentelemetry/api';
+
+export class MutableBaggageImpl implements Baggage {
+  private entries: Map<string, BaggageEntry>;
+
+  constructor(entries?: Map<string, BaggageEntry>) {
+    this.entries = entries ? new Map(entries) : new Map();
+  }
+
+  getEntry(key: string): BaggageEntry | undefined {
+    const entry = this.entries.get(key);
+
+    if (!entry) {
+      return undefined;
+    }
+
+    return Object.assign({}, entry);
+  }
+
+  getAllEntries(): [string, BaggageEntry][] {
+    return Array.from(this.entries.entries()).map(([key, value]) => [key, value]);
+  }
+
+  setEntry(key: string, entry: BaggageEntry): MutableBaggageImpl {
+    this.entries.set(key, entry);
+
+    return this;
+  }
+
+  removeEntry(key: string): MutableBaggageImpl {
+    this.entries.delete(key);
+
+    return this;
+  }
+
+  removeEntries(...keys: string[]): MutableBaggageImpl {
+    for (const key of keys) {
+      this.entries.delete(key);
+    }
+
+    return this;
+  }
+
+  clear(): MutableBaggageImpl {
+    this.entries.clear();
+
+    return this;
+  }
+}

package/src/w3c-mutable-baggage-propagator.test.ts

@@ -0,0 +1,182 @@
+import {
+  BaggageEntry,
+  ROOT_CONTEXT,
+  baggageEntryMetadataFromString,
+  defaultTextMapGetter,
+  defaultTextMapSetter,
+  propagation
+} from '@opentelemetry/api';
+import { MutableBaggageImpl } from './mutable-baggage-impl';
+import { W3CMutableBaggagePropagator } from './w3c-mutable-baggage-propagator';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { suppressTracing } from '@opentelemetry/core';
+
+const mutableBaggagePropagator = new W3CMutableBaggagePropagator();
+
+let carrier: { [key: string]: unknown };
+
+beforeEach(() => {
+  carrier = {};
+});
+
+describe('.inject()', () => {
+  it('should set baggage header', () => {
+    const entries = new Map([
+      ['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }],
+      ['key3', { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' }],
+      [
+        'key4',
+        {
+          metadata: baggageEntryMetadataFromString('key4prop1=value1;key4prop2=value2;key4prop3WithNoValue'),
+          value: 'foo'
+        }
+      ],
+      ['with/slash', { value: 'with spaces' }]
+    ]);
+    const baggage = new MutableBaggageImpl(entries);
+    const context = propagation.setBaggage(ROOT_CONTEXT, baggage);
+
+    mutableBaggagePropagator.inject(context, carrier, defaultTextMapSetter);
+
+    expect(carrier.baggage).toBe(
+      'key1=d4cda95b652f4a1592b449d5929fda1b,key3=c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a,key4=foo;key4prop1=value1;key4prop2=value2;key4prop3WithNoValue,with%2Fslash=with%20spaces'
+    );
+  });
+
+  it('should not set baggage header if baggage is undefined', () => {
+    mutableBaggagePropagator.inject(ROOT_CONTEXT, carrier, defaultTextMapSetter);
+
+    expect(carrier.baggage).toBeUndefined();
+  });
+
+  it('should not set baggage header if tracing is suppressed', () => {
+    const entries = new Map([['key1', { value: 'd4cda95b652f4a1592b449d5929fda1b' }]]);
+    const baggage = new MutableBaggageImpl(entries);
+    const context = propagation.setBaggage(suppressTracing(ROOT_CONTEXT), baggage);
+
+    mutableBaggagePropagator.inject(context, carrier, defaultTextMapSetter);
+
+    expect(carrier.baggage).toBeUndefined();
+  });
+
+  it('should skip all entries whose length exceeds the W3C standard limit of 4096 bytes', () => {
+    const longKey = Array(96).fill('k').join('');
+    const shortKey = Array(95).fill('k').join('');
+    const value = Array(4000).fill('v').join('');
+
+    const baggage = new MutableBaggageImpl(
+      new Map([
+        ['aa', { value: 'shortvalue' }],
+        ['a'.repeat(4097), { value: 'foo' }],
+        [`${[shortKey]}`, { value }],
+        [`${[longKey]}`, { value }]
+      ])
+    );
+    const context = propagation.setBaggage(ROOT_CONTEXT, baggage);
+
+    mutableBaggagePropagator.inject(context, carrier, defaultTextMapSetter);
+
+    expect(carrier.baggage).toBe(`aa=shortvalue,${shortKey}=${value}`);
+  });
+
+  it('should not exceed the W3C standard header length limit of 8192 bytes', () => {
+    const longKey0 = Array(48).fill('0').join('');
+    const longKey1 = Array(49).fill('1').join('');
+    const longValue = Array(4000).fill('v').join('');
+
+    const baggage = new MutableBaggageImpl(
+      new Map([
+        ['aa', { value: Array(8000).fill('v').join('') }],
+        [`${[longKey0]}`, { value: longValue }],
+        [`${[longKey1]}`, { value: longValue }]
+      ])
+    );
+    const context = propagation.setBaggage(ROOT_CONTEXT, baggage);
+
+    mutableBaggagePropagator.inject(context, carrier, defaultTextMapSetter);
+
+    const header = carrier.baggage as string;
+
+    expect(header.length).toEqual(8100);
+    expect(carrier.baggage).toBe(`${longKey0}=${longValue},${longKey1}=${longValue}`);
+  });
+
+  it('should not exceed the W3C standard header entry limit of 180 entries', () => {
+    const entries: Map<string, BaggageEntry> = new Map();
+
+    Array(200)
+      .fill(0)
+      .forEach((_, i) => {
+        entries.set(`${i}`, { value: 'v' });
+      });
+
+    const baggage = new MutableBaggageImpl(entries);
+    const context = propagation.setBaggage(ROOT_CONTEXT, baggage);
+
+    mutableBaggagePropagator.inject(context, carrier, defaultTextMapSetter);
+
+    const header = carrier.baggage as string;
+
+    expect(header.length).toEqual(969);
+    expect(header.split(',').length).toEqual(180);
+  });
+});
+
+describe('.extract()', () => {
+  const baggageValue =
+    'key1=d4cda95b==,key3=c88815a7,key4=foo;key4prop1=value1;k>ey4prop2=value2;key4prop3WithNoValue, keyn   = valn, keym =valm';
+  const expected = new MutableBaggageImpl(
+    new Map([
+      ['key1', { value: 'd4cda95b==' }],
+      ['key3', { value: 'c88815a7' }],
+      [
+        'key4',
+        {
+          value: 'foo',
+          // eslint-disable-next-line sort-keys-fix/sort-keys-fix
+          metadata: baggageEntryMetadataFromString('key4prop1=value1;key4prop2=value2;key4prop3WithNoValue')
+        }
+      ],
+      ['keyn', { value: 'valn' }],
+      ['keym', { value: 'valm' }]
+    ])
+  );
+
+  it('should extract context of a sampled span from carrier', () => {
+    carrier.baggage = baggageValue;
+
+    const extractedContext = mutableBaggagePropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter);
+    const extractedBaggage = propagation.getBaggage(extractedContext);
+
+    expect(JSON.stringify(extractedBaggage?.getAllEntries())).toEqual(JSON.stringify(expected.getAllEntries()));
+  });
+
+  it('should extract context of a sampled span when the headerValue comes as array', () => {
+    carrier.baggage = [baggageValue];
+    const extractedBaggage = propagation.getBaggage(
+      mutableBaggagePropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)
+    );
+
+    expect(JSON.stringify(extractedBaggage?.getAllEntries())).toEqual(JSON.stringify(expected.getAllEntries()));
+  });
+
+  it('should extract context of a sampled span when the headerValue comes as array with multiple items', () => {
+    carrier.baggage = [
+      'key1=d4cda95b==,key3=c88815a7,key4=foo;key4prop1=value1;k>ey4prop2=value2;key4prop3WithNoValue, keyn   = valn',
+      'keym =valm'
+    ];
+
+    const extractedContext = mutableBaggagePropagator.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter);
+    const extractedBaggage = propagation.getBaggage(extractedContext);
+
+    expect(JSON.stringify(extractedBaggage?.getAllEntries())).toEqual(JSON.stringify(expected.getAllEntries()));
+  });
+});
+
+describe('.fields()', () => {
+  it('returns the fields used by the baggage spec', () => {
+    const propagator = new W3CMutableBaggagePropagator();
+
+    expect(propagator.fields()).toEqual(['baggage']);
+  });
+});

package/src/w3c-mutable-baggage-propagator.ts

@@ -0,0 +1,68 @@
+import {
+  BaggageEntry,
+  Context,
+  TextMapGetter,
+  TextMapPropagator,
+  TextMapSetter,
+  propagation
+} from '@opentelemetry/api';
+import { MutableBaggageImpl } from './mutable-baggage-impl';
+import { baggageUtils, isTracingSuppressed } from '@opentelemetry/core';
+
+const BAGGAGE_HEADER = 'baggage';
+const BAGGAGE_ITEMS_SEPARATOR = ',';
+const BAGGAGE_MAX_NAME_VALUE_PAIRS = 180;
+const BAGGAGE_MAX_PER_NAME_VALUE_PAIRS = 4096;
+
+export class W3CMutableBaggagePropagator implements TextMapPropagator {
+  inject(context: Context, carrier: unknown, setter: TextMapSetter): void {
+    const baggage = propagation.getBaggage(context);
+
+    if (!baggage || isTracingSuppressed(context)) {
+      return;
+    }
+
+    const keyPairs = baggageUtils
+      .getKeyPairs(baggage)
+      .filter(pair => {
+        return pair.length <= BAGGAGE_MAX_PER_NAME_VALUE_PAIRS;
+      })
+      .slice(0, BAGGAGE_MAX_NAME_VALUE_PAIRS);
+
+    const headerValue = baggageUtils.serializeKeyPairs(keyPairs);
+
+    if (headerValue.length > 0) {
+      setter.set(carrier, BAGGAGE_HEADER, headerValue);
+    }
+  }
+
+  extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {
+    const headerValue = getter.get(carrier, BAGGAGE_HEADER);
+    const baggageString = Array.isArray(headerValue) ? headerValue.join(BAGGAGE_ITEMS_SEPARATOR) : headerValue;
+
+    const entries = {} as Record<string, BaggageEntry>;
+    const pairs = (baggageString ?? '').split(BAGGAGE_ITEMS_SEPARATOR);
+
+    pairs.forEach(entry => {
+      const keyPair = baggageUtils.parsePairKeyValue(entry);
+
+      if (keyPair) {
+        const baggageEntry: BaggageEntry = { value: keyPair.value };
+
+        if (keyPair.metadata) {
+          baggageEntry.metadata = keyPair.metadata;
+        }
+
+        entries[keyPair.key] = baggageEntry;
+      }
+    });
+
+    const baggage = new MutableBaggageImpl(new Map(Object.entries(entries)));
+
+    return propagation.setBaggage(context, baggage);
+  }
+
+  fields(): string[] {
+    return [BAGGAGE_HEADER];
+  }
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": [
+    "src/**/*.ts",
+  ],
+  "exclude": [
+    "node_modules",
+    "src/**/*.test.ts"
+  ]
+}