|
| 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