-
Notifications
You must be signed in to change notification settings - Fork 4.7k
node:zlib: pin _writeState buffer so transfer() can't free it mid-work #31206
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alii
wants to merge
6
commits into
main
Choose a base branch
from
ali/zlib-arraybuffer-pin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7ff6f71
node:zlib: pin _writeState buffer so transfer() can't free it mid-work
alii a07804b
[autofix.ci] apply automated fixes
autofix-ci[bot] 4ce66c2
node:zlib: keep the pinned _writeState in a GC-visited slot
robobun a646e74
test: move _writeState transfer coverage into zlib-writestate-transfe…
robobun 5388cfa
test: run _writeState transfer tests concurrently
robobun 6bacf38
node:zlib: sync _writeState keep-alive comments with the pinned+roote…
robobun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| // The native zlib/brotli/zstd handle caches a raw pointer into `_writeState`'s | ||
| // backing store at init() and writes two u32s through it on every async-write | ||
| // completion. Detaching that backing store while a write is in flight must not | ||
| // leave the native side writing through a stale pointer — the buffer is pinned | ||
| // (and kept in a GC-visited slot) for the handle's lifetime so transfer() | ||
| // becomes a copy and the stream still produces correct output. | ||
|
|
||
| import { describe, expect, it } from "bun:test"; | ||
| import { bunEnv, bunExe } from "harness"; | ||
|
|
||
| describe("_writeState buffer lifetime", () => { | ||
| // Run in a subprocess because an unpinned build corrupts stream bookkeeping | ||
| // (or faults) rather than throwing. | ||
| it.concurrent.each([ | ||
| ["Inflate", "deflateSync", "createInflate"], | ||
| ["BrotliDecompress", "brotliCompressSync", "createBrotliDecompress"], | ||
| ["ZstdDecompress", "zstdCompressSync", "createZstdDecompress"], | ||
| ])("%s decompresses correctly when _writeState.buffer is transferred mid-write", async (_, compress, create) => { | ||
| const script = ` | ||
| const z = require("zlib"); | ||
| const raw = Buffer.alloc(65536, 0x41); | ||
| const d = z.${compress}(raw); | ||
| const s = z.${create}({ chunkSize: 65536 }); | ||
| const out = []; | ||
| s.on("error", e => { console.log("err:" + e.message); process.exit(1); }); | ||
| s.on("data", c => out.push(c)); | ||
| s.on("end", () => { | ||
| const r = Buffer.concat(out); | ||
| if (r.length === 65536 && r.equals(raw)) console.log("OK"); | ||
| else console.log("BAD len=" + r.length); | ||
| }); | ||
| s.write(d); | ||
| s._writeState.buffer.transfer(0); | ||
| s.end(); | ||
| `; | ||
| await using proc = Bun.spawn({ | ||
| cmd: [bunExe(), "-e", script], | ||
| env: bunEnv, | ||
| stderr: "pipe", | ||
| }); | ||
| const [stdout, stderr, exitCode] = await Promise.all([proc.stdout.text(), proc.stderr.text(), proc.exited]); | ||
| expect(stderr).toBe(""); | ||
| expect(stdout.trim()).toBe("OK"); | ||
| expect(exitCode).toBe(0); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.