feat: add support for requiring basic finalizers by KevinEady · Pull Request #1568 · nodejs/node-addon-api

KevinEady · 2024-09-03T21:32:39Z

Introduce NODE_ADDON_API_REQUIRE_BASIC_FINALIZERS preprocessor directive, which adds an always-fail static assertion inside the Wrapper definition (responsible for passing the user's non-basic finalizer through a node_api_post_finalizer call) if this preprocessor directive is defined.

codecov-commenter · 2024-09-03T21:46:21Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.40%. Comparing base (b4aeecb) to head (23b57cc).
⚠️ Report is 71 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1568 +/- ##
=======================================
Coverage 64.40% 64.40% =======================================
Files 3 3 Lines 2003 2003 Branches 693 693 =======================================
Hits 1290 1290 Misses 146 146 Partials 567 567

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

KevinEady · 2024-09-04T17:37:13Z

When trying to use a non-basic finalizer with this directive defined, you'll get an error like:

../../../../../napi-inl.h:252:5: error: static assertion failed: NODE_ADDON_API_REQUIRE_BASIC_FINALIZERS defined: Finalizer must be basic.
static_assert(false,
^ ~~~~~

(error taken from the test created in this PR)

legendecas · 2024-09-06T11:10:27Z

 In general, it is best to use basic finalizers whenever possible (eg. when
-access to JavaScript is _not_ needed).
+access to JavaScript is _not_ needed). To ensure that all finalizers are basic
+finalizers at compile-time, define the `NODE_ADDON_API_REQUIRE_BASIC_FINALIZERS`


I am wondering if we should add a "best practice" target that enables all possible checks in https://github.com/nodejs/node-addon-api/blob/main/node_addon_api.gyp.

gabrielschulhof · 2024-09-06T15:22:31Z


 In general, it is best to use basic finalizers whenever possible (eg. when
-access to JavaScript is _not_ needed).
+access to JavaScript is _not_ needed). To ensure that all finalizers are basic


Let's make this passive voice: The NODE_ADDON_API_REQUIRE_BASIC_FINALIZERS preprocessor directive can be defined to ensure that all finalizers are basic.

Addressed in 23b57cc

gabrielschulhof · 2024-09-06T15:23:04Z

@@ -90,3 +90,13 @@ provide feedback to the user of the runtime error, as it is impossible to pass
 the error to JavaScript when the environment is terminating. In order to bypass
 this behavior such that the Node process will not terminate, define the


Here too: "The ... can be defined in order to bypass ... "

Addressed in 23b57cc

gabrielschulhof · 2024-09-06T15:23:32Z

 }

-#ifdef NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER
+#if defined(NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER)


Is this change needed?

Whoops, this was a leftover of a different implementation. Addressed in 23b57cc

gabrielschulhof · 2024-09-06T15:23:51Z

 }

-#ifdef NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER
+#if defined(NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER)


Addressed in 23b57cc

gabrielschulhof

LGTM with some comments.

- Use passive voice in existing and new docs - Revert unnecessary change

KevinEady · 2024-09-09T15:33:27Z

LGTM with some comments.

Hi @gabrielschulhof ,

Your changes have been introduced in 23b57cc. PTAL!

mhdawson

LGTM

KevinEady force-pushed the add-require-basic-finalizers branch from 4603869 to e21c0f6Compare September 3, 2024 21:39

feat: add support for requiring basic finalizers
7c91a10

KevinEady force-pushed the add-require-basic-finalizers branch from e21c0f6 to 7c91a10Compare September 4, 2024 17:34

KevinEady mentioned this pull request Sep 5, 2024
chore: release v8.2.0 #1571
Merged

legendecas reviewed Sep 6, 2024
View reviewed changes

gabrielschulhof reviewed Sep 6, 2024
View reviewed changes

gabrielschulhof approved these changes Sep 6, 2024
View reviewed changes

KevinEady marked this pull request as draft September 7, 2024 10:48

Address review comments
23b57cc
- Use passive voice in existing and new docs - Revert unnecessary change

KevinEady marked this pull request as ready for review September 9, 2024 15:30

KevinEady requested a review from gabrielschulhof September 9, 2024 15:32

legendecas approved these changes Sep 10, 2024
View reviewed changes

mhdawson approved these changes Sep 13, 2024
View reviewed changes

gabrielschulhof approved these changes Sep 17, 2024
View reviewed changes

legendecas merged commit 7bcb826 into nodejs:mainSep 19, 2024

snyk-ioBot mentioned this pull request Nov 10, 2024
[Snyk] Upgrade node-addon-api from 3.2.1 to 8.2.1 doperiddle/bch-rpc-explorer#9
Closed

		@@ -90,3 +90,13 @@ provide feedback to the user of the runtime error, as it is impossible to pass
		the error to JavaScript when the environment is terminating. In order to bypass
		this behavior such that the Node process will not terminate, define the

Uh oh!

Uh oh!

Conversation

KevinEady commented Sep 3, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Sep 3, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

KevinEady commented Sep 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gabrielschulhof left a comment

Choose a reason for hiding this comment

Uh oh!

KevinEady commented Sep 9, 2024

Uh oh!

mhdawson left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

KevinEady commented Sep 3, 2024•
edited
Loading

codecov-commenter commented Sep 3, 2024•
edited
Loading