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

Added timeout to NahmiiRequest #136

Merged
merged 1 commit into from
Dec 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions lib/nahmii-request.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const request = require('superagent');
const https = require('https');

const _authProvider = new WeakMap();
const _timeout = new WeakMap();

function prefixSlash(value) {
if (value.toString().startsWith('/'))
Expand All @@ -16,23 +17,25 @@ const agent = new https.Agent({
});

function getSuperagent() {
if (global.window)
if (global.window)
return request;

return request.agent(agent);
}

module.exports = class NahmiiRequest {
constructor(apiRoot, authProvider) {
constructor(apiRoot, authProvider, timeout = 30000 /* 30 sec */) {
_authProvider.set(this, authProvider);
_timeout.set(this, timeout);
this.apiRoot = apiRoot;
}

async get(uri, queries = null) {
const authToken = await _authProvider.get(this)();
let r = getSuperagent()
.get(`https://${this.apiRoot}${prefixSlash(uri)}`)
.set('authorization', `Bearer ${authToken}`);
.set('authorization', `Bearer ${authToken}`)
.timeout({ response: _timeout.get(this) });
if (queries)
r = r.query(queries);
return r.then(res => res.body);
Expand All @@ -44,6 +47,7 @@ module.exports = class NahmiiRequest {
.post(`https://${this.apiRoot}${prefixSlash(uri)}`)
.send(payload)
.set('authorization', `Bearer ${authToken}`)
.timeout({ response: _timeout.get(this) })
.then(res => res.body);
}
};
18 changes: 15 additions & 3 deletions lib/nahmii-request.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

const chai = require('chai');
const sinon = require('sinon');
const sinonChai = require('sinon-chai');
const expect = chai.expect;
chai.use(sinonChai);
chai.use(require('chai-as-promised'));
chai.use(require('sinon-chai'));

const nock = require('nock');

Expand All @@ -20,6 +20,7 @@ const fakeConfig = {
apiRoot: 'some.hubii.server'
};

const timeout = 100;
const stubbedAuthProvider = sinon.stub();

describe('Nahmii Request', () => {
Expand All @@ -42,7 +43,7 @@ describe('Nahmii Request', () => {
beforeEach(() => {
testToken = 'some JWT';
stubbedAuthProvider.resolves(testToken);
request = new NahmiiRequest(fakeConfig.apiRoot, stubbedAuthProvider);
request = new NahmiiRequest(fakeConfig.apiRoot, stubbedAuthProvider, timeout);
});

describe('#get()', () => {
Expand Down Expand Up @@ -74,6 +75,17 @@ describe('Nahmii Request', () => {
expect(scope.isDone()).to.eql(true);
expect(result).to.eql(expectedBody);
});

it('it times out if it takes too long to resolve', async () => {
const expectedBody = ['item 1', 'item 2'];
nock('https://' + fakeConfig.apiRoot)
.get(prefixSlash(uri))
.delayConnection(timeout + 100)
.reply(200, expectedBody);
const err = await request.get(uri).catch(err => err);
// return expect(err.errno).to.equal('ETIMEDOUT'); // ISSUE: https://github.com/visionmedia/superagent/issues/1487
return expect(err.code).to.equal('ABORTED');
});
});
});

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nahmii-sdk",
"version": "4.0.0",
"version": "4.0.1",
"description": "Javascript SDK for using hubii nahmii APIs",
"main": "index.js",
"scripts": {
Expand Down