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

events: refactor to use validateNumber #45770

Merged
merged 2 commits into from
Jan 22, 2023
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
16 changes: 4 additions & 12 deletions lib/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ const {
ErrorCaptureStackTrace,
FunctionPrototypeBind,
FunctionPrototypeCall,
NumberIsNaN,
NumberMAX_SAFE_INTEGER,
ObjectCreate,
ObjectDefineProperty,
Expand Down Expand Up @@ -70,7 +69,6 @@ const {
codes: {
ERR_INVALID_ARG_TYPE,
ERR_INVALID_THIS,
ERR_OUT_OF_RANGE,
ERR_UNHANDLED_ERROR
},
genericNodeError,
Expand All @@ -81,6 +79,7 @@ const {
validateAbortSignal,
validateBoolean,
validateFunction,
validateNumber,
validateString,
} = require('internal/validators');

Expand Down Expand Up @@ -279,11 +278,7 @@ ObjectDefineProperty(EventEmitter, 'defaultMaxListeners', {
return defaultMaxListeners;
},
set: function(arg) {
if (typeof arg !== 'number' || arg < 0 || NumberIsNaN(arg)) {
throw new ERR_OUT_OF_RANGE('defaultMaxListeners',
'a non-negative number',
arg);
}
validateNumber(arg, 'defaultMaxListeners', 0);
defaultMaxListeners = arg;
}
});
Expand Down Expand Up @@ -313,8 +308,7 @@ ObjectDefineProperties(EventEmitter, {
*/
EventEmitter.setMaxListeners =
function(n = defaultMaxListeners, ...eventTargets) {
if (typeof n !== 'number' || n < 0 || NumberIsNaN(n))
throw new ERR_OUT_OF_RANGE('n', 'a non-negative number', n);
validateNumber(n, 'setMaxListeners', 0);
if (eventTargets.length === 0) {
defaultMaxListeners = n;
} else {
Expand Down Expand Up @@ -410,9 +404,7 @@ function emitUnhandledRejectionOrErr(ee, err, type, args) {
* @returns {EventEmitter}
*/
EventEmitter.prototype.setMaxListeners = function setMaxListeners(n) {
if (typeof n !== 'number' || n < 0 || NumberIsNaN(n)) {
throw new ERR_OUT_OF_RANGE('n', 'a non-negative number', n);
}
validateNumber(n, 'setMaxListeners', 0);
this._maxListeners = n;
return this;
};
Expand Down
32 changes: 24 additions & 8 deletions test/parallel/test-event-emitter-max-listeners.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,22 @@
const common = require('../common');
const assert = require('assert');
const events = require('events');
const { inspect } = require('util');
const e = new events.EventEmitter();

e.on('maxListeners', common.mustCall());

// Should not corrupt the 'maxListeners' queue.
e.setMaxListeners(42);

const throwsObjs = [NaN, -1, 'and even this'];
const rangeErrorObjs = [NaN, -1];
const typeErrorObj = 'and even this';

for (const obj of throwsObjs) {
for (const obj of rangeErrorObjs) {
assert.throws(
() => e.setMaxListeners(obj),
{
code: 'ERR_OUT_OF_RANGE',
name: 'RangeError',
message: 'The value of "n" is out of range. ' +
`It must be a non-negative number. Received ${inspect(obj)}`,
}
);

Expand All @@ -49,22 +47,40 @@ for (const obj of throwsObjs) {
{
code: 'ERR_OUT_OF_RANGE',
name: 'RangeError',
message: 'The value of "defaultMaxListeners" is out of range. ' +
`It must be a non-negative number. Received ${inspect(obj)}`,
}
);
}

assert.throws(
() => e.setMaxListeners(typeErrorObj),
{
code: 'ERR_INVALID_ARG_TYPE',
name: 'TypeError',
}
);

assert.throws(
() => events.defaultMaxListeners = typeErrorObj,
{
code: 'ERR_INVALID_ARG_TYPE',
name: 'TypeError',
}
);

e.emit('maxListeners');

{
const { EventEmitter, defaultMaxListeners } = events;
for (const obj of throwsObjs) {
for (const obj of rangeErrorObjs) {
assert.throws(() => EventEmitter.setMaxListeners(obj), {
code: 'ERR_OUT_OF_RANGE',
});
}

assert.throws(() => EventEmitter.setMaxListeners(typeErrorObj), {
code: 'ERR_INVALID_ARG_TYPE',
});

assert.throws(
() => EventEmitter.setMaxListeners(defaultMaxListeners, 'INVALID_EMITTER'),
{ code: 'ERR_INVALID_ARG_TYPE' }
Expand Down