M1.7: crash-recovery journal and restore dialog
Dirty buffers are written atomically to <data_dir>/recovery/<project-id>/ about 1 s after the last edit (at most 2 s while typing), from pump_vfs, never per keystroke. Entries are removed on save, close (also force), forced project close/open and recovery.discard. project.open emits recoveryAvailable; recovery.list/restore/discard; restored buffers are dirty and keep line ending and BOM. Corrupt entries are moved aside and reported as warning notifications. UI: restore dialog in ui/src/components/recovery (Restore all, Restore selected, Discard, time, changed-on-disk hint), catalog keys and runtime allow-list. Tests: crash/restore with CRLF + BOM, corrupt entries, removal paths, property test of random edits, headless control-channel test, Vitest for the dialog. Docs: architecture, parity, gaps, ROADMAP. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
6d976ed03e
commit
0b40eb90f8
27 changed files with 2222 additions and 27 deletions
|
|
@ -37,9 +37,16 @@ const usedKeys = sourceFiles(SRC).flatMap((file) =>
|
|||
|
||||
/**
|
||||
* Keys the source never passes to `t` literally because they arrive at
|
||||
* runtime from the engine: theme labels from `theme.list`.
|
||||
* runtime from the engine: theme labels from `theme.list` and the
|
||||
* `messageKey` of `notification` events.
|
||||
*/
|
||||
const RUNTIME_KEYS = new Set(["theme.lutraDark", "theme.lutraLight"]);
|
||||
const RUNTIME_KEYS = new Set([
|
||||
"notification.recovery.corrupt",
|
||||
"notification.recovery.unavailable",
|
||||
"notification.recovery.writeFailed",
|
||||
"theme.lutraDark",
|
||||
"theme.lutraLight",
|
||||
]);
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
|
|
@ -87,7 +94,9 @@ describe("t", () => {
|
|||
describe("en.json", () => {
|
||||
it("uses flat dotted keys of known areas with string values", () => {
|
||||
for (const [key, value] of Object.entries(en)) {
|
||||
expect(key).toMatch(/^(app|project|editor|common|theme)\.[A-Za-z0-9]+(\.[A-Za-z0-9]+)*$/);
|
||||
expect(key).toMatch(
|
||||
/^(app|project|editor|common|theme|recovery|notification)\.[A-Za-z0-9]+(\.[A-Za-z0-9]+)*$/,
|
||||
);
|
||||
expect(typeof value).toBe("string");
|
||||
expect(value.trim()).not.toBe("");
|
||||
}
|
||||
|
|
|
|||
236
ui/tests/recovery/RecoveryDialog.test.ts
Normal file
236
ui/tests/recovery/RecoveryDialog.test.ts
Normal file
|
|
@ -0,0 +1,236 @@
|
|||
/**
|
||||
* Tests for the restore dialog and its store: the list from
|
||||
* `recoveryAvailable` and from `recovery.list` after `projectOpened`, the
|
||||
* "changed on disk" hint, Restore all / Restore selected / Discard with
|
||||
* explicit paths, failures, errors, Escape, and checking untrusted entries.
|
||||
* The engine is a fake behind the mocked Tauri `invoke`.
|
||||
*/
|
||||
import { flushPromises, mount, type VueWrapper } from "@vue/test-utils";
|
||||
import { createPinia, setActivePinia } from "pinia";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const invoke = vi.hoisted(() => vi.fn());
|
||||
vi.mock("@tauri-apps/api/core", () => ({ invoke }));
|
||||
|
||||
import RecoveryDialog from "../../src/components/recovery/RecoveryDialog.vue";
|
||||
import { toRecoveryEntries, useRecoveryStore } from "../../src/components/recovery/recovery";
|
||||
|
||||
/** Entries as the engine sends them. */
|
||||
const ENTRIES = [
|
||||
{ path: "src/a.php", savedAt: Date.UTC(2026, 9, 16, 12, 0), diskChanged: false },
|
||||
{ path: "src/b.php", savedAt: Date.UTC(2026, 9, 16, 12, 5), diskChanged: true },
|
||||
{ path: "c.php", savedAt: Date.UTC(2026, 9, 16, 12, 9), diskChanged: false },
|
||||
];
|
||||
|
||||
/** Every `engine_execute` call, in order. */
|
||||
let calls: { command: string; params: Record<string, unknown> }[];
|
||||
|
||||
/** Result of `recovery.restore`, per test. */
|
||||
let restoreResult: unknown;
|
||||
|
||||
/** Error `recovery.discard` fails with, if any. */
|
||||
let discardError: { code: string; message: string } | null;
|
||||
|
||||
/**
|
||||
* Rejects like the shell does with an engine error.
|
||||
*
|
||||
* @param code - error code.
|
||||
* @param message - error message.
|
||||
*/
|
||||
function fail(code: string, message: string): Promise<never> {
|
||||
return Promise.reject(Object.assign(new Error(message), { code, message }));
|
||||
}
|
||||
|
||||
/** Mounted wrappers, unmounted after each test. */
|
||||
const mounted: VueWrapper[] = [];
|
||||
|
||||
/** Mounts the dialog. */
|
||||
function mountDialog(): VueWrapper {
|
||||
const wrapper = mount(RecoveryDialog, { attachTo: document.body });
|
||||
mounted.push(wrapper);
|
||||
return wrapper;
|
||||
}
|
||||
|
||||
/** Shows the entries as if `recoveryAvailable` arrived. */
|
||||
async function offer(entries: unknown = ENTRIES): Promise<void> {
|
||||
useRecoveryStore().handleEvent({
|
||||
kind: "recoveryAvailable",
|
||||
entries: entries as never,
|
||||
});
|
||||
await flushPromises();
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
setActivePinia(createPinia());
|
||||
calls = [];
|
||||
restoreResult = { restored: [], failed: [] };
|
||||
discardError = null;
|
||||
invoke.mockReset();
|
||||
invoke.mockImplementation(
|
||||
(cmd: string, args?: { command: string; params: Record<string, unknown> }) => {
|
||||
if (cmd !== "engine_execute" || !args) {
|
||||
return Promise.reject(new Error("no shell"));
|
||||
}
|
||||
calls.push({ command: args.command, params: args.params });
|
||||
switch (args.command) {
|
||||
case "recovery.list":
|
||||
return Promise.resolve({ entries: ENTRIES });
|
||||
case "recovery.restore":
|
||||
return Promise.resolve(restoreResult);
|
||||
case "recovery.discard":
|
||||
return discardError
|
||||
? fail(discardError.code, discardError.message)
|
||||
: Promise.resolve({ discarded: args.params.paths });
|
||||
default:
|
||||
return fail("unknown_command", args.command);
|
||||
}
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
for (const wrapper of mounted.splice(0)) {
|
||||
wrapper.unmount();
|
||||
}
|
||||
});
|
||||
|
||||
describe("RecoveryDialog", () => {
|
||||
it("is hidden without entries", () => {
|
||||
const wrapper = mountDialog();
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("lists the offered files with time and the changed-on-disk hint", async () => {
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
const dialog = wrapper.get("[data-test=recovery-dialog]");
|
||||
expect(dialog.get("[role=dialog]").attributes("aria-modal")).toBe("true");
|
||||
const rows = wrapper.findAll("[data-test=recovery-entry]");
|
||||
expect(rows.map((r) => r.find(".recovery__path").text())).toEqual([
|
||||
"src/a.php",
|
||||
"src/b.php",
|
||||
"c.php",
|
||||
]);
|
||||
expect(rows[0]?.text()).toContain(
|
||||
`Saved ${new Date(ENTRIES[0]?.savedAt ?? 0).toLocaleString()}`,
|
||||
);
|
||||
expect(rows[0]?.find("[data-test=recovery-changed]").exists()).toBe(false);
|
||||
expect(rows[1]?.get("[data-test=recovery-changed]").text()).toBe(
|
||||
"The file changed on disk since then",
|
||||
);
|
||||
expect(document.activeElement).toBe(
|
||||
wrapper.get("[data-test=recovery-restore-all]").element,
|
||||
);
|
||||
});
|
||||
|
||||
it("asks the engine after projectOpened, for reloads and late subscribers", async () => {
|
||||
const wrapper = mountDialog();
|
||||
useRecoveryStore().handleEvent({ kind: "projectOpened", root: "/p", name: "p" });
|
||||
await flushPromises();
|
||||
expect(calls).toEqual([{ command: "recovery.list", params: {} }]);
|
||||
expect(wrapper.findAll("[data-test=recovery-entry]")).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("restores all listed files with explicit paths and closes", async () => {
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
await wrapper.get("[data-test=recovery-restore-all]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls).toEqual([
|
||||
{ command: "recovery.restore", params: { paths: ["src/a.php", "src/b.php", "c.php"] } },
|
||||
]);
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("restores the selected files and keeps the others listed", async () => {
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
const selected = wrapper.get("[data-test=recovery-restore-selected]");
|
||||
expect(selected.attributes("disabled")).toBeDefined();
|
||||
await wrapper.get("[data-test='recovery-select-src/b.php']").setValue(true);
|
||||
expect(selected.attributes("disabled")).toBeUndefined();
|
||||
await selected.trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls).toEqual([{ command: "recovery.restore", params: { paths: ["src/b.php"] } }]);
|
||||
expect(
|
||||
wrapper.findAll("[data-test=recovery-entry]").map((r) => r.find(".recovery__path").text()),
|
||||
).toEqual(["src/a.php", "c.php"]);
|
||||
|
||||
await wrapper.get("[data-test=recovery-discard]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(calls[1]).toEqual({
|
||||
command: "recovery.discard",
|
||||
params: { paths: ["src/a.php", "c.php"] },
|
||||
});
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("unticking a file disables Restore selected again", async () => {
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
const box = wrapper.get("[data-test='recovery-select-c.php']");
|
||||
await box.setValue(true);
|
||||
await box.setValue(false);
|
||||
expect(
|
||||
wrapper.get("[data-test=recovery-restore-selected]").attributes("disabled"),
|
||||
).toBeDefined();
|
||||
});
|
||||
|
||||
it("lists files that could not be restored until closed", async () => {
|
||||
restoreResult = {
|
||||
restored: [],
|
||||
failed: [{ path: "src/a.php", message: "unsaved changes in src/a.php" }, { bad: 1 }],
|
||||
};
|
||||
const wrapper = mountDialog();
|
||||
await offer([ENTRIES[0]]);
|
||||
await wrapper.get("[data-test=recovery-restore-all]").trigger("click");
|
||||
await flushPromises();
|
||||
const failures = wrapper.get("[data-test=recovery-failures]");
|
||||
expect(failures.attributes("role")).toBe("alert");
|
||||
expect(failures.findAll("li")).toHaveLength(1);
|
||||
expect(failures.text()).toBe(
|
||||
"src/a.php could not be restored: unsaved changes in src/a.php",
|
||||
);
|
||||
expect(document.activeElement).toBe(wrapper.get("[data-test=recovery-close]").element);
|
||||
await wrapper.get("[data-test=recovery-close]").trigger("click");
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
});
|
||||
|
||||
it("shows a failed call and keeps the list", async () => {
|
||||
discardError = { code: "failed", message: "disk full" };
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
await wrapper.get("[data-test=recovery-discard]").trigger("click");
|
||||
await flushPromises();
|
||||
expect(wrapper.get("[data-test=recovery-error]").text()).toBe("disk full");
|
||||
expect(wrapper.findAll("[data-test=recovery-entry]")).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("closes on Escape and on projectClosed without touching the journal", async () => {
|
||||
const wrapper = mountDialog();
|
||||
await offer();
|
||||
await wrapper.get("[role=dialog]").trigger("keydown", { key: "Escape" });
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
await offer();
|
||||
useRecoveryStore().handleEvent({ kind: "projectClosed" });
|
||||
await flushPromises();
|
||||
expect(wrapper.find("[data-test=recovery-dialog]").exists()).toBe(false);
|
||||
expect(calls).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("toRecoveryEntries", () => {
|
||||
it("skips malformed entries", () => {
|
||||
expect(
|
||||
toRecoveryEntries([
|
||||
ENTRIES[0],
|
||||
null,
|
||||
"x",
|
||||
{ path: 1, savedAt: 1, diskChanged: false },
|
||||
{ path: "a", savedAt: Number.NaN, diskChanged: false },
|
||||
{ path: "a", savedAt: 1, diskChanged: "yes" },
|
||||
]),
|
||||
).toEqual([ENTRIES[0]]);
|
||||
expect(toRecoveryEntries({ path: "a" })).toEqual([]);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue