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

Jump to bottom

Move rate limiting/retrying to error catching, add tests for rate limit handling #570

Merged
merged 4 commits into from
Jun 1, 2018
Merged

Move rate limiting/retrying to error catching, add tests for rate limit handling #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a920440
modifies rate limit handling functionality, adds tests for it
ggruiz May 31, 2018
983f42f
Merge branch 'coverage/webclient-rate-limit-test'
ggruiz May 31, 2018
7086db2
fix line length for lint
ggruiz May 31, 2018
51c0074
add log testing
ggruiz Jun 1, 2018
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
68 changes: 56 additions & 12 deletions src/WebClient.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ const { assert } = require('chai');
const { WebClient } = require('./WebClient');
const { LogLevel } = require('./logger');
const { addAppMetadata } = require('./util');
const rapidRetryPolicy = require('./retry-policies').rapidRetryPolicy;
const CaptureStdout = require('capture-stdout');
const isPromise = require('p-is-promise');
const nock = require('nock');
const Busboy = require('busboy');
const sinon = require('sinon');

const token = 'xoxa-faketoken';
const fastRetriesForTest = { minTimeout: 0, maxTimeout: 1 };

describe('WebClient', function () {

Expand Down Expand Up @@ -71,14 +72,18 @@ describe('WebClient', function () {

describe('apiCall()', function () {
beforeEach(function () {
this.client = new WebClient(token, { retryConfig: fastRetriesForTest });
this.client = new WebClient(token, { retryConfig: rapidRetryPolicy });
});

describe('when making a successful call', function () {
beforeEach(function () {
this.scope = nock('https://slack.com')
.post(/api/)
.reply(200, { ok: true });
.reply(200, { ok: true,
response_metadata: {
warnings: ['testWarning1', 'testWarning2']
}
});
});

it('should return results in a Promise', function () {
Expand All @@ -90,6 +95,19 @@ describe('WebClient', function () {
});
});

it('should send warnings to logs', function() {
const output = [];
const stub = function (level, message) {
output.push([level, message]);
}
const warnClient = new WebClient(token, { logLevel: LogLevel.WARN, logger: stub });
return warnClient.apiCall('method')
.then((result) => {
assert.isNotEmpty(output);
assert.lengthOf(output, 2, 'two logs pushed onto output');
});
});

it('should deliver results in a callback', function (done) {
this.client.apiCall('method', {}, (error, result) => {
assert.isNotOk(error);
Expand Down Expand Up @@ -338,7 +356,7 @@ describe('WebClient', function () {
.post(/api/)
.reply(200, { ok: true });
// NOTE: appMetaData is only evalued on client construction, so we cannot use the client already created
const client = new WebClient(token, { retryConfig: fastRetriesForTest });
const client = new WebClient(token, { retryConfig: rapidRetryPolicy });
return client.apiCall('method')
.then(() => {
scope.done();
Expand All @@ -348,7 +366,7 @@ describe('WebClient', function () {
});

describe('apiCall() - without a token', function () {
const client = new WebClient(undefined, { retryConfig: fastRetriesForTest });
const client = new WebClient(undefined, { retryConfig: rapidRetryPolicy });

const scope = nock('https://slack.com')
// NOTE: this could create false negatives if the serialization order changes (it shouldn't matter)
Expand All @@ -364,7 +382,7 @@ describe('WebClient', function () {

describe('named method aliases (facets)', function () {
beforeEach(function () {
this.client = new WebClient(token, { retryConfig: fastRetriesForTest });
this.client = new WebClient(token, { retryConfig: rapidRetryPolicy });
});
it('should properly mount methods as functions', function () {
// This test doesn't exhaustively check all the method aliases, it just tries a couple.
Expand Down Expand Up @@ -470,14 +488,13 @@ describe('WebClient', function () {
});

describe('has an option to set the retry policy ', function () {

it('retries a request which fails to get a response', function () {
const scope = nock('https://slack.com')
.post(/api/)
.replyWithError('could be a ECONNREFUESD, ENOTFOUND, ETIMEDOUT, ECONNRESET')
.post(/api/)
.reply(200, { ok: true });
const client = new WebClient(token, { retryConfig: fastRetriesForTest });
const client = new WebClient(token, { retryConfig: rapidRetryPolicy });
return client.apiCall('method')
.then((resp) => {
assert.propertyVal(resp, 'ok', true);
Expand All @@ -490,7 +507,7 @@ describe('WebClient', function () {
.reply(500)
.post(/api/)
.reply(200, { ok: true });
const client = new WebClient(token, { retryConfig: fastRetriesForTest });
const client = new WebClient(token, { retryConfig: rapidRetryPolicy });
return client.apiCall('method')
.then((resp) => {
assert.propertyVal(resp, 'ok', true);
Expand All @@ -500,15 +517,42 @@ describe('WebClient', function () {
});

describe('has rate limit handling', function () {
// NOTE: Check issue #451
it('should expose retry headers in the response');
// NOTE: see retry policy note below
it('should allow rate limit triggered retries to be turned off');

describe('when a request fails due to rate-limiting', function () {
// NOTE: is this retrying configurable with the retry policy? is it subject to the request concurrency?
it('should automatically retry the request after the specified timeout');
it('should automatically retry the request after the specified timeout', function() {
const scope = nock('https://slack.com')
.post(/api/)
.reply(429, {}, { 'retry-after': 1 })
.post(/api/)
.reply(200, { ok: true });
const client = new WebClient(token, { retryConfig: { retries: 1 } });
const startTime = new Date().getTime();
return client.apiCall('method')
.then((resp) => {
const time = new Date().getTime() - startTime;
assert.isAtLeast(time, 1000, 'elapsed time is at least a second');
assert.propertyVal(resp, 'ok', true);
});
});

it('should pause the remaining requests in queue');
it('should emit a rate_limited event on the client');

it('should emit a rate_limited event on the client', function() {
const spy = sinon.spy();
const scope = nock('https://slack.com')
.post(/api/)
.reply(429, {}, { 'retry-after': 0 });
const client = new WebClient(token, { retryConfig: { retries: 0 } });
client.on('rate_limited', spy);
return client.apiCall('method')
.catch((err) => {
sinon.assert.calledOnce(spy);
});
});
});
});

Expand Down
46 changes: 17 additions & 29 deletions src/WebClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,46 +144,34 @@ export class WebClient extends EventEmitter {
agent: this.agentConfig,
}, this.tlsConfig),
)
.then((response: got.Response<string>) => {
const result = this.buildResult(response);
// log warnings in response metadata
if (result.response_metadata !== undefined && result.response_metadata.warnings !== undefined) {
result.response_metadata.warnings.forEach(this.logger.warn);
}
return result;
})
.catch((error: got.GotError) => {
// Wrap errors in this packages own error types (abstract the implementation details' types)
if (error.name === 'RequestError') {
throw requestErrorWithOriginal(error);
} else if (error.name === 'ReadError') {
throw readErrorWithOriginal(error);
} else if (error.name === 'HTTPError') {
// Special case: retry if 429;
if (error.statusCode === 429) {
const result = this.buildResult(error.response);
const retryAfterMs = result.retryAfter !== undefined ? result.retryAfter : (60 * 1000);
this.emit('rate_limited', retryAfterMs / 1000);
this.logger.info(`API Call failed due to rate limiting. Will retry in ${retryAfterMs / 1000} seconds.`);
// wait and return the result from calling `task` again after the specified number of seconds
return delay(retryAfterMs).then(task);
}
throw httpErrorWithOriginal(error);
} else {
throw error;
}
})
.then((response: got.Response<string>) => {
const result = this.buildResult(response);
// log warnings in response metadata
if (result.response_metadata !== undefined && result.response_metadata.warnings !== undefined) {
result.response_metadata.warnings.forEach(this.logger.warn);
}

// handle rate-limiting
if (response.statusCode !== undefined && response.statusCode === 429) {
const retryAfterMs = result.retryAfter !== undefined ? result.retryAfter : (60 * 1000);
// NOTE: the following event could have more information regarding the api call that is being delayed
this.emit('rate_limited', retryAfterMs / 1000);
this.logger.info(`API Call failed due to rate limiting. Will retry in ${retryAfterMs / 1000} seconds.`);
// wait and return the result from calling `task` again after the specified number of seconds
return delay(retryAfterMs).then(task);
}

// For any error in the API response, treat them as irrecoverable by throwing an AbortError to end retries.
if (!result.ok) {
const error = errorWithCode(
new Error(`An API error occurred: ${result.error}`),
ErrorCode.PlatformError,
);
error.data = result;
throw new pRetry.AbortError(error);
}

return result;
});
};

Expand Down