process: Add --unhandled-rejections=throw and =warn-with-error-code #33475

dfabulich · 2020-05-20T00:45:40Z

This PR defines two new modes for the --unhandled-rejections flag.

The first mode is called "throw". The "throw" mode first emits
unhandledRejection. If this hook is not set, the "throw" mode will
raise the unhandled rejection as an uncaught exception.

The second mode is called "warn-with-error-code". The
"warn-with-error-code" mode first emits unhandledRejection. If this
hook is not set, the "warn-with-error-code" mode will trigger a
warning and set the process's exit code to 1.

The PR doesn't change the default behavior for unhandled rejections.
That will come in a separate PR.

Refs: #33021

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

lib/internal/process/promises.js

benjamingr · 2020-05-20T08:25:53Z

Changes look good - thanks. I'll try experimenting with it more than just a checkout asap.

dfabulich · 2020-05-20T17:35:15Z

Is there a thing I can click on to rerun the canceled/skipped checks?

mmarchini · 2020-05-20T18:18:20Z

There is, not sure if you need commit permission to do it though. Not sure why it was skipped though.

nodejs-github-bot · 2020-05-20T18:18:56Z

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

dfabulich · 2020-05-21T00:51:16Z

I don't see any logs on that tarball failure (and I can scarcely see how I could have broken this…)

dfabulich · 2020-05-22T03:00:01Z

Is there anything further I need to do here? (Do I need someone else to nudge the tarball build again?)

mmarchini · 2020-05-22T03:50:15Z

If you don't mind rebasing and force pushing, it would trigger the GitHub CI again. If the issue was on master and got fixed, doing so will fix the CI here.

(I don't remember if Actions runs on your commit, on a rebased version of it, or on a merged version of it. Worth trying anyway)

dfabulich · 2020-05-22T06:29:53Z

I'm at a loss on this tarball build. There are no logs on that failure. I just don't get it.

dfabulich · 2020-05-22T18:35:56Z

This time it looks like a flaky test, parallel/test-worker-init-failure. Unless someone has a better idea, I'm just gonna keep rebasing this branch to rerun the tests until I get a successful result. 😖

addaleax · 2020-05-22T18:40:58Z

@dfabulich No need to rebase – the relevant CI for merging this is the one that is posted by @nodejs-github-bot. The Github Actions ones are merely informative. So all that rebasing will do is making it harder to figure out what changes have been made since the last review/CI run/etc. :)

nodejs-github-bot · 2020-05-22T18:42:01Z

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

dfabulich · 2020-05-22T18:43:23Z

Thanks. I already kicked off another rebase, but if I get another weird failure, I'll just ignore it.

BridgeAR · 2020-05-23T01:56:49Z

I would like to wait for the result of our survey before landing this or to mark them as experimental. If there's no interest in such modes, it's probably not necessary to add the modes.

dfabulich · 2020-05-23T20:15:24Z

Speaking personally, I'd definitely want to use --unhandled-rejections=throw, regardless of the results of the survey and what we change the default setting to. I'd set it in NODE_OPTIONS in my .profile to get my preferred behavior.

(I can't use --strict for that right now, because I do occasionally run scripts that set an unhandledRejection handler; --strict will override their behavior. I'd just want to change the default on my own machines, at least.)

mmarchini · 2020-05-27T19:03:27Z

I'm also in favor of including those two options regardless of the survey results or TSC decision on default behavior.

