[RFC]: disable floating-point contraction when building native add-ons for local tests
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- cmake, javascript, node.js
- 领域
- build-system, testing
调研方向
Start with tools/make/lib/install/addons.mk, tools/make/lib/test/README.md, and the contributing FAQ entry on compiling native add-ons; compare the add-on detection in .github/workflows/scripts/run_affected_tests/run. The RFC leaves several policy questions open, including default behavior, CI flags, stale builds, and C examples. Done means an agreed approach updates test builds and documents the behavior while preserving release flags.
由索引模型根据 Issue 内容生成。
描述
Description
This RFC proposes updating make test so that it rebuilds the native add-ons of the packages under test with -ffp-contract=off, so local native test results match CI.
The approach was agreed on in Office Hours (2026-09-29). The open item from that meeting was how to handle packages which don't have a native add-on.
Problem
On Apple Silicon, clang fuses a*b + c into a single FMA instruction by default. The result can differ by 1 ulp from the JavaScript implementation, which rounds after each operation. Native tests using t.strictEqual then fail locally even though they pass in CI.
Reproduction on current develop (macOS arm64, Apple clang 21.0.0, node-gyp 12.4.0):
$ make install-node-addons NODE_ADDONS_PATTERN="stats/base/ndarray/dvariancech"
$ node lib/node_modules/@stdlib/stats/base/ndarray/dvariancech/test/test.native.js
not ok 11 returns expected value
expected: 6.25
actual: 6.249999999999999
# tests 12
# pass 11
# fail 1
The same package with contraction disabled:
$ CFLAGS="-ffp-contract=off" make install-node-addons NODE_ADDONS_PATTERN="stats/base/ndarray/dvariancech"
$ node lib/node_modules/@stdlib/stats/base/ndarray/dvariancech/test/test.native.js
# tests 12
# pass 12
Findings
- No
binding.gypchanges are needed (there are 1,719 of them). gyp's Makefile generator readsCFLAGSfrom the environment on both Linux and macOS (CFLAGS.target ?= $(CPPFLAGS) $(CFLAGS), appended incmd_ccingyp/pylib/gyp/generator/make.py).install-node-addonsintools/make/lib/install/addons.mkalready passes the environment through tonode-gyp rebuild, which is why the command above works today. - CI already solves "packages without add-ons".
.github/workflows/scripts/run_affected_tests/runonly builds an add-on whenlib/node_modules/${pkg}/binding.gypexists. I suggestmake testreuse that check rather than swallow a non-zero exit code from the rebuild step. Swallowing the exit code would also hide real compile errors. - Release builds should keep their current flags. FMA is faster and is usually at least as accurate. Only the test build needs to match the JavaScript reference.
Proposed changes
- Add a variable to
tools/make/lib/install/addons.mk(e.g.,NODE_ADDONS_CFLAGS) which, when set, is passed asCFLAGSandCXXFLAGStonode-gyp rebuild. - Before
make testruns tests, resolve the packages matched byTESTS_FILTER. For each one that has abinding.gyp, runinstall-node-addonswithNODE_ADDONS_CFLAGS="-ffp-contract=off". - Document the behavior in
tools/make/lib/test/README.mdand in the contributing FAQ entry on compiling native add-ons.
Related Issues
- stdlib-js/meetings #162
Questions
- Should the rebuild be on by default for
make test, or opt-in (e.g.,TEST_NATIVE=1)? Rebuilding adds compile time to every run, so a filter-lessmake testmay need to skip it. - Should CI also pass
-ffp-contract=offexplicitly? CI passes today because it builds onubuntu-latest(x86-64). As far as I can tell, that's only because baseline x86-64 has no FMA instructions to fuse into, not because contraction is turned off. If CI ever moves to arm64 runners, the same 1-ulp failures would show up there. - Should the flag be recorded (e.g., in a stamp file next to the built add-on) so that a test run doesn't use a stale add-on built with different flags?
- Do C examples and C benchmarks (
make examples-c,make benchmark-c) need the same treatment, or is this only about tests?
Other
The 1-ulp cases have been showing up in the ULP-assertion migration PRs. Several native tests have moved to isAlmostSameValue( actual, expected, 1 ) to tolerate this difference. With contraction disabled in test builds, strictEqual would work again for kernels where the JavaScript and C implementations are meant to match exactly.
Checklist
- I have read and understood the Code of Conduct.
- Searched for existing issues and pull requests.
- The issue name begins with
RFC:.
- 主要语言
- JavaScript
- 星标
- 6k
- 派生
- 1.3k
- 平均合并
- 1 天 21 小时
- 30 天内合并 PR
- 224
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
stdlib-js/stdlib 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
stdlib-js/stdlib#16655 · 1 条评论 ·
维护者通常 1 天内回复
-
Fix JavaScript lint errors可能已有人在做 @protestershankar 于 5 天前认领。 未关闭Good First Issue
难度 2/5 1-3 小时 新手友好度 82/100
stdlib-js/stdlib#16563 · 3 条评论 ·
维护者通常 1 天内回复
-
Fix C lint errors可能已有人在做 @raus7n 于 14 天前认领。 未关闭Good First Issue
难度 1/5 1 小时以内 新手友好度 82/100
stdlib-js/stdlib#16454 · 1 条评论 ·
维护者通常 1 天内回复
-
Fix JavaScript lint errors可能已有人在做 @Devansh-18155 于 39 天前认领。 未关闭Good First Issue
难度 1/5 1 小时以内 新手友好度 82/100
stdlib-js/stdlib#15970 · 1 条评论 ·
维护者通常 1 天内回复
-
Fix JavaScript lint errors可能已有人在做 @lb1192176991-lab 于 44 天前认领。 未关闭Good First Issue
难度 1/5 1 小时以内 新手友好度 90/100
stdlib-js/stdlib#15831 · 2 条评论 ·
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 69/100
维护者通常 1 天内回复
-
automation chore ci-cd consistency developer-experience difficulty: easy discoverability documentation enhancement github-actions good first issue help wanted hygiene priority: P3 seo shell yaml
难度 1/5 1 小时以内 新手友好度 76/100
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
swc-project/swc-next-issues#394 ·
-
难度 1/5 1-3 小时 新手友好度 88/100
githubnext/gh-aw-workshop#5790 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
adobe/helix-tools-website#480 ·
维护者通常 1 天内回复