events: validate options of on and once

Check whether options is object or not to avoid passing invalid type as options to `on` and `once`. Refs: https://nodejs.org/dist/latest-v19.x/docs/api/events.html#eventsonceemitter-name-options PR-URL: #46018 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
nodejs · Sep 29, 2023 · 7ace5ab · 7ace5ab
1 parent b3ec13d
commit 7ace5ab
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 10 deletions.
diff --git a/lib/events.js b/lib/events.js
@@ -81,6 +81,7 @@ const {
   validateBoolean,
   validateFunction,
   validateNumber,
+  validateObject,
   validateString,
 } = require('internal/validators');
 
@@ -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)
@@ -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)

diff --git a/test/parallel/test-events-on-async-iterator.js b/test/parallel/test-events-on-async-iterator.js
@@ -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() {

diff --git a/test/parallel/test-events-once.js b/test/parallel/test-events-once.js
@@ -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');
 
@@ -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();
 
@@ -267,7 +265,7 @@ async function eventTargetAbortSignalAfterEvent() {
 
 Promise.all([
   onceAnEvent(),
-  onceAnEventWithNullOptions(),
+  onceAnEventWithInvalidOptions(),
   onceAnEventWithTwoArgs(),
   catchesErrors(),
   catchesErrorsWithAbortSignal(),