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.

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

Jump to bottom

events: validate options of on and once #46018

Merged
merged 2 commits into from
Sep 29, 2023
Merged

events: validate options of on and once #46018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55d1bc4
events: validate options of `on` and `once`
deokjinkim Dec 30, 2022
0fd49f1
add more invalid data types to test case
deokjinkim Dec 30, 2022
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
3 changes: 3 additions & 0 deletions lib/events.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ const {
validateBoolean,
validateFunction,
validateNumber,
validateObject,
validateString,
} = require('internal/validators');

Expand Down Expand Up @@ -960,6 +961,7 @@ function getMaxListeners(emitterOrTarget) {
* @returns {Promise}
*/
async function once(emitter, name, options = kEmptyObject) {
validateObject(options, 'options');
const signal = options?.signal;
validateAbortSignal(signal, 'options.signal');
if (signal?.aborted)
Expand Down Expand Up @@ -1047,6 +1049,7 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
*/
function on(emitter, event, options = kEmptyObject) {
// Parameters validation
validateObject(options, 'options');
const signal = options.signal;
validateAbortSignal(signal, 'options.signal');
if (signal?.aborted)
Expand Down
9 changes: 9 additions & 0 deletions test/parallel/test-events-on-async-iterator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ async function invalidArgType() {
code: 'ERR_INVALID_ARG_TYPE',
name: 'TypeError',
}));

const ee = new EventEmitter();

[1, 'hi', null, false, () => {}, Symbol(), 1n].map((options) => {
return assert.throws(() => on(ee, 'foo', options), common.expectsError({
code: 'ERR_INVALID_ARG_TYPE',
name: 'TypeError',
}));
});
}

async function error() {
Expand Down
18 changes: 8 additions & 10 deletions test/parallel/test-events-once.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
const common = require('../common');
const { once, EventEmitter } = require('events');
const {
strictEqual,
deepStrictEqual,
fail,
rejects,
strictEqual,
} = require('assert');
const { kEvents } = require('internal/event_target');

Expand All @@ -24,18 +24,16 @@ async function onceAnEvent() {
strictEqual(ee.listenerCount('myevent'), 0);
}

async function onceAnEventWithNullOptions() {
async function onceAnEventWithInvalidOptions() {
const ee = new EventEmitter();

process.nextTick(() => {
ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent', null);
strictEqual(value, 42);
await Promise.all([1, 'hi', null, false, () => {}, Symbol(), 1n].map((options) => {
return rejects(once(ee, 'myevent', options), {
code: 'ERR_INVALID_ARG_TYPE',
});
}));
}


async function onceAnEventWithTwoArgs() {
const ee = new EventEmitter();

Expand Down Expand Up @@ -267,7 +265,7 @@ async function eventTargetAbortSignalAfterEvent() {

Promise.all([
onceAnEvent(),
onceAnEventWithNullOptions(),
onceAnEventWithInvalidOptions(),
onceAnEventWithTwoArgs(),
catchesErrors(),
catchesErrorsWithAbortSignal(),
Expand Down