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.

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: headers are appended to existing one (open-telemetry#2335) #2357

Merged
merged 9 commits into from Jul 21, 2021
Expand Up @@ -55,8 +55,11 @@ export function sendWithXhr(
) {
const xhr = new XMLHttpRequest();
xhr.open('POST', url);
xhr.setRequestHeader('Accept', 'application/json');
xhr.setRequestHeader('Content-Type', 'application/json');

if (!Object.keys(headers).includes('Accept'))
obecny marked this conversation as resolved.
Show resolved Hide resolved
xhr.setRequestHeader('Accept', 'application/json');
if (!Object.keys(headers).includes('Content-Type'))
xhr.setRequestHeader('Content-Type', 'application/json');
Object.entries(headers).forEach(([k, v]) => {
xhr.setRequestHeader(k, v);
});
Expand Down
109 changes: 109 additions & 0 deletions packages/opentelemetry-exporter-collector/test/browser/util.test.ts
@@ -0,0 +1,109 @@
/*
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import * as sinon from "sinon";
import { sendWithXhr } from "../../src/platform/browser/util";
import { ensureHeadersContain } from "../helper";

describe("util - browser", () => {
let server: any;
const body = "";
const url = "";

let onSuccessStub: sinon.SinonStub;
let onErrorStub: sinon.SinonStub;

beforeEach(() => {
onSuccessStub = sinon.stub();
onErrorStub = sinon.stub();
server = sinon.fakeServer.create();
});

afterEach(() => {
server.restore();
sinon.restore();
});

describe("when Content-Type and Accept headers are set explicit", () => {
const explicitContentTypeAndAcceptHeaders = {
"Content-Type": "application/json",
Accept: "application/json",
};
it("should successfully use XMLHttpRequest, Request Headers contain the expilicit headers", done => {

sendWithXhr(
body,
url,
explicitContentTypeAndAcceptHeaders,
onSuccessStub,
onErrorStub
);

// ;charset=utf-8 is applied by sinon.fakeServer
const expectedHeaders = {
...explicitContentTypeAndAcceptHeaders,
"Content-Type": "application/json;charset=utf-8",
};

setTimeout(() => {
const { requestHeaders } = server.requests[0];
ensureHeadersContain(requestHeaders, expectedHeaders);
done();
});
});
});

describe("when headers are set empty {}", () => {
const emptyHeaders = {};
it('should successfully use XMLHttpRequest, Request Headers contain Content-Type of value "application/json" and Accept of value "application/json"', done => {
obecny marked this conversation as resolved.
Show resolved Hide resolved

sendWithXhr(body, url, emptyHeaders, onSuccessStub, onErrorStub);

// ;charset=utf-8 is applied by sinon.fakeServer
const expectedHeaders = {
Accept: "application/json",
"Content-Type": "application/json;charset=utf-8",
};

setTimeout(() => {
const { requestHeaders } = server.requests[0];
ensureHeadersContain(requestHeaders, expectedHeaders);
done();
});
});
});

describe("when custom headers are set", () => {
const customHeaders = { aHeader: "aValue", bHeader: "bValue" };
it('should successfully use XMLHttpRequest, Request Headers contain Content-Type of value "application/json", Accept of value "application/json" and custom headers', done => {
obecny marked this conversation as resolved.
Show resolved Hide resolved

sendWithXhr(body, url, customHeaders, onSuccessStub, onErrorStub);

// ;charset=utf-8 is applied by sinon.fakeServer
const expectedHeaders = {
...customHeaders,
Accept: "application/json",
"Content-Type": "application/json;charset=utf-8",
};

setTimeout(() => {
const { requestHeaders } = server.requests[0];
ensureHeadersContain(requestHeaders, expectedHeaders);
done();
});
});
});
});