Skip to content

Commit

Permalink
stream: fix eventNames() to not return not defined events
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyasShabiCS committed Feb 18, 2024
1 parent bf39716 commit 05c64c3
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ const {
SymbolFor,
SymbolAsyncIterator,
SymbolDispose,
ArrayIsArray,

Check failure on line 52 in lib/events.js

View workflow job for this annotation

GitHub Actions / lint-js-and-md

'ArrayIsArray' is assigned a value but never used
} = primordials;
const kRejection = SymbolFor('nodejs.rejection');

Expand Down
11 changes: 11 additions & 0 deletions lib/internal/streams/legacy.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
const {
ArrayIsArray,
ObjectSetPrototypeOf,
ReflectOwnKeys,
} = primordials;

const EE = require('events');
Expand Down Expand Up @@ -93,6 +94,16 @@ Stream.prototype.pipe = function(dest, options) {
return dest;
};

Stream.prototype.eventNames = function eventNames() {
const names = [];
for (const key of ReflectOwnKeys(this._events)) {
if (typeof this._events[key] === 'function' || (ArrayIsArray(this._events[key]) && this._events[key].length > 0)) {
names.push(key);
}
}
return names;
};

function prependListener(emitter, event, fn) {
// Sadly this is not cacheable as some libraries bundle their own
// event emitter implementation with them.
Expand Down
42 changes: 42 additions & 0 deletions test/parallel/test-stream-event-names.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
'use strict';

require('../common');
const assert = require('assert');
const { Readable, Writable, Duplex } = require('stream');

{
const stream = new Readable();
assert.strictEqual(stream.eventNames().length, 0);
}

{
const stream = new Readable();
stream.on('foo', () => {});
stream.on('data', () => {});
stream.on('error', () => {});
assert.deepStrictEqual(stream.eventNames(), ['error', 'data', 'foo']);
}

{
const stream = new Writable();
assert.strictEqual(stream.eventNames().length, 0);
}

{
const stream = new Writable();
stream.on('foo', () => {});
stream.on('drain', () => {});
stream.on('prefinish', () => {});
assert.deepStrictEqual(stream.eventNames(), ['prefinish', 'drain', 'foo']);
}
{
const stream = new Duplex();
assert.strictEqual(stream.eventNames().length, 0);
}

{
const stream = new Duplex();
stream.on('foo', () => {});
stream.on('finish', () => {});
assert.deepStrictEqual(stream.eventNames(), ['finish', 'foo']);
}

0 comments on commit 05c64c3

Please sign in to comment.