feat: add support for nogc types via BasicEnv

[KevinEady]

• Introduce Napi::NogcEnv class, taking the place of Napi::Env in finalizer callbacks.
• Introduce void Napi::NogcEnv::AddPostFinalizer() and overloads.
• Modify tests to support above changes

Closes: #1508

TODO:

• docs
• discuss implementation, namings, etc
• wait for src: restore ability to run under NAPI_EXPERIMENTAL #1409 to land, and incorporate changes

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 69.38776% with 15 lines in your changes missing coverage. Please review.

Project coverage is 64.40%. Comparing base (12ffe91) to head (195ec28).
Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
napi-inl.h	70.83%	2 Missing and 12 partials ⚠️
napi.h	0.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1514      +/-   ##
==========================================
- Coverage   64.69%   64.40%   -0.30%     
==========================================
  Files           3        3              
  Lines        1997     2003       +6     
  Branches      687      693       +6     
==========================================
- Hits         1292     1290       -2     
- Misses        144      146       +2     
- Partials      561      567       +6     

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

[KevinEady]

@vmoroz your comment on removing const ref on std::nullptr_t has been addressed, and @mhdawson your comment on reference deletion has been addressed, both in 2a689b6

[vmoroz]

Should we add checks for the standard/experimental to ci-win.yml too?

[KevinEady]

Good thought... I pretty much copied Gabriel's CI file. I'll comment on his PR to verify, since mine would end up being overwritten when i rebase to master after his is merged.

[mhdawson]

Agreed we should do a release to get out the previous fixe that @gabrielschulhof made and then put this out in a SemVer major.

[KevinEady]

Hi team,

Using some SFINAE magic, I was able to determine at compile time how to associate the finalizer -- either directly or with node_api_post_finalizer. This would address #1367 as implemented.

This means no changes were needed to any existing tests, and I created a new test in finalizer_order to ensure finalizers are being called correctly.

PTAL! @gabrielschulhof @vmoroz @legendecas @mhdawson

[gabrielschulhof]

Looks good!

I think the Gc vs. NoGc nomenclature is a bit confusing. Unfortunately, we established this in core. I think maybe we should go with DuringGc and OutsideGc. For env, we'd have DuringGcEnv and Env, since Env is already established, but for the finalizer type names I think we can go with DuringGc and OutsideGc for clarity.

[gabrielschulhof]

Suggested change

	assert.strictEqual(isCallbackCalled, false, 'Expected callback not be called [before ticking]');
	assert.strictEqual(isCallbackCalled, false, 'Expected callback to not be called [before ticking]');

[gabrielschulhof]

Suggested change

	virtual void Finalize(NogcEnv env);
	virtual void Finalize(Napi::NogcEnv env);

[gabrielschulhof]

I tested this with Napi::External and it works great!

const { makeSync, makeAsync } = require('bindings')('test_sync_fini')

const doAsync = process.argv[2] === 'async'

;(function test(iter = 0) {
  for (let i = 0; i < 1000000; i++) {
    const id = `${iter}:${i}`
    if (doAsync) {
      makeAsync(id)
    } else {
      makeSync(id)
    }
  }
  setTimeout(test, 0, iter + 1)
})()

Here's a video of the output. Guess which column is async 🙂

Screen.Recording.2024-06-24.at.8.46.57.AM.mov