Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
144 changes: 144 additions & 0 deletions apps/server/src/workspace/WorkspaceFileSystem.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import * as Effect from "effect/Effect";
import * as FileSystem from "effect/FileSystem";
import * as Layer from "effect/Layer";
import * as Path from "effect/Path";
import * as PlatformError from "effect/PlatformError";

import * as ServerConfig from "../config.ts";
import { makeFakeWslHost } from "../testUtils/fakeWsl.ts";
Expand Down Expand Up @@ -621,6 +622,144 @@ it.layer(layerTest, { excludeTestServices: true })("WorkspaceFileSystemLive", (i
});

describe("writeFile", () => {
it.effect.each([
{ existing: false, failure: "write" },
{ existing: true, failure: "write" },
{ existing: true, failure: "rename" },
{ existing: true, failure: "cleanup" },
] as const)(
"handles $failure failure without losing destination contents (existing: $existing)",
({ existing, failure }) =>
Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
const target = path.join(yield* fs.realPath(cwd), "report.md");
const original = "original contents\n";
if (existing) yield* writeTextFile(cwd, "report.md", original);
const cause = new Error("Save failed");
const failing = (operation: string) =>
Effect.fail(
PlatformError.systemError({
_tag: "Unknown",
module: "FileSystem",
method: operation,
cause,
}),
);
const service = yield* WorkspaceFileSystem.make.pipe(
Effect.provide(layerKnownWorkspacesTest),
Effect.provideService(FileSystem.FileSystem, {
...fs,
open: (file, options) =>
fs.open(file, options).pipe(
// The real handle keeps its methods on its prototype, so it is extended, not spread.
Effect.map((handle): FileSystem.File =>
failure === "write"
? Object.create(handle, {
writeAll: {
value: (data: Uint8Array) =>
handle
.writeAll(data.slice(0, 4))
.pipe(Effect.andThen(failing("writeAll"))),
},
})
: handle,
),
),
rename: (from, to) =>
failure === "rename" ? failing("rename") : fs.rename(from, to),
remove: (file, options) =>
failure === "cleanup" ? failing("remove") : fs.remove(file, options),
}),
);

if (failure === "cleanup") {
expect(
yield* service.writeFile({
cwd,
relativePath: "report.md",
contents: "replacement\n",
}),
).toEqual({ relativePath: "report.md" });
expect(yield* fs.readFileString(target)).toBe("replacement\n");
return;
}

const error = yield* service
.writeFile({ cwd, relativePath: "report.md", contents: "replacement contents\n" })
.pipe(Effect.flip);

expect(error).toMatchObject({
_tag: "WorkspaceFileSystemOperationError",
operation: "write-file",
operationPath: target,
});
if (existing) expect(yield* fs.readFileString(target)).toBe(original);
else expect(yield* fs.exists(target)).toBe(false);
expect(yield* fs.readDirectory(cwd)).toEqual(existing ? ["report.md"] : []);
}),
);

it.effect.skipIf(HostProcess.Platform.defaultValue() === "win32" || process.getuid?.() === 0)(
"saves a writable file inside a read-only directory",
() =>
Effect.gen(function* () {
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
yield* writeTextFile(cwd, "docs/report.md", "original\n");
const docs = path.join(cwd, "docs");
yield* fs.chmod(path.join(docs, "report.md"), 0o600);
yield* Effect.acquireRelease(fs.chmod(docs, 0o500), () =>
fs.chmod(docs, 0o700).pipe(Effect.ignore),
);

yield* workspaceFileSystem.writeFile({
cwd,
relativePath: "docs/report.md",
contents: "edited\n",
});

expect(yield* fs.readFileString(path.join(docs, "report.md"))).toBe("edited\n");
}),
);

it.effect.skipIf(!symlinksSupported)(
"replaces a symlink swapped in after the target check instead of writing through it",
() =>
Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
const outside = path.join(yield* makeTempDir, "outside.txt");
yield* fs.writeFileString(outside, "outside\n");
yield* writeTextFile(cwd, "report.md", "original\n");
const target = path.join(yield* fs.realPath(cwd), "report.md");
let swapped = false;
const swap = Effect.suspend(() => {
if (swapped) return Effect.void;
swapped = true;
return fs.remove(target).pipe(Effect.andThen(fs.symlink(outside, target)));
});
const service = yield* WorkspaceFileSystem.make.pipe(
Effect.provide(layerKnownWorkspacesTest),
Effect.provideService(FileSystem.FileSystem, {
...fs,
readLink: (file) => swap.pipe(Effect.andThen(fs.readLink(file))),
makeTempDirectory: (options) =>
swap.pipe(Effect.andThen(fs.makeTempDirectory(options))),
}),
);

yield* service.writeFile({ cwd, relativePath: "report.md", contents: "edited\n" });

expect(yield* fs.readFileString(outside)).toBe("outside\n");
expect(yield* fs.readFileString(target)).toBe("edited\n");
}),
);

