Skip to content

Prevent timeout value from skirting limit check #3536

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

Merged
merged 8 commits into from
Nov 9, 2018
Merged

Prevent timeout value from skirting limit check #3536

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
64764f5
fix(runnable.js): Prevent timeout value from skirting limit check
plroebuck Oct 27, 2018
2fac117
fix(runnable.js): Something screwed up the function documentation
plroebuck Oct 27, 2018
96f5c18
docs(runnable.js): FU prettier
plroebuck Oct 27, 2018
72f60d9
fix(lib/runnable.js): Fix timeout upper limit check (again)
plroebuck Nov 6, 2018
5d4ac5f
test(unit/runnable.spec.js): Updated tests for `#timeout(ms)`
plroebuck Nov 6, 2018
20083cb
feat(lib/utils.js): Add `clamp` function
plroebuck Nov 9, 2018
0a88350
fix(lib/runnable.js): Fix timeout range issue for good
plroebuck Nov 9, 2018
0685cdc
test(unit/runnable.spec.js): Update timeout tests to verify upper and…
plroebuck Nov 9, 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
26 changes: 19 additions & 7 deletions lib/runnable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,35 @@ function Runnable(title, fn) {
utils.inherits(Runnable, EventEmitter);

/**
* Set & get timeout `ms`.
* Get current timeout value in msecs.
*
* @api private
* @param {number|string} ms
* @return {Runnable|number} ms or Runnable instance.
* @private
* @returns {number} current timeout threshold value
*/
/**
* @summary
* Set timeout threshold value (msecs).
*
* @description
* A string argument can use shorthand (such as "2s") and will be converted.
* If the value is `0` or exceeds `2^<sup>31</sup>`, timeouts will be disabled.
*
* @private
* @param {number|string} ms - Timeout threshold value.
* @returns {Runnable} this
* @chainable
*/
Runnable.prototype.timeout = function(ms) {
if (!arguments.length) {
return this._timeout;
}
if (typeof ms === 'string') {
ms = milliseconds(ms);
}
// see #1652 for reasoning
if (ms === 0 || ms > Math.pow(2, 31)) {
this._enableTimeouts = false;
}
if (typeof ms === 'string') {
ms = milliseconds(ms);
}
debug('timeout %d', ms);
this._timeout = ms;
if (this.timer) {
Expand Down