This PR defines two new modes for the --unhandled-rejections flag. The first mode is called "throw". The "throw" mode first emits unhandledRejection. If this hook is not set, the "throw" mode will raise the unhandled rejection as an uncaught exception. The second mode is called "warn-with-error-code". The "warn-with-error-code" mode first emits unhandledRejection. If this hook is not set, the "warn-with-error-code" mode will trigger a warning and set the process's exit code to 1. The PR doesn't change the default behavior for unhandled rejections. That will come in a separate PR. Refs: #33021 PR-URL: #33475 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Notable changes: build: * (SEMVER-MINOR) reset embedder string to "-node.0" (Michaël Zasso) #33376 cli: * (SEMVER-MINOR) add alias for report-directory to make it consistent (AshCripps) #33587 crypto: * (SEMVER-MINOR) allow KeyObjects in postMessage (Tobias Nießen) #33360 deps: * (SEMVER-MINOR) V8: cherry-pick 0d6debcc5f08 (Michaël Zasso) #33376 * (SEMVER-MINOR) update V8 to 8.3.110.9 (Michaël Zasso) #33376 dgram: * (SEMVER-MINOR) allow typed arrays in .send() (Sarat Addepalli) #22413 events: * (SEMVER-MINOR) initial implementation of experimental EventTarget (James M Snell) #33556 fs: * (SEMVER-MINOR) implement lutimes (Maël Nison) #33399 http: * (SEMVER-MINOR) expose host and protocol on ClientRequest (wenningplus) #33803 * (SEMVER-MINOR) add maxTotalSockets to agent class (rickyes) #33617 * (SEMVER-MINOR) return this from OutgoingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from ClientRequest#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from IncomingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) added scheduling option to http agent (delvedor) #33278 http2: * (SEMVER-MINOR) return this for Http2ServerRequest#setTimeout (Pranshu Srivastava) #33994 * (SEMVER-MINOR) do not modify explicity set date headers (Pranshu Srivastava) #33160 process: * (SEMVER-MINOR) add unhandled-rejection throw and warn-with-error-code (Dan Fabulich) #33475 src: * (SEMVER-MINOR) store key data in separate class (Tobias Nießen) #33360 * (SEMVER-MINOR) add NativeKeyObject base class (Tobias Nießen) #33360 * (SEMVER-MINOR) rename internal key handles to KeyObjectHandle (Tobias Nießen) #33360 * (SEMVER-MINOR) add equality operators for BaseObjectPtr (Anna Henningsen) #33772 * (SEMVER-MINOR) introduce BaseObject base FunctionTemplate (Anna Henningsen) #33772 * (SEMVER-MINOR) add public APIs to manage v8::TracingController (Anna Henningsen) #33850 win: * (SEMVER-MINOR) allow skipping the supported platform check (João Reis) #33176 worker: * (SEMVER-MINOR) add public method for marking objects as untransferable (Anna Henningsen) #33979 * (SEMVER-MINOR) emit `'messagerror'` events for failed deserialization (Anna Henningsen) #33772 * (SEMVER-MINOR) allow passing JS wrapper objects via postMessage (Anna Henningsen) #33772 * (SEMVER-MINOR) allow transferring/cloning generic BaseObjects (Anna Henningsen) #33772 worker,fs: * (SEMVER-MINOR) make FileHandle transferable (Anna Henningsen) #33772 zlib: * (SEMVER-MINOR) add `maxOutputLength` option (unknown) #33516 PR-URL: #34093

Notable changes: build: * (SEMVER-MINOR) reset embedder string to "-node.0" (Michaël Zasso) #33376 cli: * (SEMVER-MINOR) add alias for report-directory to make it consistent (AshCripps) #33587 crypto: * (SEMVER-MINOR) allow KeyObjects in postMessage (Tobias Nießen) #33360 deps: * (SEMVER-MINOR) V8: cherry-pick 0d6debcc5f08 (Michaël Zasso) #33376 * (SEMVER-MINOR) update V8 to 8.3.110.9 (Michaël Zasso) #33376 dgram: * (SEMVER-MINOR) allow typed arrays in .send() (Sarat Addepalli) #22413 events: * (SEMVER-MINOR) initial implementation of experimental EventTarget (James M Snell) #33556 fs: * (SEMVER-MINOR) implement lutimes (Maël Nison) #33399 http: * (SEMVER-MINOR) expose host and protocol on ClientRequest (wenningplus) #33803 * (SEMVER-MINOR) add maxTotalSockets to agent class (rickyes) #33617 * (SEMVER-MINOR) return this from OutgoingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from ClientRequest#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from IncomingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) added scheduling option to http agent (delvedor) #33278 http2: * (SEMVER-MINOR) return this for Http2ServerRequest#setTimeout (Pranshu Srivastava) #33994 * (SEMVER-MINOR) do not modify explicity set date headers (Pranshu Srivastava) #33160 process: * (SEMVER-MINOR) add unhandled-rejection throw and warn-with-error-code (Dan Fabulich) #33475 src: * (SEMVER-MINOR) store key data in separate class (Tobias Nießen) #33360 * (SEMVER-MINOR) add NativeKeyObject base class (Tobias Nießen) #33360 * (SEMVER-MINOR) rename internal key handles to KeyObjectHandle (Tobias Nießen) #33360 * (SEMVER-MINOR) add equality operators for BaseObjectPtr (Anna Henningsen) #33772 * (SEMVER-MINOR) introduce BaseObject base FunctionTemplate (Anna Henningsen) #33772 * (SEMVER-MINOR) add public APIs to manage v8::TracingController (Anna Henningsen) #33850 stream*: * runtime deprecate Transform._transformState (Robert Nagy) #32763 win: * (SEMVER-MINOR) allow skipping the supported platform check (João Reis) #33176 worker: * (SEMVER-MINOR) add public method for marking objects as untransferable (Anna Henningsen) #33979 * (SEMVER-MINOR) emit `'messagerror'` events for failed deserialization (Anna Henningsen) #33772 * (SEMVER-MINOR) allow passing JS wrapper objects via postMessage (Anna Henningsen) #33772 * (SEMVER-MINOR) allow transferring/cloning generic BaseObjects (Anna Henningsen) #33772 worker,fs: * (SEMVER-MINOR) make FileHandle transferable (Anna Henningsen) #33772 zlib: * (SEMVER-MINOR) add `maxOutputLength` option (unknown) #33516 PR-URL: #34093

