doc: discourage error event #37264

benjamingr · 2021-02-07T12:27:49Z

Basically - the "error" event is being removed from the code - it was never documented on process but in order to be cautious the change is still semver-major.

This PR changes the wording to indicate the future behaviour.

Bikeshedding/suggestions welcome

aduh95 · 2021-02-07T17:49:50Z

Could you add an entry in deprecations.md?

benjamingr · 2021-02-07T18:25:10Z

@aduh95 not technically deprecated since not technically documented 😅

I am happy to add it to deprecations.md though this isn't going through the regular cycle.

mcollina · 2021-02-08T08:20:55Z

doc/api/events.md

+
+Currently errors are first forwarded to the `process.on('error')` event
+before reaching `process.on('uncaughtException')` - this behaviour will change
+in the next major release to align `EventTarget` with other Node.js APIs. Any


I don't like naming "the next major release". I prefer if we say it is deprecated and will be removed in a future major release.

Good idea, done

@mcollina any chance this can get a second review? I'd prefer to make sure the changes are what you had in mind

@mcollina ping (I'll also update it with Trott's suggestions before landing)

Trott · 2021-02-10T23:55:18Z

doc/api/events.md

-the other registered handlers from being invoked.
+by default the error is treated as an uncaught exception on
+`process.nextTick()`. This means uncaught exceptions in `EventTarget`s will
+crash the Node.js process by default.


Optional/non-blocking nit:

Suggested change

crash the Node.js process by default.

terminate the Node.js process by default.

Trott · 2021-02-10T23:59:16Z

doc/api/events.md

+from being invoked.
+
+The `EventTarget` does not implement any special default handling for `'error'`
+type events like `EventEmitter` does in order to be spec compliant.


Suggested change

type events like `EventEmitter` does in order to be spec compliant.

type events like `EventEmitter` does to be spec compliant.

...or even:

Suggested change

type events like `EventEmitter` does in order to be spec compliant.

type events like `EventEmitter` does.

It's not clear without additional context which is being spec compliant. Is it EventTarget being spec compliant but not implementing it? Or is it EventEmitter being spec compliant by implementing it? (I know the answer, or at least I think I do, but a reader may not.) Then again, maybe it's not even relevant, hence the removal suggestion above.

Trott · 2021-02-11T00:00:03Z

doc/api/events.md

+before reaching `process.on('uncaughtException')` - this behaviour is
+deprecated and will change in a future release to align `EventTarget` with
+other Node.js APIs. Any code relying on the `process.on('error')` event should
+be aligned with the new behaviour.


We use US spellings, so this:

Suggested change

be aligned with the new behaviour.

be aligned with the new behavior.

Trott · 2021-02-11T00:01:18Z

doc/api/events.md

+type events like `EventEmitter` does in order to be spec compliant.
+
+Currently errors are first forwarded to the `process.on('error')` event
+before reaching `process.on('uncaughtException')` - this behaviour is


Suggested change

before reaching `process.on('uncaughtException')` - this behaviour is

before reaching `process.on('uncaughtException')`. This behavior is

Trott

LGTM with US spelling applied to behaviour/behavior. Other changes are optional/non-blocking.

benjamingr · 2021-02-11T09:10:06Z

@Trott any chance you could also review #37237 ? Landing this one doesn't make a ton of sense without that one :)

mcollina

lgtm

PR-URL: #37264 Refs: #37237 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

benjamingr · 2021-02-11T15:11:01Z

Landed in cf5f6af

PR-URL: #37264 Refs: #37237 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

benjamingr added the doc Issues and PRs related to the documentations. label Feb 7, 2021

benjamingr requested review from jasnell and Trott February 7, 2021 12:27

nodejs-github-bot added the events Issues and PRs related to the events subsystem / EventEmitter. label Feb 7, 2021

aduh95 added semver-major PRs that contain breaking changes and should be released in the next major version. and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels Feb 7, 2021

benjamingr mentioned this pull request Feb 7, 2021

events: change EventTarget handler exception behavior #37237

Closed

addaleax approved these changes Feb 7, 2021

View reviewed changes

mcollina requested changes Feb 8, 2021

View reviewed changes

Trott reviewed Feb 10, 2021

View reviewed changes

Trott reviewed Feb 11, 2021

View reviewed changes

Trott approved these changes Feb 11, 2021

View reviewed changes

mcollina approved these changes Feb 11, 2021

View reviewed changes

benjamingr force-pushed the event-target-error-event branch from 322cd88 to 04625f9 Compare February 11, 2021 12:05

doc: discourage error event

36173aa

benjamingr force-pushed the event-target-error-event branch from 04625f9 to 36173aa Compare February 11, 2021 12:11

benjamingr added a commit that referenced this pull request Feb 11, 2021

doc: discourage error event

cf5f6af

PR-URL: #37264 Refs: #37237 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

benjamingr closed this Feb 11, 2021

danielleadams pushed a commit that referenced this pull request Feb 16, 2021

doc: discourage error event

3464c9f

PR-URL: #37264 Refs: #37237 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

This was referenced Feb 16, 2021

v15.9.0 proposal #37405

Closed

v15.9.0 proposal #37406

Merged

targos pushed a commit that referenced this pull request May 1, 2021

doc: discourage error event

b7c9366

PR-URL: #37264 Refs: #37237 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

danielleadams mentioned this pull request May 3, 2021

v14.17.0 proposal #38507

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: discourage error event #37264

doc: discourage error event #37264

benjamingr commented Feb 7, 2021

aduh95 commented Feb 7, 2021

benjamingr commented Feb 7, 2021

mcollina Feb 8, 2021

benjamingr Feb 8, 2021

benjamingr Feb 9, 2021

benjamingr Feb 11, 2021

Trott Feb 10, 2021 •

edited

Loading

Trott Feb 10, 2021

Trott Feb 11, 2021

Trott Feb 11, 2021

Trott left a comment

benjamingr commented Feb 11, 2021

mcollina left a comment

benjamingr commented Feb 11, 2021

	crash the Node.js process by default.
	terminate the Node.js process by default.

	type events like `EventEmitter` does in order to be spec compliant.
	type events like `EventEmitter` does to be spec compliant.

	type events like `EventEmitter` does in order to be spec compliant.
	type events like `EventEmitter` does.

	be aligned with the new behaviour.
	be aligned with the new behavior.

	before reaching `process.on('uncaughtException')` - this behaviour is
	before reaching `process.on('uncaughtException')`. This behavior is

doc: discourage error event #37264

doc: discourage error event #37264

Conversation

benjamingr commented Feb 7, 2021

aduh95 commented Feb 7, 2021

benjamingr commented Feb 7, 2021

mcollina Feb 8, 2021

Choose a reason for hiding this comment

benjamingr Feb 8, 2021

Choose a reason for hiding this comment

benjamingr Feb 9, 2021

Choose a reason for hiding this comment

benjamingr Feb 11, 2021

Choose a reason for hiding this comment

Trott Feb 10, 2021 • edited Loading

Choose a reason for hiding this comment

Trott Feb 10, 2021

Choose a reason for hiding this comment

Trott Feb 11, 2021

Choose a reason for hiding this comment

Trott Feb 11, 2021

Choose a reason for hiding this comment

Trott left a comment

Choose a reason for hiding this comment

benjamingr commented Feb 11, 2021

mcollina left a comment

Choose a reason for hiding this comment

benjamingr commented Feb 11, 2021

Trott Feb 10, 2021 •

edited

Loading