Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.
Open
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
5 changes: 5 additions & 0 deletions History.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

0.7.0 / 2016-12-15
==================

* [FEATURE] Retry with optional delay

0.6.0 / 2016-05-16
==================

Expand Down
9 changes: 9 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ function onresponse (err, res) {
}
```

You can optionally add a delay to each retry.

```javascript
superagent
.get('https://segment.io')
.retry(2, 500) // retry twice with 0.5 second delay
.end(onresponse);
```

## Retrying Cases

Currently the retrying logic checks for:
Expand Down
17 changes: 10 additions & 7 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,28 @@ module.exports.retries = retries;
/**
* Sets the amount of times to retry the request
* @param {Number} count
* @param {Number} [delay] optional delay in ms
*/

function retry (retries) {
function retry (retries, delay) {

var self = this
, oldEnd = this.end;

retries = retries || 1;
retries = retries === Number(retries) && retries || 1;
delay = delay === Number(delay) && delay || 0;

this.end = function (fn) {
var timeout = this._timeout;

function attemptRetry () {
return oldEnd.call(self, function (err, res) {
if (!retries || !shouldRetry(err, res)) return fn && fn(err, res);
if (!retries-- || !shouldRetry(err, res)) return fn && fn(err, res);

reset(self, timeout);

retries--;
return attemptRetry();
setTimeout(function() {
reset(self, timeout);
attemptRetry();
}, delay);
});
}

Expand All @@ -65,6 +67,7 @@ function reset (request, timeout) {
request.timeout(timeout);
delete request.req;
delete request._timer;
delete request._endCalled;

for (var k in headers) {
request.set(k, headers[k]);
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": "superagent-retry",
"version": "0.6.0",
"version": "0.7.0",
"description": "A retrying layer for a superagent request",
"keywords": [
"superagent",
Expand Down
29 changes: 29 additions & 0 deletions test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -237,5 +237,34 @@ describe('superagent-retry', function () {
done();
})
});

it('should retry with delay', function (done) {
var requests = 0;
var millisecs = Date.now();
var url = 'http://localhost:' + port + '/timeout';

app.get('/timeout', function (req, res, next) {
requests++;
if (requests > 10) res.send('hi!');
});

agent
.get(url)
.timeout(10)
.end(function (err, res) {
should.exist(err);
});

agent
.get(url)
.timeout(2)
.retry(10, 20)
.end(function (err, res) {
millisecs = Date.now() - millisecs;
res.text.should.eql('hi!');
millisecs.should.above(200);
done();
});
});
});
})