This PR defines two new modes for the --unhandled-rejections flag. The first mode is called "throw". The "throw" mode first emits unhandledRejection. If this hook is not set, the "throw" mode will raise the unhandled rejection as an uncaught exception. The second mode is called "warn-with-error-code". The "warn-with-error-code" mode first emits unhandledRejection. If this hook is not set, the "warn-with-error-code" mode will trigger a warning and set the process's exit code to 1. The PR doesn't change the default behavior for unhandled rejections. That will come in a separate PR. Refs: #33021 PR-URL: #33475 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Notable changes: build: * (SEMVER-MINOR) reset embedder string to "-node.0" (Michaël Zasso) #33376 cli: * (SEMVER-MINOR) add alias for report-directory to make it consistent (AshCripps) #33587 crypto: * (SEMVER-MINOR) allow KeyObjects in postMessage (Tobias Nießen) #33360 deps: * (SEMVER-MINOR) V8: cherry-pick 0d6debcc5f08 (Michaël Zasso) #33376 * (SEMVER-MINOR) update V8 to 8.3.110.9 (Michaël Zasso) #33376 dgram: * (SEMVER-MINOR) allow typed arrays in .send() (Sarat Addepalli) #22413 events: * (SEMVER-MINOR) initial implementation of experimental EventTarget (James M Snell) #33556 fs: * (SEMVER-MINOR) implement lutimes (Maël Nison) #33399 http: * (SEMVER-MINOR) expose host and protocol on ClientRequest (wenningplus) #33803 * (SEMVER-MINOR) add maxTotalSockets to agent class (rickyes) #33617 * (SEMVER-MINOR) return this from OutgoingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from ClientRequest#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) return this from IncomingMessage#destroy() (Colin Ihrig) #32789 * (SEMVER-MINOR) added scheduling option to http agent (delvedor) #33278 http2: * (SEMVER-MINOR) return this for Http2ServerRequest#setTimeout (Pranshu Srivastava) #33994 * (SEMVER-MINOR) do not modify explicity set date headers (Pranshu Srivastava) #33160 process: * (SEMVER-MINOR) add unhandled-rejection throw and warn-with-error-code (Dan Fabulich) #33475 src: * (SEMVER-MINOR) store key data in separate class (Tobias Nießen) #33360 * (SEMVER-MINOR) add NativeKeyObject base class (Tobias Nießen) #33360 * (SEMVER-MINOR) rename internal key handles to KeyObjectHandle (Tobias Nießen) #33360 * (SEMVER-MINOR) add equality operators for BaseObjectPtr (Anna Henningsen) #33772 * (SEMVER-MINOR) introduce BaseObject base FunctionTemplate (Anna Henningsen) #33772 * (SEMVER-MINOR) add public APIs to manage v8::TracingController (Anna Henningsen) #33850 stream*: * runtime deprecate Transform._transformState (Robert Nagy) #32763 win: * (SEMVER-MINOR) allow skipping the supported platform check (João Reis) #33176 worker: * (SEMVER-MINOR) add public method for marking objects as untransferable (Anna Henningsen) #33979 * (SEMVER-MINOR) emit `'messagerror'` events for failed deserialization (Anna Henningsen) #33772 * (SEMVER-MINOR) allow passing JS wrapper objects via postMessage (Anna Henningsen) #33772 * (SEMVER-MINOR) allow transferring/cloning generic BaseObjects (Anna Henningsen) #33772 worker,fs: * (SEMVER-MINOR) make FileHandle transferable (Anna Henningsen) #33772 zlib: * (SEMVER-MINOR) add `maxOutputLength` option (unknown) #33516 PR-URL: #34093

mmarchini · 2020-08-10T23:20:06Z

TSC will be voting on the intended default behavior for unhandled rejections on v15, where we also intend to remove the deprecation warning. We want to listen to Node.js users experiences with unhandled promises and what you think should be the default before voting, so we prepared a survey: https://www.surveymonkey.com/r/FTJM7YD

We also wrote an accompanying blog post for extra context: https://medium.com/@nodejs/node-js-promise-reject-use-case-survey-98e3328340c9

The survey will run for at least two weeks, at which point we'll evaluate if the number of replies is enough for us to move forward, otherwise we might extend it for a week or two. Please fill out the survey as it will help us decide the future of unhandled promise rejections on Node.js!

addaleax · 2020-09-23T20:33:25Z

If this should be backported to v12.x, it would need a manual backport

glasser · 2021-03-24T21:09:37Z

This PR added two new values for --unhandled-rejection but didn't update the --help text to list them. I've filed #37896 as an issue; I'm not sure I can describe the new values succinctly enough to file a PR.

