Skip to content

Commit

Permalink
feat: add the original function parameters to the list of arguments e…
Browse files Browse the repository at this point in the history
…mitted in a timeout event.

fixes nodeshift#324
  • Loading branch information
lholmquist committed Jun 10, 2019
1 parent 766bbf4 commit 9338e57
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/circuit.js
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ class CircuitBreaker extends EventEmitter {
*/
const latency = Date.now() - latencyStartTime;
this.semaphore.release();
this.emit('timeout', error, latency);
this.emit('timeout', error, latency, args);
resolve(handleError(
error, this, timeout, args, latency, resolve, reject));
}, this.options.timeout);
Expand Down
18 changes: 18 additions & 0 deletions test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -808,6 +808,24 @@ test('Circuit Breaker timeout event emits latency', t => {
breaker.fire(-1).catch(noop);
});

test('Circuit Breaker timeout event emits function parameters', t => {
t.plan(6);
const breaker = circuit(slowFunction, { timeout: 10 });

breaker.on('timeout', (result, latencyTime, args) => {
t.ok(args, 'third argument is the function args');
t.equal(Array.isArray(args), true, 'The args parameter is an array');
t.equal(args[0], -1, 'this is the first argument');
t.equal(args[1].arg1, 'arg1', 'this is the second argument object');
t.equal(args[1].arg2, 'arg2', 'this is the second argument object');
t.equal(args[2][0], '1', 'this is the third argument');
breaker.shutdown();
t.end();
});

breaker.fire(-1, {arg1: 'arg1', arg2: 'arg2'}, ['1', '2']).catch(noop);
});

test('Circuit Breaker timeout with semaphore released', t => {
t.plan(1);
const breaker = circuit(slowFunction, { timeout: 10, capacity: 2 });
Expand Down

0 comments on commit 9338e57

Please sign in to comment.