Skip to content

Commit bd58bd1

Browse files
fix(web): switching a file between markdown and the editor no longer saves a draft twice
Each file surface (the editor and rendered markdown) built its own save coordinator in useFileSaveCoordinator, set up in an effect and recovering unsaved drafts in a second effect. Switching surfaces with an edit pending disposed the old coordinator, which flushed the draft, and the new one read the same still-unconfirmed draft from the query cache and wrote it again. Save sessions now live in a keyed store (fileSaveSessions.ts), one per file, held open by a ref callback on the surface element. The last surface to leave flushes; a session created while that flush is in flight skips the draft it is writing, and picks it back up if that flush fails. Regaining write access is a registry subscription on the session state instead of a re-render-driven effect. Effects: useFileSaveCoordinator.ts 2 -> 0 (file deleted, along with its render-phase setState that rebuilt the session on identity change); FilePreviewPanel.tsx unchanged at 3. Co-Authored-By: Claude Opus 5.5 <[email protected]>
1 parent 5d91ab1 commit bd58bd1

5 files changed

Lines changed: 430 additions & 333 deletions

File tree

‎apps/web/src/components/files/FilePreviewPanel.tsx‎

Lines changed: 54 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ import {
117117
shouldShowFileExplorer,
118118
workspaceAssetResource,
119119
} from "./filePreviewMode";
120-
import { useFileSaveCoordinator } from "./useFileSaveCoordinator";
120+
import { changeFileSaveSession, fileSaveSessionRef } from "./fileSaveSessions";
121121
import { revisionedQuery } from "~/state/revisionedQuery";
122122
import {
123123
getOptimisticProjectFileQueryData,
@@ -675,12 +675,7 @@ function EditableFileSurface({
675675
};
676676
const surfaceRef = useRef<HTMLDivElement>(null);
677677
const selectionFrameRef = useRef<number | null>(null);
678-
const saveCoordinator = useFileSaveCoordinator({
679-
environmentId,
680-
cwd,
681-
relativePath,
682-
onPendingChange,
683-
});
678+
const saveTarget = { environmentId, cwd, relativePath };
684679
// Retain file identity for echoed editor changes; only external changes replace the editor's draft.
685680
const [externalFile, setExternalFile] = useState(() =>
686681
editableFileContents(environmentId, cwd, relativePath, contents),
@@ -709,7 +704,7 @@ function EditableFileSurface({
709704
if (file.contents === getProjectFileContents(environmentId, cwd, relativePath)) return;
710705
setEditedContents(file.contents);
711706
setProjectFileQueryData(environmentId, cwd, relativePath, file.contents);
712-
saveCoordinator.change(file.contents);
707+
changeFileSaveSession(saveTarget, file.contents);
713708
if (!nextLineAnnotations) return;
714709
const remapped = remapFileCommentAnnotations(nextLineAnnotations);
715710
// The editor hands back the array it was given until an edit moves an annotation.
@@ -852,53 +847,55 @@ function EditableFileSurface({
852847

853848
return (
854849
<EditProvider createEditor={createFileEditor}>
855-
<div ref={surfaceRef} className="flex min-h-0 flex-1">
856-
<Virtualizer
857-
className="file-preview-virtualizer min-h-0 flex-1 overflow-auto"
858-
config={{
859-
overscrollSize: 600,
860-
intersectionObserverMargin: 1200,
861-
}}
862-
>
863-
<File<FileCommentAnnotationGroup>
864-
file={externalFile}
865-
edit={editable}
866-
editorOptions={editorOptions}
867-
onEditChange={handleEditChange}
868-
options={{
869-
disableFileHeader: true,
870-
enableGutterUtility: !hasOpenCommentForm,
871-
enableLineSelection: !hasOpenCommentForm,
872-
onGutterUtilityClick: setSelectedRange,
873-
onLineSelectionChange: setSelectedRange,
874-
onLineSelectionEnd: handleLineSelectionEnd,
875-
overflow: wordWrap ? "wrap" : "scroll",
876-
theme: resolveDiffThemeName(resolvedTheme),
877-
preferredHighlighter: PREFERRED_HIGHLIGHTER,
878-
themeType: resolvedTheme,
879-
unsafeCSS: FILE_LINK_REVEAL_UNSAFE_CSS,
880-
onPostRender: handlePostRender,
850+
<div ref={fileSaveSessionRef(saveTarget, onPendingChange)} className="contents">
851+
<div ref={surfaceRef} className="flex min-h-0 flex-1">
852+
<Virtualizer
853+
className="file-preview-virtualizer min-h-0 flex-1 overflow-auto"
854+
config={{
855+
overscrollSize: 600,
856+
intersectionObserverMargin: 1200,
881857
}}
882-
selectedLines={selectedRange}
883-
lineAnnotations={lineAnnotations}
884-
renderAnnotation={(annotation) => (
885-
<div className="py-1">
886-
{annotation.metadata.entries.map((entry) => (
887-
<DiffCommentAnnotation
888-
key={entry.id}
889-
kind={entry.kind}
890-
rangeLabel={formatFileCommentRange(entry.startLine, entry.endLine)}
891-
text={entry.text}
892-
onCancel={() => removeAnnotationEntry(entry.id)}
893-
onComment={(text) => submitAnnotationEntry(entry.id, text)}
894-
onDelete={() => removeAnnotationEntry(entry.id)}
895-
/>
896-
))}
897-
</div>
898-
)}
899-
className="min-h-full"
900-
/>
901-
</Virtualizer>
858+
>
859+
<File<FileCommentAnnotationGroup>
860+
file={externalFile}
861+
edit={editable}
862+
editorOptions={editorOptions}
863+
onEditChange={handleEditChange}
864+
options={{
865+
disableFileHeader: true,
866+
enableGutterUtility: !hasOpenCommentForm,
867+
enableLineSelection: !hasOpenCommentForm,
868+
onGutterUtilityClick: setSelectedRange,
869+
onLineSelectionChange: setSelectedRange,
870+
onLineSelectionEnd: handleLineSelectionEnd,
871+
overflow: wordWrap ? "wrap" : "scroll",
872+
theme: resolveDiffThemeName(resolvedTheme),
873+
preferredHighlighter: PREFERRED_HIGHLIGHTER,
874+
themeType: resolvedTheme,
875+
unsafeCSS: FILE_LINK_REVEAL_UNSAFE_CSS,
876+
onPostRender: handlePostRender,
877+
}}
878+
selectedLines={selectedRange}
879+
lineAnnotations={lineAnnotations}
880+
renderAnnotation={(annotation) => (
881+
<div className="py-1">
882+
{annotation.metadata.entries.map((entry) => (
883+
<DiffCommentAnnotation
884+
key={entry.id}
885+
kind={entry.kind}
886+
rangeLabel={formatFileCommentRange(entry.startLine, entry.endLine)}
887+
text={entry.text}
888+
onCancel={() => removeAnnotationEntry(entry.id)}
889+
onComment={(text) => submitAnnotationEntry(entry.id, text)}
890+
onDelete={() => removeAnnotationEntry(entry.id)}
891+
/>
892+
))}
893+
</div>
894+
)}
895+
className="min-h-full"
896+
/>
897+
</Virtualizer>
898+
</div>
902899
</div>
903900
</EditProvider>
904901
);
@@ -926,15 +923,10 @@ function RenderedMarkdownSurface({
926923
readOnly: boolean;
927924
workspaceMutationId: string | null;
928925
}) {
929-
const saveCoordinator = useFileSaveCoordinator({
930-
environmentId,
931-
cwd,
932-
relativePath,
933-
onPendingChange,
934-
});
926+
const saveTarget = { environmentId, cwd, relativePath };
935927

936928
return (
937-
<ScrollArea className="min-h-0 flex-1">
929+
<ScrollArea ref={fileSaveSessionRef(saveTarget, onPendingChange)} className="min-h-0 flex-1">
938930
<FileMarkdownPreview
939931
text={contents}
940932
cwd={cwd}
@@ -951,7 +943,7 @@ function RenderedMarkdownSurface({
951943
const nextContents = setMarkdownTaskChecked(currentContents, markerOffset, checked);
952944
if (nextContents === currentContents) return;
953945
setProjectFileQueryData(environmentId, cwd, relativePath, nextContents);
954-
saveCoordinator.change(nextContents);
946+
changeFileSaveSession(saveTarget, nextContents);
955947
}
956948
}
957949
/>
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
import { EnvironmentId } from "@t3tools/contracts";
2+
import { Cause } from "effect";
3+
import { AsyncResult } from "effect/reactivity";
4+
import { describe, expect, it, vi } from "vite-plus/test";
5+
6+
import {
7+
createFileSaveSessions,
8+
type FileSaveSessionDeps,
9+
type FileSaveTarget,
10+
} from "./fileSaveSessions";
11+
12+
const target: FileSaveTarget = {
13+
environmentId: EnvironmentId.make("file-save-sessions"),
14+
cwd: "/workspace",
15+
relativePath: "file.txt",
16+
};
17+
18+
function setup() {
19+
vi.useFakeTimers();
20+
const state = {
21+
writable: true,
22+
unsaved: null as string | null,
23+
onWritable: [] as Array<() => void>,
24+
};
25+
const persist = vi.fn<FileSaveSessionDeps["persist"]>(async () => AsyncResult.success(undefined));
26+
const confirm = vi.fn((_target: FileSaveTarget, _contents: string) => true);
27+
const onPendingChange = vi.fn();
28+
const sessions = createFileSaveSessions({
29+
debounceMs: 500,
30+
canPersist: () => state.writable,
31+
subscribeWritable: (_target, onWritable) => {
32+
state.onWritable.push(onWritable);
33+
return () => {
34+
state.onWritable = state.onWritable.filter((listener) => listener !== onWritable);
35+
};
36+
},
37+
persist,
38+
confirm,
39+
readUnsaved: () => state.unsaved,
40+
});
41+
const writes = () => persist.mock.calls.map(([written, contents]) => [written, contents]);
42+
return {
43+
state,
44+
sessions,
45+
persist,
46+
confirm,
47+
onPendingChange,
48+
writes,
49+
[Symbol.dispose]: () => vi.useRealTimers(),
50+
};
51+
}
52+
53+
describe("file save sessions", () => {
54+
it("debounces edits and clears the pending marker once confirmed", async () => {
55+
using h = setup();
56+
h.sessions.acquire(target, h.onPendingChange);
57+
h.sessions.change(target, "a");
58+
h.sessions.change(target, "ab");
59+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", true);
60+
await vi.advanceTimersByTimeAsync(500);
61+
expect(h.writes()).toEqual([[target, "ab"]]);
62+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", false);
63+
});
64+
65+
it("flushes on the last release and drops edits from retired editors", async () => {
66+
using h = setup();
67+
const releaseFirst = h.sessions.acquire(target, h.onPendingChange);
68+
const releaseSecond = h.sessions.acquire(target, h.onPendingChange);
69+
h.sessions.change(target, "pending edit");
70+
releaseFirst();
71+
expect(h.persist).not.toHaveBeenCalled();
72+
releaseSecond();
73+
h.sessions.change(target, "stale editor contents");
74+
await vi.runAllTimersAsync();
75+
expect(h.writes()).toEqual([[target, "pending edit"]]);
76+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", false);
77+
});
78+
79+
it("gives a replaced file a fresh session and flushes the old one", async () => {
80+
using h = setup();
81+
const other = { ...target, relativePath: "other.txt" };
82+
const release = h.sessions.acquire(target, h.onPendingChange);
83+
h.sessions.change(target, "old file edit");
84+
release();
85+
h.sessions.acquire(other, h.onPendingChange);
86+
h.sessions.change(target, "stale editor contents");
87+
h.sessions.change(other, "new file edit");
88+
await vi.runAllTimersAsync();
89+
expect(h.writes()).toEqual([
90+
[target, "old file edit"],
91+
[other, "new file edit"],
92+
]);
93+
});
94+
95+
it("resumes an unsaved draft when a session is created", async () => {
96+
using h = setup();
97+
h.state.unsaved = "pending draft";
98+
h.sessions.acquire(target, h.onPendingChange);
99+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", true);
100+
await vi.advanceTimersByTimeAsync(500);
101+
expect(h.writes()).toEqual([[target, "pending draft"]]);
102+
});
103+
104+
it("does not queue a draft that a retired session is still writing", async () => {
105+
using h = setup();
106+
let finishWrite = () => {};
107+
h.persist.mockImplementationOnce(
108+
() =>
109+
new Promise((resolve) => {
110+
finishWrite = () => resolve(AsyncResult.success(undefined));
111+
}),
112+
);
113+
const release = h.sessions.acquire(target, h.onPendingChange);
114+
h.sessions.change(target, "draft");
115+
h.state.unsaved = "draft";
116+
release();
117+
// A StrictMode ref replay reacquires while the flush is in flight.
118+
h.sessions.acquire(target, h.onPendingChange);
119+
finishWrite();
120+
await vi.runAllTimersAsync();
121+
expect(h.writes()).toEqual([[target, "draft"]]);
122+
});
123+
124+
it("hands out one ref callback per file and listener, so rerenders keep the debounce", async () => {
125+
using h = setup();
126+
const ref = h.sessions.ref({ ...target }, h.onPendingChange);
127+
ref({});
128+
h.sessions.change(target, "a");
129+
// A rerender rebuilds the target; an unchanged ref means React keeps the lease.
130+
expect(h.sessions.ref({ ...target }, h.onPendingChange)).toBe(ref);
131+
h.sessions.change(target, "ab");
132+
expect(h.persist).not.toHaveBeenCalled();
133+
await vi.advanceTimersByTimeAsync(500);
134+
expect(h.writes()).toEqual([[target, "ab"]]);
135+
expect(h.sessions.ref({ ...target, relativePath: "other.txt" }, h.onPendingChange)).not.toBe(
136+
ref,
137+
);
138+
});
139+
140+
it("requeues a draft whose retired flush failed on the live session", async () => {
141+
using h = setup();
142+
let failWrite = () => {};
143+
h.persist.mockImplementationOnce(
144+
() =>
145+
new Promise((resolve) => {
146+
failWrite = () => resolve(AsyncResult.failure(Cause.fail("offline")));
147+
}),
148+
);
149+
const release = h.sessions.acquire(target, h.onPendingChange);
150+
h.sessions.change(target, "draft");
151+
h.state.unsaved = "draft";
152+
release();
153+
h.sessions.acquire(target, h.onPendingChange);
154+
failWrite();
155+
await vi.runAllTimersAsync();
156+
expect(h.writes()).toEqual([
157+
[target, "draft"],
158+
[target, "draft"],
159+
]);
160+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", false);
161+
});
162+
163+
it("keeps edits pending while unwritable and resumes them when access returns", async () => {
164+
using h = setup();
165+
h.sessions.acquire(target, h.onPendingChange);
166+
h.state.writable = false;
167+
h.sessions.change(target, "pending edit");
168+
h.state.unsaved = "pending edit";
169+
await vi.runAllTimersAsync();
170+
expect(h.persist).not.toHaveBeenCalled();
171+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", true);
172+
173+
h.state.writable = true;
174+
for (const onWritable of h.state.onWritable) onWritable();
175+
await vi.advanceTimersByTimeAsync(500);
176+
expect(h.writes()).toEqual([[target, "pending edit"]]);
177+
expect(h.onPendingChange).toHaveBeenLastCalledWith("file.txt", false);
178+
});
179+
180+
it("skips recovery while unwritable and stops watching access after release", async () => {
181+
using h = setup();
182+
h.state.writable = false;
183+
h.state.unsaved = "pending draft";
184+
const release = h.sessions.acquire(target, h.onPendingChange);
185+
expect(h.onPendingChange).not.toHaveBeenCalled();
186+
release();
187+
expect(h.state.onWritable).toEqual([]);
188+
await vi.runAllTimersAsync();
189+
expect(h.persist).not.toHaveBeenCalled();
190+
});
191+
});

0 commit comments

Comments
 (0)