mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-09 14:38:59 +02:00
Lockyer
790c42505a
fs.mkdirSync(dir, { recursive: true }) is a no-op on an existing directory
in Node, but bun on Windows throws EEXIST - crashing hook install on any
repo whose .git/hooks already existed, leaving the repo unprotected.
Add lib/fs-utils.ts mkdirpSync: swallow EEXIST only when statSync confirms
the path is an existing directory; a regular file occupying the path, a
stat failure, or any other errno still rethrows. Use it in
installPrepushHook().
The regression test emulates the Windows bun fs semantics via a
bun --preload fixture, so the exact crash path runs (and fails on the old
code) on any platform, including CI Linux.
Absorbed from PR #2641 with authorship preserved.
Fixes #2635
91 lines
3.2 KiB
TypeScript
91 lines
3.2 KiB
TypeScript
/**
|
|
* mkdirpSync + install-prepush-hook under bun-on-Windows EEXIST semantics
|
|
* (#2635).
|
|
*
|
|
* bun on Windows throws EEXIST from fs.mkdirSync(dir, { recursive: true })
|
|
* when dir already exists - Node treats it as a no-op - which crashed
|
|
* `gstack-redact install-prepush-hook` on any repo whose .git/hooks already
|
|
* existed. The CLI regression test below emulates those Windows semantics via
|
|
* a `bun --preload` fixture (test/helpers/emulate-bun-windows-eexist.ts), so
|
|
* the crash path runs on any platform, including CI Linux.
|
|
*/
|
|
import { describe, test, expect } from "bun:test";
|
|
import * as fs from "fs";
|
|
import * as os from "os";
|
|
import * as path from "path";
|
|
import { spawnSync } from "child_process";
|
|
import { mkdirpSync } from "../lib/fs-utils";
|
|
|
|
const REDACT = path.resolve(import.meta.dir, "..", "bin", "gstack-redact");
|
|
const EEXIST_PRELOAD = path.resolve(
|
|
import.meta.dir,
|
|
"helpers",
|
|
"emulate-bun-windows-eexist.ts",
|
|
);
|
|
|
|
function tmpdir(): string {
|
|
return fs.mkdtempSync(path.join(os.tmpdir(), "fs-utils-"));
|
|
}
|
|
|
|
describe("mkdirpSync", () => {
|
|
test("creates missing nested directories", () => {
|
|
const base = tmpdir();
|
|
try {
|
|
const dir = path.join(base, "a", "b", "c");
|
|
mkdirpSync(dir);
|
|
expect(fs.statSync(dir).isDirectory()).toBe(true);
|
|
} finally {
|
|
fs.rmSync(base, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("tolerates the directory already existing", () => {
|
|
const base = tmpdir();
|
|
try {
|
|
mkdirpSync(base); // exists -> must be a no-op, not EEXIST
|
|
mkdirpSync(base); // and idempotent on repeat calls
|
|
} finally {
|
|
fs.rmSync(base, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("still throws EEXIST when a regular file occupies the path", () => {
|
|
const base = tmpdir();
|
|
try {
|
|
const file = path.join(base, "occupied");
|
|
fs.writeFileSync(file, "x");
|
|
expect(() => mkdirpSync(file)).toThrow(/EEXIST/);
|
|
} finally {
|
|
fs.rmSync(base, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("install-prepush-hook under bun-on-Windows EEXIST semantics (#2635)", () => {
|
|
test("install succeeds when .git/hooks already exists, existing hook preserved", () => {
|
|
const base = tmpdir();
|
|
try {
|
|
const repo = path.join(base, "repo");
|
|
spawnSync("git", ["init", "-q", repo]);
|
|
const hookDir = path.join(repo, ".git", "hooks");
|
|
fs.mkdirSync(hookDir, { recursive: true });
|
|
const hookPath = path.join(hookDir, "pre-push");
|
|
fs.writeFileSync(hookPath, "#!/usr/bin/env bash\necho mine\n", { mode: 0o755 });
|
|
|
|
// Under the emulated bun-on-Windows fs, the bare
|
|
// fs.mkdirSync(dir, { recursive: true }) in installPrepushHook() throws
|
|
// EEXIST (the #2635 crash). With mkdirpSync it must install cleanly.
|
|
const r = spawnSync("bun", ["--preload", EEXIST_PRELOAD, REDACT, "install-prepush-hook"], {
|
|
cwd: repo,
|
|
encoding: "utf8",
|
|
});
|
|
expect(r.status).toBe(0);
|
|
expect(r.stderr ?? "").not.toContain("EEXIST");
|
|
expect(fs.readFileSync(hookPath, "utf8")).toContain("gstack-redact pre-push (managed)");
|
|
expect(fs.readFileSync(path.join(hookDir, "pre-push.local"), "utf8")).toContain("echo mine");
|
|
} finally {
|
|
fs.rmSync(base, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|