Mohamed Boudra
5731f016c2
Steer is the better default for Enter while an agent is running, but flipping DEFAULT_CLIENT_SETTINGS alone would only reach new installs. Client defaults are materialized into storage — the first load writes the whole default blob and every save re-stamps it — so every existing install already has "interrupt" on disk, and a stored "interrupt" cannot be told apart from one the user actually chose. A one-time migration flips them all; picking "interrupt" afterwards sticks. The applied-migration marker sits in its own storage key rather than in the settings blob: StoredAppSettingsSchema is strict and readValidatedJson clears the value when parsing fails, so an unknown field there would wipe every setting for anyone who downgrades. migrateAppSettings owns both of its writes so the settings blob always lands before the marker. A failed marker write leaves the migration to re-run harmlessly; a failed settings write must leave the marker unwritten, or the migration is lost and the user keeps "interrupt" for good.
104 lines
4.0 KiB
TypeScript
104 lines
4.0 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { createInMemoryKeyValueStorage } from "./fakes";
|
|
import { APP_SETTINGS_KEY, SETTINGS_MIGRATIONS_KEY } from "./keys";
|
|
import { migrateAppSettings } from "./migrations";
|
|
import { DEFAULT_CLIENT_SETTINGS, type AppSettings, type SendBehavior } from "./storage";
|
|
|
|
function settingsWith(sendBehavior: SendBehavior): AppSettings {
|
|
return { ...DEFAULT_CLIENT_SETTINGS, sendBehavior };
|
|
}
|
|
|
|
type Storage = ReturnType<typeof createInMemoryKeyValueStorage>;
|
|
|
|
function appliedIds(storage: Storage): string[] {
|
|
const raw = storage.entries.get(SETTINGS_MIGRATIONS_KEY);
|
|
return raw === undefined ? [] : JSON.parse(raw).applied;
|
|
}
|
|
|
|
function storedSendBehavior(storage: Storage): SendBehavior | undefined {
|
|
const raw = storage.entries.get(APP_SETTINGS_KEY);
|
|
return raw === undefined ? undefined : JSON.parse(raw).sendBehavior;
|
|
}
|
|
|
|
/** An in-memory storage whose write to `failingKey` always throws, as a full disk would. */
|
|
function createFailingWriteStorage(failingKey: string): Storage {
|
|
const storage = createInMemoryKeyValueStorage();
|
|
const setItem = storage.setItem.bind(storage);
|
|
return Object.assign(storage, {
|
|
async setItem(key: string, value: string) {
|
|
if (key === failingKey) throw new Error(`write to ${key} failed`);
|
|
await setItem(key, value);
|
|
},
|
|
});
|
|
}
|
|
|
|
describe("migrateAppSettings", () => {
|
|
it("flips a stored interrupt to steer and marks itself applied", async () => {
|
|
const storage = createInMemoryKeyValueStorage();
|
|
|
|
const result = await migrateAppSettings(settingsWith("interrupt"), storage);
|
|
|
|
expect(result.sendBehavior).toBe("steer");
|
|
expect(storedSendBehavior(storage)).toBe("steer");
|
|
expect(appliedIds(storage)).toEqual(["steer-default"]);
|
|
});
|
|
|
|
it("leaves interrupt alone once the migration has run", async () => {
|
|
const storage = createInMemoryKeyValueStorage();
|
|
await migrateAppSettings(settingsWith("interrupt"), storage);
|
|
|
|
const result = await migrateAppSettings(settingsWith("interrupt"), storage);
|
|
|
|
expect(result.sendBehavior).toBe("interrupt");
|
|
});
|
|
|
|
it("leaves queue alone", async () => {
|
|
const storage = createInMemoryKeyValueStorage();
|
|
|
|
const result = await migrateAppSettings(settingsWith("queue"), storage);
|
|
|
|
expect(result.sendBehavior).toBe("queue");
|
|
expect(storage.entries.has(APP_SETTINGS_KEY)).toBe(false);
|
|
expect(appliedIds(storage)).toEqual(["steer-default"]);
|
|
});
|
|
|
|
it("marks itself applied on a fresh install without rewriting settings", async () => {
|
|
const storage = createInMemoryKeyValueStorage();
|
|
|
|
await migrateAppSettings(settingsWith("steer"), storage);
|
|
|
|
expect(storage.entries.has(APP_SETTINGS_KEY)).toBe(false);
|
|
expect(appliedIds(storage)).toEqual(["steer-default"]);
|
|
});
|
|
|
|
it("keeps unknown migration ids written by a newer client", async () => {
|
|
const storage = createInMemoryKeyValueStorage({
|
|
[SETTINGS_MIGRATIONS_KEY]: JSON.stringify({ applied: ["some-later-migration"] }),
|
|
});
|
|
|
|
await migrateAppSettings(settingsWith("interrupt"), storage);
|
|
|
|
expect(appliedIds(storage)).toEqual(["some-later-migration", "steer-default"]);
|
|
});
|
|
|
|
it("stays unmarked when the settings write fails, so a later launch retries", async () => {
|
|
const storage = createFailingWriteStorage(APP_SETTINGS_KEY);
|
|
|
|
await expect(migrateAppSettings(settingsWith("interrupt"), storage)).rejects.toThrow();
|
|
|
|
expect(appliedIds(storage)).toEqual([]);
|
|
});
|
|
|
|
it("re-runs harmlessly when the marker write fails after settings landed", async () => {
|
|
const failing = createFailingWriteStorage(SETTINGS_MIGRATIONS_KEY);
|
|
await expect(migrateAppSettings(settingsWith("interrupt"), failing)).rejects.toThrow();
|
|
expect(storedSendBehavior(failing)).toBe("steer");
|
|
|
|
const recovered = createInMemoryKeyValueStorage(Object.fromEntries(failing.entries));
|
|
const result = await migrateAppSettings(settingsWith("steer"), recovered);
|
|
|
|
expect(result.sendBehavior).toBe("steer");
|
|
expect(appliedIds(recovered)).toEqual(["steer-default"]);
|
|
});
|
|
});
|