events: add max listener warning for EventTarget by jasnell · Pull Request #36001 · nodejs/node

jasnell · 2020-11-06T16:12:38Z

Fixes: #35990

Signed-off-by: James M Snell jasnell@gmail.com

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

doc/api/events.md

lib/internal/event_target.js

benjamingr

Looks good - except the static on EventTarget.

Domenic pointed me towards https://heycam.github.io/webidl/#create-an-interface-object that does not allow adding additional properties.

benjamingr · 2020-11-06T17:50:40Z

@jasnell would it be possible to make it static on events rather than a symbol on EventTarget so there are no additional methods tacked onto the EventTarget instance? (Even behind a symbol)

I think the DOM people and spec feel very strongly that once there are things added it's no longer a spec compliant EventTarget.

jasnell · 2020-11-06T18:04:10Z

Possible, yes, ideal, no? It would end up needing to be something like...

events.setEventTargetMaxListeners(eventTarget, 5);

Because the limit should be settable per EventTarget instance to match the behavior on EventEmitter and NodeEventTarget

jasnell · 2020-11-06T18:41:41Z

Ok, this is the approach I just implemented:

const events = require('events')
const et1 = new EventTarget();
const et2 = new EventTarget();

events.setEventTargetMaxListeners(15); // Set the default for all EventTargets

events.setEventTargetMaxListeners(15, et1); // Set the max for et1
events.setEventTargetMaxListeners(15, et1, et2); // Set the max for et1 and et2

It's not pretty but it works.

nodejs-github-bot · 2020-11-06T19:23:50Z

CI: https://ci.nodejs.org/job/node-test-pull-request/34139/

doc/api/events.md

lib/events.js

jasnell · 2020-11-12T14:53:18Z

The answer may very well be "yes" but I want to make sure that's a conscious choice.

I wouldn't see why not to be honest. They are functionally consistent with each other.

Trott · 2020-11-13T14:32:45Z

doc/api/events.md

+-->
+
+* `n` {number} A non-negative number. The maximum number of listeners per
+  `EventTarget` event.


Suggested change

`EventTarget` event.

`EventTarget` or `EventEmitter`.

Trott · 2020-11-13T14:33:10Z

doc/api/events.md

+  `EventTarget` event.
+* `...eventsTargets` {EventTarget[]|EventEmitter[]} Zero or more {EventTarget}
+  or {EventEmitter} instances. If none are specified, `n` is set as the default
+  max for all newly created {EventTarget} and {EventEmitter} objects.


Suggested change

max for all newly created {EventTarget} and {EventEmitter} objects.

maximum for all newly-created {EventTarget} and {EventEmitter} objects.

github-actions · 2020-11-16T09:48:22Z

Landed in cd31340...dc79f3f

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #36001 Fixes: #35990 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Notable changes: dns: * (SEMVER-MINOR) add a cancel() method to the promise Resolver (Szymon Marczak) #33099 events: * (SEMVER-MINOR) add max listener warning for EventTarget (James M Snell) #36001 http: * (SEMVER-MINOR) add support for abortsignal to http.request (Benjamin Gruenbaum) #36048 http2: * (SEMVER-MINOR) allow setting the local window size of a session (Yongsheng Zhang) #35978 lib: * (SEMVER-MINOR) add throws option to fs.f/l/statSync (Andrew Casey) #33716 path: * (SEMVER-MINOR) add `path/posix` and `path/win32` alias modules (ExE Boss) #34962 readline: * (SEMVER-MINOR) add getPrompt to get the current prompt (Mattias Runge-Broberg) #33675 src: * (SEMVER-MINOR) add loop idle time in diagnostic report (Gireesh Punathil) #35940 util: * (SEMVER-MINOR) add `util/types` alias module (ExE Boss) #34055 PR-URL: TODO

