src: deprecate two- and one-argument AtExit() #30227

addaleax · 2019-11-02T20:22:14Z

Using AtExit() without an Environment* pointer or providing
an argument is almost always a sign of improperly relying on global
state and/or using AtExit() as an addon when the addon-targeting
AddEnvironmentCleanupHook() would be the better choice.

Deprecate those variants. This also updates the addon docs to
refer to AddEnvironmentCleanupHook() rather than AtExit().

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

fhinkel · 2019-11-03T23:15:20Z

test/addons/at-exit/binding.cc

@@ -3,7 +3,11 @@
 #include <node.h>
 #include <v8.h>

+// TODO(addaleax): Maybe merge this file with the cctest for AtExit()?


Do you want to keep this as a todo or should we open an issue instead?

I can open an issue about it once this lands. 👍

nodejs-github-bot · 2019-11-04T05:21:49Z

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

nodejs-github-bot · 2019-11-04T07:52:22Z

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

nodejs-github-bot · 2019-11-04T12:52:16Z

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

nodejs-github-bot · 2019-11-05T18:40:57Z

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

Using `AtExit()` without an `Environment*` pointer or providing an argument is almost always a sign of improperly relying on global state and/or using `AtExit()` as an addon when the addon-targeting `AddEnvironmentCleanupHook()` would be the better choice. Deprecate those variants. This also updates the addon docs to refer to `AddEnvironmentCleanupHook()` rather than `AtExit()`.

nodejs-github-bot · 2019-11-05T19:43:01Z

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

nodejs-github-bot · 2019-11-05T22:04:14Z

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

Using `AtExit()` without an `Environment*` pointer or providing an argument is almost always a sign of improperly relying on global state and/or using `AtExit()` as an addon when the addon-targeting `AddEnvironmentCleanupHook()` would be the better choice. Deprecate those variants. This also updates the addon docs to refer to `AddEnvironmentCleanupHook()` rather than `AtExit()`. PR-URL: #30227 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: James M Snell <[email protected]>

addaleax · 2019-11-05T23:03:04Z

Landed in 5b2067c, thanks for the reviews!

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: nodejs#30227 (comment)

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: #30227 (comment) PR-URL: #30275 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>

Using `AtExit()` without an `Environment*` pointer or providing an argument is almost always a sign of improperly relying on global state and/or using `AtExit()` as an addon when the addon-targeting `AddEnvironmentCleanupHook()` would be the better choice. Deprecate those variants. This also updates the addon docs to refer to `AddEnvironmentCleanupHook()` rather than `AtExit()`. PR-URL: #30227 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: James M Snell <[email protected]>

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: #30227 (comment) PR-URL: #30275 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>

Notable changes: * addons: * Deprecate one- and two-argument `AtExit()`. Use the three-argument variant of `AtExit()` or `AddEnvironmentCleanupHook()` instead (Anna Henningsen) nodejs#30227 * child_process,cluster: * The `serialization` option is added that allows child process IPC to use the V8 serialization API (to e.g., pass through data types like sets or maps) (Anna Henningsen) nodejs#30162 * deps: * Update V8 to 7.9 * Update `npm` to 6.13.0 (Ruy Adorno) nodejs#30271 * embedder: * Exposes the ability to pass cli flags / options through an API as embedder (Shelley Vohr) nodejs#30466 * Allow adding linked bindings to Environment (Anna Henningsen) nodejs#30274 * esm: * Unflag --experimental-modules (Guy Bedford) nodejs#29866 * stream: * Add `writable.writableCorked` property (Robert Nagy) nodejs#29012 * worker: * Allow specifying resource limits (Anna Henningsen) nodejs#26628 * v8: * The Serialization API is now stable (Anna Henningsen) nodejs#30234 PR-URL: nodejs#30547

