Skip to content
Permalink
Browse files

timers: rename validateTimerDuration to getTimerDuration

The function did not only validate the timer but it caused side
effects like a warning and potentially returned a different value
than the input value. Thus the name `validate` did not seem to be
appropriate.

PR-URL: #26809
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
BridgeAR committed Mar 20, 2019
1 parent 6c913fb commit 9e8c9be3ff07845320c350fa3b2097cfbdada85e
Showing with 9 additions and 9 deletions.
  1. +3 −3 lib/_http_client.js
  2. +2 −2 lib/internal/stream_base_commons.js
  3. +2 −2 lib/internal/timers.js
  4. +2 −2 lib/timers.js
@@ -45,7 +45,7 @@ const {
ERR_INVALID_PROTOCOL,
ERR_UNESCAPED_CHARACTERS
} = require('internal/errors').codes;
const { validateTimerDuration } = require('internal/timers');
const { getTimerDuration } = require('internal/timers');
const is_reused_symbol = require('internal/freelist').symbols.is_reused_symbol;
const {
DTRACE_HTTP_CLIENT_REQUEST,
@@ -146,7 +146,7 @@ function ClientRequest(input, options, cb) {
this.socketPath = options.socketPath;

if (options.timeout !== undefined)
this.timeout = validateTimerDuration(options.timeout, 'timeout');
this.timeout = getTimerDuration(options.timeout, 'timeout');

var method = options.method;
var methodIsString = (typeof method === 'string');
@@ -743,7 +743,7 @@ ClientRequest.prototype.setTimeout = function setTimeout(msecs, callback) {
}

listenSocketTimeout(this);
msecs = validateTimerDuration(msecs, 'msecs');
msecs = getTimerDuration(msecs, 'msecs');
if (callback) this.once('timeout', callback);

if (this.socket) {
@@ -21,7 +21,7 @@ const { owner_symbol } = require('internal/async_hooks').symbols;
const {
kTimeout,
setUnrefTimeout,
validateTimerDuration
getTimerDuration
} = require('internal/timers');

const kMaybeDestroy = Symbol('kMaybeDestroy');
@@ -205,7 +205,7 @@ function setStreamTimeout(msecs, callback) {
this.timeout = msecs;

// Type checking identical to timers.enroll()
msecs = validateTimerDuration(msecs, 'msecs');
msecs = getTimerDuration(msecs, 'msecs');

// Attempt to clear an existing timer in both cases -
// even if it will be rescheduled we don't want to leak an existing timer.
@@ -359,7 +359,7 @@ function setUnrefTimeout(callback, after) {
}

// Type checking used by timers.enroll() and Socket#setTimeout()
function validateTimerDuration(msecs, name) {
function getTimerDuration(msecs, name) {
validateNumber(msecs, name);
if (msecs < 0 || !isFinite(msecs)) {
throw new ERR_OUT_OF_RANGE(name, 'a non-negative finite number', msecs);
@@ -586,7 +586,7 @@ module.exports = {
kRefed,
initAsyncResource,
setUnrefTimeout,
validateTimerDuration,
getTimerDuration,
immediateQueue,
getTimerCallbacks,
immediateInfoFields: {
@@ -36,7 +36,7 @@ const {
},
kRefed,
initAsyncResource,
validateTimerDuration,
getTimerDuration,
timerListMap,
timerListQueue,
immediateQueue,
@@ -102,7 +102,7 @@ function unenroll(item) {
// This function does not start the timer, see `active()`.
// Using existing objects as timers slightly reduces object overhead.
function enroll(item, msecs) {
msecs = validateTimerDuration(msecs, 'msecs');
msecs = getTimerDuration(msecs, 'msecs');

// If this item was already in a list somewhere
// then we should unenroll it from that

0 comments on commit 9e8c9be

Please sign in to comment.
You can’t perform that action at this time.