-
Notifications
You must be signed in to change notification settings - Fork 4.7k
fs: auto-close Dir async iterator on exit #28895
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
3
commits into
main
Choose a base branch
from
farm/4c570a07/fix-dir-iter-close
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
3 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| // https://github.com/oven-sh/bun/issues/28894 | ||
| // `fs.Dir` async iterator should close the directory handle on exit | ||
| // (natural completion, `break`, or thrown error) to match Node.js. | ||
| import { expect, test } from "bun:test"; | ||
| import { tempDir } from "harness"; | ||
| import { opendir as opendirPromise } from "node:fs/promises"; | ||
|
claude[bot] marked this conversation as resolved.
|
||
|
|
||
| test("Dir async iterator closes handle on break", async () => { | ||
| using dir = tempDir("dir-iter-break", { | ||
| "a.txt": "", | ||
| "b.txt": "", | ||
| "c.txt": "", | ||
| }); | ||
| const d = await opendirPromise(String(dir)); | ||
|
|
||
| const names: string[] = []; | ||
| for await (const entry of d) { | ||
| names.push(entry.name); | ||
| break; | ||
| } | ||
| expect(names).toHaveLength(1); | ||
|
|
||
| // The iterator should have closed the handle. A second close must throw. | ||
| expect(() => d.closeSync()).toThrow("Directory handle was closed"); | ||
| }); | ||
|
|
||
| test("Dir async iterator closes handle on natural completion", async () => { | ||
| using dir = tempDir("dir-iter-complete", { | ||
| "x.txt": "", | ||
| "y.txt": "", | ||
| }); | ||
| const d = await opendirPromise(String(dir)); | ||
|
|
||
| const names: string[] = []; | ||
| for await (const entry of d) { | ||
| names.push(entry.name); | ||
| } | ||
| expect(names.sort()).toEqual(["x.txt", "y.txt"]); | ||
|
|
||
| expect(() => d.closeSync()).toThrow("Directory handle was closed"); | ||
| }); | ||
|
|
||
| test("Dir async iterator closes handle when body throws", async () => { | ||
| using dir = tempDir("dir-iter-throw", { | ||
| "a.txt": "", | ||
| "b.txt": "", | ||
| }); | ||
| const d = await opendirPromise(String(dir)); | ||
|
|
||
| await expect( | ||
| (async () => { | ||
| for await (const _entry of d) { | ||
| throw new Error("boom"); | ||
| } | ||
| })(), | ||
| ).rejects.toThrow("boom"); | ||
|
|
||
| expect(() => d.closeSync()).toThrow("Directory handle was closed"); | ||
| }); | ||
|
|
||
| test("Dir async iterator throws ERR_DIR_CLOSED on second iteration after auto-close", async () => { | ||
| using dir = tempDir("dir-iter-reiter", { | ||
| "a.txt": "", | ||
| "b.txt": "", | ||
| }); | ||
| const d = await opendirPromise(String(dir)); | ||
|
|
||
| for await (const _entry of d) { | ||
| break; | ||
| } | ||
|
|
||
| // The first iteration auto-closed the handle. A second iteration must | ||
| // throw ERR_DIR_CLOSED immediately instead of silently re-yielding cached | ||
| // entries. Matches Node's behavior. | ||
| await expect( | ||
| (async () => { | ||
| for await (const _entry of d) { | ||
| // unreachable | ||
| } | ||
| })(), | ||
| ).rejects.toThrow("Directory handle was closed"); | ||
| }); | ||
|
|
||
| test("Dir async iterator throws ERR_DIR_CLOSED when user closed manually inside loop", async () => { | ||
| using dir = tempDir("dir-iter-user-closed", { | ||
| "a.txt": "", | ||
| }); | ||
| const d = await opendirPromise(String(dir)); | ||
|
|
||
| // Matches Node: when the user closes the handle inside the loop, the | ||
| // iterator's finally tries to close again and the resulting ERR_DIR_CLOSED | ||
| // propagates out of the `for await`. | ||
| await expect( | ||
| (async () => { | ||
| for await (const _entry of d) { | ||
| d.closeSync(); | ||
| break; | ||
| } | ||
| })(), | ||
| ).rejects.toThrow("Directory handle was closed"); | ||
| }); | ||
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.