Notable changes: * addons: * Deprecate one- and two-argument `AtExit()`. Use the three-argument variant of `AtExit()` or `AddEnvironmentCleanupHook()` instead (Anna Henningsen) #30227 * child_process,cluster: * The `serialization` option is added that allows child process IPC to use the V8 serialization API (to e.g., pass through data types like sets or maps) (Anna Henningsen) #30162 * deps: * Update V8 to 7.9 * Update `npm` to 6.13.0 (Ruy Adorno) #30271 * embedder: * Exposes the ability to pass cli flags / options through an API as embedder (Shelley Vohr) #30466 * Allow adding linked bindings to Environment (Anna Henningsen) #30274 * esm: * Unflag --experimental-modules (Guy Bedford) #29866 * stream: * Add `writable.writableCorked` property (Robert Nagy) #29012 * worker: * Allow specifying resource limits (Anna Henningsen) #26628 * v8: * The Serialization API is now stable (Anna Henningsen) #30234 PR-URL: #30547

Using `AtExit()` without an `Environment*` pointer or providing an argument is almost always a sign of improperly relying on global state and/or using `AtExit()` as an addon when the addon-targeting `AddEnvironmentCleanupHook()` would be the better choice. Deprecate those variants. This also updates the addon docs to refer to `AddEnvironmentCleanupHook()` rather than `AtExit()`. PR-URL: #30227 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: James M Snell <[email protected]>

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: #30227 (comment) PR-URL: #30275 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>

Using `AtExit()` without an `Environment*` pointer or providing an argument is almost always a sign of improperly relying on global state and/or using `AtExit()` as an addon when the addon-targeting `AddEnvironmentCleanupHook()` would be the better choice. Deprecate those variants. This also updates the addon docs to refer to `AddEnvironmentCleanupHook()` rather than `AtExit()`. PR-URL: #30227 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: James M Snell <[email protected]>

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: #30227 (comment) PR-URL: #30275 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>

nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Nov 2, 2019

addaleax added embedding Issues and PRs related to embedding Node.js in another project. semver-minor PRs that contain new features and should be released in the next minor version. labels Nov 2, 2019

devnexen approved these changes Nov 3, 2019

View reviewed changes

fhinkel reviewed Nov 3, 2019

View reviewed changes

fhinkel approved these changes Nov 3, 2019

View reviewed changes

danbev approved these changes Nov 4, 2019

View reviewed changes

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

jasnell approved these changes Nov 5, 2019

View reviewed changes

addaleax force-pushed the atexit-deprecate branch from c66a706 to 7c59832 Compare November 5, 2019 19:42

addaleax closed this Nov 5, 2019

addaleax deleted the atexit-deprecate branch November 5, 2019 23:03

addaleax added a commit to addaleax/node that referenced this pull request Nov 5, 2019

test: remove AtExit() addon test

adccf30

Move the one bit of the addon test that was not covered by the cctest into the latter and delete the former. Refs: nodejs#30227 (comment)

addaleax mentioned this pull request Nov 5, 2019

test: remove AtExit() addon test #30275

Closed

3 tasks

BridgeAR mentioned this pull request Nov 19, 2019

v13.2.0 proposal #30547

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

nick-erm mentioned this pull request May 7, 2020

Question: What about for support WorkingThreads on WRTC addon? node-webrtc/node-webrtc#623

Open

ewanharris mentioned this pull request Apr 21, 2021

feat: support node 16 tidev/node-ios-device#71

Merged

frederickjansen mentioned this pull request Nov 3, 2021

Add support for Node.js 16 openvenues/node-postal#36

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: deprecate two- and one-argument AtExit() #30227

src: deprecate two- and one-argument AtExit() #30227

addaleax commented Nov 2, 2019

fhinkel Nov 3, 2019

addaleax Nov 4, 2019

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 5, 2019

nodejs-github-bot commented Nov 5, 2019

nodejs-github-bot commented Nov 5, 2019

addaleax commented Nov 5, 2019

src: deprecate two- and one-argument AtExit() #30227

src: deprecate two- and one-argument AtExit() #30227

Conversation

addaleax commented Nov 2, 2019

Checklist

fhinkel Nov 3, 2019

Choose a reason for hiding this comment

addaleax Nov 4, 2019

Choose a reason for hiding this comment

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 4, 2019

nodejs-github-bot commented Nov 5, 2019

nodejs-github-bot commented Nov 5, 2019

nodejs-github-bot commented Nov 5, 2019

addaleax commented Nov 5, 2019