These values were added in v15.0.0 by nodejs#33475 but were not included in the `node --help` output. Also document which value is the default. Fixes nodejs#37896.

These values were added in v15.0.0 by nodejs#33475 but were not included in the `node --help` output. Also documents which value is the default. PR-URL: nodejs#37899 Fixes: nodejs#37896 Refs: nodejs#33475 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

These values were added in v15.0.0 by #33475 but were not included in the `node --help` output. Also documents which value is the default. PR-URL: #37899 Fixes: #37896 Refs: #33475 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. process Issues and PRs related to the process subsystem. labels May 20, 2020

dfabulich mentioned this pull request May 20, 2020

process: Change default --unhandled-rejections=throw #33021

Closed

4 tasks

dfabulich force-pushed the unhandled-rejections-options branch 2 times, most recently from 8cad029 to 37c3332 Compare May 20, 2020 01:41

ljharb reviewed May 20, 2020

View reviewed changes

lib/internal/process/promises.js Show resolved Hide resolved

benjamingr approved these changes May 20, 2020

View reviewed changes

dfabulich force-pushed the unhandled-rejections-options branch from 37c3332 to eb7fa12 Compare May 22, 2020 04:07

dfabulich force-pushed the unhandled-rejections-options branch from eb7fa12 to eb66dab Compare May 22, 2020 15:19

dfabulich force-pushed the unhandled-rejections-options branch from eb66dab to bec0458 Compare May 22, 2020 18:36

addaleax approved these changes May 22, 2020

View reviewed changes

addaleax added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. semver-minor PRs that contain new features and should be released in the next minor version. labels May 22, 2020

BridgeAR removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 23, 2020

mmarchini mentioned this pull request May 27, 2020

Add a new process.unhandledRejections runtime flag #33577

Closed

This was referenced Jun 16, 2020

process: Don't warn/throw on unhandled rejections when hook is set #33017

Closed

process: Change default --unhandled-rejections=warn-with-error-code #33033

Closed

github-actions bot mentioned this pull request Jun 18, 2020

CI Relability 2020-06-18 JaneaSystems/nodejs-reliability#11

Open

18 tasks

This was referenced Jun 19, 2020

CI Relability 2020-06-19 JaneaSystems/nodejs-reliability#12

Open

CI Relability 2020-06-20 JaneaSystems/nodejs-reliability#13

Open

CI Relability 2020-06-21 JaneaSystems/nodejs-reliability#14

Open

codebytere mentioned this pull request Jun 28, 2020

v14.5.0 proposal #34093

Merged

addaleax added the backport-requested-v12.x label Sep 23, 2020

glasser mentioned this pull request Mar 24, 2021

Values for --unhandled-rejection flag added in v15 are not in --help (and default value is not indicated) #37896

Closed

glasser mentioned this pull request Mar 24, 2021

src: document newer values for --unhandled-rejections flag #37899

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

process: Add --unhandled-rejections=throw and =warn-with-error-code #33475

process: Add --unhandled-rejections=throw and =warn-with-error-code #33475

dfabulich commented May 20, 2020 •

edited

Loading

benjamingr commented May 20, 2020

dfabulich commented May 20, 2020

mmarchini commented May 20, 2020

nodejs-github-bot commented May 20, 2020

dfabulich commented May 21, 2020

dfabulich commented May 22, 2020

mmarchini commented May 22, 2020

dfabulich commented May 22, 2020

dfabulich commented May 22, 2020

addaleax commented May 22, 2020

nodejs-github-bot commented May 22, 2020

dfabulich commented May 22, 2020

BridgeAR commented May 23, 2020

dfabulich commented May 23, 2020

mmarchini commented May 27, 2020

mmarchini commented Aug 10, 2020

addaleax commented Sep 23, 2020

glasser commented Mar 24, 2021

process: Add --unhandled-rejections=throw and =warn-with-error-code #33475

process: Add --unhandled-rejections=throw and =warn-with-error-code #33475

Conversation

dfabulich commented May 20, 2020 • edited Loading

Checklist

benjamingr commented May 20, 2020

dfabulich commented May 20, 2020

mmarchini commented May 20, 2020

nodejs-github-bot commented May 20, 2020

dfabulich commented May 21, 2020

dfabulich commented May 22, 2020

mmarchini commented May 22, 2020

dfabulich commented May 22, 2020

dfabulich commented May 22, 2020

addaleax commented May 22, 2020

nodejs-github-bot commented May 22, 2020

dfabulich commented May 22, 2020

BridgeAR commented May 23, 2020

dfabulich commented May 23, 2020

mmarchini commented May 27, 2020

mmarchini commented Aug 10, 2020

addaleax commented Sep 23, 2020

glasser commented Mar 24, 2021

dfabulich commented May 20, 2020 •

edited

Loading