timers: warn on overflowed timeout duration
Cherry-pick from ayo Ayo commit log: > Previously there wasn't any clear indicator when you hit the overflow > other than possibly unexpected behavior, and I think emitting a warning > may be appropriate. > PR-URL: https://github.com/ayojs/ayo/pull/71 > Reviewed-By: Scott Trinh <scott@scotttrinh.com> > Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> > Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> > Reviewed-By: Anna Henningsen <anna@addaleax.net> > Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> PR-URL: https://github.com/nodejs/node/pull/15627 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
parent
4843c2f415
commit
ce3586da31
@ -398,6 +398,9 @@ exports.enroll = function(item, msecs) {
|
||||
|
||||
// Ensure that msecs fits into signed int32
|
||||
if (msecs > TIMEOUT_MAX) {
|
||||
process.emitWarning(`${msecs} does not fit into a 32-bit signed integer.` +
|
||||
`\nTimer duration was truncated to ${TIMEOUT_MAX}.`,
|
||||
'TimeoutOverflowWarning');
|
||||
msecs = TIMEOUT_MAX;
|
||||
}
|
||||
|
||||
@ -442,8 +445,15 @@ exports.setTimeout = setTimeout;
|
||||
|
||||
function createSingleTimeout(callback, after, args) {
|
||||
after *= 1; // coalesce to number or NaN
|
||||
if (!(after >= 1 && after <= TIMEOUT_MAX))
|
||||
if (!(after >= 1 && after <= TIMEOUT_MAX)) {
|
||||
if (after > TIMEOUT_MAX) {
|
||||
process.emitWarning(`${after} does not fit into` +
|
||||
' a 32-bit signed integer.' +
|
||||
'\nTimeout duration was set to 1.',
|
||||
'TimeoutOverflowWarning');
|
||||
}
|
||||
after = 1; // schedule on next tick, follows browser behavior
|
||||
}
|
||||
|
||||
var timer = new Timeout(after, callback, args);
|
||||
if (process.domain)
|
||||
@ -531,8 +541,15 @@ exports.setInterval = function(callback, repeat, arg1, arg2, arg3) {
|
||||
|
||||
function createRepeatTimeout(callback, repeat, args) {
|
||||
repeat *= 1; // coalesce to number or NaN
|
||||
if (!(repeat >= 1 && repeat <= TIMEOUT_MAX))
|
||||
if (!(repeat >= 1 && repeat <= TIMEOUT_MAX)) {
|
||||
if (repeat > TIMEOUT_MAX) {
|
||||
process.emitWarning(`${repeat} does not fit into` +
|
||||
' a 32-bit signed integer.' +
|
||||
'\nInterval duration was set to 1.',
|
||||
'TimeoutOverflowWarning');
|
||||
}
|
||||
repeat = 1; // schedule on next tick, follows browser behavior
|
||||
}
|
||||
|
||||
var timer = new Timeout(repeat, callback, args);
|
||||
timer._repeat = repeat;
|
||||
|
40
test/parallel/test-timers-max-duration-warning.js
Normal file
40
test/parallel/test-timers-max-duration-warning.js
Normal file
@ -0,0 +1,40 @@
|
||||
'use strict';
|
||||
|
||||
const common = require('../common');
|
||||
const assert = require('assert');
|
||||
const timers = require('timers');
|
||||
|
||||
const OVERFLOW = Math.pow(2, 31); // TIMEOUT_MAX is 2^31-1
|
||||
|
||||
function timerNotCanceled() {
|
||||
common.fail('Timer should be canceled');
|
||||
}
|
||||
|
||||
process.on('warning', common.mustCall((warning) => {
|
||||
const lines = warning.message.split('\n');
|
||||
|
||||
assert.strictEqual(warning.name, 'TimeoutOverflowWarning');
|
||||
assert.strictEqual(lines[0], `${OVERFLOW} does not fit into a 32-bit signed` +
|
||||
' integer.');
|
||||
assert.strictEqual(lines.length, 2);
|
||||
}, 3));
|
||||
|
||||
|
||||
{
|
||||
const timeout = setTimeout(timerNotCanceled, OVERFLOW);
|
||||
clearTimeout(timeout);
|
||||
}
|
||||
|
||||
{
|
||||
const interval = setInterval(timerNotCanceled, OVERFLOW);
|
||||
clearInterval(interval);
|
||||
}
|
||||
|
||||
{
|
||||
const timer = {
|
||||
_onTimeout: timerNotCanceled
|
||||
};
|
||||
timers.enroll(timer, OVERFLOW);
|
||||
timers.active(timer);
|
||||
timers.unenroll(timer);
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user