n-api: document nextTick timing in callbacks #33804

mafintosh · 2020-06-09T08:57:19Z

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

Document that nextTicks when c/c++ calls js are ran before returning to c/c++ if any are scheduled by the js callback. Just fixed a bug in Electron related to this, so thought we could help others avoid this quirk by making it more clear.

doc/api/n-api.md

mcollina

lgtm

legendecas

👍 Overall LGTM. Please address the issue that lint complains.

addaleax

LGTM with the linter warning addressed – and the linter complaint is correct, this isn’t a side effect of the function but rather half its purpose :)

mafintosh · 2020-06-11T11:49:33Z

Updated the message

gabrielschulhof · 2020-06-15T04:04:42Z

doc/api/n-api.md

@@ -4755,6 +4755,9 @@ is sufficient and appropriate. Use of the `napi_make_callback` function
 may be required when implementing custom async behavior that does not use
 `napi_create_async_work`.

+Any `process.nextTick`s or Promises scheduled on the microtask queue by
+JavaScript during the callback are ran before returning back to C/C++.


Suggested change

JavaScript during the callback are ran before returning back to C/C++.

JavaScript during the callback are run before returning back to C/C++.

Better perhaps?

Suggested change

JavaScript during the callback are ran before returning back to C/C++.

JavaScript during the callback are executed before returning back to C/C++.

mhdawson

LGTM with fixes suggested by @gabrielschulhof

nodejs-github-bot · 2020-06-17T08:19:14Z

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

PR-URL: #33804 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

mcollina · 2020-06-17T16:24:58Z

Landed in 50fb019

PR-URL: #33804 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 9, 2020

mcollina reviewed Jun 9, 2020

View reviewed changes

doc/api/n-api.md Outdated Show resolved Hide resolved

mafintosh force-pushed the n-api-next-tick-timing branch from 91b6970 to f457dd0 Compare June 9, 2020 09:20

mcollina approved these changes Jun 9, 2020

View reviewed changes

mcollina requested review from jasnell and addaleax June 9, 2020 09:21

mafintosh force-pushed the n-api-next-tick-timing branch from f457dd0 to 96d65ba Compare June 9, 2020 09:25

legendecas approved these changes Jun 9, 2020

View reviewed changes

jasnell approved these changes Jun 9, 2020

View reviewed changes

addaleax approved these changes Jun 9, 2020

View reviewed changes

n-api: document nextTick timing in callbacks

e848bb4

mafintosh force-pushed the n-api-next-tick-timing branch from 96d65ba to e848bb4 Compare June 11, 2020 11:49

legendecas approved these changes Jun 11, 2020

View reviewed changes

gabrielschulhof reviewed Jun 15, 2020

View reviewed changes

gabrielschulhof approved these changes Jun 15, 2020

View reviewed changes

mhdawson approved these changes Jun 16, 2020

View reviewed changes

mcollina closed this Jun 17, 2020

codebytere mentioned this pull request Jun 28, 2020

v14.5.0 proposal #34093

Merged

codebytere mentioned this pull request Jul 13, 2020

v12.18.3 proposal #34343

Merged

snyk-bot mentioned this pull request May 22, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 Rednickle/node-1#72

Open

This was referenced May 22, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 molllyn1/node#78

Open

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 aliceUnhinged613/node#92

Open

137717unity mentioned this pull request May 22, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 137717unity/node#95

Open

snyk-bot mentioned this pull request May 23, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 ron-a20/node#95

Open

wedataintelligence mentioned this pull request May 24, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 wedataintelligence/node#77

Open

baby636 mentioned this pull request May 24, 2023

[Snyk] Security upgrade gatsby-plugin-sharp from 2.6.24 to 3.15.0 baby636/node#92

Open

aliceUnhinged613 mentioned this pull request Nov 25, 2023

[Snyk] Fix for 28 vulnerabilities aliceUnhinged613/node#98

Open

wedataintelligence mentioned this pull request Nov 28, 2023

[Snyk] Fix for 28 vulnerabilities wedataintelligence/node#87

Open

baby636 mentioned this pull request Nov 28, 2023

[Snyk] Fix for 37 vulnerabilities baby636/node#110

Open

ron-a20 mentioned this pull request Dec 19, 2023

[Snyk] Fix for 30 vulnerabilities ron-a20/node#112

Open

137717unity mentioned this pull request Dec 19, 2023

[Snyk] Fix for 30 vulnerabilities 137717unity/node#113

Open

wedataintelligence mentioned this pull request Dec 19, 2023

[Snyk] Fix for 30 vulnerabilities wedataintelligence/node#96

Open

aliceUnhinged613 mentioned this pull request Dec 19, 2023

[Snyk] Fix for 30 vulnerabilities aliceUnhinged613/node#114

Open

baby636 mentioned this pull request Dec 20, 2023

[Snyk] Fix for 43 vulnerabilities baby636/node#126

Open

137717unity mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 137717unity/node#125

Open

aliceUnhinged613 mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 aliceUnhinged613/node#125

Open

ron-a20 mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 ron-a20/node#123

Open

molllyn1 mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 molllyn1/node#109

Open

kissofire mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.2.13 to 3.15.0 kissofire/node#126

Open

wedataintelligence mentioned this pull request Apr 14, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.3.10 to 3.15.0 wedataintelligence/node#108

Open

baby636 mentioned this pull request Apr 15, 2024

[Snyk] Security upgrade gatsby-plugin-sharp from 2.6.24 to 3.15.0 baby636/node#146

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

n-api: document nextTick timing in callbacks #33804

n-api: document nextTick timing in callbacks #33804

mafintosh commented Jun 9, 2020

mcollina left a comment

legendecas left a comment

addaleax left a comment

mafintosh commented Jun 11, 2020 •

edited

Loading

gabrielschulhof Jun 15, 2020

gabrielschulhof Jun 15, 2020

mhdawson left a comment

nodejs-github-bot commented Jun 17, 2020

mcollina commented Jun 17, 2020

	JavaScript during the callback are ran before returning back to C/C++.
	JavaScript during the callback are run before returning back to C/C++.

	JavaScript during the callback are ran before returning back to C/C++.
	JavaScript during the callback are executed before returning back to C/C++.

n-api: document nextTick timing in callbacks #33804

n-api: document nextTick timing in callbacks #33804

Conversation

mafintosh commented Jun 9, 2020

Checklist

mcollina left a comment

Choose a reason for hiding this comment

legendecas left a comment

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

mafintosh commented Jun 11, 2020 • edited Loading

gabrielschulhof Jun 15, 2020

Choose a reason for hiding this comment

gabrielschulhof Jun 15, 2020

Choose a reason for hiding this comment

mhdawson left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Jun 17, 2020

mcollina commented Jun 17, 2020

mafintosh commented Jun 11, 2020 •

edited

Loading