feat: expand ~ (tilde) to home directory in file tools (read/write/edit) (openclaw#29779) thanks @Glucksberg

Verified:
- pnpm install --frozen-lockfile
- pnpm build
- pnpm check
- pnpm test:macmini

Co-authored-by: Glucksberg <80581902+Glucksberg@users.noreply.github.com>
Co-authored-by: Tak Hoffman <781889+Takhoffman@users.noreply.github.com>
This commit is contained in:
Glucksberg
2026-03-01 09:00:52 -04:00
committed by GitHub
parent ea3955cd78
commit 645d963954
3 changed files with 81 additions and 2 deletions

View File

@@ -173,3 +173,67 @@ describe("fs-safe", () => {
});
});
});
describe("tilde expansion in file tools", () => {
it("expandHomePrefix respects process.env.HOME changes", async () => {
const { expandHomePrefix } = await import("./home-dir.js");
const originalHome = process.env.HOME;
const fakeHome = "/tmp/fake-home-test";
process.env.HOME = fakeHome;
try {
const result = expandHomePrefix("~/file.txt");
expect(result).toBe(`${fakeHome}/file.txt`);
} finally {
process.env.HOME = originalHome;
}
});
it("reads a file via ~/path after HOME override", async () => {
const root = await tempDirs.make("openclaw-tilde-test-");
const originalHome = process.env.HOME;
process.env.HOME = root;
try {
await fs.writeFile(path.join(root, "hello.txt"), "tilde-works");
const result = await openFileWithinRoot({
rootDir: root,
relativePath: "~/hello.txt",
});
const buf = Buffer.alloc(result.stat.size);
await result.handle.read(buf, 0, buf.length, 0);
await result.handle.close();
expect(buf.toString("utf8")).toBe("tilde-works");
} finally {
process.env.HOME = originalHome;
}
});
it("writes a file via ~/path after HOME override", async () => {
const root = await tempDirs.make("openclaw-tilde-test-");
const originalHome = process.env.HOME;
process.env.HOME = root;
try {
await writeFileWithinRoot({
rootDir: root,
relativePath: "~/output.txt",
data: "tilde-write-works",
});
const content = await fs.readFile(path.join(root, "output.txt"), "utf8");
expect(content).toBe("tilde-write-works");
} finally {
process.env.HOME = originalHome;
}
});
it("rejects ~/path that resolves outside root", async () => {
const root = await tempDirs.make("openclaw-tilde-outside-");
// HOME points to real home, ~/file goes to /home/dev/file which is outside root
await expect(
openFileWithinRoot({
rootDir: root,
relativePath: "~/escape.txt",
}),
).rejects.toMatchObject({
code: expect.stringMatching(/outside-workspace|not-found|invalid-path/),
});
});
});