Skip to content

feat: port 6_object_wrap test to CTS#32

Open
kraenhansen wants to merge 4 commits intonodejs:mainfrom
kraenhansen:feat/port-6-object-wrap
Open

feat: port 6_object_wrap test to CTS#32
kraenhansen wants to merge 4 commits intonodejs:mainfrom
kraenhansen:feat/port-6-object-wrap

Conversation

@kraenhansen
Copy link
Copy Markdown
Member

@kraenhansen kraenhansen commented Mar 8, 2026

Summary

Ports 6_object_wrap from the Node.js test suite into the CTS. This is the first test to exercise the experimental addon infrastructure (add_node_api_cts_experimental_addon()), serving as end-to-end validation of #31.

Three build targets:

  • myobject (stable) — object wrap with getters/setters, plusOne, multiply
  • myobject_basic_finalizer (experimental, NAPI_EXPERIMENTAL) — basic finalizer verification, guarded by experimentalFeatures.postFinalizer
  • nested_wrap (NAPI_VERSION=10) — nested napi_ref finalization

Three JS test files:

  • test.js — property descriptors, constructor/plain-function invocation, method chaining
  • test-basic-finalizer.js — experimental finalizer with gcUntil, behind feature guard
  • nested_wrap.js — nested wrap finalization with gcUntil

All C++ source files are copied verbatim from upstream.

Test plan

  • npm run addons:configure && npm run addons:build — all three targets compile
  • npm run node:test — all 58 tests pass (3 new)
  • C++ files diff clean against upstream

🤖 Generated with Claude Code

@kraenhansen kraenhansen moved this from Need Triage to Has PR in Node-API Team Project Mar 8, 2026
@kraenhansen kraenhansen marked this pull request as draft March 8, 2026 13:01
@kraenhansen

This comment was marked as outdated.

@kraenhansen kraenhansen force-pushed the feat/port-6-object-wrap branch from d57e9e9 to d833299 Compare March 28, 2026 19:33
@kraenhansen
Copy link
Copy Markdown
Member Author

CI fails on Node.js v20 — same root cause as #28. The nested_wrap addon is built with NAPI_VERSION=10 which isn't fully supported on v20 (see nodejs/node#55676).

Blocked on #37 (dropping Node v20 from CI).

@kraenhansen kraenhansen moved this from Has PR to In Progress in Node-API Team Project Mar 28, 2026
@bavulapati
Copy link
Copy Markdown
Contributor

We can use the napiVersion and skipTest primitives from #46 to skip this test when napi version < 10

Port all three build targets and test files from upstream:
- myobject (stable) — object wrap with getters/setters/methods
- myobject_basic_finalizer (experimental) — basic finalizer verification
- nested_wrap (NAPI_VERSION=10) — nested ref finalization

The experimental target (myobject_basic_finalizer) exercises the
add_node_api_cts_experimental_addon() CMake function for the first time,
serving as end-to-end validation of the experimental infrastructure.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kraenhansen kraenhansen force-pushed the feat/port-6-object-wrap branch from d833299 to b3d558f Compare April 25, 2026 20:35
bavulapati and others added 2 commits April 25, 2026 23:08
Signed-off-by: Balakrishna Avulapati <ba@bavulapati.com>
use the napiVersion and skipTest primitives for porting test_6_object_wrap
@kraenhansen kraenhansen marked this pull request as ready for review April 25, 2026 21:16
Copy link
Copy Markdown
Contributor

@bavulapati bavulapati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

assert.strictEqual(obj, null);
})();

await gcUntil('basic-finalizer', () => addon.getFinalizerCallCount() === 1);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's interesting to see why the original test is asserting the finalizerCallCount again!

assert.strictEqual(addon.getFinalizerCallCount(), 1);

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree - that's curious 🤔 Perhaps the git history tells a story? I'd be okay with deleting that in a follow-up PR once we start refactoring these tests.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep it. It's to handle the case where the gcUntil loop finishes without satisfying the condition addon.getFinalizerCallCount() === 1.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the assertion should fail in that case.

assert.strictEqual(obj, null);
})();

await gcUntil('basic-finalizer', () => addon.getFinalizerCallCount() === 1);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep it. It's to handle the case where the gcUntil loop finishes without satisfying the condition addon.getFinalizerCallCount() === 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants