Skip to content

Commit 716cede

Browse files
author
rsi-pr-agent
committed
fixup! fix(web): file saves no longer overwrite newer disk changes (#1869)
Fork-Domain: upstream-fixes Fork-Tier: bugfix Fork-Upstreamable: yes
1 parent 858eba8 commit 716cede

5 files changed

Lines changed: 77 additions & 7 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import * as Cause from "effect/Cause";
2+
import { AsyncResult } from "effect/reactivity";
3+
import { expect, it, vi } from "vite-plus/test";
4+
import { FileSaveCoordinator } from "./fileSaveCoordinator";
5+
6+
it("does not retry a refused draft through its old debounce timer after draining a flush", async () => {
7+
vi.useFakeTimers();
8+
try {
9+
const first = Promise.withResolvers<AsyncResult.AsyncResult<unknown, unknown>>();
10+
const persist = vi
11+
.fn()
12+
.mockReturnValueOnce(first.promise)
13+
.mockResolvedValue(AsyncResult.failure(Cause.interrupt()));
14+
const coordinator = new FileSaveCoordinator({
15+
debounceMs: 500,
16+
persist,
17+
onPendingChange: vi.fn(),
18+
onConfirmed: vi.fn(),
19+
});
20+
coordinator.change("first");
21+
coordinator.flush();
22+
coordinator.change("conflicting newest draft");
23+
first.resolve(AsyncResult.success(undefined));
24+
await vi.advanceTimersByTimeAsync(0);
25+
await vi.advanceTimersByTimeAsync(500);
26+
expect(persist.mock.calls).toEqual([["first"], ["conflicting newest draft"]]);
27+
} finally {
28+
vi.useRealTimers();
29+
}
30+
});

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export class FileSaveCoordinator<A = unknown, E = unknown> {
7878
return;
7979
}
8080

81+
this.clearTimer(); // fork-hook: upstream-fixes/file-save-drain-timer
8182
this.saving = true;
8283
const contents = this.latestContents;
8384
const revision = this.latestRevision;
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { runAtomCommand } from "@t3tools/client-runtime/state/runtime";
2+
import { appAtomRegistry } from "~/rpc/atomRegistry";
3+
import { projectEnvironment } from "~/state/projects";
4+
import { withStaleWriteGuard } from "./fileSaveConflict.fork";
5+
import type { FileSaveCoordinator } from "./fileSaveCoordinator";
6+
import type { FileSaveTarget } from "./fileSaveSessions";
7+
8+
export function guardFileSaveSessionFork(
9+
target: FileSaveTarget,
10+
current: () => FileSaveCoordinator | null,
11+
) {
12+
const persist = withStaleWriteGuard(
13+
(request) => runAtomCommand(appAtomRegistry, projectEnvironment.writeFile, request),
14+
{
15+
get current() {
16+
return current();
17+
},
18+
},
19+
);
20+
return {
21+
persist: (contents: string) =>
22+
persist({
23+
environmentId: target.environmentId,
24+
input: { cwd: target.cwd, relativePath: target.relativePath, contents },
25+
}),
26+
};
27+
}
28+
29+
export function resumeFileSaveSessionFork(
30+
session: { leases: number; flushingOnRelease: boolean } | undefined,
31+
): void {
32+
if (session && session.leases > 0) session.flushingOnRelease = false;
33+
}

apps/web/src/components/files/useFileSaveCoordinator.fork.browser.test.tsx renamed to apps/web/src/components/files/fileSaveSessions.fork.browser.test.tsx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { render, fakeTimers } from "../../../test/render";
22
import { EnvironmentId, ProjectWriteFileError, projectFileRevision } from "@t3tools/contracts";
33
import * as Cause from "effect/Cause";
4-
import { AsyncResult } from "effect/reactivity";
4+
import { Atom, AsyncResult } from "effect/reactivity";
55
import { StrictMode, useEffect } from "react";
66
import { describe, expect, it, vi } from "vite-plus/test";
77

@@ -17,11 +17,12 @@ vi.mock(import("../ui/toast"), async (original) => {
1717
vi.mock(import("~/state/session"), async (original) => ({
1818
...(await original()),
1919
readEnvironmentScope: () => true,
20-
useEnvironmentScope: () => true,
20+
sessionHasScope: () => true,
21+
environmentSession: { sessionStateAtom: () => Atom.make(null) } as never,
2122
}));
22-
vi.mock(import("~/state/use-atom-command"), async (original) => ({
23+
vi.mock(import("@t3tools/client-runtime/state/runtime"), async (original) => ({
2324
...(await original()),
24-
useAtomCommand: (() => writeFile) as never,
25+
runAtomCommand: ((...args: unknown[]) => writeFile(args[2])) as never,
2526
}));
2627
vi.mock(import("./projectFilesQueryState"), async (original) => ({
2728
...(await original()),
@@ -35,7 +36,7 @@ import {
3536
optimisticFileAtom,
3637
setProjectFileQueryData,
3738
} from "./projectFilesQueryState";
38-
import { useFileSaveCoordinator } from "./useFileSaveCoordinator";
39+
import { changeFileSaveSession, useFileSaveSession } from "./fileSaveSessions";
3940

4041
const environmentId = EnvironmentId.make("stale-write-guard");
4142
const onPendingChange = vi.fn();
@@ -82,9 +83,9 @@ function showLoadedFile(contents: string) {
8283
async function openEditor() {
8384
let change: (contents: string) => void = () => {};
8485
function FileSurface() {
85-
const coordinator = useFileSaveCoordinator(props);
86+
useFileSaveSession(props, onPendingChange);
8687
useEffect(() => {
87-
change = (contents) => coordinator.change(contents);
88+
change = (contents) => changeFileSaveSession(props, contents);
8889
});
8990
return null;
9091
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { projectEnvironment } from "~/state/projects";
77
import { environmentSession, readEnvironmentScope, sessionHasScope } from "~/state/session";
88

99
import { FileSaveCoordinator } from "./fileSaveCoordinator";
10+
import { guardFileSaveSessionFork, resumeFileSaveSessionFork } from "./fileSaveSessionGuard.fork"; // fork-hook: upstream-fixes/stale-write-guard-import
1011
import {
1112
confirmProjectFileQueryData,
1213
getUnsavedProjectFileQueryData,
@@ -21,6 +22,7 @@ export interface FileSaveTarget {
2122
export type FilePendingListener = (relativePath: string, pending: boolean) => void;
2223

2324
export interface FileSaveSessionDeps {
25+
readonly guardFork?: typeof guardFileSaveSessionFork; // fork-hook: upstream-fixes/stale-write-guard-contract
2426
readonly debounceMs: number;
2527
readonly canPersist: (target: FileSaveTarget) => boolean;
2628
/** Calls `onWritable` each time the target environment regains write access. */
@@ -69,6 +71,7 @@ export function createFileSaveSessions(deps: FileSaveSessionDeps) {
6971
for (const listener of listeners.keys()) listener(target.relativePath, pending);
7072
},
7173
persist: (contents) => deps.persist(target, contents),
74+
...deps.guardFork?.(target, () => (sessions.get(key) === session ? coordinator : null)), // fork-hook: upstream-fixes/stale-write-guard
7275
onConfirmed: (contents) => deps.confirm(target, contents),
7376
onSettled: () => {
7477
if (!session.flushingOnRelease) return;
@@ -130,6 +133,7 @@ export function createFileSaveSessions(deps: FileSaveSessionDeps) {
130133
/** Edits for a file nobody holds open are dropped, so retired editors stay inert. */
131134
change(target: FileSaveTarget, contents: string): void {
132135
const session = sessions.get(fileSaveKey(target));
136+
resumeFileSaveSessionFork(session); // fork-hook: upstream-fixes/stale-write-session-resume
133137
if (session && session.leases > 0) session.coordinator.change(contents);
134138
},
135139
};
@@ -140,6 +144,7 @@ function fileSaveKey({ environmentId, cwd, relativePath }: FileSaveTarget): stri
140144
}
141145

142146
const fileSaveSessions = createFileSaveSessions({
147+
guardFork: guardFileSaveSessionFork, // fork-hook: upstream-fixes/stale-write-session-persist
143148
debounceMs: 500,
144149
canPersist: ({ environmentId }) => readEnvironmentScope(environmentId, AuthFilesystemWriteScope),
145150
subscribeWritable: ({ environmentId }, onWritable) => {

0 commit comments

Comments
 (0)