fix: backport Node.js cleanup hook fixes for node::ObjectWrap addons (45-x-y) - #53391
Draft
claude[bot] wants to merge 7 commits into
Draft
fix: backport Node.js cleanup hook fixes for node::ObjectWrap addons (45-x-y)#53391claude[bot] wants to merge 7 commits into
claude[bot] wants to merge 7 commits into
Conversation
Node.js 24.19.0 made node::ObjectWrap register an environment cleanup hook but did not carry the fix that makes RemoveEnvironmentCleanupHook() safe to call from ~ObjectWrap() during garbage collection, so any addon built against the 24.19.0+ headers aborts with "Assertion failed: (env) != nullptr" once one of its wrapped objects is collected while no context is entered. Cherry-picks: * nodejs/node#63985 "src: keep global list of addon-provided cleanup hooks" (68321eff80918e324e9fdaf1aa8cee6db14b84f7 on nodejs/node main). * nodejs/node#65630 "src: fix use-after-free in CleanupHookThunkRun" at dd2fa31b1d99e5a6710e08ce4139da7c2e344598 and its regression cctest at fd325a7fc2b33839c024220aa0c44b9104749686 (not yet landed upstream). Fixes: #53387 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
Adds a minimal node::ObjectWrap addon fixture with a helper that runs a full garbage collection while no context is entered, and a spec that loads it in an ELECTRON_RUN_AS_NODE child process and asserts the process exits cleanly. Reproduces #53387 on unfixed builds. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
trop
Bot
added
45-x-y
backport
6 tasks
The native addon fixtures under spec/fixtures/native-addon are yarn workspaces, so yarn only runs their build scripts once per install state. In CI the root `yarn install` builds them first, against the system Node.js headers, and the later spec install with npm_config_nodedir set never rebuilds them. N-API fixtures load anyway, but the object-wrap fixture uses Node's C++ API, embeds the system NODE_MODULE_VERSION, and is rejected by Electron with ERR_DLOPEN_FAILED. Rebuild every native addon fixture with node-gyp after the spec install so they are compiled against the configured Electron headers, which is what spec-runner already intended. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
The rebuild of the native addon fixtures against Electron's node headers broke every Linux test shard: the CI test image ships GCC 11, which cannot parse the V8 headers (`class V8_DEPRECATE_SOON(...) V8_EXPORT Value` mixes a C++11 attribute with a GNU attribute, rejected by GCC <= 12, see #53284): v8config.h:865:20: error: expected identifier before '__attribute__' v8-primitive.h:658:4: error: expected '}' before 'public' Only addons registering through Node's C++ module API (NODE_MODULE / NODE_MODULE_INIT) embed NODE_MODULE_VERSION and need Electron's headers, so limit the rebuild to those; the N-API fixtures keep loading fine as built by the root install. On Linux, when the Chromium toolchain from the source checkout is present (CI restores third_party/llvm-build and libc++ into the test job via src_artifacts, and the nan tests already build with it), compile the fixture with clang and Electron's libc++ exactly as script/nan-spec-runner.js does; otherwise, and for the --electronVersion prebuilt path, keep using the system compiler. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
…indows
The Windows test shards failed the fixture rebuild before configure:
node-gyp inherits NPM_CONFIG_MSVS_VERSION=2022 from the test step's env,
but the runners only ship a newer Visual Studio ("msvs_version does not
match this version"). The root install that built the same fixtures ran
without that pin and picked the installed toolset, so strip it from the
rebuild environment and let node-gyp detect Visual Studio. The Electron
import library it links against is already staged by
script/actions/move-artifacts.sh as gen/node_headers/Release/node.lib.
Also replace the source scan for NODE_MODULE usage with an explicit
"electron:requiresElectronHeaders" flag in the fixture's package.json, so
only fixtures that declare they need Electron's headers (currently
object-wrap) are rebuilt and the N-API fixtures are left untouched.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
…ture The rebuild of spec/fixtures/native-addon/object-wrap against Electron's headers broke two more sets of Linux test shards: * linux-arm64: the test job runs on an arm64 host but restores the x64 Chromium toolchain of the cross-compiling build job, so node-gyp died with "Exec format error: .../llvm-build/Release+Asserts/bin/clang". The image's GCC is the one that rejects the V8 headers (#53284), so nothing on that host can compile the fixture. Check that the Chromium clang actually runs before selecting it; when it does not, warn loudly, skip the rebuild and export ELECTRON_SKIP_ELECTRON_HEADER_ADDON_SPECS so the ObjectWrap spec is reported as skipped there (with a comment pointing at this gap) instead of failing with an ABI error. Every other platform keeps running the spec for real. * linux-x64-asan / -ubsan: the link failed with "ld.lld: error: unable to find library -lc++abi". Sanitizer builds compile libc++abi into the electron executable and export it from there (export_libcxxabi_from_executables) rather than producing libc++abi.a, so only pass -lc++abi when that archive exists; the symbols resolve from the executable when the addon is loaded. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U (cherry picked from commit a723f64)
…kipped
The linux-arm test job runs the specs with --skipYarnInstall, so the spec
install that rebuilds spec/fixtures/native-addon/object-wrap against
Electron's headers never happens there and the ObjectWrap spec failed to
load the fixture the root install built against the system Node.js
headers ("was compiled against a different Node.js version using
NODE_MODULE_VERSION 127. This version of Node.js requires
NODE_MODULE_VERSION 146"). When the install is needed but skipped, warn
and export ELECTRON_SKIP_ELECTRON_HEADER_ADDON_SPECS so those specs are
reported as skipped, as on linux-arm64 where no toolchain can build the
fixture.
Also format the previous change with oxfmt, which `yarn lint:fmt`
flagged in CI.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
(cherry picked from commit de4cc41)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Deepak Mohan · Slack thread
Before: On 45-x-y (Node.js 24.20.0) any native addon deriving from
node::ObjectWrapthat is rebuilt against the current headers aborts the process withAssertion failed: (env) != nullptrinnode::RemoveEnvironmentCleanupHookas soon as one of its wrapped objects is garbage-collected while no context is entered (e.g. idle-time GC), because Node.js 24.19.0 backported the change that makesObjectWrapregister a cleanup hook without the follow-up fix that makes removing that hook safe during GC.After:
RemoveEnvironmentCleanupHook()no longer requires a current context andCleanupHookThunkRun()no longer reads the thunk after the hook may have freed it, sonode::ObjectWrapaddons survive garbage collection and environment teardown.Description of Change
Backport of #53390
Note: the "Valid Backport" check stays red until #53390 merges, since this manual backport was opened ahead of the original PR.
See that PR for details. It cherry-picks nodejs/node#63985 (68321eff80918e324e9fdaf1aa8cee6db14b84f7) and nodejs/node#65630 at dd2fa31b1d99e5a6710e08ce4139da7c2e344598 / fd325a7fc2b33839c024220aa0c44b9104749686 (not yet landed upstream) into
patches/node, and adds thenode::ObjectWrapnative addon regression spec. Refs #53387.Validation
Same as #53390: a full Electron build was not possible in the environment this was prepared in, so the patched runtime itself has not been exercised. The patch files are byte-identical to the main PR and were verified to apply cleanly via
script/git-import-patchesonto nodejs/node v24.20.0 plus the 45-x-y patch set (72 patches), then re-exported withscript/git-export-patcheswith no churn in other patches. The spec was validated throughscript/spec-runner.js --electronVersion=<v> --skipYarnInstallon Linux x64 against prebuilt releases (no 45-x-y release with a fixed Node.js exists yet): Electron 42.11.0 (Node.js 24.19.0, unfixed) fails with the #53387 assertion, Electron 42.10.1 (Node.js 24.18.1) passes.Checklist
npm testpassesRelease Notes
Notes: Fixed native addons deriving from
node::ObjectWrapaborting during garbage collection on Node.js 24.19.0 and later.🤖 Generated with Claude Code
https://claude.ai/code/session_01NawBg2exXYXTXt12SBGe9U
Generated by Claude Code