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

Retry should pass all of the resolve arguments to the callback #1231

Merged
merged 3 commits into from
Jul 12, 2016
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Another big performance win has been re-implementing `queue`, `cargo`, and `prio
- Added `autoInject`, a relative of `auto` that automatically spreads a task's dependencies as arguments to the task function. (#608, #1055, #1099, #1100)
- You can now limit the concurrency of `auto` tasks. (#635, #637)
- Added `retryable`, a relative of `retry` that wraps an async function, making it retry when called. (#1058)
- `retry` now supports specifying a function that determines the next time interval, useful for exponential backoff and other retry strategies. (#1161)
- `retry` now supports specifying a function that determines the next time interval, useful for exponential backoff, logging and other retry strategies. (#1161)
- `retry` will now pass all of the arguments the task function was resolved with to the callback (#1231).
- Added `q.unsaturated` -- callback called when a `queue`'s number of running workers falls below a threshold. (#868, #1030, #1033, #1034)
- Added `q.error` -- a callback called whenever a `queue` task calls its callback with an error. (#1170)
- `applyEach` and `applyEachSeries` now pass results to the final callback. (#1088)
Expand Down
4 changes: 2 additions & 2 deletions lib/retry.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,11 @@ export default function retry(opts, task, callback) {

var attempt = 1;
function retryAttempt() {
task(function(err, result) {
task(function(err) {
if (err && attempt++ < options.times) {
setTimeout(retryAttempt, options.intervalFunc(attempt));
} else {
callback(err, result);
callback.apply(null, arguments);
}
});
}
Expand Down
23 changes: 22 additions & 1 deletion mocha_test/retry.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
var async = require('../lib');
var expect = require('chai').expect;
var assert = require('assert');
var _ = require('lodash');

describe("retry", function () {

Expand Down Expand Up @@ -121,7 +122,7 @@ describe("retry", function () {
}, 50);
});

it('retry does not precompute the intervals (#1226)',function(done) {
it('retry does not precompute the intervals (#1226)', function(done) {
var callTimes = [];
function intervalFunc() {
callTimes.push(new Date().getTime());
Expand All @@ -136,4 +137,24 @@ describe("retry", function () {
done();
});
});

it('retry passes all resolve arguments to callback', function(done) {
function fn(callback) {
callback(null, 1, 2, 3); // respond with indexed values
}
async.retry(5, fn, _.rest(function(args) {
expect(args).to.be.eql([null, 1, 2, 3]);
done();
}));
});

// note this is a synchronous test ensuring retry is synchrnous in the fastest (most straightforward) case
it('retry calls fn immediately and will call callback if successful', function() {
function fn(callback) {
callback(null, {a: 1});
}
async.retry(5, fn, function(err, result) {
expect(result).to.be.eql({a: 1});
});
})
});