Skip to content

Commit 38876e5

Browse files
fix(web): closing a file tab no longer overwrites newer changes
The file editor's save coordinator only ever incremented its edit revision, so `dispose` treated any tab that had been edited once as holding unsaved work. Closing or switching that tab re-wrote the remembered buffer, replacing whatever had changed the file since the last save. Track the revision confirmed on disk and flush on dispose only when the buffer holds a newer edit. Edits made inside the debounce window are still saved on close, and a write that failed before the close is still retried. Fixes #8475
1 parent 0e2905e commit 38876e5

2 files changed

Lines changed: 116 additions & 1 deletion

File tree

‎apps/web/src/components/files/fileSaveCoordinator.test.ts‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,117 @@ describe("FileSaveCoordinator", () => {
7373
expect(onPendingChange.mock.calls.at(-1)).toEqual([false]);
7474
});
7575

76+
it("does not rewrite already saved contents when the editor closes", async () => {
77+
vi.useFakeTimers();
78+
const persist = vi
79+
.fn<(contents: string) => Promise<AtomCommandResult<void, never>>>()
80+
.mockResolvedValue(AsyncResult.success(undefined));
81+
const coordinator = new FileSaveCoordinator({
82+
debounceMs: 500,
83+
persist,
84+
onPendingChange: vi.fn(),
85+
onConfirmed: vi.fn(),
86+
});
87+
88+
coordinator.change("edited");
89+
await vi.advanceTimersByTimeAsync(500);
90+
expect(persist).toHaveBeenCalledOnce();
91+
92+
coordinator.dispose();
93+
await vi.runAllTimersAsync();
94+
expect(persist).toHaveBeenCalledOnce();
95+
});
96+
97+
it("saves an edit made inside the debounce window when the editor closes", async () => {
98+
vi.useFakeTimers();
99+
const persist = vi
100+
.fn<(contents: string) => Promise<AtomCommandResult<void, never>>>()
101+
.mockResolvedValue(AsyncResult.success(undefined));
102+
const coordinator = new FileSaveCoordinator({
103+
debounceMs: 500,
104+
persist,
105+
onPendingChange: vi.fn(),
106+
onConfirmed: vi.fn(),
107+
});
108+
109+
coordinator.change("unsaved");
110+
coordinator.dispose();
111+
await vi.runAllTimersAsync();
112+
expect(persist).toHaveBeenCalledOnce();
113+
expect(persist).toHaveBeenCalledWith("unsaved");
114+
});
115+
116+
it("flushes an edit made while a write was in flight when the editor closes", async () => {
117+
vi.useFakeTimers();
118+
const inFlight = deferred();
119+
const persist = vi
120+
.fn<(contents: string) => Promise<AtomCommandResult<void, never>>>()
121+
.mockReturnValueOnce(inFlight.promise)
122+
.mockResolvedValue(AsyncResult.success(undefined));
123+
const coordinator = new FileSaveCoordinator({
124+
debounceMs: 500,
125+
persist,
126+
onPendingChange: vi.fn(),
127+
onConfirmed: vi.fn(),
128+
});
129+
130+
coordinator.change("first");
131+
await vi.advanceTimersByTimeAsync(500);
132+
coordinator.change("latest");
133+
coordinator.dispose();
134+
inFlight.resolve(AsyncResult.success(undefined));
135+
await vi.runAllTimersAsync();
136+
137+
expect(persist).toHaveBeenCalledTimes(2);
138+
expect(persist).toHaveBeenLastCalledWith("latest");
139+
});
140+
141+
it("does not rewrite a write that lands while the editor closes", async () => {
142+
vi.useFakeTimers();
143+
const inFlight = deferred();
144+
const persist = vi
145+
.fn<(contents: string) => Promise<AtomCommandResult<void, never>>>()
146+
.mockReturnValueOnce(inFlight.promise)
147+
.mockResolvedValue(AsyncResult.success(undefined));
148+
const coordinator = new FileSaveCoordinator({
149+
debounceMs: 500,
150+
persist,
151+
onPendingChange: vi.fn(),
152+
onConfirmed: vi.fn(),
153+
});
154+
155+
coordinator.change("only");
156+
await vi.advanceTimersByTimeAsync(500);
157+
coordinator.dispose();
158+
inFlight.resolve(AsyncResult.success(undefined));
159+
await vi.runAllTimersAsync();
160+
161+
expect(persist).toHaveBeenCalledOnce();
162+
});
163+
164+
it("retries a failed write when the editor closes", async () => {
165+
vi.useFakeTimers();
166+
const persist = vi
167+
.fn()
168+
.mockResolvedValueOnce(AsyncResult.failure(Cause.fail(new Error("write failed"))))
169+
.mockResolvedValue(AsyncResult.success(undefined));
170+
const coordinator = new FileSaveCoordinator({
171+
debounceMs: 500,
172+
persist,
173+
onPendingChange: vi.fn(),
174+
onConfirmed: vi.fn(),
175+
});
176+
177+
coordinator.change("latest");
178+
await vi.advanceTimersByTimeAsync(500);
179+
expect(persist).toHaveBeenCalledOnce();
180+
181+
coordinator.dispose();
182+
await vi.runAllTimersAsync();
183+
expect(persist).toHaveBeenCalledTimes(2);
184+
expect(persist).toHaveBeenLastCalledWith("latest");
185+
});
186+
76187
it("leaves the file pending when the latest write fails", async () => {
77188
vi.useFakeTimers();
78189
const onPendingChange = vi.fn();

‎apps/web/src/components/files/fileSaveCoordinator.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ export class FileSaveCoordinator<A = unknown, E = unknown> {
1111
private timer: ReturnType<typeof setTimeout> | null = null;
1212
private latestContents = "";
1313
private latestRevision = 0;
14+
// Revision of the last edit confirmed on disk, so `dispose` can tell an
15+
// unsaved edit from one the debounce already wrote and only flush the former.
16+
private persistedRevision = 0;
1417
private lastChangeAt = 0;
1518
private saving = false;
1619
private disposed = false;
@@ -28,7 +31,7 @@ export class FileSaveCoordinator<A = unknown, E = unknown> {
2831
dispose(): void {
2932
this.disposed = true;
3033
this.clearTimer();
31-
if (this.latestRevision > 0) void this.persistLatest();
34+
if (this.latestRevision > this.persistedRevision) void this.persistLatest();
3235
}
3336

3437
private schedule(delay: number): void {
@@ -54,6 +57,7 @@ export class FileSaveCoordinator<A = unknown, E = unknown> {
5457
const result = await this.options.persist(contents);
5558
const succeeded = result._tag === "Success";
5659
if (succeeded) {
60+
this.persistedRevision = revision;
5761
this.options.onConfirmed(contents);
5862
}
5963

0 commit comments

Comments
 (0)