it.effect("rejects writes outside a known workspace", () =>
Effect.gen(function* () {
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
Expand Down Expand Up @@ -687,6 +826,8 @@ it.layer(layerTest, { excludeTestServices: true })("WorkspaceFileSystemLive", (i
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
yield* writeTextFile(cwd, "src/main.ts", "export {};\n");
const target = path.join(cwd, "src/main.ts");
if (HostProcess.Platform.defaultValue() !== "win32") yield* fileSystem.chmod(target, 0o750);

yield* workspaceFileSystem.writeFile({
cwd,
Expand All @@ -697,6 +838,9 @@ it.layer(layerTest, { excludeTestServices: true })("WorkspaceFileSystemLive", (i
expect(yield* fileSystem.readFileString(path.join(cwd, "src/main.ts"))).toBe(
"export const edited = true;\n",
);
if (HostProcess.Platform.defaultValue() !== "win32") {
expect((yield* fileSystem.stat(target)).mode & 0o777).toBe(0o750);
}

yield* writeTextFile(cwd, "report.txt", "ordinary file");
for (const relativePath of whitespaceFilePaths) {
Expand Down
72 changes: 53 additions & 19 deletions apps/server/src/workspace/WorkspaceFileSystem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import type {
ProjectWriteFileResult,
} from "@t3tools/contracts";
import { expandHomePath } from "@t3tools/provider-core/server/pathExpansion";
import { writeFileStringAtomically } from "@t3tools/shared/atomicWrite";
import * as HostProcess from "@t3tools/shared/HostProcess";
import { isNetworkPath } from "@t3tools/shared/path";
import * as Context from "effect/Context";
Expand Down Expand Up @@ -613,26 +614,59 @@ export const make = Effect.gen(function* () {
}),
),
);
yield* Effect.tryPromise({
// A symlink swapped in after the check is not followed. Windows lacks O_NOFOLLOW.
try: () =>
NodeFSP.writeFile(realTargetPath, contents, {
flag:
NodeFS.constants.O_WRONLY |
NodeFS.constants.O_CREAT |
NodeFS.constants.O_TRUNC |
(NodeFS.constants.O_NOFOLLOW ?? 0),
}),
catch: (cause) =>
new WorkspaceFileSystemOperationError({
workspaceRoot: input.cwd,
relativePath: input.relativePath,
resolvedPath: realTargetPath,
operationPath: realTargetPath,
operation: "write-file",
cause,
}),
const writeError = (cause: unknown) =>
new WorkspaceFileSystemOperationError({
workspaceRoot: input.cwd,
relativePath: input.relativePath,
resolvedPath: realTargetPath,
operationPath: realTargetPath,
operation: "write-file",
cause,
});
const staged = yield* Effect.tryPromise({
try: async () => {
// Checks write access without truncating; a symlink swapped in here is not followed on POSIX.
const existing = await NodeFSP.open(
realTargetPath,
NodeFS.constants.O_WRONLY | (NodeFS.constants.O_NOFOLLOW ?? 0),
).catch((error: unknown) => {
if ((error as NodeJS.ErrnoException).code === "ENOENT") return undefined;
throw error;
});
if (!existing) return {};
try {
const mode = (await existing.stat()).mode & 0o777;
const canStage = await NodeFSP.access(
path.dirname(realTargetPath),
NodeFS.constants.W_OK,
).then(
() => true,
() => false,
);
if (canStage) return { mode };
// Staging needs a writable directory; a writable file in a read-only one is saved in place.
await existing.truncate(0);
await existing.writeFile(contents);
return undefined;
} finally {
await existing.close();
}
},
catch: writeError,
});
if (staged) {
yield* writeFileStringAtomically({
filePath: realTargetPath,
contents,
...staged,
// The target was checked as resolved; a link swapped in since is replaced, not followed.
followSymlinks: false,
}).pipe(
Effect.provideService(FileSystem.FileSystem, fileSystem),
Effect.provideService(Path.Path, path),
Effect.mapError(writeError),
);
}
// Editor autosave overwrites existing files, which leaves the indexed paths unchanged, and
// fff's watcher applies the new contents on its own. A forced rescan re-walks the whole
// workspace, and the save would wait for it.
Expand Down
11 changes: 9 additions & 2 deletions packages/shared/src/atomicWrite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,20 @@ const isUnsupportedSync = (error: PlatformError.PlatformError) => {
export const writeFileStringAtomically = (input: {
readonly filePath: string;
readonly contents: string | Iterable<string>;
/** Permission bits for the replacement; ignored on Windows. */
readonly mode?: number;
/** False renames onto `filePath` itself, replacing a link there instead of writing through it. */
readonly followSymlinks?: boolean;
}) =>
Effect.scoped(
Effect.gen(function* () {
const fs = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const platform = yield* HostProcess.Platform;
const targetPath = yield* resolveSymlinkTarget(input.filePath);
const targetPath =
input.followSymlinks === false
? path.resolve(input.filePath)
: yield* resolveSymlinkTarget(input.filePath);
const targetDirectory = path.dirname(targetPath);

yield* fs.makeDirectory(targetDirectory, { recursive: true });
Expand Down Expand Up @@ -81,7 +88,7 @@ export const writeFileStringAtomically = (input: {
if (batchLength > 0) yield* file.writeAll(encoder.encode(batch.join("")));
}
if (platform !== "win32") {
yield* fs.chmod(tempPath, yield* replacedMode(fs, targetPath));
yield* fs.chmod(tempPath, input.mode ?? (yield* replacedMode(fs, targetPath)));
}
yield* file.sync;
}),
Expand Down
Loading