RobotWebTools / rclnodejs / 22995098940

86%

push

github

Add AddressSanitizer (ASan) memory testing for native addon (#1430)

Add ASan-based memory testing infrastructure to detect memory errors (leaks, use-after-free, type mismatches) in the C++ N-API addon code.

Bug fixes found and resolved by ASan:
- src/executor.cpp: Fix new-delete-type-mismatch in Executor::Stop(). The uv_close callback deleted via uv_handle_t* (96 bytes) but the object was allocated as uv_async_t (128 bytes). Fixed by casting back to uv_async_t* before delete.
- src/rcl_context_bindings.cpp: Fix argv memory leak in Init(). RCPPUTILS_SCOPE_EXIT for FreeArgs was placed after early return paths, so argv was never freed on error. Moved it immediately after allocation.

New files:
- scripts/run_asan_test.sh: ASan test runner that builds with -fsanitize=address, sets up LD_PRELOAD/LSAN_OPTIONS, temporarily hides prebuilds to load the debug build, and auto-excludes tests from blocklist.json and asan_blocklist.json. Supports --no-build, --exclude, and specific test file arguments.
- test/asan_blocklist.json: Tests excluded under ASan due to LD_PRELOAD incompatibility with child processes (npm, colcon, ros2 CLI) or known third-party issues (ref-napi heap-use-after-free).
- .github/workflows/linux-x64-asan-test.yml: Standalone CI workflow running ASan tests on push/PR to develop (Jazzy + Node 24.X + x64).

Other changes:
- package.json: Add "test:asan" npm script.
- suppr.txt: Add napi_create_reference and napi_create_external suppressions for module-level singleton allocations.
- README.md: Add ASan CI badge to status table.

Fix: #1429

1405 of 1770 branches covered (79.38%)

Branch coverage included in aggregate %.

2876 of 3209 relevant lines covered (89.62%)

471.85 hits per line