Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(baggage): include baggage metadata when propagating baggage entries #2766

Merged
merged 3 commits into from
Feb 9, 2022
Merged

fix(baggage): include baggage metadata when propagating baggage entries #2766

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b473d1e
feat(baggage): include baggage metadata when propagating baggage entries
chrskrchr Feb 6, 2022
2fdfedb
Merge branch 'main' into ck.baggageMetadata
chrskrchr Feb 8, 2022
aff56e2
Merge branch 'main' into ck.baggageMetadata
legendecas Feb 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions packages/opentelemetry-core/src/baggage/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,17 @@ export function serializeKeyPairs(keyPairs: string[]): string {
}

export function getKeyPairs(baggage: Baggage): string[] {
return baggage
.getAllEntries()
.map(
([key, value]) =>
`${encodeURIComponent(key)}=${encodeURIComponent(value.value)}`
);
return baggage.getAllEntries().map(([key, value]) => {
let entry = `${encodeURIComponent(key)}=${encodeURIComponent(value.value)}`;

// include opaque metadata if provided
// NOTE: we intentionally don't URI-encode the metadata - that responsibility falls on the metadata implementation
if (value.metadata !== undefined) {
entry += BAGGAGE_PROPERTIES_SEPARATOR + value.metadata.toString();
}

return entry;
});
}

export function parsePairKeyValue(entry: string): ParsedBaggageKeyValue | undefined {
Expand Down
6 changes: 4 additions & 2 deletions packages/opentelemetry-core/test/baggage/W3CBaggagePropagator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
defaultTextMapGetter,
defaultTextMapSetter,
propagation,
baggageEntryMetadataFromString
} from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import * as assert from 'assert';
Expand All @@ -39,8 +40,9 @@ describe('W3CBaggagePropagator', () => {
it('should set baggage header', () => {
const baggage = propagation.createBaggage({
key1: { value: 'd4cda95b652f4a1592b449d5929fda1b' },
key3: { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' },
'with/slash': { value: 'with spaces' },
key3: { value: 'c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a' },
key4: { value: 'foo', metadata: baggageEntryMetadataFromString('key4prop1=value1;key4prop2=value2;key4prop3WithNoValue') }
});

httpBaggagePropagator.inject(
Expand All @@ -50,7 +52,7 @@ describe('W3CBaggagePropagator', () => {
);
assert.deepStrictEqual(
carrier[BAGGAGE_HEADER],
'key1=d4cda95b652f4a1592b449d5929fda1b,key3=c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a,with%2Fslash=with%20spaces'
'key1=d4cda95b652f4a1592b449d5929fda1b,with%2Fslash=with%20spaces,key3=c88815a7-0fa9-4d95-a1f1-cdccce3c5c2a,key4=foo;key4prop1=value1;key4prop2=value2;key4prop3WithNoValue'
);
});

Expand Down