Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
17 changes: 17 additions & 0 deletions src/jsc/bindings/bindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2369,6 +2369,23 @@ JSC::EncodedJSValue SystemError__toErrorInstance(const SystemError* arg0, JSC::J

JSC::JSObject* result = createError(globalObject, ErrorType::Error, message);

// When this is called from the top of the event loop (async fs / dns / socket
// threadpool callbacks) there are no JS frames on the stack, so createError()
// captures an empty stack trace. ErrorInstance::materializeErrorInfoIfNeeded
// then never installs a .stack property for an empty trace, leaving
// err.stack === undefined where Node.js always returns at least
// "Error: <message>". Install the lazy stack getter in that case; it formats
// whatever stackTrace() holds at access time (header-only, or the async frames
// later attached by Bun__attachAsyncStackFromPromise) and honors
// Error.prepareStackTrace.
Comment thread
robobun marked this conversation as resolved.
Outdated
if (auto* instance = dynamicDowncast<JSC::ErrorInstance>(result)) {
auto* trace = instance->stackTrace();
if (!trace || trace->isEmpty()) {
auto* zigGlobal = defaultGlobalObject(globalObject);
instance->putDirectCustomAccessor(vm, vm.propertyNames->stack, zigGlobal->m_lazyStackCustomGetterSetter.get(zigGlobal), JSC::PropertyAttribute::DontEnum | JSC::PropertyAttribute::CustomAccessor | 0);
}
}

auto clientData = WebCore::clientData(vm);

if (err.code.tag != BunStringTag::Empty) {
Expand Down
80 changes: 80 additions & 0 deletions test/js/node/fs/fs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5799,3 +5799,83 @@ describe("fs.close on stdio descriptors", () => {
expect(exitCode).toBe(0);
});
});

describe("async fs errors have a .stack string", () => {
const nope = path.join(tmpdir(), "__bun_fs_stack_nope", "deep", "f");
const header = /^Error: ENOENT: no such file or directory/;

it.each([
["open", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.open(nope, "r", cb)],
["readFile", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.readFile(nope, cb)],
["stat", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.stat(nope, cb)],
["readdir", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.readdir(nope, cb)],
["unlink", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.unlink(nope, cb)],
["mkdir", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.mkdir(nope, cb)],
["rm", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.rm(nope, cb)],
["copyFile", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.copyFile(nope, nope + "2", cb)],
["rename", (cb: (e: NodeJS.ErrnoException | null) => void) => fs.rename(nope, nope + "2", cb)],
] as const)("fs.%s (callback)", async (_name, call) => {
const err = await new Promise<NodeJS.ErrnoException>(resolve => call(e => resolve(e!)));
expect(err).toBeInstanceOf(Error);
expect(err.code).toBe("ENOENT");
expect(typeof err.stack).toBe("string");
expect(err.stack).toMatch(header);
});

it.each(["readFile", "stat", "readdir", "unlink", "mkdir", "rm"] as const)("fs.promises.%s", async name => {
let err: any;
try {
await (fs.promises as any)[name](nope);
} catch (e) {
err = e;
}
expect(err).toBeInstanceOf(Error);
expect(err.code).toBe("ENOENT");
expect(typeof err.stack).toBe("string");
expect(err.stack).toMatch(header);
});

it("fs.promises via .then() (no await chain)", async () => {
const err = await new Promise<any>(resolve => {
fs.promises.readFile(nope).then(
() => resolve(undefined),
e => resolve(e),
);
});
expect(err).toBeInstanceOf(Error);
expect(typeof err.stack).toBe("string");
expect(err.stack).toMatch(header);
});

it("createReadStream 'error' event", async () => {
const err = await new Promise<any>(resolve => {
const s = fs.createReadStream(nope);
s.on("error", resolve);
});
expect(err).toBeInstanceOf(Error);
expect(err.code).toBe("ENOENT");
expect(typeof err.stack).toBe("string");
expect(err.stack).toMatch(header);
});

it("honors Error.prepareStackTrace for empty-trace errors", async () => {
await using proc = Bun.spawn({
cmd: [
bunExe(),
"-e",
`
Error.prepareStackTrace = (err, frames) => "prep:" + frames.length + ":" + err.message;
require("node:fs").readFile(${JSON.stringify(nope)}, e => {
console.log(typeof e.stack === "string" && e.stack.startsWith("prep:") ? "ok" : "bad:" + e.stack);
});
`,
],
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);
});
});
Loading