Notable changes: dns: * (SEMVER-MINOR) add a cancel() method to the promise Resolver (Szymon Marczak) #33099 events: * (SEMVER-MINOR) add max listener warning for EventTarget (James M Snell) #36001 http: * (SEMVER-MINOR) add support for abortsignal to http.request (Benjamin Gruenbaum) #36048 http2: * (SEMVER-MINOR) allow setting the local window size of a session (Yongsheng Zhang) #35978 lib: * (SEMVER-MINOR) add throws option to fs.f/l/statSync (Andrew Casey) #33716 path: * (SEMVER-MINOR) add `path/posix` and `path/win32` alias modules (ExE Boss) #34962 readline: * (SEMVER-MINOR) add getPrompt to get the current prompt (Mattias Runge-Broberg) #33675 src: * (SEMVER-MINOR) add loop idle time in diagnostic report (Gireesh Punathil) #35940 util: * (SEMVER-MINOR) add `util/types` alias module (ExE Boss) #34055 PR-URL: #36232

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: nodejs#36001 Fixes: nodejs#35990 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #36001 Backport-PR-URL: #38386 Fixes: #35990 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

jasnell requested a review from benjamingr November 6, 2020 16:12

benjamingr reviewed Nov 6, 2020

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

benjamingr reviewed Nov 6, 2020

View reviewed changes

lib/internal/event_target.js Outdated Show resolved Hide resolved

benjamingr reviewed Nov 6, 2020

View reviewed changes

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

This comment has been minimized.

Sign in to view

jasnell force-pushed the max-listeners-for-eventtarget branch from 34e87e4 to 53dc04d Compare November 6, 2020 17:10

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

This comment has been minimized.

Sign in to view

jasnell force-pushed the max-listeners-for-eventtarget branch from 53dc04d to abb7409 Compare November 6, 2020 18:54

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

This comment has been minimized.

Sign in to view

jasnell requested a review from benjamingr November 6, 2020 19:00

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

jasnell force-pushed the max-listeners-for-eventtarget branch from abb7409 to 1f87c08 Compare November 6, 2020 19:16

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 6, 2020

benjamingr reviewed Nov 7, 2020

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

benjamingr reviewed Nov 7, 2020

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

benjamingr reviewed Nov 7, 2020

View reviewed changes

lib/events.js Outdated Show resolved Hide resolved

benjamingr approved these changes Nov 7, 2020

View reviewed changes

jasnell added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 12, 2020

jasnell mentioned this pull request Nov 12, 2020

doc: cleanup events docs #36100

Closed

3 tasks

Trott reviewed Nov 13, 2020

View reviewed changes

Trott approved these changes Nov 13, 2020

View reviewed changes

benjamingr added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 16, 2020

github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 16, 2020

github-actions bot closed this Nov 16, 2020

codebytere mentioned this pull request Nov 22, 2020

v15.3.0 proposal #36232

Merged

targos added the backport-open-v14.x label Apr 24, 2021

targos mentioned this pull request Apr 24, 2021

[v14.x] Backport AbortController and friends #38386

Closed

targos added backported-to-v14.x and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-open-v14.x labels Apr 30, 2021

danielleadams mentioned this pull request May 3, 2021

v14.17.0 proposal #38507

Merged

ejose19 mentioned this pull request Jan 15, 2022

[node] add EventEmitter.setMaxListeners static method DefinitelyTyped/DefinitelyTyped#58205

Merged

7 tasks

mcollina mentioned this pull request Sep 4, 2024

Expose setMaxListeners property on AbortSignal #54758

Closed

	max for all newly created {EventTarget} and {EventEmitter} objects.
	maximum for all newly-created {EventTarget} and {EventEmitter} objects.

Uh oh!

Conversation

jasnell commented Nov 6, 2020

Checklist

Uh oh!

Uh oh!

Uh oh!

benjamingr left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

benjamingr commented Nov 6, 2020

Uh oh!

jasnell commented Nov 6, 2020

Uh oh!

jasnell commented Nov 6, 2020

Uh oh!

This comment has been minimized.

nodejs-github-bot commented Nov 6, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jasnell commented Nov 12, 2020

Uh oh!

Trott Nov 13, 2020

Choose a reason for hiding this comment

Uh oh!

Trott Nov 13, 2020

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants