Skip to content
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.

Sign up for GitHub

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

Check if path exists before returning from opendirSync #17846

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Check if path exists before returning from opendirSync #17846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/js/node/fs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,6 +1021,10 @@ function _toUnixTimestamp(time: any, name = "time") {
function opendirSync(path, options) {
// TODO: validatePath
// validateString(path, "path");
if (!fs.existsSync(path)) {

This comment was marked as outdated.

Sign in to view

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

accessSync won't error if it's not a directory

Copy link
Member

@paperclover paperclover Mar 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true. then instead, this PR should expose an opendir binding in src/bun.js/node/node_fs_binding.zig to fs.ts, and have a matching implementation function in src/bun.js/node/node_fs.zig. this function would return a directory file descriptor. Then, there can be internal variants of readdir that work on this file descriptor.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pointers. I figured this would involve some Zig bindings, but wanted to ensure that there wasn't anything in JS-land that I was missing. I'm starting to work on the bindings now, should hopefully have something up this week, time permitting

throw new Error("ENOENT");
}

return new Dir(1, path, options);
}

Expand Down
8 changes: 8 additions & 0 deletions test/js/node/fs/fs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import fs, {
mkdtempSync,
openAsBlob,
openSync,
opendirSync,
promises,
statfsSync,
statfs,
Expand Down Expand Up @@ -572,6 +573,13 @@ describe("copyFileSync", () => {
}
});

describe("opendirSync", () => {
it("should throw ENOENT on a nonexistent directory", () => {
const dirName = Math.random().toString(8);
expect(() => opendirSync(dirName)).toThrow("ENOENT");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.toThrow({ code: "ENOENT" })

})
});

describe("mkdirSync", () => {
it("should create a directory", () => {
const now = Date.now().toString();
Expand Down