fix(napi): wasi debug compile error by Brooooooklyn · Pull Request #3081 · napi-rs/napi-rs

Brooooooklyn · 2025-12-30T15:56:34Z

Note

Addresses WASI debug build issues and strengthens WASI CI.

Excludes wasm from debug-only buffer tracking and GC cleanup paths (js_values/buffer.rs, bindgen_runtime/mod.rs) via #[cfg(all(debug_assertions, not(windows), not(target_family = "wasm")))]
Tightens WASM cleanup hook gating to #[cfg(all(target_family = "wasm", not(feature = "noop")))] in env.rs
CI: Adds conditional cargo check -p napi --all-features --target wasm32-wasip1-threads when RUSTFLAGS == '--cfg tokio_unstable' in test-node-wasi

^{Written by Cursor Bugbot for commit ffc8cb9. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

Chores
- Added build validation step for WebAssembly target with all features enabled.
- Optimized WebAssembly builds by excluding debug-only assertions and code tracking, reducing binary size and overhead.
- Refined WebAssembly feature flag handling for better configuration control.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-30T15:56:46Z

📝 Walkthrough

Walkthrough

The PR tightens conditional compilation gates to exclude WebAssembly targets from debug-assertion code paths in the NAPI bindgen runtime, and adds a cargo check step for WASM builds in the CI workflow. Additionally, the environment cleanup hook registration is gated to exclude the noop feature under WASM targets.

Changes

Cohort / File(s)	Summary
CI Workflow `.github/workflows/test-release.yaml`	Adds a "Check" step in the test-node-wasi workflow that runs `cargo check` for the napi crate with all features targeting `wasm32-wasip1-threads`, conditional on `RUSTFLAGS` environment variable.
Debug Buffer Tracking `crates/napi/src/bindgen_runtime/js_values/buffer.rs`	Tightens cfg conditions on debug-only buffer tracking and assertions by adding `not(target_family = "wasm")` to exclude WASM targets. Affects imports (HashSet, Mutex) and `BufferSlice`/`Buffer` debug guard implementations.
Runtime Cleanup Guards `crates/napi/src/bindgen_runtime/mod.rs`	Excludes WASM targets from debug-only code in `drop_buffer` and `drop_buffer_slice` by adding `not(target_family = "wasm")` to existing debug-assertion cfgs.
Environment Cleanup Hook `crates/napi/src/bindgen_runtime/env.rs`	Tightens WASM-specific cfg for `Env::add_env_cleanup_hook` to exclude compilation when the noop feature is enabled, preventing hook registration under that feature flag.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

fix(napi): skip debug buffer tracking on wasm targets #3078: Modifies the same buffer-related debug-only conditional compilation logic (not(target_family = "wasm") additions in buffer.rs).
fix(napi): validate status before copying data in env arraybuffer fallback #3077: Updates identical debug-only compilation guards in bindgen_runtime, particularly in buffer.rs and env.rs, with matching cfg tightening patterns.
fix(napi): shutdown runtime at env cleanup on windows #3026: Affects environment cleanup/hook behavior and its conditional compilation gating.

Poem

🐰 A WASM build checked and cleaned,
Debug guards now lean and green,
No Windows, no WASM in sight,
The runtime shines ever bright! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main purpose of the PR: fixing a WebAssembly debug compilation error by gating debug-only code and adjusting conditional compilation attributes.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 893e913 and ffc8cb9.

📒 Files selected for processing (4)

.github/workflows/test-release.yaml
crates/napi/src/bindgen_runtime/js_values/buffer.rs
crates/napi/src/bindgen_runtime/mod.rs
crates/napi/src/env.rs

🧰 Additional context used

🧠 Learnings (7)

📓 Common learnings

Learnt from: CR
Repo: napi-rs/napi-rs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T09:31:23.877Z
Learning: Applies to /crates/**/*.rs : Use `#[napi]` attribute on impl blocks to define classes exported to JavaScript/TypeScript

Learnt from: CR
Repo: napi-rs/napi-rs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T09:31:23.877Z
Learning: Run `yarn workspace examples/napi build` before testing to ensure code generation reflects current Rust changes