process: refactor promise rejection handling #25200

joyeecheung · 2018-12-24T01:24:10Z

It's easier to review without the indentation changes: https://github.com/nodejs/node/pull/25200/files?w=1

src: refactor tickInfo access

Wrap access to tickInfo fields in functions
Rename kHasScheduled to kHasTickScheduled and
kHasPromiseRejections to kHasRejectionToWarn for clarity - note
the latter will be set to false if the rejection does not lead to
a warning so the previous description is not accurate.
Set kHasRejectionToWarn in JS land of relying on C++ to use
an implict contract (return value of the promise rejection handler)
to set it, as the decision is made entirely in JS land.
Destructure promise reject event constants.

process: make tick callback and promise rejection callback more robust

Rename internalTickCallback to processTicksAndRejections, make
sure it does not get called if it's not set in C++.
Rename emitPromiseRejectionWarnings to processPromiseRejections
since it also emit events that are not warnings.
Sets SetPromiseRejectCallback in the Environment constructor
to make sure it only gets called once per-isolate, and make
sure it does not get called if it's not set in C++.
Wrap promise rejection callback initialization into
listenForRejections().
Add comments.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

nodejs-github-bot · 2018-12-24T01:24:12Z

@joyeecheung build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2053/pipeline

joyeecheung · 2018-12-24T01:25:11Z

CI: https://ci.nodejs.org/job/node-test-pull-request/19779/ ✔️
Benchmark CI: https://ci.nodejs.org/view/Node.js%20benchmark/job/benchmark-node-micro-benchmarks/283/

lib/internal/process/promises.js

lib/internal/process/next_tick.js

lib/internal/process/promises.js

joyeecheung · 2018-12-25T23:48:53Z

I left the more opinionated refactoring out of this PR and focused on renaming & improving robustness.

CI: https://ci.nodejs.org/job/node-test-pull-request/19808/
Benchmark CI: https://ci.nodejs.org/view/Node.js%20benchmark/job/benchmark-node-micro-benchmarks/284/

Trott · 2018-12-26T05:59:50Z

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19812/

addaleax · 2018-12-26T13:26:48Z

src/env.cc

@@ -241,6 +241,8 @@ Environment::Environment(IsolateData* isolate_data,
 if (options_->no_force_async_hooks_checks) {
 async_hooks_.no_force_checks();
 }
+
+ isolate()->SetPromiseRejectCallback(task_queue::PromiseRejectCallback);


Can you leave a TODO comment for me? We’re letting a single Environment take control of per-Isolate state here – I know it’s been that way before, but it’s not what we should be doing…

Out of curiosity - when would multiple Environments correspond to an isolate?

Trott · 2018-12-26T16:19:09Z

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19824/

Trott · 2018-12-26T22:43:12Z

Getting closer...

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19825/

lib/internal/process/promises.js

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants.

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments.

…e robust

joyeecheung · 2019-01-04T17:56:36Z

Addressed the reviews. CI: https://ci.nodejs.org/job/node-test-pull-request/19937/

joyeecheung · 2019-01-06T02:43:41Z

Landed in f6a1d88...d18b0a0, thanks!

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants. PR-URL: #25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments. PR-URL: #25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax · 2019-01-09T00:05:12Z

This needs to be backported to v11.x.

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax · 2019-01-15T18:20:39Z

This applies cleanly now. :)

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants. PR-URL: #25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments. PR-URL: #25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Wrap access to tickInfo fields in functions - Rename `kHasScheduled` to `kHasTickScheduled` and `kHasPromiseRejections` to `kHasRejectionToWarn` for clarity - note the latter will be set to false if the rejection does not lead to a warning so the previous description is not accurate. - Set `kHasRejectionToWarn` in JS land of relying on C++ to use an implict contract (return value of the promise rejection handler) to set it, as the decision is made entirely in JS land. - Destructure promise reject event constants. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>

- Rename `internalTickCallback` to `processTicksAndRejections`, make sure it does not get called if it's not set in C++. - Rename `emitPromiseRejectionWarnings` to `processPromiseRejections` since it also emit events that are not warnings. - Sets `SetPromiseRejectCallback` in the `Environment` constructor to make sure it only gets called once per-isolate, and make sure it does not get called if it's not set in C++. - Wrap promise rejection callback initialization into `listenForRejections()`. - Add comments. PR-URL: nodejs#25200 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> 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++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Dec 24, 2018

starkwang added the promises Issues and PRs related to ECMAScript promises. label Dec 24, 2018

BridgeAR reviewed Dec 24, 2018

View reviewed changes

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

lib/internal/process/next_tick.js Outdated Show resolved Hide resolved

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

joyeecheung force-pushed the refactor-tasks branch from 147e825 to 698cfad Compare December 25, 2018 23:42

addaleax approved these changes Dec 26, 2018

View reviewed changes

BridgeAR approved these changes Dec 27, 2018

View reviewed changes

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

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

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

jasnell approved these changes Dec 27, 2018

View reviewed changes

joyeecheung added 4 commits January 5, 2019 01:44

fixup! process: make tick callback and promise rejection callback mor…

bdad2db

…e robust

fixup! src: refactor tickInfo access

4a6765b

joyeecheung force-pushed the refactor-tasks branch from 698cfad to 4a6765b Compare January 4, 2019 17:55

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 4, 2019

joyeecheung closed this Jan 6, 2019

joyeecheung removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 6, 2019

addaleax added the backport-requested-v11.x label Jan 9, 2019

addaleax removed the backport-requested-v11.x label Jan 15, 2019

BridgeAR mentioned this pull request Jan 16, 2019

v11.7.0 proposal #25537

Merged

MylesBorins mentioned this pull request Jan 24, 2019

v11.8.0 proposal #25687

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

process: refactor promise rejection handling #25200

process: refactor promise rejection handling #25200

joyeecheung commented Dec 24, 2018 •

edited

Loading

nodejs-github-bot commented Dec 24, 2018

joyeecheung commented Dec 24, 2018 •

edited by Trott

Loading

joyeecheung commented Dec 25, 2018

Trott commented Dec 26, 2018

addaleax Dec 26, 2018

joyeecheung Dec 27, 2018

Trott commented Dec 26, 2018

Trott commented Dec 26, 2018

joyeecheung commented Jan 4, 2019

joyeecheung commented Jan 6, 2019

addaleax commented Jan 9, 2019

addaleax commented Jan 15, 2019

process: refactor promise rejection handling #25200

process: refactor promise rejection handling #25200

Conversation

joyeecheung commented Dec 24, 2018 • edited Loading

src: refactor tickInfo access

process: make tick callback and promise rejection callback more robust

Checklist

nodejs-github-bot commented Dec 24, 2018

joyeecheung commented Dec 24, 2018 • edited by Trott Loading

joyeecheung commented Dec 25, 2018

Trott commented Dec 26, 2018

addaleax Dec 26, 2018

Choose a reason for hiding this comment

joyeecheung Dec 27, 2018

Choose a reason for hiding this comment

Trott commented Dec 26, 2018

Trott commented Dec 26, 2018

joyeecheung commented Jan 4, 2019

joyeecheung commented Jan 6, 2019

addaleax commented Jan 9, 2019

addaleax commented Jan 15, 2019

joyeecheung commented Dec 24, 2018 •

edited

Loading

joyeecheung commented Dec 24, 2018 •

edited by Trott

Loading