Repository navigation
Conversation
|
Updated 12:59 PM PT - Sep 28th, 2026
❌ @robobun, your commit 6383f7a has 1 failures in
🧪 To try this PR locally: bunx bun-pr 34575That installs a local version of the PR into your bun-34575 --bun |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughChangesThe PR updates native constructor wiring, adds JavaScript-compatible construction and instance tracking for mock functions, removes redundant native function creation arguments, and adds coverage for non-constructible native functions and function inspection. Constructor and host-function semantics
Suggested reviewers: Merge Risk: 🔵 Low · up to The constructor fixes are low risk, but the child-process regression test can hide unexpected diagnostics when it exits successfully. Tightening the stderr assertion would provide bounded follow-up before merge. 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/jsc/bindings/JSMockFunction.cpp`:
- Around line 1006-1015: Update the fallback construction in the mock
constructor path around newTarget and thisObject so a primitive
newTarget.prototype resolves to newTarget’s realm-aware %Object.prototype%,
rather than lexicalGlobalObject’s prototype. Preserve the explicit
object-prototype path, and add a cross-realm test covering a primitive
newTarget.prototype.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4fa5656d-f25c-42d0-8664-9fc5cf5bf3fe
📒 Files selected for processing (8)
src/jsc/bindings/JSFFIFunction.cppsrc/jsc/bindings/JSMockFunction.cppsrc/jsc/modules/NodeBufferModule.htest/js/bun/ffi/ffi.test.jstest/js/bun/test/mock-fn.test.jstest/js/node/buffer-resolveObjectURL.test.tstest/js/node/buffer.test.jstest/js/node/os/os.test.js
There was a problem hiding this comment.
Beyond the inline nit, I also checked: JSFFIFunction::create's only caller (Bun__CreateFFIFunctionWithData) omits nativeConstructor so it picks up the header default callHostFunctionAsConstructor — the os.freemem test exercises exactly that path. The new instances push in jsMockFunctionCallImpl doesn't break the pre-existing stolen.instances / mockClear assertions in the same file. jsMockFunctionConstruct has RETURN_IF_EXCEPTION after each throwing call and thisObject is rooted via the instances/contexts arrays before user JS runs.
Extended reasoning...
This is well-executed and thoroughly tested, but it's non-trivial native JSC binding work with observable API-surface changes (mock.instances now populated on every call to match Jest; every Rust-created host function via JSFFIFunction::create becomes non-constructable), so deferring to a human. The only finding is a nit about an unrelated drive-by test change.
There was a problem hiding this comment.
Both prior nits are addressed (PR description now justifies the os.test.js $USER fallback, and the FFI subprocess test asserts stderr). I didn't find anything new, but this adds a new native [[Construct]] handler in JSC bindings and changes user-visible semantics (mock.instances is now populated on every call; FFI/node:os/node:buffer natives are no longer constructable), so a maintainer should sign off.
What was reviewed:
jsMockFunctionConstruct:getFunctionRealm+createSubclassStructurematches the NapiClass/ObjectConstructor pattern; exception checks after each throwing call;thisObjectis stack-rooted and stored ininstances/contextsbefore user JS runs.JSFFIFunction::createnow honors itsnativeConstructorparam — the only caller omits it and picks up the header defaultcallHostFunctionAsConstructor, covered by thefreememtest.mock.instancespush recordsthisValue(the created instance, not an object returned by the impl), matching Jest.
Extended reasoning...
Overview
Fixes a fuzzer-found debug assertion / release UB where three native construct handlers could return primitives to asObject(). JSMockFunction gets a dedicated construct handler implementing ordinary-function [[Construct]] semantics; JSFFIFunction::createForFFI and ::create now route construct through callHostFunctionAsConstructor; isUtf8/isAscii/resolveObjectURL drop their redundant nativeConstructor argument. Tests cover all three sites plus mock.instances semantics, cross-realm newTarget.prototype fallback, and function-vs-class inspection.
Security risks
None identified. No untrusted-input parsing, no auth/crypto/permission surface. The construct handler runs user JS via jsMockFunctionCallImpl, but that path already existed for the call handler and the new code adds proper exception propagation around it.
Level of scrutiny
High — this is native C++ in src/jsc/bindings/, the most-blocked category per REVIEW.md. The new jsMockFunctionConstruct interacts with JSC's realm resolution and structure caching, and jsMockFunctionCallImpl now records thisValue into mock.instances on every invocation (a Jest-compat behavior change). JSFFIFunction::create now actually uses its nativeConstructor parameter, which flips every function created through Bun__CreateFFIFunctionWithData (node:os natives, etc.) from "constructable, returns primitive through asObject()" to "throws TypeError on new" — a correct fix, but a behavioral change a maintainer should be aware of.
Other factors
All three prior review threads (CodeRabbit's cross-realm fallback, my os.test.js justification note, my FFI stderr assertion nit) are resolved on the current head (a852cf8). The PR description includes a scope audit of every remaining nativeConstructor site in the tree. Test coverage is thorough — every fixed site has both new X() and Reflect.construct variants, and the mock construct block covers primitive/object returns, newTarget.prototype, throwing impls, spies, and cross-realm. No bugs surfaced in this review pass. Deferring rather than approving because new native construct-handler logic and user-visible semantic changes in bun:test mocks warrant a maintainer glance.
a852cf8 to
474a12e
Compare
There was a problem hiding this comment.
All four of my earlier findings are addressed (cross-realm fallback prototype, putNativeFn / utf-8-validate, the stderr assertion, and node:sqlite backup in 1e8bc91) and this pass found nothing new. I'm not auto-approving because the change spans six JSC binding files, adds a new native [[Construct]] handler with realm/prototype logic, and changes mock.instances semantics to match Jest — worth a maintainer's eyes.
What was reviewed:
jsMockFunctionConstruct: exception scopes aftergetFunctionRealm/createSubclassStructure/the call impl are all present; object-vs-primitive return matches ordinary[[Construct]].JSFFIFunction::create'snativeConstructorparam defaults tocallHostFunctionAsConstructorin the header and its only caller omits it, so thefreememtest covers that path.- Re-checked for remaining self-as-
nativeConstructorJSFunction::createsites after 1e8bc91 — none found beyond those the Scope section already lists as safe.
Extended reasoning...
Overview
The PR eliminates a class of debug-assertion / release-UB bugs where a native [[Construct]] handler returns a primitive to Interpreter::executeConstruct's unchecked asObject(). It touches six C++ files in src/jsc/ (JSFFIFunction.cpp, JSMockFunction.cpp, NodeBufferModule.h, NodeSqliteModule.h, UTF8ValidateModule.h, _NativeModule.h) and nine test files. The mechanical fixes drop the trailing self-as-nativeConstructor argument so those functions become non-constructable. JSMockFunction gets a new dedicated jsMockFunctionConstruct that mirrors ordinary JS constructor semantics via getFunctionRealm + InternalFunction::createSubclassStructure, and jsMockFunctionCallImpl now populates mock.instances on every invocation.
Security risks
None identified. This is a correctness/UB fix in the JSC binding layer; no auth, crypto, permissions, or untrusted-input parsing surface is touched. The change removes a UB path reachable from user JS.
Level of scrutiny
High. Per REVIEW.md, native-code memory safety is "the most-blocked category", and JSMockFunction.cpp adds a new construct handler with exception-scope, realm-resolution, and GC-object-creation logic. The PR also went through three rounds of completeness fixes during review (cross-realm prototype, putNativeFn/utf-8-validate, node:sqlite backup), each catching a real missed sibling — that history alone argues for a maintainer sign-off rather than bot approval.
Other factors
- All four of my prior inline findings have been addressed with code + tests; the last one (
NodeSqliteModule.h) landed in 1e8bc91 with aReflect.construct/Bun.inspectassertion innode-sqlite.test.ts. - The
mock.instanceschange is a user-visible behavior change (previously never populated; now recordsthisValueon every call). It matches Jest, is well-tested (instances is pushed on every invocation), and is arguably a bugfix, but it's an API-semantics decision a maintainer should confirm. - I verified
JSFFIFunction.h:72defaultsnativeConstructortocallHostFunctionAsConstructorand the onlyJSFFIFunction::createcaller (Bun__CreateFFIFunctionWithData) omits the argument, so the fix on line 155 does not depend on any caller passing it explicitly. - Test coverage is thorough: every fixed export has a
Reflect.constructthrows-TypeError+Bun.inspectassertion, andmock-fn.test.jscovers primitive/object returns,newTarget.prototype, cross-realm fallback, throwing implementations, and spy construction.
|
CI status (build 75341): 285/286 jobs passed. The one red is All bot review findings are addressed as of 1e8bc91:
The final balanced-paren sweep of every 8-arg |
1e8bc91 to
6947a57
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@test/js/node/buffer-resolveObjectURL.test.ts`:
- Line 52: Remove the standalone bug-context comment from the test body near the
resolveObjectURL setup; leave the test’s setup, action, and assertions
unchanged.
In `@test/js/node/os/os.test.js`:
- Line 120: Update the username and shell environment fallback assertions in the
relevant OS tests to use nullish coalescing (`?? "unknown"`) instead of
truthiness fallback, preserving explicitly empty values. Add coverage for both
unset and empty USER and SHELL environment values.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: f4303628-2670-4edc-9001-dba9a2aab80b
📒 Files selected for processing (15)
src/jsc/bindings/JSFFIFunction.cppsrc/jsc/bindings/JSMockFunction.cppsrc/jsc/modules/NodeBufferModule.hsrc/jsc/modules/NodeSqliteModule.hsrc/jsc/modules/UTF8ValidateModule.hsrc/jsc/modules/_NativeModule.htest/js/bun/ffi/ffi.test.jstest/js/bun/jsc/bun-jsc.test.tstest/js/bun/test/mock-fn.test.jstest/js/first_party/utf-8-validate/utf-8-validate.test.tstest/js/node/buffer-resolveObjectURL.test.tstest/js/node/buffer.test.jstest/js/node/os/os.test.jstest/js/node/sqlite/node-sqlite.test.tstest/js/node/util/test-util-types.test.js
|
CI status, build 89069: 195/196 jobs passed. The one red lane (debian 13 x64-asan) is an LSan leak report in the RSA keygen threadpool job ( Current head 42a91f6: rebased over the engine-native FFI rework (#35246), all CodeRabbit and claude findings addressed, #36497 consolidated into this PR. Ready for review. |
There was a problem hiding this comment.
No new findings — all prior review comments (missing putNativeFn/utf-8-validate/node:sqlite sibling sites, stderr assertion, comment length) are addressed on the current head, and the comment-cop flag is resolved by 80e069b. This still touches JSC bindings and changes user-visible mock.instances semantics, so leaving the merge decision to a human.
What was reviewed:
jsMockFunctionConstruct: exception checks aftergetFunctionRealm/createSubclassStructure/the impl call are present;result.isObject()gate matches ordinary-function[[Construct]].JSFFIFunction::createnow honors itsnativeConstructorparam — checked its sole caller (Bun__CreateFFIFunctionWithData) already defaults tocallHostFunctionAsConstructorvia the header.- Re-swept the remaining self-as-
nativeConstructorsites listed in the Scope section; each is always-throws or always-object as claimed. os.test.js??fallback matchesnode_os.rs'sunwrap_or(b"unknown")(unset ≠ empty).
Extended reasoning...
Overview
The PR fixes a bug class where native [[Construct]] handlers returned primitives, which JSC::Interpreter::executeConstruct hands to an unchecked asObject() — an assertion in debug and UB in release. Six sites are touched: JSMockFunction gets a real construct handler implementing ordinary-function [[Construct]] semantics; JSFFIFunction::createForFFI, node:buffer's isUtf8/isAscii/resolveObjectURL, the shared putNativeFn helper, utf-8-validate, and node:sqlite's backup all drop their self-as-nativeConstructor argument so they become non-constructable. Nine test files add coverage. The PR also changes mock.instances to be populated on every invocation (matching Jest), not only on construct calls.
Security risks
None. This closes a fuzzer-found UB path rather than opening one. No auth, crypto, or permissions code is touched. The new construct handler does not introduce untrusted-input parsing.
Level of scrutiny
High. src/jsc/bindings/ C++ is memory-safety-critical (REVIEW.md's most-blocked category), and jsMockFunctionConstruct is new native code that runs user JS via jsMockFunctionCallImpl. The exception-scope discipline looks correct (RETURN_IF_EXCEPTION after each fallible call, no clearException), and the getFunctionRealm + createSubclassStructure pattern matches NapiClass and JSC's ObjectConstructor. But the mock.instances semantics change (now pushed on every call with thisValue, so a plain fn() records undefined and obj.m() records obj) is a user-visible behavior change to bun:test that a maintainer should confirm is the intended Jest-parity direction — Jest does behave this way, but existing Bun tests that read mock.instances may see different lengths.
Other factors
The PR has been through three rounds of completeness review (my earlier findings caught the missing putNativeFn, utf-8-validate, and node:sqlite siblings; all fixed). CI was 285/286 with the one red flagged pre-existing on main. Test coverage is thorough — every fixed site has both a Reflect.construct throws-TypeError assertion and a Bun.inspect [Function: ...] assertion, plus the mock construct block covers primitive/object returns, newTarget.prototype, cross-realm, and throwing implementations. Given the scope (native construct semantics + a bun:test behavior change), I'm deferring rather than approving.
42a91f6 to
34f80ff
Compare
There was a problem hiding this comment.
Additional findings (outside current diff — PR may have been updated during review):
-
🟡
test/js/bun/ffi/ffi.test.js:1531-1542— This newcc()test is the only in-process TinyCC compilation in the tree not gated.skipIf(isASAN)— every one of the eightcc()blocks incc.test.ts(lines 19, 31, 240, 399, 468, 581, 630, 1090) carries that gate with "TinyCC's setjmp/longjmp error handling conflicts with ASan", including the trivial include-freeadd(a,b)case.FFI_FIXTURE_PATHgates on the system compiler (compileFixture), which is orthogonal to bundled TinyCC and ASAN;ffi-test.calso#includes<stdio.h>/<stdlib.h>(cc.test.ts:16-17 notes CI can't find those), and the result is never.close()'d in a file whose siblinglinkSymbolstest three tests up runs in a subprocess specifically to keep unfinalized native handles off the ASAN leak checker. Gate thisit.skipIf(isASAN)(...), or run it in a subprocess with a minimal inline source (e.g.bool returns_true(void){return 1;}) and.close()the library — matching the pattern the earlier review comment asked for ("skipIf'd on availability, as the description already claims").Extended reasoning...
What's off
Commit 5d0f5dc added
"cc()-compiled functions are not constructors"atffi.test.js:1531-1542, insidedescribe.skipIf(!FFI_FIXTURE_PATH)("engine-native FFI (single implementation)"). It callscc({ source: import.meta.dir + "/ffi-test.c", ... })in-process, does not.close()the result, and is not gated onisASAN.ffi.test.jsdoesn't importisASANat all.Why this violates the harness convention
Every other in-process
cc()compilation in the repo lives intest/js/bun/ffi/cc.test.tsand is.skipIf(isASAN)-gated:Line Block Gate 19 can run a .c fileit.todoIf(isWindows || isASAN)31 given an add(a, b) function(no system includes)describe.skipIf(isASAN)240 threadsafe JSCallback from foreign threaddescribe.skipIf(isWindows || isASAN)399 GC liveness of compiled symbolsdescribe.skipIf(isASAN)468 variadic functions inside cc()describe.skipIf(isASAN)581 long double varargsdescribe.skipIf(isASAN || ...)630 thread-local storagedescribe.skipIf(isASAN)1090 compiler runtime header directorydescribe.skipIf(isASAN)Each carries the identical rationale comment: "TinyCC's setjmp/longjmp error handling conflicts with ASan." The convention is blanket — even the trivial
int add(int a, int b) { return a + b; }block at line 31, which has no system includes and can't fail compilation, is gated. The one un-gateddescribein cc.test.ts ("double <-> JSValue conversions"at line 650) runs itscc()calls inside spawned subprocesses, not in the test process.REVIEW.md, Tests reviewers reject: "Copy harness conventions exactly."
Why the existing gate doesn't help
FFI_FIXTURE_PATHis set whencompileFixture(import.meta.dir + "/ffi-test.c")succeeds (ffi.test.js:24) — i.e., whenwhich('cc') || which('clang') || which('gcc')finds a system C compiler fordlopen. That's orthogonal to bundled TinyCC and to ASAN: on the ASAN CI lane with a system toolchain installed,FFI_FIXTURE_PATHis truthy and this test runs.The pre-existing
cc()call in this same describe block (ffi.test.js:1564) doesn't count: it passesargs: ["ptr", "buffer_length"], whichffi_body.rsrejects at argument-type validation (buffer_length is only supported for ... not in cc()) before TinyCC ever runs. So the new test is genuinely the only in-process TinyCC compilation inffi.test.js— and the only unguarded one in the tree.Step-by-step: two concrete failure modes on the ASAN lane
Mode 1 — missing system headers → longjmp under ASAN:
ffi-test.clines 3-4:#include <stdio.h>/#include <stdlib.h>.cc.test.ts:16-17(the repo's own comment): "TODO: we need to install build-essential and Apple SDK in CI. It can't find includes." Bundled TinyCC only ships its own builtin headers; the system toolchain that satisfiedcompileFixtureknows SDK paths TinyCC does not.- If TinyCC fails to locate
<stdio.h>, itlongjmps to its internal error handler — the exact interaction everyisASANgate in cc.test.ts documents as ASAN-incompatible. That takes down the wholeffi.test.jsfile, not just this test.
Mode 2 — unfinalized native handle → LSan leak report:
- The test destructures
{ symbols: { returns_true } }fromcc(...)and never calls.close(). ffi.test.js:1063-1065— the siblinglinkSymbols()constructor test three tests above — runs in a subprocess with the explicit rationale: "the linked library's native handle is not finalized onbun test's exit path, which the ASan lane's leak checker reports against this file."- A
cc()-compiled library has the same lifecycle: an unfinalized handle at process exit is attributed toffi.test.jsby LSan.
Impact
Commit 5d0f5dc (2026-08-16) postdates the last CI build referenced in the PR timeline (build 89069, 2026-08-05), so this test has not yet been exercised on the ASAN lane. If either failure mode fires, the whole of
ffi.test.jsgoes red on that lane — but CI would catch it immediately on the next push, so this isn't silently shipping a runtime bug.Fix
Match the convention. Either:
import { bunEnv, bunExe, compileFixture, isASAN, isGlibcVersionAtLeast, isWindows, tempDir } from "harness"; // ... it.skipIf(isASAN)("cc()-compiled functions are not constructors", () => { const lib = cc({ source: import.meta.dir + "/ffi-test.c", symbols: { returns_true: { args: [], returns: "bool" } }, }); const { returns_true } = lib.symbols; expect(returns_true()).toBe(true); expect(() => new returns_true()).toThrow(TypeError); expect(() => Reflect.construct(returns_true, [])).toThrow(TypeError); expect(Bun.inspect(returns_true)).toBe("[Function: returns_true]"); lib.close(); });
or, to run on the ASAN lane too, follow the
linkSymbolssibling and spawn a subprocess with a minimal include-free source (bool returns_true(void){return 1;}) written viatempDir, closing the library before exit — which is what the PR description's "TinyCC-backed test … run in a subprocess and gated onccavailability" already claims this test does.
|
On the |
There was a problem hiding this comment.
I reviewed this PR and found no bugs on this pass — all seven prior inline findings have been addressed as of de99310. Because it adds a new C++ [[Construct]] handler in JSMockFunction.cpp, changes bun:test mock semantics (mock.instances/mock.contexts now populated on every invocation), and makes a large set of native exports non-constructable, a human sign-off is still warranted.
What was reviewed:
jsMockFunctionConstruct: exception checks aftergetFunctionRealm/createSubclassStructure/jsMockFunctionCallImpl, object-return-wins fallback — matches theNapiClass/ObjectConstructorpattern.mock.instancespush injsMockFunctionCallImplmirrors the siblingcalls/contextsblocks and is covered by the new "instances is pushed on every invocation" test; checked existingmockClear/mockResettests still hold.JSFFIFunction::createnow honoringnativeConstructor(defaultcallHostFunctionAsConstructorin the header) andcreateForFFI— thecc()subprocess test now discriminates thecreateForFFIhunk.- All seven
JSFunction::createself-as-constructor drops (NodeBufferModule,_NativeModuleputNativeFn,UTF8ValidateModule,NodeSqliteModule) each have aReflect.construct-throws test.
Extended reasoning...
Overview
Fixes a fuzzer-found debug assertion / release UB where native [[Construct]] handlers returned primitives through asObject(). Seven call sites across JSMockFunction, JSFFIFunction, and five native-module headers are fixed; JSMockFunction gets a proper ordinary-function [[Construct]] implementation, and the rest become non-constructable via callHostFunctionAsConstructor or by dropping the redundant nativeConstructor argument. Nine test files gain coverage; jsMockFunctionCall is refactored into an impl that accepts thisValue and now populates mock.instances on every call (Jest parity).
Security risks
None identified. The change tightens behavior (functions that previously had UB on new now throw TypeError), does not touch auth/crypto/permissions, and does not parse untrusted input. The new C++ code follows the ThrowScope discipline (RETURN_IF_EXCEPTION after each fallible call) and the instances push mirrors the existing calls/contexts pattern verbatim.
Level of scrutiny
High. This is C++ in src/jsc/bindings/ — REVIEW.md's most-blocked category — and it changes user-visible bun:test API behavior (mock.instances, mock.contexts, non-constructability of ~80 native exports including all putNativeFn consumers). The jsMockFunctionConstruct implementation looks correct and matches the NapiClass/ObjectConstructor pattern, but an API-surface change of this breadth deserves a maintainer's eyes rather than bot-only approval.
Other factors
- All seven of my prior inline findings (missed sibling sites in
_NativeModule.h/UTF8ValidateModule.h/NodeSqliteModule.h, thelinkSymbolstest not coveringcreateForFFI, the missing default.prototype, the multi-line comment, theos.test.jsdrive-by, the missingstderrassertion) have been addressed in commits through de99310. - The
mock.instances-on-every-call change is a Jest-compat fix, not a break, but it is a behavior change nonetheless — pre-existing tests that readmock.instancesafter plain calls would now see entries. - The author explicitly deferred adding a default
.prototypeto mocks as a separate API change; the current behavior is pinned by anisBun-gated test. - Test coverage is thorough: each fixed factory has a discriminating test, and the mock construct block covers primitives, object passthrough,
mockReturnValue, explicitnewTarget, cross-realm fallback, throwing implementations, and spies.
### Problem
- `class Sub extends StringDecoder {}; new Sub("utf8")` returns the
class `Sub` itself. `s.write` is `undefined`, and `Sub` gains an own
`encoding` property. `Reflect.construct(StringDecoder, ["utf8"],
Object)` returns `Object`. Node returns an instance.
- `JSStringDecoderConstructor` registers one native function for
[[Call]] and [[Construct]] (`src/jsc/bindings/JSStringDecoder.h:118`).
JSC passes new.target in the `this` slot of a native constructor, so the
branch for `StringDecoder.call(receiver, encoding)`
(`JSStringDecoder.cpp:592`) takes `Sub` as the receiver.
- Found by an audit. No issue reports it.
### Fix
- Register separate `call` and `construct` functions that share one
`createDecoder` body. For a [[Construct]] it takes the structure from
new.target with `InternalFunction::createSubclassStructure`, as `JSHash`
and the generated classes do. `call` keeps the receiver branch
unchanged.
- The Node.js compatibility page no longer lists this gap. Not in this
PR: `JSMockFunction.cpp:459` has the same cause, and #34575 and #41398
carry it.
- `new StringDecoder()` costs the same as before (ThinLTO A/B in the
notes).
- Verified: `test/js/node/string_decoder/string-decoder.test.js` (143
pass, released bun fails the 45 new cases), Node's
`test-string-decoder*.js`, `express-body-parser-test.test.ts`.
Self-reviewed: 4 concerns raised, 4 addressed.
### Background
- [[Call]] is `f()`. [[Construct]] is `new f()` or `Reflect.construct`.
A JSC `InternalFunction` takes one native function for each.
- new.target is the constructor that `new` was applied to: `Sub` for
`new Sub()`. The new object takes its prototype from it.
- A JSC `Structure` holds the prototype of an object.
`createSubclassStructure` returns the base structure with the prototype
of new.target.
- The receiver branch serves iconv-lite 0.4 (under express body-parser),
which runs `StringDecoder.call(this, enc)` on a plain object. It stores
the native decoder on that object.
<details><summary>Notes</summary>
**Repro**
```js
const { StringDecoder } = require("string_decoder");
class Sub extends StringDecoder {}
const s = new Sub("utf8");
console.log(s === Sub, typeof s, s instanceof Sub, Reflect.ownKeys(Sub));
// bun 1.4.3: true function false [ "length", "name", "prototype", "encoding" ]
// node v26.3.0: false object true [ 'length', 'name', 'prototype' ]
// this branch: false object true [ "length", "name", "prototype" ]
```
**Sibling sites** (every place that registers one function for both
[[Call]] and [[Construct]])
- `src/jsc/bindings/JSMockFunction.cpp:459`: `jsMockFunctionCall` reads
`thisValue()`, so `new mockFn()` sees new.target as `this`. Same root
cause. Excluded here because #34575 and #41398 already change that
function. This PR does not fix `mock()` or `spyOn()`.
- These never read `this` or new.target, so the confusion cannot happen
there: the seven sink constructors from
`src/codegen/generate-jssink.ts:59` (`js_construct` ignores the frame),
`JSDOMConstructorNotConstructable` (throws on both paths), the
`ObjectTemplate` `DummyCallback` in the V8 shim,
`jsNodeVmWasmDisallowed` (`NodeVM.cpp:1046`, throws on both paths),
`vm.createContext` (`NodeVM.cpp:1714`), and `SlowBuffer`.
- #42528 makes other native constructors honor new.target. It does not
cover `StringDecoder`.
**Cost of `new StringDecoder()`**
A first version had a parse helper and called `JSStringDecoder::create`
from both `call` and `construct`. With two call sites,
`allocateCell<JSStringDecoder>` went out of line and `new
StringDecoder()` got slower. One shared `createDecoder` keeps a single
call site for the allocation, and `construct` compiles to 9 instructions
that end in `jmp createDecoder`.
ThinLTO release build, only this translation unit replaced, one pinned
core, 300 reps of 200000 constructions, p50 in ns over 5 alternating
rounds:
| variant | `new StringDecoder()` | `new StringDecoder("utf8")` |
| --- | --- | --- |
| main | 11.6 to 12.3 | 19.5 to 21.1 |
| first version | 14.9 to 16.1 | 19.8 to 20.9 |
| this PR | 11.4 to 12.6 | 18.0 to 19.3 |
**Behavior details**
- Order matches Node: the `prototype` of new.target is read before the
encoding is parsed (probed with a Proxy new.target and an encoding
object with a `toString`).
- `call` is unchanged, including the `thisValue != constructor` check,
so `StringDecoder.call(StringDecoder, enc)` still returns a fresh
decoder. The two `putDirect` lines in the receiver branch are textually
untouched, so #34609 and other work on that branch should merge without
a conflict.
- A new.target whose `prototype` is not an object gets
`StringDecoder.prototype`, as for every JSC built-in class. Node gives
`Object.prototype` there, because its `StringDecoder` is an ordinary
function.
- Cross-realm: a class defined in a `node:vm` context or a ShadowRealm
can extend `StringDecoder`. The function realm of new.target is not
always a `Zig::GlobalObject`, so the code goes through
`defaultGlobalObject()`. A revoked Proxy as new.target throws a
TypeError.
- Remaining difference, not changed here: Node's `end(buf)` and `text()`
call `this.write()`, so a subclass that overrides `write` sees those
calls. Bun's native `end` and `text` call the native write directly. A
plain instance with a patched `write` shows the same difference today.
- Not changed here: `lastNeed`, `lastTotal` and `lastChar` throw on a
`StringDecoder.call(this)` receiver, because the prototype accessors
have a class check. Instances of a subclass are real `JSStringDecoder`
cells, so the accessors work on them.
**Suites run with the debug (ASAN) build**
- `test/js/node/string_decoder/string-decoder.test.js`: 143 pass. The
whole decode suite now also runs against `class SubStringDecoder extends
StringDecoder`. Released bun 1.4.3: 98 pass, 45 fail.
- The same file and a script of every throw path under
`BUN_JSC_validateExceptionChecks=1`: clean.
- `test/js/node/test/parallel/`: `test-string-decoder.js`,
`test-string-decoder-end.js`, `test-string-decoder-fuzz.js`,
`test-crypto-hash.js`, `test-fs-read-stream-encoding.js`,
`test-readline-keys.js`, `test-stream-decoder-objectmode.js`,
`test-stream-push-strings.js`,
`test-stream-readable-setEncoding-existing-buffers.js`,
`test-stream-readable-setEncoding-null.js`,
`test-stream2-decode-partial.js`, `test-stream2-set-encoding.js`.
- `test/js/third_party/body-parser/express-body-parser-test.test.ts`,
and iconv-lite 0.4.24 (`StringDecoder.call(this, enc)` with
`InternalDecoder.prototype = StringDecoder.prototype`) by hand.
**Self-review**
The review asked for four changes. All are in this PR: the stale docs
line, the sibling-sites list, the slower `new StringDecoder()` of the
first version, and multi-line comments in `src/`.
</details>
<!-- robobun:evidence:begin -->
---
**[human-review]** gate passed · iteration 0 · 4 files touched
<details><summary>fails on main (without fix)</summary>
```console
ASAN without fix: BUILD FAILED (no junit output)
$ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/string_decoder/string-decoder.test.js
ninja: Entering directory `/workspace/bun/build/debug'
[1/164] cc obj/src/jsc/bindings/sqlite/sqlite3.c.o
[2/164] gen generated_host_exports.rs
generated_host_exports.rs: 122 exports (host=5, lazy=10, generic=107, rust=0); 243 extern-C blocks audited
[3/164] gen ZigGeneratedClasses.{cpp,h,rs}
Found 2 classes from /workspace/bun/src/jsc/resolve_message.classes.ts
- ResolveMessage (15 fields)
- BuildMessage (10 fields)
Found 1 classes from /workspace/bun/src/runtime/api/Archive.classes.ts
- Archive (4 fields, 1 class fields)
Found 2 classes from /workspace/bun/src/runtime/api/BunObject.classes.ts
- ResourceUsage (8 fields)
- Subprocess (20 fields)
Found 1 classes from /workspace/bun/src/runtime/api/cron.classes.ts
- CronJob (5 fields)
Found 3 classes from /workspace/bun/src/runtime/api/filesystem_router.classes.ts
- FileSystemRouter (5 fields)
- FrameworkFileSystemRouter (2 fields)
- MatchedRoute (8 fields)
Found 1 classes from /workspace/bun/src/runtime/api/Glob.classes
... (truncated)
release without fix: 45 FAILED
bun test v1.4.3-canary.1 (6a92015)
test/js/node/string_decoder/string-decoder.test.js:
(pass) require('string_decoder') [0.10ms]
(pass) Bun.inspect(StringDecoder) [0.09ms]
(pass) FakeStringDecoderCall > StringDecoder-utf8 [1.88ms]
(pass) FakeStringDecoderCall > StringDecoder-ucs-2 [0.94ms]
(pass) FakeStringDecoderCall > StringDecoder-utf16le [0.04ms]
(pass) FakeStringDecoderCall > StringDecoder-utf8-additional [0.11ms]
(pass) FakeStringDecoderCall > StringDecoder-utf16le-additional [0.06ms]
(pass) FakeStringDecoderCall > StringDecoder.end > base64 testbuf [0.18ms]
(pass) FakeStringDecoderCall > StringDecoder.end > base64url testbuf [0.10ms]
(pass) FakeStringDecoderCall > StringDecoder.end > hex testbuf [0.11ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf8 testbuf [0.06ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf16le testbuf [0.04ms]
(pass) FakeStringDecoderCall > StringDecoder.end > ucs2 testbuf [0.05ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "�a" [0.03ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "��"
(pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "��"
(pass) FakeS
... (truncated)
```
</details>
<details><summary>passes on PR (with fix)</summary>
```console
ASAN with fix: all passed
$ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/string_decoder/string-decoder.test.js
bun test v1.4.3 (6a92015)
test/js/node/string_decoder/string-decoder.test.js:
(pass) require('string_decoder') [6.27ms]
(pass) Bun.inspect(StringDecoder) [5.39ms]
(pass) FakeStringDecoderCall > StringDecoder-utf8 [340.80ms]
(pass) FakeStringDecoderCall > StringDecoder-ucs-2 [239.90ms]
(pass) FakeStringDecoderCall > StringDecoder-utf16le [4.82ms]
(pass) FakeStringDecoderCall > StringDecoder-utf8-additional [9.54ms]
(pass) FakeStringDecoderCall > StringDecoder-utf16le-additional [8.09ms]
(pass) FakeStringDecoderCall > StringDecoder.end > base64 testbuf [25.18ms]
(pass) FakeStringDecoderCall > StringDecoder.end > base64url testbuf [17.47ms]
(pass) FakeStringDecoderCall > StringDecoder.end > hex testbuf [13.70ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf8 testbuf [15.44ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf16le testbuf [11.48ms]
(pass) FakeStringDecoderCall > StringDecoder.end > ucs2 testbuf [12.16ms]
(pass) FakeStringDecoderCall > StringDecoder.end > utf
... (truncated)
release with fix: all passed
$ bun scripts/build.ts --profile=release
[configured] bun-profile → bun (stripped) in 706ms (unchanged)
ninja: Entering directory `/workspace/bun/build/release'
[1/125] cc obj/src/jsc/bindings/sqlite/sqlite3.c.o
[2/125] gen generated_host_exports.rs
generated_host_exports.rs: 122 exports (host=5, lazy=10, generic=107, rust=0); 243 extern-C blocks audited
[3/125] gen ZigGeneratedClasses.{cpp,h,rs}
Found 2 classes from /workspace/bun/src/jsc/resolve_message.classes.ts
- ResolveMessage (15 fields)
- BuildMessage (10 fields)
Found 1 classes from /workspace/bun/src/runtime/api/Archive.classes.ts
- Archive (4 fields, 1 class fields)
Found 2 classes from /workspace/bun/src/runtime/api/BunObject.classes.ts
- ResourceUsage (8 fields)
- Subprocess (20 fields)
Found 1 classes from /workspace/bun/src/runtime/api/cron.classes.ts
- CronJob (5 fields)
Found 3 classes from /workspace/bun/src/runtime/api/filesystem_router.classes.ts
- FileSystemRouter (5 fields)
- FrameworkFileSystemRouter (2 fields)
- MatchedRoute (8 fields)
Found 1 classes from /workspace/bun/src/runtime/api/Glob.classes.ts
- Glob (5 fields)
Found 1 classes from /workspace/bun/src/runtime/api
... (truncated)
```
</details>
<details><summary>diff hotspot</summary>
```
docs/runtime/nodejs-compat.mdx | 2 +-
src/jsc/bindings/JSStringDecoder.cpp | 45 ++++++--
src/jsc/bindings/JSStringDecoder.h | 5 +-
test/js/node/string_decoder/string-decoder.test.js | 114 ++++++++++++++++++++-
4 files changed, 151 insertions(+), 15 deletions(-)
```
</details>
**gate history** · 1 passed · 0 rejected · iteration 0
<details><summary>evidence per changed file</summary>
```
file reads edits tests
docs/runtime/nodejs-compat.mdx 1 1 18
src/jsc/bindings/JSStringDecoder.cpp 5 12 18
src/jsc/bindings/JSStringDecoder.h 1 1 18
test/js/node/string_decoder/string-decoder.test.js 2 5 18
```
</details>
<!-- robobun:evidence:end -->
…2582) ### Problem - `class Sub extends StringDecoder {}; new Sub("utf8")` returns the class `Sub` itself. `s.write` is `undefined`, and `Sub` gains an own `encoding` property. `Reflect.construct(StringDecoder, ["utf8"], Object)` returns `Object`. Node returns an instance. - `JSStringDecoderConstructor` registers one native function for [[Call]] and [[Construct]] (`src/jsc/bindings/JSStringDecoder.h:118`). JSC passes new.target in the `this` slot of a native constructor, so the branch for `StringDecoder.call(receiver, encoding)` (`JSStringDecoder.cpp:592`) takes `Sub` as the receiver. - Found by an audit. No issue reports it. ### Fix - Register separate `call` and `construct` functions that share one `createDecoder` body. For a [[Construct]] it takes the structure from new.target with `InternalFunction::createSubclassStructure`, as `JSHash` and the generated classes do. `call` keeps the receiver branch unchanged. - The Node.js compatibility page no longer lists this gap. Not in this PR: `JSMockFunction.cpp:459` has the same cause, and oven-sh#34575 and oven-sh#41398 carry it. - `new StringDecoder()` costs the same as before (ThinLTO A/B in the notes). - Verified: `test/js/node/string_decoder/string-decoder.test.js` (143 pass, released bun fails the 45 new cases), Node's `test-string-decoder*.js`, `express-body-parser-test.test.ts`. Self-reviewed: 4 concerns raised, 4 addressed. ### Background - [[Call]] is `f()`. [[Construct]] is `new f()` or `Reflect.construct`. A JSC `InternalFunction` takes one native function for each. - new.target is the constructor that `new` was applied to: `Sub` for `new Sub()`. The new object takes its prototype from it. - A JSC `Structure` holds the prototype of an object. `createSubclassStructure` returns the base structure with the prototype of new.target. - The receiver branch serves iconv-lite 0.4 (under express body-parser), which runs `StringDecoder.call(this, enc)` on a plain object. It stores the native decoder on that object. <details><summary>Notes</summary> **Repro** ```js const { StringDecoder } = require("string_decoder"); class Sub extends StringDecoder {} const s = new Sub("utf8"); console.log(s === Sub, typeof s, s instanceof Sub, Reflect.ownKeys(Sub)); // bun 1.4.3: true function false [ "length", "name", "prototype", "encoding" ] // node v26.3.0: false object true [ 'length', 'name', 'prototype' ] // this branch: false object true [ "length", "name", "prototype" ] ``` **Sibling sites** (every place that registers one function for both [[Call]] and [[Construct]]) - `src/jsc/bindings/JSMockFunction.cpp:459`: `jsMockFunctionCall` reads `thisValue()`, so `new mockFn()` sees new.target as `this`. Same root cause. Excluded here because oven-sh#34575 and oven-sh#41398 already change that function. This PR does not fix `mock()` or `spyOn()`. - These never read `this` or new.target, so the confusion cannot happen there: the seven sink constructors from `src/codegen/generate-jssink.ts:59` (`js_construct` ignores the frame), `JSDOMConstructorNotConstructable` (throws on both paths), the `ObjectTemplate` `DummyCallback` in the V8 shim, `jsNodeVmWasmDisallowed` (`NodeVM.cpp:1046`, throws on both paths), `vm.createContext` (`NodeVM.cpp:1714`), and `SlowBuffer`. - oven-sh#42528 makes other native constructors honor new.target. It does not cover `StringDecoder`. **Cost of `new StringDecoder()`** A first version had a parse helper and called `JSStringDecoder::create` from both `call` and `construct`. With two call sites, `allocateCell<JSStringDecoder>` went out of line and `new StringDecoder()` got slower. One shared `createDecoder` keeps a single call site for the allocation, and `construct` compiles to 9 instructions that end in `jmp createDecoder`. ThinLTO release build, only this translation unit replaced, one pinned core, 300 reps of 200000 constructions, p50 in ns over 5 alternating rounds: | variant | `new StringDecoder()` | `new StringDecoder("utf8")` | | --- | --- | --- | | main | 11.6 to 12.3 | 19.5 to 21.1 | | first version | 14.9 to 16.1 | 19.8 to 20.9 | | this PR | 11.4 to 12.6 | 18.0 to 19.3 | **Behavior details** - Order matches Node: the `prototype` of new.target is read before the encoding is parsed (probed with a Proxy new.target and an encoding object with a `toString`). - `call` is unchanged, including the `thisValue != constructor` check, so `StringDecoder.call(StringDecoder, enc)` still returns a fresh decoder. The two `putDirect` lines in the receiver branch are textually untouched, so oven-sh#34609 and other work on that branch should merge without a conflict. - A new.target whose `prototype` is not an object gets `StringDecoder.prototype`, as for every JSC built-in class. Node gives `Object.prototype` there, because its `StringDecoder` is an ordinary function. - Cross-realm: a class defined in a `node:vm` context or a ShadowRealm can extend `StringDecoder`. The function realm of new.target is not always a `Zig::GlobalObject`, so the code goes through `defaultGlobalObject()`. A revoked Proxy as new.target throws a TypeError. - Remaining difference, not changed here: Node's `end(buf)` and `text()` call `this.write()`, so a subclass that overrides `write` sees those calls. Bun's native `end` and `text` call the native write directly. A plain instance with a patched `write` shows the same difference today. - Not changed here: `lastNeed`, `lastTotal` and `lastChar` throw on a `StringDecoder.call(this)` receiver, because the prototype accessors have a class check. Instances of a subclass are real `JSStringDecoder` cells, so the accessors work on them. **Suites run with the debug (ASAN) build** - `test/js/node/string_decoder/string-decoder.test.js`: 143 pass. The whole decode suite now also runs against `class SubStringDecoder extends StringDecoder`. Released bun 1.4.3: 98 pass, 45 fail. - The same file and a script of every throw path under `BUN_JSC_validateExceptionChecks=1`: clean. - `test/js/node/test/parallel/`: `test-string-decoder.js`, `test-string-decoder-end.js`, `test-string-decoder-fuzz.js`, `test-crypto-hash.js`, `test-fs-read-stream-encoding.js`, `test-readline-keys.js`, `test-stream-decoder-objectmode.js`, `test-stream-push-strings.js`, `test-stream-readable-setEncoding-existing-buffers.js`, `test-stream-readable-setEncoding-null.js`, `test-stream2-decode-partial.js`, `test-stream2-set-encoding.js`. - `test/js/third_party/body-parser/express-body-parser-test.test.ts`, and iconv-lite 0.4.24 (`StringDecoder.call(this, enc)` with `InternalDecoder.prototype = StringDecoder.prototype`) by hand. **Self-review** The review asked for four changes. All are in this PR: the stale docs line, the sibling-sites list, the slower `new StringDecoder()` of the first version, and multi-line comments in `src/`. </details> <!-- robobun:evidence:begin --> --- **[human-review]** gate passed · iteration 0 · 4 files touched <details><summary>fails on main (without fix)</summary> ```console ASAN without fix: BUILD FAILED (no junit output) $ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/string_decoder/string-decoder.test.js ninja: Entering directory `/workspace/bun/build/debug' [1/164] cc obj/src/jsc/bindings/sqlite/sqlite3.c.o [2/164] gen generated_host_exports.rs generated_host_exports.rs: 122 exports (host=5, lazy=10, generic=107, rust=0); 243 extern-C blocks audited [3/164] gen ZigGeneratedClasses.{cpp,h,rs} Found 2 classes from /workspace/bun/src/jsc/resolve_message.classes.ts - ResolveMessage (15 fields) - BuildMessage (10 fields) Found 1 classes from /workspace/bun/src/runtime/api/Archive.classes.ts - Archive (4 fields, 1 class fields) Found 2 classes from /workspace/bun/src/runtime/api/BunObject.classes.ts - ResourceUsage (8 fields) - Subprocess (20 fields) Found 1 classes from /workspace/bun/src/runtime/api/cron.classes.ts - CronJob (5 fields) Found 3 classes from /workspace/bun/src/runtime/api/filesystem_router.classes.ts - FileSystemRouter (5 fields) - FrameworkFileSystemRouter (2 fields) - MatchedRoute (8 fields) Found 1 classes from /workspace/bun/src/runtime/api/Glob.classes ... (truncated) release without fix: 45 FAILED bun test v1.4.3-canary.1 (6a92015) test/js/node/string_decoder/string-decoder.test.js: (pass) require('string_decoder') [0.10ms] (pass) Bun.inspect(StringDecoder) [0.09ms] (pass) FakeStringDecoderCall > StringDecoder-utf8 [1.88ms] (pass) FakeStringDecoderCall > StringDecoder-ucs-2 [0.94ms] (pass) FakeStringDecoderCall > StringDecoder-utf16le [0.04ms] (pass) FakeStringDecoderCall > StringDecoder-utf8-additional [0.11ms] (pass) FakeStringDecoderCall > StringDecoder-utf16le-additional [0.06ms] (pass) FakeStringDecoderCall > StringDecoder.end > base64 testbuf [0.18ms] (pass) FakeStringDecoderCall > StringDecoder.end > base64url testbuf [0.10ms] (pass) FakeStringDecoderCall > StringDecoder.end > hex testbuf [0.11ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf8 testbuf [0.06ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf16le testbuf [0.04ms] (pass) FakeStringDecoderCall > StringDecoder.end > ucs2 testbuf [0.05ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "�a" [0.03ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "��" (pass) FakeStringDecoderCall > StringDecoder.end > utf8 partial "��" (pass) FakeS ... (truncated) ``` </details> <details><summary>passes on PR (with fix)</summary> ```console ASAN with fix: all passed $ BUN_DEBUG_QUIET_LOGS=1 bun scripts/build.ts --profile=debug --quiet test "--reporter=junit" "--reporter-outfile=/tmp/pr_gate.xml" test/js/node/string_decoder/string-decoder.test.js bun test v1.4.3 (6a92015) test/js/node/string_decoder/string-decoder.test.js: (pass) require('string_decoder') [6.27ms] (pass) Bun.inspect(StringDecoder) [5.39ms] (pass) FakeStringDecoderCall > StringDecoder-utf8 [340.80ms] (pass) FakeStringDecoderCall > StringDecoder-ucs-2 [239.90ms] (pass) FakeStringDecoderCall > StringDecoder-utf16le [4.82ms] (pass) FakeStringDecoderCall > StringDecoder-utf8-additional [9.54ms] (pass) FakeStringDecoderCall > StringDecoder-utf16le-additional [8.09ms] (pass) FakeStringDecoderCall > StringDecoder.end > base64 testbuf [25.18ms] (pass) FakeStringDecoderCall > StringDecoder.end > base64url testbuf [17.47ms] (pass) FakeStringDecoderCall > StringDecoder.end > hex testbuf [13.70ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf8 testbuf [15.44ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf16le testbuf [11.48ms] (pass) FakeStringDecoderCall > StringDecoder.end > ucs2 testbuf [12.16ms] (pass) FakeStringDecoderCall > StringDecoder.end > utf ... (truncated) release with fix: all passed $ bun scripts/build.ts --profile=release [configured] bun-profile → bun (stripped) in 706ms (unchanged) ninja: Entering directory `/workspace/bun/build/release' [1/125] cc obj/src/jsc/bindings/sqlite/sqlite3.c.o [2/125] gen generated_host_exports.rs generated_host_exports.rs: 122 exports (host=5, lazy=10, generic=107, rust=0); 243 extern-C blocks audited [3/125] gen ZigGeneratedClasses.{cpp,h,rs} Found 2 classes from /workspace/bun/src/jsc/resolve_message.classes.ts - ResolveMessage (15 fields) - BuildMessage (10 fields) Found 1 classes from /workspace/bun/src/runtime/api/Archive.classes.ts - Archive (4 fields, 1 class fields) Found 2 classes from /workspace/bun/src/runtime/api/BunObject.classes.ts - ResourceUsage (8 fields) - Subprocess (20 fields) Found 1 classes from /workspace/bun/src/runtime/api/cron.classes.ts - CronJob (5 fields) Found 3 classes from /workspace/bun/src/runtime/api/filesystem_router.classes.ts - FileSystemRouter (5 fields) - FrameworkFileSystemRouter (2 fields) - MatchedRoute (8 fields) Found 1 classes from /workspace/bun/src/runtime/api/Glob.classes.ts - Glob (5 fields) Found 1 classes from /workspace/bun/src/runtime/api ... (truncated) ``` </details> <details><summary>diff hotspot</summary> ``` docs/runtime/nodejs-compat.mdx | 2 +- src/jsc/bindings/JSStringDecoder.cpp | 45 ++++++-- src/jsc/bindings/JSStringDecoder.h | 5 +- test/js/node/string_decoder/string-decoder.test.js | 114 ++++++++++++++++++++- 4 files changed, 151 insertions(+), 15 deletions(-) ``` </details> **gate history** · 1 passed · 0 rejected · iteration 0 <details><summary>evidence per changed file</summary> ``` file reads edits tests docs/runtime/nodejs-compat.mdx 1 1 18 src/jsc/bindings/JSStringDecoder.cpp 5 12 18 src/jsc/bindings/JSStringDecoder.h 1 1 18 test/js/node/string_decoder/string-decoder.test.js 2 5 18 ``` </details> <!-- robobun:evidence:end -->
5a58f77 to
a6b47f2
Compare
|
Rebased onto main (e375701) and corrected the description. Three things changed. A correction. The description said these functions are not constructable "like Node's". That holds for only part of them. Node v26.3.0 writes 27 of them in JS, so they are ordinary functions there and
So
Cost, measured on release builds of main and of this branch.
The method is in the description's notes. In short: main-thread instructions between two marker syscalls, counted by single-step, with the JIT off so the loop has a fixed cost. Wall-clock could not resolve the difference on this machine. Tests added. One case for each primitive a constructed mock can return (string, symbol, bigint, number, boolean, null, undefined), through Edited: an earlier version of this comment said that |
Five registration sites passed a plain call function as the native
[[Construct]] handler too. A construct then ran the call function and
read its boolean, number or string result as an object. Array.of,
Array.from, every Symbol.species path and Reflect.construct construct
their callee, so this one line killed a release build:
Array.of.call(require("util").types.isDate, 1, 2, 3);
The sites now pass no constructor, so JSC's default throws a TypeError:
- putNativeFn in _NativeModule.h (node:util/types, bun:jsc)
- node:buffer isUtf8, isAscii, transcode and resolveObjectURL
- utf-8-validate
- node:sqlite backup
- Zig::JSFFIFunction::create, which now uses its nativeConstructor
parameter (the native node:os functions), and createForFFI (bun:ffi)
The same remedy as #31393.
c71a08a to
6c4214a
Compare
|
This pull request now covers native functions only. A self-review of the whole diff found that the two halves share no code and have different risks, and that the mock half was the one that held it back. Removed: the
Kept: 5 source files, +10 and -11 lines, and 8 test files. The remedy is the one #31393 and #31219 used: pass no native constructor, so One decision is needed from a maintainer. On main One case stays open. Cost of what remains, measured on release builds of main (36cd151) and of this branch: an With |
|
One correction to the open
The repro for the construct contract is: import { CString, ptr } from "bun:ffi";
Reflect.construct(CString, [ptr(Buffer.from("hi\0"))]);On a debug build this fails This pull request does not change |
|
CI status. The diff is green. CI is red on one file that this pull request does not touch, for a reason on the CI hosts.
The same failure is on main builds 120892, 120896 and 120898. It is reported for both builds above. Nothing in this diff reaches S3 or Docker. Every test file that this pull request touches passed on every lane in both builds: I will not push again to rerun CI. The pull request is mergeable, has no open review thread, and waits on the decision in the description. |
|
Both PRs need the same decision from a maintainer: may a construct form that returns a value today start to throw a
With #44226 alone, |
… and CLI (#46021) ### What does this PR do? Hardening. This collects the open pull requests that fix a crash in Bun into one change, and fixes about 20 more crashes that had no pull request. "Crash" here means a segfault, a Rust panic, an abort, a failed assertion, memory corruption that a sanitizer reports, a native stack overflow, or an exception that ends the process and that the program can't catch. With this PR those cases throw a normal error, print a normal CLI error and exit 1, or just work. 306 pull requests are included: 227 whole, and 79 cut down to the crash fix where the rest was a refactor, a feature or a behavior change. Each one was checked against current `main` first. 45 more turned out to be fixed already, and 17 were duplicates. The full list is at the bottom. #### Crashes you could hit in normal use - **`bun build` with macros and a `.env` file crashed at random.** In a repro with many macro modules, more than a third of the builds crashed. Now 3,000 of 3,000 produce the right bundle. (#45960) - **`bun run` and `bunx` aborted if a signal arrived while the child was being spawned.** (#38926, #45965) - **`bun build --compile ./index.js ./public/*` panicked** if an embedded file's name wasn't valid UTF-8. - **A truncated or corrupted compiled executable** died with SIGBUS or a panic at startup. It now prints an error. (#31787, #38251, #41360) - **Dev server:** several `Option::unwrap()` panics after a failed or deleted import (#38046, #44744, #44746), a segfault when an `onLoad` plugin throws while another bundle is queued, a request that hung and then panicked with `bundle active`, and `server.stop()` that never resolved after a client aborted a waiting request. - **`Bun.serve`:** `server.fetch(url, { headers: new Headers() })` followed by a GC segfaulted (#40888). Routes were used after free after `server.reload()` with `tls.serverName` (#38636). - **`text()` and `json()` on a stream of string chunks** could abort the process, a regression in 1.4.0. (#44269) - **`Bun.Transpiler` with `exports.eliminate` or `exports.replace`** aborted on `export default 1` and on most re-export clauses. (#44137) - **A decorated `declare` field in a class expression** with `experimentalDecorators` panicked. (#38095) - **YAML and JSON5 files with a key that isn't a string** panicked with `--no-bundle` and in `Bun.Transpiler`. (#41827) - **`Bun.FileSystemRouter`:** reading `.params` segfaulted when a rejected route candidate left its parameters behind. (#39290, #39291) - **Native addons that call `uv_async_*`, `uv_timer_*`, `uv_idle_*`, `uv_prepare_*`, `uv_check_*`, `uv_queue_work` or `uv_cwd`** aborted with "unsupported uv function" on Linux and macOS. They're implemented now. (#36609, #39652, #39892) - **`--watch` and `--hot`** panicked when the system was out of inotify instances or file descriptors, or when the reload `exec` failed. They print an error now. (#39629, #39975, #44837) - **Paths longer than the path buffer** panicked in `bun install`, the resolver, the bundler, `--compile`, `tsconfig.json` `paths` and `baseUrl`, `package.json` `main` and `sideEffects`, `bun run --filter`, `bun pm diff`, source maps and snapshots. They're ordinary errors now, or they work. (#36340, #37529, #39104, #39650, #43067) - **A Worker that creates a `ShadowRealm` and imports `node:worker_threads` in it** segfaulted. - **`structuredClone` or `postMessage` of an X25519 key** gave an object that aborted the process when read. (#45624) - **`node:stream` web adapters and `node:http2`** could end the process with an exception that no handler could catch. (#45076, #45975) - **Windows:** a watcher panic in a burst of file changes (#44344), a segfault after the machine resumes from sleep (#33015), crashes in the shell's pipe reader (#39638, #43606), and addons that import from `node.exe` without the delay-load hook (#35618). Most of the rest needs unusual input: strings near the 2 GiB limit, buffers that another thread or a getter resizes or detaches in the middle of a call, `worker.terminate()` at a bad moment, running out of memory or file descriptors, very deep nesting, or hostile arguments to `bun:ffi`, `node:vm` and `bun:sqlite`. #### Behavior changes Things that didn't crash before and behave differently now: - `new` on native functions that aren't constructors throws a `TypeError`, as in Node: `util.types.*`, `buffer.isAscii`, `isUtf8`, `transcode`, `resolveObjectURL`, `bun:jsc` exports, `cc()` symbols. It used to return the call's result. They also stop printing as `[class hostname]`. (#34575) - `` $`cmd` `` throws `ERR_INVALID_ARG_VALUE` if an environment variable's name or value contains a NUL byte. It used to cut the value at the NUL. (#44981) - `cc()` functions throw a `TypeError` for arguments that used to reach C as garbage, and `read.*(ptr, NaN)` throws. (#37989, #38057, #40773) - As PID 1, `bun` exits with 128 + the signal number on Ctrl+C or `docker stop`. (#38877) - A `NODE_MODULE` addon that's already loaded by the main thread throws `ERR_DLOPEN_FAILED` when a live Worker loads it too, as in Node. (#39968) - An exception from a `node:vm` context reaches `uncaughtException` handlers. (#39992) `vm.constants.DONT_CONTEXTIFY` returns the real global proxy. (#34623) - `createPrivateKey` rejects an EC JWK whose private value doesn't match its public point. (#33752) - `@dec static {}` is a syntax error, as in TypeScript and esbuild. (#44883) - `clearTimeout` ignores 0 and negative ids, and timer ids no longer wrap. (#44771) - HEAD for a `Response` whose body is an S3-backed `Blob` reports the length that GET sends. (#44734) - `bun:sqlite` and `node:sqlite`: if `iterate()` left a write unfinished on a connection that has a hook, a user function or an authorizer, the write is finished on the connection's next call instead of during garbage collection. If the database is gone too, it's rolled back. - `bun test --bail` runs exit listeners and closes SQLite databases. (#39010) - Dev server: a request for a client script waits while a bundle is in flight (#42733), query strings reach framework routes (#33232), and a request gets a 500 instead of hanging when plugins fail (#36812). #### File formats - `.jsc` bytecode files get a 24-byte footer so they can be verified before decoding. Files from an older Bun are ignored and the source is parsed instead. (#39396) - `node:vm` `cachedData` gets an 8-byte checksum. A blob from an older Bun is rejected, which the API allows. (#32839) - The built-in modules section of a compiled executable changes from format 1 to 2 and carries an engine stamp. (#44907) #### Performance Measured in instructions per operation on release builds of this branch and its base, with an A/A run for the noise floor (0.0 to 0.2 %). No change: `Bun.serve`, `node:http`, WebSocket echo and publish, `bun build` of 3,807 modules, `bun run` with 2,000 imports, `readdir` / `Glob` / `fs.cp` over 23,689 entries, startup and RSS. The binary grows by 176 KB (0.17 %). | Faster | Instructions | | --- | --- | | WebSocket echo of a 1 MB non-ASCII text message | −72 % | | `Bun.inspect` of a large non-ASCII string | −39 % | | `Bun.markdown.html` on large non-ASCII input | −33 % | | `` $`cmd` `` with 300 environment variables | −6 % | | `fs.readSync` | −5 % | | `TextEncoder.encodeInto`, short ASCII strings | −4 % | | async `crypto.pbkdf2`, 16-byte inputs | −17 % | | Slower | Instructions | Why | | --- | --- | --- | | `cc()` calls | +5 to +51 per call | Argument count and type checks, and a check for `close()` (#37989, #38057, #43802, #44921). `dlopen()` calls don't change | | `process.env.X = v` | 38 → 593 per write | Writes aren't cached. Reads don't change (#38871) | | async `crypto.pbkdf2`, inputs of 1 KB or more | +4 to +9 % | Password and salt are copied (#40554) | | `bun build` with an object `--define` used thousands of times | +4.5 % | The object is copied per use (#45969) | #### Not included - Fixes that need a WebKit change: #39967, #42534, #42982, #43764, #43786, #44226. #42185 too: a typed array that has no `ArrayBuffer` yet can't be pinned, so `view.buffer.transfer()` during an async call can still free its bytes. Creating the `ArrayBuffer` up front costs 7 to 12 % on every async `fs` call, so the fix belongs in JSC: an `ArrayBuffer` created while the view is borrowed should start out pinned. - #45442 (`calc()` sums as a flat list): it changes minified output for real stylesheets to survive a `calc()` with 25,000 terms. It deserves its own review. - #40023 (Windows event loop redesign), #29928 (Windows exit path), #40534, #43963, #39571, #42904, #42834, #36355, #43266: refactors or features whose crash is already covered or isn't a crash. - The pull requests marked *(crash fix only)* below should stay open for their other half. ### How did you verify your code works? - **Tests.** Every fix has a test that fails on `main` (a release or an ASAN build) and passes on this branch, except where that isn't practical: code that only runs on Windows or macOS, inputs that need several GB of memory, and a few rare races. Those were checked by hand or by reading. - **Stored repro scripts.** 230 crash repros ran on release and ASAN builds of this branch and of `main`, side by side. Release: 88 no longer crash. ASAN: 106 no longer crash. None crashes that didn't before. What still crashes needs WebKit, is SQLite's own bug, or isn't a crash. The ASAN number is from a later commit than the release number. - **Dev server.** Because one fix makes requests wait, 2,171 generated programs ran random interleavings of edits, build errors, failing plugins, reloads, stops and disconnects with about 120,000 requests. No request hung, was answered twice or got a stale body. `main` hung in 82 of 1,161 programs. This also found the four dev server bugs listed above. - **Path helpers.** 336,000 boundary cases with buffers of exactly the computed size, and 12,003 random calls through 30 JS APIs on an ASAN build, compared with `main`. No sanitizer report, and the results match wherever `main` doesn't panic. - **What worked on 1.4.3 still works.** Reviewers compared behavior with 1.4.3 and took out what changed it: for example an output directory layout change for 9 or more entry points, a `server.reload()` change, and a changed error message for `import("file:///50%deposit.ts")`. - **Not run locally:** the Windows, macOS and FreeBSD code paths. CI compiles and tests them. ### Included pull requests **Bundler, transpiler, CSS, macros** (33) - #33881 bundler: allocate wrapper_ref for CommonJS modules with no non-hoistable statements - #35055 Bun.build plugins: handle filter RegExp flags beyond i/m/v - #37769 bundler: fail the build instead of panicking when the bundle thread cannot create its waker - #37784 bundler: copy inlined env values into the define arena, and give each Bun.build its own env copy *(crash fix only)* - #37858 bundler: fail the build instead of panicking when a plugin answer string cannot be converted - #38046 bun build --server-components: require the bun target and reject directives without a framework *(crash fix only)* - #38095 js_parser: fix panic on decorated declare/abstract fields in class expressions with experimentalDecorators - #38966 bundler: keep deep CSS, export star and composes graphs from overflowing the linker's stack - #38984 bundler: stop an export star ambiguity that loops back into a re-export chain from overflowing the stack - #39113 css: reject stylesheets of 2 GiB or more instead of aborting on an int cast - #39396 bundler: frame .jsc bytecode sidecars and verify them before decoding - #39855 bundler: join the work still on the pools before the bundle is torn down *(crash fix only)* - #41157 dev server: leave out an html link to a cached json module instead of panicking, and mark a new placeholder file stale - #41801 css: decode ill-formed UTF-8 to U+FFFD before tokenizing *(crash fix only)* - #41827 bundler: handle YAML and JSON5 keys that are not strings instead of panicking - #42242 js_parser: compress symbol link chains when following merged declarations - #42387 bundler: check receivers on the Bun.build plugin object and freeze its filters during a build - #42413 Bounds-check the InternalSourceMap window reader - #42657 macros: keep visited values alive so a reused address does not get another value's Expr - #43330 transpiler: do not print an empty `var` for a data file with no named export - #43355 bundler: fix "The memory limit has been exceeded." on large HTML entries - #43658 react-compiler: fix skipped functions and build aborts for dead code in a try body *(crash fix only)* - #44137 js_parser: fix four crashes of exports.eliminate and exports.replace - #44467 js_parser: replace skipped expressions with E::Missing and skip argument checks after a stack overflow - #44662 js_parser: walk binary chains on the heap and check the stack when rewriting decorated #private accesses - #44712 json5: reject sources of 2 GiB or more before parsing instead of aborting on an int cast - #44864 js_parser: walk conditional chains in import()/require() and define keys in a loop - #44883 js_parser: reject a decorator on a class static block, keep decorators out of the body of `declare global` *(crash fix only)* - #45045 Fix a segfault in new Bun.Transpiler(): re-point options.log after the constructor moves its Log - #45604 css: keep a url() in an at-rule prelude as written, and never print the resolved path of a url() *(crash fix only)* - #45748 bundler: put --banner/--footer in the bytecode ESM module record (flags from a parse, entries from JSC) *(crash fix only)* - #45960 macros: give each parse-worker macro VM its own env loader - #45969 js_parser: copy object and array defines per use, and copy the list of a lone JSX spread object *(crash fix only)* **`bun build --compile` and standalone executables** (3) - #31787 Don't crash at startup when a standalone executable's embedded graph is corrupted *(crash fix only)* - #38251 compile: exit with an error instead of SIGBUS when a standalone executable is truncated - #41360 standalone: check every offset in the embedded module graph before reading it **Resolver, module loading, plugins, paths** (25) - #32269 Bun.plugin: validate the namespace without a shared regex - #33183 bun:jsc: filter internal cells out of getProtectedObjects() - #34575 Don't register native functions as their own constructors - #36340 paths: size the thread-local join output buffers to MAX_PATH_BYTES on Windows - #37037 mock.module: reject async factory results that are not objects - #37065 bun:jsc: propagate JSONParse exceptions from samplingProfilerStackTraces - #37529 resolver: don't abort on a package.json sideEffects entry longer than the join buffer - #38179 node:module: throw instead of crashing when module._compile is set to a non-function - #38273 bun test: report a test file or preload the loader cannot resolve instead of exiting; keep the JUnit report valid U… *(crash fix only)* - #38732 paths: compute the common path of 9+ inputs with the same loop as fewer *(crash fix only)* - #39228 paths: strip C:\\ down to the drive root in without_trailing_slash_windows_path *(crash fix only)* - #39650 bun run --filter: stop panicking on workspace paths longer than the path buffer - #40186 resolver: stop deeply nested exports targets from overflowing the stack - #40258 resolver: publish Entry.abs_path through the per-entry mutex - #42183 node:module: reject a _resolveFilename override result that contains a null byte - #42401 node:module: accept any `this` in Module.prototype.require *(crash fix only)* - #42405 Bun.plugin: transpile a copy of typed array onLoad contents - #42414 node:module: end the Module._stat path at the first null byte - #42685 resolver: strip the trailing separator inside bust_dir_cache - #42735 Throw a RangeError instead of aborting when require.resolve paths or Worker preload outgrows its Vector - #43067 Report a path that does not fit a path buffer instead of aborting *(crash fix only)* - #44410 Fix a crash when code from a node:vm context reads require.cache or require.extensions - #44466 Trace the value an object or data module exports from its JSSourceCode - #45044 Bun.plugin: give onLoad's args.path its own bytes - #45117 cjs: do not call an `__esModule` getter during the annotation lookup **Dev server, `bun bake`, routers, `--watch` and `--hot`** (28) - #28793 Stop file watcher thread before Global.exit tears down memory *(crash fix only)* - #32143 bake: fix "Runtime file not found" panic in production builds of custom frameworks - #32443 watcher: don't free the Watcher in the spawn-to-start window *(crash fix only)* - #33232 bake: normalize the HTTP request-target before matching framework routes - #36812 bake: respond 500 and release both RequestContext refs when on_plugins_rejected / OOM drains a deferred framework r… - #37039 bake: report per-file print failures in the dev server instead of serving empty modules - #37276 hot_reloader: take entries_mutex for watcher-thread directory cache probes - #37444 bake: unregister Bake::SourceProvider from the source map table when it is destroyed - #39290 FileSystemRouter: match / against a root-level optional catch-all route *(crash fix only)* - #39291 FileSystemRouter: order dynamic routes by per-segment precedence like Next.js *(crash fix only)* - #39629 watch: report a failed watcher init as an error instead of a crash - #41185 bake: check for exceptions in the production build's module loader hooks and helpers - #41340 bake: skip the directory watch when the directory cannot be opened - #41617 Decide a directory watch event from the watchlist, not from the resolver's cached listing *(crash fix only)* - #42547 bake: re-arm the memory visualizer timer when it fires - #42733 dev server: make a client script request wait for the bundle in flight - #42828 bake: serve routes from a router root outside the project root instead of aborting or answering 404 - #42831 bake: resolve app.root and router roots through one checked join - #42836 bake: report route scan errors instead of aborting, and fail bun build --app on them *(crash fix only)* - #42840 dev server: map a router type's server entry point to the root route of that type - #42862 Bun.serve: return before a pending app.plugins setup() settles *(crash fix only)* - #42920 Do not create a mimalloc heap per FileSystemRouter, reload() or :nth-child(An-B) selector - #42934 dev server: register a client component without evaluating it - #43329 dev server: check the route bundle index of a client script URL before Index::init - #44249 fs.watch: read each directory and close it before descending - #44344 Windows: fix a watcher panic and lost events in a burst of file changes, and a --hot that stops watching a deleted… - #44744 dev server: answer a cached-file lookup only for a graph that bundled the file - #44746 dev server: keep an importer in its own graph when an import fails or is deleted **`Bun.serve`, sockets, HTTP, WebSocket, HTTP/2, QUIC, DNS** (28) - #42667 Reland "usockets(windows): keep a closed poll alive until the outer tick and libuv are done with it" (#39643) - #33015 fix(windows): segfault in uv__wake_all_loops after system resume *(crash fix only)* - #35761 node:quic: detach lsquic ctx pointers before the finalize-order sweep at worker VM teardown - #37082 Bun.serve: terminate FIFO/pipe file responses at EOF - #38024 dns: keep the c-ares uv_poll_t alive while its poll callback is on the stack (Windows) - #38636 serve: fix route use-after-free after reload() with tls.serverName *(crash fix only)* - #40888 server.fetch: copy a Headers argument instead of adopting the wrapper's pointer - #41337 Update lsquic to 4.9.4 and free unsent stateless resets on destroy *(crash fix only)* - #41384 usockets: hold a tick level for the whole of close_all - #41412 Windows: wait for close completions when closing a worker's uv loop - #41516 node:http2: handle an empty byte range in respondWithFile and respondWithFD - #41521 udp: report every binaryType from the getter, reject a dgram bind of the other family *(crash fix only)* - #42188 net: do not assert a two-character host in SocketAddress.parse - #42210 libuv(windows): keep a pipe's completed read counted until its read callback returns - #42334 fetch, Bun.serve: throw a RangeError for Headers that total 4 GiB or more *(crash fix only)* - #43738 usockets: close a socket whose resume the kernel refuses from the loop, not from the caller - #44338 node:http: response trailers travel with the end call of the response *(crash fix only)* - #44433 bake: make the parked-request list non-owning and look up the DevServer when a plugin load settles - #44533 node:quic: capture the handshake while the conn is alive, set the application at session creation - #44734 Bun.serve: answer HEAD for an S3-backed Blob body without an S3 stat - #44751 node:quic: close() waits only for opened streams, and lsquic sends no GOAWAY before HTTP/3 starts *(crash fix only)* - #44897 node:http2: throw instead of panic when the native setNextStreamID() misses its argument - #45076 node:http2: let close() and destroy() win over the refusal of a request - #45341 uws: AsyncSocket::write takes a size_t length, so res.end() sends a body of 2 GiB or more whole - #45522 node:http2: throw for an ALTSVC frame that is too long and for a pushPromise id that is not a stream id - #45676 node:quic: do not reset a stream lsquic has already finished - #45822 node:quic: name a stream in queued session events by a per-session key, not by its address - #45858 Bun.serve WebSocket: a message that does not fit in memory fails one connection, not the server *(crash fix only)* **Streams, Blob, S3, files, `node:fs`** (28) - #33845 io: propagate IoRequestLoop init failure instead of aborting *(crash fix only)* - #36365 prompt: drop debug_assert that rejects answers containing CR - #37090 Deliver FIFO bodies whose writer connects after the reader opens *(crash fix only)* - #38039 node:fs: stop fs.copyFile(src, "") from segfaulting on Windows - #38653 shell(cp): reject copying a directory into itself; walk cp trees without recursion - #39207 Convert scope-object receivers in the chaining functions and inspect.custom fallbacks - #39390 Blob deserialize: reject over-long paths, treat size >= MAX_SIZE as unknown, make slice() non-panicking - #39639 fetch: drop the upload and drain hop refs at VM teardown *(crash fix only)* - #40008 inspect hooks: copy user options with putDirectMayBeIndex *(crash fix only)* - #40462 Windows: FileSink.start({ path }) on a live writer: hand the writer a libuv fd and close the old source *(crash fix only)* - #41440 node:fs: pass the buffer to the read/readv/write/writev callback on error - #41584 Walk the timer pairing heap without recursion - #41608 native-readable: accept a stream with no native handle - #41710 JSSink write(): convert the chunk before resolving the native sink *(crash fix only)* - #42711 webstreams: bound the native recursion through a chain of tees or text streams - #43264 fetch: reject a file: URL whose path has an encoded NUL - #43709 s3: fix double free of a multipart part's bytes on worker terminate - #43950 streams: link readers and writers last, reject their promises as handled - #44036 PipeReader: label a chunk Eof only when the reader is at its end - #44181 streams: throw instead of aborting when a direct stream's text sink cannot take a string chunk - #44195 fs: validate POSIX directory records in one parser, report a malformed record as EIO *(crash fix only)* - #44269 streams: join the string chunks of a text consumer with one allocation - #44490 watch(windows): report a failed child spawn as an error instead of a panic *(crash fix only)* - #44954 process.stdout/stderr with no FileSink: write synchronously, reset after a failed write *(crash fix only)* - #45004 streams: leave a stream alone when a consumer fails to lock it - #45521 FileSink: throw ERR_ILLEGAL_CONSTRUCTOR from the constructor that script reaches by writer.constructor - #45738 s3: own the Blob store across the calls that run user JS - #45975 node:stream: do not touch the web controller after the web side is done **Node-API, V8 API, `bun:ffi`, `process.dlopen`** (15) - #36609 napi: implement uv_cwd on POSIX - #37989 bun:ffi: stop cc() from turning non-numeric pointer arguments into garbage pointers - #38057 bun:ffi: make cc() reject non-numeric i64/u64 arguments instead of passing garbage - #38425 bun:ffi: throw on an empty cc() source array instead of panicking - #39652 napi: implement uv_async_t, uv_queue_work and uv_default_loop on posix - #39805 Share one handle scope implementation between Node-API and the V8 API - #39892 napi: implement uv_idle_t, uv_prepare_t, uv_check_t and uv_timer_t on posix - #40144 bun:ffi: return undefined for a NULL napi_value from cc() and throw the scheduled napi exception - #40773 bun:ffi: add the full byteOffset in read.*, do not truncate it to int32 - #41704 napi: hand the thrown value to napi_get_and_clear_last_exception after napi_run_script - #42960 process.dlopen: run a V8 addon's init function after dlopen() returns - #43797 Fix debug assertion on an empty error message from a V8 addon or SQLite *(crash fix only)* - #43802 bun:ffi: throw a TypeError when a cc() symbol is called after its library's close() - #43940 napi: fail with ERR_BUFFER_TOO_LARGE instead of aborting above the ArrayBuffer limit *(crash fix only)* - #44921 bun:ffi: pad a short call to a cc() symbol with undefined **`node:vm`, workers, process, timers** (19) - #34623 node:vm: run DONT_CONTEXTIFY contexts directly against the real global - #32839 node:vm: reject invalid cachedData instead of crashing - #36921 error printer: clear the pending exception when formatting a non-Error uncaught value throws - #37270 error printer: one render per error, [Circular] under the key that closes the cycle - #38740 bun:test: give each VM its own fake clock *(crash fix only)* - #39864 Report a refused HTTP, bundle, IO or process waiter thread as an error instead of a crash *(crash fix only)* - #39992 process: deliver exceptions reported against a node:vm context to uncaughtException - #41654 node:vm: give each SourceTextModule request the import attributes of the declaration that created it *(crash fix only)* - #41739 Do not forward the inherited IPC channel to spawned scripts and tools - #41769 node:vm: stop compiling accepted cachedData, report each cachedData decode to the GC *(crash fix only)* - #42045 bun:test fake timers: never move the fake clock backwards - #42308 process.execve: throw instead of aborting for a string past the string limits - #42734 node:vm: report cachedData of 2 GiB or more as rejected instead of aborting - #42843 process.dlopen: reject a filename of PATH_MAX or more before dlopen() - #43500 process: accept SIGSTKFLT, SIGPOLL and SIGPWR, and emit every name of a signal number *(crash fix only)* - #44486 worker: stop the start sequence when a handler it calls stops the worker - #44771 timers: allocate ids from one 64-bit counter that never wraps - #44837 --hot: defer a reload during the preloads, and report a reload that cannot start - #44991 Fix a use-after-free in the VM ref-string intern for a string over the length limit **Shell, spawn, CLI, `bun test`, `bun install`** (31) - #30642 Fail fast at startup when simdutf has no usable implementation for this CPU - #34223 Fix four crashes: HTMLRewriter disturbed body, S3 locked-stream upload, ConnectionsList closed parser, shell brace… *(crash fix only)* - #34884 Guard the console and test-runner formatters against native stack overflow on deeply nested values *(crash fix only)* - #36584 process.chdir: publish an immutable cwd slice so no thread sees a torn cwd - #37135 bun test --parallel: hold the JSC API lock while draining the worker's final IPC backlog - #37527 shell(mv): report ENAMETOOLONG instead of panicking when a source name does not fit the path buffers - #37528 cli: stop aborting on absolute script paths longer than 1024 bytes on Windows - #38162 shell(cp): report ENAMETOOLONG instead of panicking on operands longer than the path buffers - #38205 shell(windows): report ENAMETOOLONG for operands that do not fit the path buffer - #39010 bun test: exit through the VM teardown path when --bail stops a run - #39104 bun test: report over-long coverage dir, JUnit outfile and bunfig root instead of panicking *(crash fix only)* - #39638 shell(cat): serve a second cat on the same stdin instead of hanging or panicking - #39641 usockets: report an out-of-descriptors event loop init as an error, not a crash *(crash fix only)* - #40181 shell: stop deeply nested if clauses from overflowing the parser stack - #40885 shell: throw instead of panicking when a ReadableStream is used as a redirect - #41155 ipc: send a queue item larger than 2 GiB in capped write requests - #42298 bun:test: print String objects with 16-bit storage correctly - #42577 bun:test: root the return values toHaveReturnedWith collects - #43606 shell(windows): report a failed pipe reader start through on_reader_error instead of leaking the subprocess *(crash fix only)* - #43838 node:cluster: read a worker's `ack` and `addressType` in the primary only when they are int32 - #44172 node:cluster: refuse a descriptor of the wrong kind in the primary *(crash fix only)* - #44185 node:cluster: one handle for each descriptor that workers name *(crash fix only)* - #44491 bun test: run every callback when native code leaves an exception pending *(crash fix only)* - #44694 shell mv: refuse to copy a directory into itself on the cross-device fallback - #44752 shell: take the command-substitution capture and drop its NUL bytes - #44981 shell: reject NUL bytes in .cwd() and .env() at the native setters - #45206 ini: reject a source of 2 GiB or more in Parser::parse instead of aborting on an int cast *(crash fix only)* - #45348 bun test: fix a segfault in .not.toThrow(Class) when Symbol.hasInstance accepts a thrown string, symbol or BigInt - #45649 shell: replace the output counters in mkdir, cp, ls and touch with the OutputTask queue - #45792 bun test: SIGKILL a spawnSync child that is still running 500 ms after the test's timeout *(crash fix only)* - #45910 create: own the remote-template response buffers instead of parking them in the CLI arena **Web APIs, Buffer, encoding, URL, crypto, zlib, SQLite, Redis and the rest** (96) - #29709 console: guard JSX/Proxy recursion in Bun.inspect (stack overflow SIGSEGV) - #30817 console.takeHeapSnapshot: clear prior snapshots before building - #30956 spawnSync: make signal-forwarding register/unregister safe for concurrent callers *(crash fix only)* - #31505 node:zlib: reject invalid brotli flush values at validation *(crash fix only)* - #31735 node:path: fix win32 drive-relative resolve on non-Windows hosts *(crash fix only)* - #32085 Fix crash when RedisClient onclose/onconnect is set to a non-callable - #32240 Fix BroadcastChannel custom inspect crash with numeric option keys - #33181 Reject interior null bytes in Bun.mmap, Glob.scan, and FileSystemRouter paths *(crash fix only)* - #33752 node:crypto: validate EC JWK private scalar matches public point in createPrivateKey - #34976 spyOn: install and restore through one writer that throws when the object refuses *(crash fix only)* - #35562 structuredClone: purify NaN in deserialized Date timestamp so getTime never returns a forged JSValue - #35618 napi(windows): load addons that import node.exe without win_delay_load_hook - #35757 Coerce later arguments before capturing input buffers in Bun.Transpiler and Bun.RedisClient - #37252 Report UTF-16 to UTF-8 encode counts through size_t so exactly 2^32 written bytes doesn't wrap to 0 - #37338 node:module: build require.cache without user-writable globals and propagate its exceptions *(crash fix only)* - #37340 redis: accept unsubscribe acks that arrive outside subscriber mode - #37370 Error.appendStackTrace: make appending an error's trace to itself a no-op - #37443 node:crypto: fix null deref when worker.terminate() lands during an EC JWK private key import - #37448 jsc: check for exceptions before using a stored constructEmptyArray result *(crash fix only)* - #38009 MessagePort: fix a heap-use-after-free in contextDestroyed(), release ref() when the last 'message' listener is rem… *(crash fix only)* - #38469 napi: settle or refuse async work queued during VM teardown instead of taking a ticket - #38708 Handle 16-bit module sources in the error preview, the new-position fix-up and the REPL *(crash fix only)* - #38821 process.env: make a failed env build throw instead of aborting (Windows 0xC0000409 on Bun.$ / Bun.sql / process.env… - #38871 process.env: coerce to string on every execution of an assignment, not just the first - #38877 cli: exit 128 + signo when bun cannot die from a re-raised signal (bun as container PID 1) - #38926 Clear the inherited signal mask at startup and exec children with an empty one *(crash fix only)* - #39382 Make a failed util.inspect load throw from custom inspect functions instead of aborting - #39481 Always create the error when a native error message exceeds the string length limit - #39651 performance: keep the user timing entry counts exact after clearMarks(name) and clearMeasures(name) - #39775 Turn seccomp SIGSYS traps into ENOSYS so the syscall fallbacks run on Android - #39968 process.dlopen: replay a non-context-aware V8 addon only while no other live VM owns it - #39975 watch: report a failed reload exec as an error instead of a panic *(crash fix only)* - #40346 Give Glob's native scan methods their own private names - #40554 node:crypto: copy password and salt for async pbkdf2 and scrypt - #40567 url: reject URL-encoded input over the WTF decode limit instead of aborting - #40577 url: throw a RangeError instead of aborting when URLSearchParams or FormData outgrows its Vector - #41073 Store array-index property names as indexed properties in native object builders - #41137 Write the sampling profiler report at exit from Bun, not JSC's atexit hook - #41365 webview: fail only the view when WebKit lacks initWithDirectory: - #41574 Decode a private copy of a JS buffer in the UTF-8 decoders *(crash fix only)* - #41652 console: read a BigInt depth option by value in console.dir - #41749 Startup: reopen fd 0-2 as /dev/null only when the fd is closed - #41819 Report an incoherent BUN_JSC_* option combination as a configuration error, not a crash *(crash fix only)* - #42158 webview: reject malformed Chrome replies instead of crashing - #42179 shell: clamp a `> ${buf}` redirect to the target buffer's live length - #42187 node:crypto: throw ERR_OUT_OF_RANGE for >2 GiB buffer arguments instead of aborting - #42191 URLPattern: throw instead of aborting when a pattern string passes the string limit - #42192 Copy WebAssembly.Memory bytes for native borrows that outlive the call *(crash fix only)* - #42198 Make Bun.$, Bun.sql, Bun.postgres and Bun.SQL custom value getters so reifying the Bun object passes exception chec… - #42203 node:fs: fs.read into a WebAssembly.Memory view writes into the block a grow freed - #42214 Headers: throw a RangeError instead of aborting when the set-cookie list cannot grow - #42218 Headers: throw instead of aborting when a value passes the string length limit - #42220 URLPattern: throw instead of aborting when the token list cannot grow - #42225 Throw ERR_STRING_TOO_LONG from Bun.wrapAnsi instead of aborting when the output passes the string length limit - #42226 Throw instead of aborting when a MIME string does not fit in a string *(crash fix only)* - #42237 Bun.Cookie: throw instead of aborting when the Set-Cookie string passes the string length limit - #42249 Copy a shared input before libdeflate compresses it in Bun.gzipSync and Bun.deflateSync - #42253 bun test: walk nested describe scopes without native recursion - #42259 Throw instead of aborting when a domainToASCII host passes the string length limit - #42310 Parse a private copy of a shared or resizable buffer in Bun.Transpiler, Bun.markdown, Bun.YAML and Bun.TOML *(crash fix only)* - #42312 YAML, JSON5, XML stringify: throw instead of aborting when the output passes the string length limit - #42318 Bound libdeflate's emit path so a racing input cannot overrun the output - #42338 inspector: check the type of process.argv in getModuleGraph - #42364 node:perf_hooks: do not truncate the monitorEventLoopDelay resolution to int32 - #42412 transpiler cache: reject an entry with no sourcemap section - #42479 worker_threads: do not abort when markAsUntransferable/markAsUncloneable gets a WebAssembly GC reference - #42517 EventTarget: skip a listener object that has no realm - #42518 fs.Stats: make the date accessors define the property like Object.defineProperty *(crash fix only)* - #42575 Stop natives from writing onto a foreign `this` with putDirect: process.ppid, require.cache, StringDecoder, the nat… *(crash fix only)* - #42631 JSStringView: pin the cell that owns the borrowed characters - #42660 bun_core: read /dev/urandom when getrandom(2) answers ENOSYS or EPERM - #42780 node:crypto: treat a name too long to convert to UTF-8 as unknown instead of aborting - #42782 node:crypto: throw ERR_OUT_OF_RANGE for a passphrase larger than INT_MAX bytes - #42856 url: do not abort when a host is too long for the IDNA conversion buffers - #42868 sqlite, console, process: do not abort on a string too long to convert to UTF-8 *(crash fix only)* - #42941 Bun.sliceAnsi: throw instead of aborting when the result passes the string length limit - #43058 Bun.serve: fix crash and cross-request 500 when inspecting a non-Response return value throws - #43904 JSC bindings: build property keys from a BunString through Bun::toIdentifier - #44124 Bun.Image: decode WebP into a Bun-owned canvas and read ICCP without the demuxer *(crash fix only)* - #44190 Convert scope-object receivers before Buffer read*/write* and vm.Script describe them - #44211 Stop getsockname(out), useFakeTimers() and the stream source pull() from writing onto a caller's object with putDirect - #44295 bun test --coverage: append a final newline to a text that lacks one *(crash fix only)* - #44360 rust-argon2: return OutOfMemory instead of aborting when the memory cost cannot be allocated - #44421 node:zlib: free zstd's workers before the dictionary they read - #44521 util.parseArgs: pick the default args start from a per-VM eval flag, as Node v26 does *(crash fix only)* - #44740 structured clone: tolerate a zero-sized shared WebAssembly.Memory in computeMemoryCost() - #44759 HTMLRewriter: park a suspended handler's token before the output flush - #44907 Builtins section format 2: an engine stamp says which buns compile its modules - #45188 Reject an oversized WebCrypto cipher output instead of aborting - #45354 Throw for a `file:` URL whose path is not UTF-8 on Linux and macOS, through one `fileSystemPath()` accessor *(crash fix only)* - #45608 ipc: refuse an over-long message before the receive buffer stores it - #45624 webcrypto: write the key type into the X25519 structured-clone record - #45625 node:sqlite: refuse session.close() and Symbol.dispose inside a SQLite callback - #45653 glob: a group with `?` or a class matches when an alternative takes 64 bytes or more - #45820 Bun.file, S3Client.file and Bun.write no longer keep a buffer path alive forever - #45832 `bun check`: fix a panic on `export *` without a module specifier, and a false error for one in parentheses ### Already fixed on `main`, or duplicates of a pull request above Already fixed: #27323 #30401 #31011 #31206 #31566 #31626 #31695 #31702 #31945 #32773 #34154 #34697 #34744 #34964 #35655 #35816 #36020 #36181 #36296 #36342 #36581 #36602 #36807 #36818 #36857 #37172 #37235 #37239 #37267 #37420 #37731 #37914 #38113 #38119 #38509 #38514 #38540 #38975 #39410 #40749 #41163 #41171 #42108 #43085 #43230 Duplicates: #45654 #29986 #33378 #36895 #37070 #37639 #38014 #39021 #41266 #42250 #42951 #43238 #44259 #45335 #45565 #45726 #45965 Fixes #5019 Fixes #6106 Fixes #10690 Fixes #10886 Fixes #13566 Fixes #14745 Fixes #15551 Fixes #20454 Fixes #21310 Fixes #29145 Fixes #30454 Fixes #30613 Fixes #30766 Fixes #32103 Fixes #32142 Fixes #32183 Fixes #32212 Fixes #39060 Fixes #42296 Fixes #42931 Fixes #43671 Fixes #44201 Fixes #44735 Fixes #44783 Fixes #45198 Fixes #45327 Fixes #45491 Fixes #45721 --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
|
This is Claude (an AI assistant) commenting on Jarred's behalf. This fix went in with #46021, which is merged. Closing. |
Fixes #32103
Problem
panic(main thread): Segmentation fault at address 0xA. Asserts build:ASSERTION FAILED: isCell(),JSCJSValue.h:766.[[Construct]]handler, so a construct reads a primitive as an object. The widest isputNativeFn(src/jsc/modules/_NativeModule.h), 81 exports.[class hostname](OS Module os["class"] gives wrong output #32103).Fix
newthrowsTypeError:putNativeFn, fournode:bufferfunctions,utf-8-validate,node:sqlitebackup, andJSFFIFunction::createandcreateForFFI(node:os,bun:ffi).test-util-types.test.jsandos.test.jsexit 134 withsrc/at main. Alsoffi,bun-jsc,buffer.Background
[[Construct]]handler must return an object, which JSC does not check.Array.of,Array.fromandSymbol.speciesconstruct the callee.prototypeon each.Downsides
newon these functions returned the call's result on main and now throws. fix(buffer): use correct constructor forbuffer.isAscii#22480 kept theisAsciiconstructor as the less breaking choice. Five return an object undernewon main and in Node, for exampleos.loadavg.bun:ffiCStringis not changed.Array.from.call(CString, [1, 2, 3])still aborts. Its constructor returns a string by contract.isDatecall takes 639.0 instructions and.textis 58,143,989 bytes on both builds.Notes
What changed in this revision. This pull request also carried a construct handler for
bun:testmocks and themock.instanceschange. #41398 covers both, so they are removed here. The removed commit is kept on the branchrobobun/e9fbc481/mock-construct-half(13cae76).Array.of.call(mock(), 1, 2, 3)keeps its segfault until a mock change lands.The decision to make. On main
new f()on these functions runs the call function and evaluates to its result:new os.hostname()is a string,new buffer.isAscii(buf)is a boolean,new os.loadavg()is the array. #22480 noted that removal of theisAsciiandisUtf8constructors "would be more breaking than correcting the current bug" and addedexpect(new isAscii(...)).toBeFalse()totest/js/node/buffer.test.js. This pull request changes that line to expect aTypeError. #31393 made the opposite choice formodule._compile,Module._resolveFilename,Module.runMainandperformance.now. The five functions that return an object undernewon main and in Node v26.3.0 areos.loadavg,os.userInfo,os.networkInterfaces,buffer.transcodeandsqlite.backup.Node v26.3.0, which functions
newaccepts. Checked withReflect.construct(Object, [], f):os.freemem,release,totalmem,versionosfunctionsbuffer.isUtf8,isAscii,transcode,resolveObjectURLsqlite.backuputil.types.*Node writes those 27 functions in JS, so they are ordinary functions there. In Node
new os.hostname()returns an emptywrappedFnobject andArray.of.call(os.hostname, 1, 2, 3)returns that object with0,1,2andlengthset. On main the first returns the string and the second aborts.bun:ffiCString.docs/runtime/ffi.mdxsaysnew CString()returns a normal string, andconstructFFICString(src/jsc/bindings/JSFFICString.cpp) returns one. So it cannot drop its constructor, and this pull request does not change it. A release build of main (367d939d9a) aborts onArray.from.call(CString, [1, 2, 3])and on aSymbol.speciesfilter. A debug build also fails theasObjectassertion onReflect.construct(CString, [ptr(buffer)]). The release build returns the string there.Array.of.call(CString, 1, 2, 3)segfaults at address 0x3 for a different reason:Array.ofconstructs with the length3, andCStringreads3as a pointer.How the numbers were measured. Release builds of main
36cd1514ecand of this branch6c4214a189, same machine.perfandvalgrindare not available in the build container (perf_event_openreturnsEPERM), so instructions were counted with aptracesingle-step counter: it runs the process at full speed to a marker syscall, single-steps the main thread to a second marker, and counts the steps.BUN_JSC_useJIT=0, 500 warm-up calls,Bun.gc(true), then the window. A per-call figure is the difference between windows of 1000 and 3000 calls, divided by 2000.util.types.isDate(date), window of 1000 / 3000 callsbuffer.isUtf8(buf), window of 1000 / 3000 callssize: text, data, bssOther open pull requests. #43802 rewrites
createForFFIand passestrampolineas the constructor again. Thecc()test that this pull request adds toffi.test.jsfails on that line.Local test runs on a debug ASAN build, on a machine with a load average above 400.
test-util-types55 pass,os56 pass,bun-jsc42 pass,utf-8-validate2 pass,buffer-resolveObjectURL4 pass,buffer683 pass.node-sqlitehas 4GC stresstests that time out, andffihas 10integer identitiestests that time out at 5 s.GC stress > TagStore LRU churntimes out the same way withsrc/at main. The three tests added toffi.test.jspass.no test proof · iteration 24 · platform-specific test(s) that do not run on this machine, deferring to CI, which covers all platforms: test/js/node/sqlite/node-sqlite.test.ts, test/js/node/os/os.test.js, test/js/node/buffer.test.js, test/js/bun/jsc/bun-jsc.test.ts, test/js/bun/ffi/ffi.test.js