opendev/gerrit
Code Issues Proposed changes

Merge "Use Accept JSON Header when fetching JSON"

Browse Source
This commit is contained in:
Ben Rohlfs
2019-08-21 12:26:25 +00:00
committed by Gerrit Code Review
parent 46d430c4d9 b31d5cd075
commit e7090ae529
2 changed files with 32 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-rest-api-interface.js
View File

@@ -349,6 +349,11 @@
* @param {Defs.FetchJSONRequest} req * @param {Defs.FetchJSONRequest} req
*/ */
_fetchJSON(req) { _fetchJSON(req) {
if (!req.fetchOptions) req.fetchOptions = {};
if (!req.fetchOptions.headers) req.fetchOptions.headers = new Headers();
if (!req.fetchOptions.headers.has('Accept')) {
req.fetchOptions.headers.append('Accept', 'application/json');
}
return this._fetchRawJSON(req).then(response => { return this._fetchRawJSON(req).then(response => {
if (!response) { if (!response) {
return; return;

31
polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-rest-api-interface_test.html
View File

@@ -63,8 +63,31 @@ limitations under the License.
sandbox.restore(); sandbox.restore();
}); });
suite('fetchJSON()', () => {
test('Sets header to accept application/json', () => {
const authFetchStub = sandbox.stub(element._auth, 'fetch')
.returns(Promise.resolve());
element._fetchJSON({url: '/dummy/url'});
assert.isTrue(authFetchStub.called);
assert.equal(authFetchStub.lastCall.args[1].headers.get('Accept'),
'application/json');
});
test('Use header option accept when provided', () => {
const authFetchStub = sandbox.stub(element._auth, 'fetch')
.returns(Promise.resolve());
const headers = new Headers();
headers.append('Accept', '*/*');
const fetchOptions = {headers};
element._fetchJSON({url: '/dummy/url', fetchOptions});
assert.isTrue(authFetchStub.called);
assert.equal(authFetchStub.lastCall.args[1].headers.get('Accept'),
'*/*');
});
});
test('JSON prefix is properly removed', done => { test('JSON prefix is properly removed', done => {
element._fetchJSON('/dummy/url').then(obj => { element._fetchJSON({url: '/dummy/url'}).then(obj => {
assert.deepEqual(obj, {hello: 'bonjour'}); assert.deepEqual(obj, {hello: 'bonjour'});
done(); done();
}); });
@@ -465,7 +488,7 @@ limitations under the License.
element.addEventListener('server-error', serverErrorStub); element.addEventListener('server-error', serverErrorStub);
const authErrorStub = sandbox.stub(); const authErrorStub = sandbox.stub();
element.addEventListener('auth-error', authErrorStub); element.addEventListener('auth-error', authErrorStub);
element._fetchJSON('/bar').finally(r => { element._fetchJSON({url: '/bar'}).finally(r => {
flush(() => { flush(() => {
assert.isTrue(authErrorStub.called); assert.isTrue(authErrorStub.called);
assert.isFalse(serverErrorStub.called); assert.isFalse(serverErrorStub.called);
@@ -484,7 +507,7 @@ limitations under the License.
element.addEventListener('server-error', serverErrorStub); element.addEventListener('server-error', serverErrorStub);
const authErrorStub = sandbox.stub(); const authErrorStub = sandbox.stub();
element.addEventListener('auth-error', authErrorStub); element.addEventListener('auth-error', authErrorStub);
element._fetchJSON('/bar').finally(r => { element._fetchJSON({url: '/bar'}).finally(r => {
flush(() => { flush(() => {
assert.isTrue(authErrorStub.called); assert.isTrue(authErrorStub.called);
assert.isFalse(serverErrorStub.called); assert.isFalse(serverErrorStub.called);
@@ -1112,7 +1135,7 @@ limitations under the License.
test('gerrit auth is used', () => { test('gerrit auth is used', () => {
sandbox.stub(Gerrit.Auth, 'fetch').returns(Promise.resolve()); sandbox.stub(Gerrit.Auth, 'fetch').returns(Promise.resolve());
element._fetchJSON('foo'); element._fetchJSON({url: 'foo'});
assert(Gerrit.Auth.fetch.called); assert(Gerrit.Auth.fetch.called);
}); });