jb/pi-ask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: avoid destructive ask config writes

Browse Source
This commit is contained in:
Erik Kotsiuba
2026-06-01 00:52:35 +02:00
parent bf3c26d9aa
commit fa89c1551a
10 changed files with 213 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/config-store.test.ts
+59 -34
View File
@@ -1,13 +1,16 @@
import assert from "node:assert/strict";
import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import test from "node:test";
import { DEFAULT_ASK_CONFIG } from "../src/config/defaults.ts";
import type { AskConfig } from "../src/config/schema.ts";
import { AskConfigStore } from "../src/config/store.ts";
const DEFAULT_KEYMAPS_NOTICE_PATTERN =
/Using default ask keymaps for this session/;
const SAVE_FAILURE_PATTERN =
/Unable to save ask config .* managed outside pi-ask/;
function expectedConfigFile(
overrides: { behaviour?: typeof DEFAULT_ASK_CONFIG.behaviour } = {}
@@ -42,6 +45,28 @@ test("config store writes defaults when file is missing", async () => {
await rm(dirname(path), { force: true, recursive: true });
});
test("config store uses defaults when initial config creation fails", async () => {
class FailingInitialSaveStore extends AskConfigStore {
override save(_config: AskConfig | Partial<AskConfig>): Promise<AskConfig> {
return Promise.reject(
new Error("Unable to save ask config; edit it manually.")
);
}
}
const path = await makeTempPath("pi-ask-config-initial-save-failure-");
const store = new FailingInitialSaveStore(path);
const result = await store.ensureLoaded();
assert.deepEqual(result.config, DEFAULT_ASK_CONFIG);
assert.equal(result.notice?.kind, "warning");
assert.equal(
result.notice?.text,
"Unable to save ask config; edit it manually."
);
await rm(dirname(path), { force: true, recursive: true });
});
test("config store writes full normalized config on save", async () => {
const path = await makeTempPath("pi-ask-config-save-");
const store = new AskConfigStore(path);
@@ -69,43 +94,51 @@ test("config store writes full normalized config on save", async () => {
await rm(dirname(path), { force: true, recursive: true });
});
test("config store backs up broken json and loads defaults", async () => {
test("config store reports friendly save failures", async () => {
const path = await makeTempPath("pi-ask-config-save-failure-");
await mkdir(path, { recursive: true });
const store = new AskConfigStore(path);
await assert.rejects(store.save(DEFAULT_ASK_CONFIG), SAVE_FAILURE_PATTERN);
await rm(path, { force: true, recursive: true });
});
test("config store leaves broken json unchanged and loads defaults", async () => {
const path = await makeTempPath("pi-ask-config-broken-");
await mkdir(dirname(path), { recursive: true });
await writeFile(path, "{bad json", "utf-8");
const store = new AskConfigStore(path);
const result = await store.ensureLoaded();
const dirEntries = await import("node:fs/promises").then(({ readdir }) =>
readdir(dirname(path))
);
const dirEntries = await readdir(dirname(path));
assert.deepEqual(result.config, DEFAULT_ASK_CONFIG);
assert.equal(
result.notice?.text,
"Config was invalid or unsupported. Backed it up and loaded defaults. Change any behaviour setting or edit the config file to save a fresh config."
"Config was invalid or unsupported. Loaded defaults for this session and left the config file unchanged. Edit the config file or run /reload after fixing it."
);
assert(dirEntries.some((entry) => entry.includes(".bak.json")));
await assert.rejects(readFile(path, "utf-8"));
assert.equal(
dirEntries.some((entry) => entry.includes(".bak.json")),
false
);
assert.equal(await readFile(path, "utf-8"), "{bad json");
await rm(dirname(path), { force: true, recursive: true });
});
test("config store loads current config version without rewriting", async () => {
test("config store loads migrated config without rewriting", async () => {
const path = await makeTempPath("pi-ask-config-current-");
await mkdir(dirname(path), { recursive: true });
await writeFile(
path,
JSON.stringify({
schemaVersion: 1,
behaviour: {
autoSubmitWhenAnsweredWithoutNotes: true,
confirmDismissWhenDirty: true,
doublePressReviewShortcuts: true,
showFooterHints: false,
},
keymaps: DEFAULT_ASK_CONFIG.keymaps,
})
);
const content = JSON.stringify({
schemaVersion: 1,
behaviour: {
autoSubmitWhenAnsweredWithoutNotes: true,
confirmDismissWhenDirty: true,
doublePressReviewShortcuts: true,
showFooterHints: false,
},
keymaps: DEFAULT_ASK_CONFIG.keymaps,
});
await writeFile(path, content);
const store = new AskConfigStore(path);
const result = await store.ensureLoaded();
@@ -118,10 +151,11 @@ test("config store loads current config version without rewriting", async () =>
assert.equal(result.config.behaviour.doublePressReviewShortcuts, true);
assert.equal(result.config.behaviour.showFooterHints, false);
assert.deepEqual(result.config.keymaps, DEFAULT_ASK_CONFIG.keymaps);
assert.equal(await readFile(path, "utf-8"), content);
await rm(dirname(path), { force: true, recursive: true });
});
test("config store migrates the legacy root config path into extensions", async () => {
test("config store reads legacy root config without copying it", async () => {
const root = await import("node:fs/promises").then(({ mkdtemp }) =>
mkdtemp(join(tmpdir(), "pi-ask-config-legacy-"))
);
@@ -151,17 +185,8 @@ test("config store migrates the legacy root config path into extensions", async
assert.equal(result.config.behaviour.confirmDismissWhenDirty, true);
assert.equal(result.config.behaviour.doublePressReviewShortcuts, true);
assert.equal(result.config.behaviour.showFooterHints, false);
await assert.rejects(readFile(legacyPath, "utf-8"));
assert.deepEqual(
JSON.parse(await readFile(path, "utf-8")),
expectedConfigFile({
behaviour: {
...DEFAULT_ASK_CONFIG.behaviour,
autoSubmitWhenAnsweredWithoutNotes: true,
showFooterHints: false,
},
})
);
assert.ok(await readFile(legacyPath, "utf-8"));
await assert.rejects(readFile(path, "utf-8"));
await rm(root, { force: true, recursive: true });
});
tests/settings-list.test.ts
+35 -1
View File
@@ -3,6 +3,7 @@ import test from "node:test";
import { visibleWidth } from "@earendil-works/pi-tui";
import { DEFAULT_ASK_CONFIG } from "../src/config/defaults.ts";
import type { AskConfig } from "../src/config/schema.ts";
import type { AskConfigNotice } from "../src/config/store.ts";
import { AskSettingsList } from "../src/ui/settings-list.ts";
const savedConfig: AskConfig = {
@@ -36,6 +37,7 @@ function plainTheme() {
function createList(
options: {
notice?: AskConfigNotice;
onClose?: () => void;
onSave?: (config: AskConfig) => Promise<AskConfig>;
savedConfig?: AskConfig;
@@ -48,7 +50,7 @@ function createList(
});
return new AskSettingsList(plainTheme(), {
configPath: "/tmp/eko24ive-pi-ask.json",
notice: undefined,
notice: options.notice,
onClose,
onSave: options.onSave ?? ((config) => Promise.resolve(config)),
savedConfig: options.savedConfig ?? savedConfig,
@@ -130,6 +132,38 @@ test("settings list shows save failures and reverts the toggle", async () => {
assert(text.includes("[off]"));
});
test("settings list renders load warnings", () => {
const list = createList({
notice: {
kind: "warning",
text: "Unable to save ask config; edit it manually.",
},
});
const text = list.render(72).join("\n");
assert(text.includes("Unable to save ask config; edit it manually."));
});
test("settings list clears load warnings after successful save", async () => {
const list = createList({
notice: {
kind: "warning",
text: "Unable to save ask config; edit it manually.",
},
});
list.handleInput(" ");
await new Promise((resolve) => setImmediate(resolve));
const text = list.render(72).join("\n");
assert.equal(
text.includes("Unable to save ask config; edit it manually."),
false
);
});
test("settings list uses configured navigation and close keys", async () => {
let saved: AskConfig | undefined;
const customConfig: AskConfig = {