-
Notifications
You must be signed in to change notification settings - Fork 5.1k
test(node:fs): speed up and fix the AbortSignal leak detector #36206
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
robobun
wants to merge
8
commits into
main
Choose a base branch
from
farm/ac263b55/speedup-fs-abortsignal-leak-test
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
8 commits
Select commit
Hold shift + click to select a range
304d67a
test(node:fs): speed up and tighten the AbortSignal leak test
robobun ca4226f
drop the now-vacuous RSS cap; settle at 2,000 iterations
robobun 4090c23
make the heapStats check actually detect the leak; drop the timeout
robobun 0ff4d9c
un-quarantine the test on ASAN lanes
robobun 6ae0d7c
ci: retrigger
robobun b663137
run the leak check in-process instead of via a spawned fixture
robobun bd27318
[autofix.ci] apply automated fixes
autofix-ci[bot] 862e37c
assert on delta from baseline, not an absolute wrapper count
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
41 changes: 0 additions & 41 deletions
41
test/js/node/fs/abort-signal-leak-read-write-file-fixture.ts
This file was deleted.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -1,6 +1,48 @@ | ||
| import { heapStats } from "bun:jsc"; | ||
| import { expect, test } from "bun:test"; | ||
| import path from "path"; | ||
| import fs from "fs"; | ||
| import { expectMaxObjectTypeCount, isASAN, isDebug, tempDir } from "harness"; | ||
| import { join } from "path"; | ||
|
|
||
| test("should not leak memory with already aborted signals", async () => { | ||
| expect([path.join(import.meta.dir, "abort-signal-leak-read-write-file-fixture.ts")]).toRun(); | ||
| // https://github.com/oven-sh/bun/pull/16788 | ||
| test("fs.promises readFile/writeFile does not leak AbortSignal", async () => { | ||
| using dir = tempDir("fs-abort-signal-leak", { blah: "blah" }); | ||
| const target = join(String(dir), "blah"); | ||
| const noop = () => {}; | ||
|
|
||
| // pre-aborted signal: readFile/writeFile reject immediately and must release | ||
| // the signal reference on the early-return path. | ||
| await expect(fs.promises.readFile(target, { signal: AbortSignal.abort() })).rejects.toMatchObject({ | ||
| name: "AbortError", | ||
| }); | ||
| await expect(fs.promises.writeFile(target, "blah", { signal: AbortSignal.abort() })).rejects.toMatchObject({ | ||
| name: "AbortError", | ||
| }); | ||
|
|
||
| // abort after the write has been scheduled: the async completion path must | ||
| // also release the signal reference. The write may legitimately finish before | ||
| // nextTick fires, so either resolution or AbortError is acceptable here. | ||
| { | ||
| const controller = new AbortController(); | ||
| const prom = fs.promises.writeFile(target, "blah", { signal: controller.signal }); | ||
| process.nextTick(() => controller.abort()); | ||
| await prom.catch(e => expect(e).toMatchObject({ name: "AbortError" })); | ||
| } | ||
|
|
||
| // Leak detector. A JSAbortSignal wrapper is only pinned by hasPendingActivity() | ||
| // when the signal is NOT aborted AND has an abort listener (see | ||
| // JSAbortSignalCustom.cpp), so the loop below uses a never-aborted signal with | ||
| // a no-op listener: if readFile/writeFile forget to drop the pending-activity | ||
| // ref they take, every one of these wrappers survives GC and the object count | ||
| // below climbs with ITERATIONS instead of staying flat. | ||
| const baseline = heapStats().objectTypeCounts.AbortSignal ?? 0; | ||
| const ITERATIONS = isDebug || isASAN ? 100 : 2_000; | ||
| for (let i = 0; i < ITERATIONS; i++) { | ||
| const controller = new AbortController(); | ||
| controller.signal.addEventListener("abort", noop); | ||
| await fs.promises.writeFile(target, "blah", { signal: controller.signal }); | ||
| await fs.promises.readFile(target, { signal: controller.signal }); | ||
| } | ||
|
|
||
| await expectMaxObjectTypeCount(expect, "AbortSignal", baseline + 10); | ||
| }); | ||
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.