Skip to content

Commit

Permalink
fix(instrumentation-http): do not mutate given headers object for out…
Browse files Browse the repository at this point in the history
  • Loading branch information
trentm authored and rdeavila94 committed Jan 3, 2024
1 parent 591c776 commit c1ae813
Showing 3 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions experimental/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ All notable changes to experimental packages in this project will be documented
* allows for experimental usage of this instrumentation with non-browser runtimes
* fix(instrumentation-http): memory leak when responses are not resumed
* fix(instrumentation-fetch): compatibility with Map types for fetch headers
* fix(instrumentation-http): Do not mutate given headers object for outgoing http requests. Fixes aws-sdk signing error on retries. [#4346](https://github.com/open-telemetry/opentelemetry-js/pull/4346)

## 0.45.1

Original file line number Diff line number Diff line change
@@ -675,6 +675,10 @@ export class HttpInstrumentation extends InstrumentationBase<Http> {

if (!optionsParsed.headers) {
optionsParsed.headers = {};
} else {
// Make a copy of the headers object to avoid mutating an object the
// caller might have a reference to.
optionsParsed.headers = Object.assign({}, optionsParsed.headers);
}
propagation.inject(requestContext, optionsParsed.headers);

Original file line number Diff line number Diff line change
@@ -269,6 +269,20 @@ describe('HttpInstrumentation Integration tests', () => {
assertSpan(span, SpanKind.CLIENT, validations);
});

it('should not mutate given headers object when adding propagation headers', async () => {
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 0);

const headers = { 'x-foo': 'foo' };
const result = await httpRequest.get(
new url.URL(`${protocol}://localhost:${mockServerPort}/?query=test`),
{ headers }
);
assert.deepStrictEqual(headers, { 'x-foo': 'foo' });
assert.ok(result.reqHeaders[DummyPropagation.TRACE_CONTEXT_KEY]);
assert.ok(result.reqHeaders[DummyPropagation.SPAN_CONTEXT_KEY]);
});

it('should create a span for GET requests and add propagation headers with Expect headers', async () => {
let spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 0);

0 comments on commit c1ae813

Please sign in to comment.