Skip to content

Commit 4bdc91e

Browse files
fix(web): file saves no longer overwrite newer disk changes (#1869)
## Problem An open workspace file panel saves its buffer over disk changes it never saw. An agent or terminal edits the file, the user types, and autosave silently drops the newer disk contents. ## Change Each save names the disk version its draft started from; a stale save is refused, and the user is asked. 1. Panel loads the file; client keeps its revision 2. Save sends `expectedRevision` with the contents 3. Server re-reads the file and compares - one write per real file at a time 4. Changed or deleted: refused as `contents_changed` 5. Editor shows a persistent toast: - **Overwrite:** saves the draft without the check - **Reload:** drops draft, shows disk version - **Old drafts:** dropped or superseded, never saved **Revision:** length plus FNV-1a over the decoded text; synchronous, since `crypto.subtle` is missing on plain-HTTP remote origins. **Read failure:** stays `operation_failed`, never a conflict. **Unchanged:** saves with no loaded revision (new files, older clients) write as before. ### Layout ```text packages/contracts/src/ ├── projectFileRevision.fork.ts shared revision hash └── project.ts hooks: expectedRevision, contents_changed apps/server/src/ ├── workspace/WorkspaceFileSystem.fork.ts compare before write, write lock ├── workspace/WorkspaceFileSystem.ts hook: call the check ├── server.ts hook: add the write lock └── ws.ts hook: map the error apps/web/src/components/files/ ├── fileSaveBase.fork.ts per-file loaded revision ├── fileSaveConflict.fork.ts guarded write + toast ├── fileSaveCoordinator.ts hook: discard() ├── projectFilesQueryState.ts hooks: capture, forget └── useFileSaveCoordinator.ts hook: wrap the write ``` ### Surfaces - **Web editors:** plain, rendered, rich markdown - **Shared:** `useFileSaveCoordinator` saves all - **Desktop:** wraps web - **Mobile:** no workspace file editor - **Server:** `WorkspaceFileSystem.writeFile` only ### Retirement notes - **Hash:** duplicates upstream's private one - lives in `fileContentRevision.ts` - **Cherry-pick:** touches fork-only files - does not apply to upstream `main` as is - **Upstream:** fixed only the tab-close case - `pingdotgg#8630` - closed `pingdotgg#8475` ## Scope and approval Closes #1761 Human decision from the housekeeping walk: fix in the fork, ask on conflict. - [ ] **Disk change:** never lost to a stale buffer ## Verification Real Chrome, dev build of this branch, scratch project: 1. Panel loads `README.md` 2. Disk gains a line; user types in panel 3. Toast appears; disk keeps the new line ✅ 4. **Reload:** panel shows disk; toast closes ✅ 5. Disk changes again; user types; toast appears ✅ 6. **Overwrite:** disk holds the panel text ✅ https://github.com/user-attachments/assets/c1b44fba-f2c2-44f5-ae2e-9d2964570901 | Span | Real | Clip | | --- | --- | --- | | load and edit | 11s | 3x | | prompt and reload | 7s | kept | | idle | 85s | cut | | edit, prompt, overwrite | 13s | kept | **Tests:** each case fails without its fix and passes with it. - [x] Web: stale save asks, then overwrites - [x] Web: Reload drops the draft unwritten - [x] Web: Reload covers a reopened panel - [x] Web: Reload covers a closed panel's in-flight save - [x] Web: a save landing after Reload stays dropped - [x] Web: a fresh edit after Reload keeps it dropped - [x] Web: a saved draft is never resent unchecked - [x] Server: stale write refused - [x] Server: matching base saved - [x] Server: deleted file refused - [x] Server: file turned FIFO refused as not a file - [x] Server: racing saves via any link: one wins - [x] Server: unreadable file fails as a read - [x] Server: outside paths refused, never followed **Checks:** - [x] `vp run fork:ci` → exit 0 - [x] `apps/web` `vp run build` → exit 0 - [x] `apps/server` `vp run build` → exit 0 - [ ] `vp run check:changed` → exit 1 - all failures in files this PR does not touch - format: 3 mobile and server files - lint: `serviceLauncher.fork.test.ts` - test: `GitManager.test.ts` CLAUDE.md case Claude Opus 5.5, Claude Code in T3 Code. ## Fork trailers Fork-Domain: upstream-fixes Fork-Tier: bugfix Fork-Upstreamable: yes Co-authored-by: donjor <[email protected]>
1 parent 41476b4 commit 4bdc91e

15 files changed

Lines changed: 795 additions & 0 deletions

‎apps/server/src/server.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ import * as RepositoryIdentityResolver from "./project/RepositoryIdentityResolve
111111
import * as WorkspaceEntries from "./workspace/WorkspaceEntries.ts";
112112
import * as KnownWorkspaces from "./workspace/KnownWorkspaces.ts";
113113
import * as WorkspaceFileSystem from "./workspace/WorkspaceFileSystem.ts";
114+
import * as WorkspaceFileSystemFork from "./workspace/WorkspaceFileSystem.fork.ts"; // fork-hook: upstream-fixes/stale-write-serial-import
114115
import * as WorkspacePaths from "./workspace/WorkspacePaths.ts";
115116
import * as GitVcsDriver from "./vcs/GitVcsDriver.ts";
116117
import * as VcsDriverRegistry from "./vcs/VcsDriverRegistry.ts";
@@ -493,6 +494,7 @@ const layerWorkspaceFileSystem = WorkspaceFileSystem.layer.pipe(
493494
Layer.provide(layerWorkspaceEntries),
494495
Layer.provide(layerKnownWorkspaces),
495496
Layer.provide(layerServerSettings), // fork-hook: upstream-fixes/wfs-server-settings-layer
497+
WorkspaceFileSystemFork.oneWritePerFile, // fork-hook: upstream-fixes/stale-write-serial
496498
);
497499

498500
const layerWorkspace = Layer.mergeAll(

‎apps/server/src/workspace/WorkspaceFileSystem.fork.test.ts‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
// @effect-diagnostics nodeBuiltinImport:off - FileSystem cannot create a FIFO.
2+
import * as NodeChildProcess from "node:child_process";
23
import * as NodeServices from "@effect/platform-node/NodeServices";
34
import { it, describe, expect } from "@effect/vitest";
45
import * as Effect from "effect/Effect";
56
import * as FileSystem from "effect/FileSystem";
67
import * as Layer from "effect/Layer";
78
import * as Path from "effect/Path";
9+
import { projectFileRevision } from "@t3tools/contracts";
10+
import * as HostProcess from "@t3tools/shared/HostProcess";
811
import * as ServerConfig from "../config.ts";
912
import * as ServerSettings from "../serverSettings.ts";
1013
import * as VcsDriverRegistry from "../vcs/VcsDriverRegistry.ts";
1114
import * as VcsProcess from "../vcs/VcsProcess.ts";
1215
import * as KnownWorkspaces from "./KnownWorkspaces.ts";
1316
import * as WorkspaceEntries from "./WorkspaceEntries.ts";
1417
import * as WorkspaceFileSystem from "./WorkspaceFileSystem.ts";
18+
import * as WorkspaceFileSystemFork from "./WorkspaceFileSystem.fork.ts";
1519
import * as WorkspacePaths from "./WorkspacePaths.ts";
1620
const ServerSettingsLayer = ServerSettings.layerTest();
1721
const KnownWorkspacesLayer = Layer.mock(KnownWorkspaces.KnownWorkspaces)({
@@ -22,6 +26,7 @@ const ProjectLayer = WorkspaceFileSystem.layer.pipe(
2226
Layer.provide(WorkspacePaths.layer),
2327
Layer.provide(WorkspaceEntries.layer.pipe(Layer.provide(WorkspacePaths.layer))),
2428
Layer.provide(ServerSettingsLayer),
29+
WorkspaceFileSystemFork.oneWritePerFile,
2530
);
2631
const TestLayer = Layer.empty.pipe(
2732
Layer.provideMerge(ProjectLayer),
@@ -81,4 +86,203 @@ it.layer(TestLayer, { excludeTestServices: true })("WorkspaceFileSystemLive", (i
8186
}),
8287
);
8388
});
89+
90+
describe("writeFile", () => {
91+
it.effect("refuses a save whose draft predates a disk change", () =>
92+
Effect.gen(function* () {
93+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
94+
const fileSystem = yield* FileSystem.FileSystem;
95+
const path = yield* Path.Path;
96+
const cwd = yield* makeTempDir;
97+
yield* writeTextFile(cwd, "README.md", "# Readme\n");
98+
const loadedRevision = projectFileRevision("# Readme\n");
99+
yield* writeTextFile(cwd, "README.md", "# Readme\nline from disk\n");
100+
101+
const error = yield* workspaceFileSystem
102+
.writeFile({
103+
cwd,
104+
relativePath: "README.md",
105+
contents: "# Readme edited\n",
106+
expectedRevision: loadedRevision,
107+
})
108+
.pipe(Effect.flip);
109+
110+
expect(error._tag).toBe("WorkspaceFileChangedError");
111+
expect(yield* fileSystem.readFileString(path.join(cwd, "README.md"))).toBe(
112+
"# Readme\nline from disk\n",
113+
);
114+
}),
115+
);
116+
117+
it.effect("refuses a save whose loaded file was deleted since", () =>
118+
Effect.gen(function* () {
119+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
120+
const fileSystem = yield* FileSystem.FileSystem;
121+
const path = yield* Path.Path;
122+
const cwd = yield* makeTempDir;
123+
124+
const error = yield* workspaceFileSystem
125+
.writeFile({
126+
cwd,
127+
relativePath: "empty.md",
128+
contents: "draft\n",
129+
expectedRevision: projectFileRevision(""),
130+
})
131+
.pipe(Effect.flip);
132+
133+
expect(error._tag).toBe("WorkspaceFileChangedError");
134+
expect(yield* fileSystem.exists(path.join(cwd, "empty.md"))).toBe(false);
135+
}),
136+
);
137+
138+
it.effect.skipIf(HostProcess.Platform.defaultValue() === "win32")(
139+
"refuses a save whose loaded file became a FIFO as not a file",
140+
() =>
141+
Effect.gen(function* () {
142+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
143+
const fileSystem = yield* FileSystem.FileSystem;
144+
const path = yield* Path.Path;
145+
const cwd = yield* makeTempDir;
146+
const filePath = path.join(cwd, "README.md");
147+
yield* writeTextFile(cwd, "README.md", "# Readme\n");
148+
yield* fileSystem.remove(filePath);
149+
yield* Effect.promise(
150+
() =>
151+
new Promise<void>((resolve, reject) =>
152+
NodeChildProcess.execFile("mkfifo", [filePath], (error) =>
153+
error ? reject(error) : resolve(),
154+
),
155+
),
156+
);
157+
158+
const error = yield* workspaceFileSystem
159+
.writeFile({
160+
cwd,
161+
relativePath: "README.md",
162+
contents: "# Readme edited\n",
163+
expectedRevision: projectFileRevision("# Readme\n"),
164+
})
165+
.pipe(Effect.flip);
166+
167+
// Not a disk change: Overwrite would block opening the FIFO.
168+
expect(error).toBeInstanceOf(WorkspaceFileSystem.WorkspacePathNotFileError);
169+
}),
170+
);
171+
172+
it.effect("reports an unreadable file as a failed read, not a disk change", () =>
173+
Effect.gen(function* () {
174+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
175+
const fileSystem = yield* FileSystem.FileSystem;
176+
const path = yield* Path.Path;
177+
const cwd = yield* makeTempDir;
178+
yield* writeTextFile(cwd, "README.md", "# Readme\n");
179+
yield* fileSystem.chmod(path.join(cwd, "README.md"), 0o000);
180+
181+
const error = yield* workspaceFileSystem
182+
.writeFile({
183+
cwd,
184+
relativePath: "README.md",
185+
contents: "# Readme edited\n",
186+
expectedRevision: projectFileRevision("# Readme\n"),
187+
})
188+
.pipe(Effect.flip);
189+
190+
expect(error).toMatchObject({
191+
_tag: "WorkspaceFileSystemOperationError",
192+
operation: "read",
193+
});
194+
}),
195+
);
196+
197+
it.effect("lets only one of two saves from the same disk version through, by any name", () =>
198+
Effect.gen(function* () {
199+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
200+
const fileSystem = yield* FileSystem.FileSystem;
201+
const path = yield* Path.Path;
202+
const cwd = yield* makeTempDir;
203+
yield* writeTextFile(cwd, "README.md", "# Readme\n");
204+
yield* fileSystem.symlink(path.join(cwd, "README.md"), path.join(cwd, "Alias.md"));
205+
yield* fileSystem.link(path.join(cwd, "README.md"), path.join(cwd, "Hard.md"));
206+
const save = (relativePath: string, contents: string) =>
207+
workspaceFileSystem
208+
.writeFile({
209+
cwd,
210+
relativePath,
211+
contents,
212+
expectedRevision: projectFileRevision("# Readme\n"),
213+
})
214+
.pipe(Effect.result);
215+
216+
const saves = [
217+
save("README.md", "# From one\n"),
218+
save("Alias.md", "# From two\n"),
219+
save("Hard.md", "# From three\n"),
220+
];
221+
const results = yield* Effect.all(saves, {
222+
concurrency: "unbounded",
223+
});
224+
225+
expect(results.map((result) => result._tag).toSorted()).toEqual([
226+
"Failure",
227+
"Failure",
228+
"Success",
229+
]);
230+
}),
231+
);
232+
233+
it.effect("refuses a path outside the workspace before following it", () =>
234+
Effect.gen(function* () {
235+
const fileSystem = yield* FileSystem.FileSystem;
236+
const cwd = yield* makeTempDir;
237+
const followed: Array<string> = [];
238+
const watchedFileSystem = Layer.succeed(FileSystem.FileSystem, {
239+
...fileSystem,
240+
stat: (target) => {
241+
followed.push(target);
242+
return fileSystem.stat(target);
243+
},
244+
realPath: (target) => {
245+
followed.push(target);
246+
return fileSystem.realPath(target);
247+
},
248+
});
249+
250+
const failures = yield* Effect.gen(function* () {
251+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
252+
return yield* Effect.forEach(
253+
["../outside.md", "//server/share/notes.md"],
254+
(relativePath) =>
255+
workspaceFileSystem.writeFile({ cwd, relativePath, contents: "x" }).pipe(Effect.flip),
256+
);
257+
}).pipe(Effect.provide(Layer.fresh(ProjectLayer).pipe(Layer.provide(watchedFileSystem))));
258+
259+
expect(failures.map((failure) => failure._tag)).toEqual([
260+
"WorkspacePathOutsideRootError",
261+
"WorkspacePathOutsideRootError",
262+
]);
263+
expect(followed).toEqual([]);
264+
}),
265+
);
266+
267+
it.effect("saves over the disk version the draft started from", () =>
268+
Effect.gen(function* () {
269+
const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
270+
const fileSystem = yield* FileSystem.FileSystem;
271+
const path = yield* Path.Path;
272+
const cwd = yield* makeTempDir;
273+
yield* writeTextFile(cwd, "README.md", "# Readme\n");
274+
275+
yield* workspaceFileSystem.writeFile({
276+
cwd,
277+
relativePath: "README.md",
278+
contents: "# Readme edited\n",
279+
expectedRevision: projectFileRevision("# Readme\n"),
280+
});
281+
282+
expect(yield* fileSystem.readFileString(path.join(cwd, "README.md"))).toBe(
283+
"# Readme edited\n",
284+
);
285+
}),
286+
);
287+
});
84288
});

0 commit comments

Comments
 (0)