feat(updater): support ignoring a specific version
This commit is contained in:
1 parent
c6f9ddb5a4
commit
967084c498
16 files changed
+439
-14
No files matched your search
@@ -667,6 +667,124 @@ describe("settingsStore persisted settings initialization", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("settingsStore editor settings persistence", () => {
|
||||
beforeEach(() => {
|
||||
vi.resetModules();
|
||||
setActivePinia(createPinia());
|
||||
});
|
||||
|
||||
it("rolls back a failed atomic update and allows retry", async () => {
|
||||
const loadEditorSettings = vi.fn().mockResolvedValue({
|
||||
ignoredUpdateVersion: "",
|
||||
executeModeDefaultVersion: EXECUTE_MODE_CURRENT_DEFAULT_VERSION,
|
||||
});
|
||||
const saveEditorSettings = vi.fn().mockRejectedValueOnce(new Error("save failed")).mockResolvedValueOnce(undefined);
|
||||
vi.doMock("@/lib/backend/api", () => ({ loadEditorSettings, saveEditorSettings }));
|
||||
|
||||
const { useSettingsStore } = await import("@/stores/settingsStore");
|
||||
const store = useSettingsStore();
|
||||
await store.initEditorSettings();
|
||||
|
||||
await expect(store.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.70" })).rejects.toThrow("save failed");
|
||||
expect(store.editorSettings.ignoredUpdateVersion).toBe("");
|
||||
|
||||
await store.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.70" });
|
||||
|
||||
expect(store.editorSettings.ignoredUpdateVersion).toBe("0.5.70");
|
||||
expect(saveEditorSettings).toHaveBeenCalledTimes(2);
|
||||
expect(saveEditorSettings).toHaveBeenLastCalledWith(expect.objectContaining({ ignoredUpdateVersion: "0.5.70" }));
|
||||
});
|
||||
|
||||
it("loads the persisted ignored version in a new store instance", async () => {
|
||||
let persistedSettings: Record<string, unknown> = {
|
||||
ignoredUpdateVersion: "",
|
||||
executeModeDefaultVersion: EXECUTE_MODE_CURRENT_DEFAULT_VERSION,
|
||||
};
|
||||
const loadEditorSettings = vi.fn(async () => JSON.parse(JSON.stringify(persistedSettings)));
|
||||
const saveEditorSettings = vi.fn(async (settings: Record<string, unknown>) => {
|
||||
persistedSettings = JSON.parse(JSON.stringify(settings));
|
||||
});
|
||||
vi.doMock("@/lib/backend/api", () => ({ loadEditorSettings, saveEditorSettings }));
|
||||
|
||||
const { useSettingsStore } = await import("@/stores/settingsStore");
|
||||
const firstStore = useSettingsStore();
|
||||
await firstStore.initEditorSettings();
|
||||
await firstStore.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.70" });
|
||||
|
||||
setActivePinia(createPinia());
|
||||
const restartedStore = useSettingsStore();
|
||||
await restartedStore.initEditorSettings();
|
||||
|
||||
expect(restartedStore.editorSettings.ignoredUpdateVersion).toBe("0.5.70");
|
||||
});
|
||||
|
||||
it("serializes overlapping saves so an older snapshot cannot finish last", async () => {
|
||||
let resolveFirstSave!: () => void;
|
||||
const loadEditorSettings = vi.fn().mockResolvedValue({
|
||||
ignoredUpdateVersion: "",
|
||||
executeModeDefaultVersion: EXECUTE_MODE_CURRENT_DEFAULT_VERSION,
|
||||
});
|
||||
const saveEditorSettings = vi.fn().mockImplementationOnce(
|
||||
() =>
|
||||
new Promise<void>((resolve) => {
|
||||
resolveFirstSave = resolve;
|
||||
}),
|
||||
);
|
||||
saveEditorSettings.mockResolvedValueOnce(undefined);
|
||||
vi.doMock("@/lib/backend/api", () => ({ loadEditorSettings, saveEditorSettings }));
|
||||
|
||||
const { useSettingsStore } = await import("@/stores/settingsStore");
|
||||
const store = useSettingsStore();
|
||||
await store.initEditorSettings();
|
||||
|
||||
const firstSave = store.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.70" });
|
||||
await vi.waitFor(() => expect(saveEditorSettings).toHaveBeenCalledOnce());
|
||||
const secondSave = store.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.71" });
|
||||
|
||||
expect(saveEditorSettings).toHaveBeenCalledOnce();
|
||||
expect(store.editorSettings.ignoredUpdateVersion).toBe("0.5.70");
|
||||
resolveFirstSave();
|
||||
await Promise.all([firstSave, secondSave]);
|
||||
|
||||
expect(store.editorSettings.ignoredUpdateVersion).toBe("0.5.71");
|
||||
expect(saveEditorSettings).toHaveBeenCalledTimes(2);
|
||||
expect(saveEditorSettings.mock.calls[0][0]).toEqual(expect.objectContaining({ ignoredUpdateVersion: "0.5.70" }));
|
||||
expect(saveEditorSettings.mock.calls[1][0]).toEqual(expect.objectContaining({ ignoredUpdateVersion: "0.5.71" }));
|
||||
});
|
||||
|
||||
it("does not carry a failed atomic value into an already queued unrelated save", async () => {
|
||||
let rejectFirstSave!: (error: Error) => void;
|
||||
const loadEditorSettings = vi.fn().mockResolvedValue({
|
||||
ignoredUpdateVersion: "",
|
||||
theme: "system",
|
||||
executeModeDefaultVersion: EXECUTE_MODE_CURRENT_DEFAULT_VERSION,
|
||||
});
|
||||
const saveEditorSettings = vi.fn().mockImplementationOnce(
|
||||
() =>
|
||||
new Promise<void>((_resolve, reject) => {
|
||||
rejectFirstSave = reject;
|
||||
}),
|
||||
);
|
||||
saveEditorSettings.mockResolvedValueOnce(undefined);
|
||||
vi.doMock("@/lib/backend/api", () => ({ loadEditorSettings, saveEditorSettings }));
|
||||
|
||||
const { useSettingsStore } = await import("@/stores/settingsStore");
|
||||
const store = useSettingsStore();
|
||||
await store.initEditorSettings();
|
||||
|
||||
const ignoredVersionSave = store.updateEditorSettingsAndPersist({ ignoredUpdateVersion: "0.5.70" });
|
||||
await vi.waitFor(() => expect(saveEditorSettings).toHaveBeenCalledOnce());
|
||||
store.updateEditorSettings({ theme: "xcode-dark" });
|
||||
rejectFirstSave(new Error("save failed"));
|
||||
|
||||
await expect(ignoredVersionSave).rejects.toThrow("save failed");
|
||||
await vi.waitFor(() => expect(saveEditorSettings).toHaveBeenCalledTimes(2));
|
||||
|
||||
expect(store.editorSettings).toMatchObject({ ignoredUpdateVersion: "", theme: "xcode-dark" });
|
||||
expect(saveEditorSettings.mock.calls[1][0]).toEqual(expect.objectContaining({ ignoredUpdateVersion: "", theme: "xcode-dark" }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("settingsStore sidebar connection sort persistence", () => {
|
||||
beforeEach(() => {
|
||||
vi.resetModules();
|
||||
|
||||
@@ -590,6 +590,7 @@ export interface EditorSettings {
|
||||
exportRowLimit: number;
|
||||
queryExportKeysetOptimizationEnabled: boolean;
|
||||
updateDownloadSource: UpdateDownloadSource;
|
||||
ignoredUpdateVersion: string;
|
||||
toolbarItems: ToolbarItems;
|
||||
objectBrowserShowCheckbox: boolean;
|
||||
objectBrowserViewMode: "list" | "grid";
|
||||
@@ -779,6 +780,7 @@ export const DEFAULT_EDITOR_SETTINGS: EditorSettings = {
|
||||
exportRowLimit: 100000,
|
||||
queryExportKeysetOptimizationEnabled: true,
|
||||
updateDownloadSource: "official",
|
||||
ignoredUpdateVersion: "",
|
||||
toolbarItems: { ...DEFAULT_TOOLBAR_ITEMS },
|
||||
objectBrowserShowCheckbox: false,
|
||||
objectBrowserViewMode: "list",
|
||||
@@ -1153,6 +1155,7 @@ export function normalizeEditorSettings(settings: Partial<EditorSettings>, exist
|
||||
exportRowLimit: typeof settings.exportRowLimit === "number" && settings.exportRowLimit >= 100 && settings.exportRowLimit <= 2147483647 ? Math.round(settings.exportRowLimit) : DEFAULT_EDITOR_SETTINGS.exportRowLimit,
|
||||
queryExportKeysetOptimizationEnabled: typeof settings.queryExportKeysetOptimizationEnabled === "boolean" ? settings.queryExportKeysetOptimizationEnabled : DEFAULT_EDITOR_SETTINGS.queryExportKeysetOptimizationEnabled,
|
||||
updateDownloadSource: normalizeUpdateDownloadSource(settings.updateDownloadSource),
|
||||
ignoredUpdateVersion: typeof settings.ignoredUpdateVersion === "string" ? settings.ignoredUpdateVersion : DEFAULT_EDITOR_SETTINGS.ignoredUpdateVersion,
|
||||
toolbarItems: normalizeToolbarItems(settings.toolbarItems),
|
||||
objectBrowserShowCheckbox: typeof settings.objectBrowserShowCheckbox === "boolean" ? settings.objectBrowserShowCheckbox : DEFAULT_EDITOR_SETTINGS.objectBrowserShowCheckbox,
|
||||
objectBrowserViewMode: settings.objectBrowserViewMode === "grid" ? "grid" : DEFAULT_EDITOR_SETTINGS.objectBrowserViewMode,
|
||||
@@ -1197,10 +1200,6 @@ function editorSettingsPatchSnapshot(settings: Partial<EditorSettings>): Partial
|
||||
return JSON.parse(JSON.stringify(settings)) as Partial<EditorSettings>;
|
||||
}
|
||||
|
||||
function saveEditorSettings(settings: EditorSettings) {
|
||||
void api.saveEditorSettings(editorSettingsSnapshot(settings)).catch(() => {});
|
||||
}
|
||||
|
||||
export interface SettingsNavigationRequest {
|
||||
id: number;
|
||||
tab: string;
|
||||
@@ -1224,11 +1223,37 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
const isEditorSettingsLoaded = ref(false);
|
||||
let initEditorSettingsPromise: Promise<void> | null = null;
|
||||
let pendingEditorSettingsPatches: Partial<EditorSettings>[] = [];
|
||||
let editorSettingsSaveQueue: Promise<void> | null = null;
|
||||
let editorSettingsAtomicUpdateQueue: Promise<void> = Promise.resolve();
|
||||
let editorSettingsPatchRevision = 0;
|
||||
const editorSettingsFieldRevisions = new Map<keyof EditorSettings, number>();
|
||||
let pendingAiChatSelection: AiChatSelectionState | null = null;
|
||||
let aiChatSelectionSaveRunning = false;
|
||||
|
||||
const editorSettings = ref<EditorSettings>(normalizeEditorSettings({}));
|
||||
|
||||
function enqueueEditorSettingsSave(): Promise<void> {
|
||||
const saveCurrentSettings = () => api.saveEditorSettings(editorSettingsSnapshot(editorSettings.value));
|
||||
const save = editorSettingsSaveQueue ? editorSettingsSaveQueue.catch(() => {}).then(saveCurrentSettings) : saveCurrentSettings();
|
||||
const trackedSave = save.finally(() => {
|
||||
if (editorSettingsSaveQueue === trackedSave) editorSettingsSaveQueue = null;
|
||||
});
|
||||
editorSettingsSaveQueue = trackedSave;
|
||||
return trackedSave;
|
||||
}
|
||||
|
||||
function saveEditorSettings() {
|
||||
void enqueueEditorSettingsSave().catch(() => {});
|
||||
}
|
||||
|
||||
function markEditorSettingsPatch(partial: Partial<EditorSettings>): number {
|
||||
const revision = ++editorSettingsPatchRevision;
|
||||
for (const key of Object.keys(partial) as (keyof EditorSettings)[]) {
|
||||
if (partial[key] !== undefined) editorSettingsFieldRevisions.set(key, revision);
|
||||
}
|
||||
return revision;
|
||||
}
|
||||
|
||||
function requestSettingsNavigation(tab: string, section?: string) {
|
||||
settingsNavigationRequest.value = {
|
||||
id: Date.now(),
|
||||
@@ -1246,7 +1271,7 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
pendingEditorSettingsPatches = [];
|
||||
for (const patch of pendingPatches) applyEditorSettingsPatch(patch);
|
||||
isEditorSettingsLoaded.value = true;
|
||||
if (pendingPatches.length) saveEditorSettings(editorSettings.value);
|
||||
if (pendingPatches.length) saveEditorSettings();
|
||||
}
|
||||
|
||||
async function initEditorSettings() {
|
||||
@@ -1265,7 +1290,7 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
const savedUpdateDownloadSource = (saved as { updateDownloadSource?: unknown }).updateDownloadSource;
|
||||
if (savedUpdateDownloadSource === "atomgit" || needsExecuteModeDefaultMigration) {
|
||||
// Persist one-time migrations so removed or unsafe defaults cannot reappear.
|
||||
await api.saveEditorSettings(normalized).catch(() => {});
|
||||
await enqueueEditorSettingsSave().catch(() => {});
|
||||
}
|
||||
completeEditorSettingsInitialization();
|
||||
return;
|
||||
@@ -1275,7 +1300,7 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
if (legacy) {
|
||||
editorSettings.value = legacy;
|
||||
try {
|
||||
await api.saveEditorSettings(legacy);
|
||||
await enqueueEditorSettingsSave();
|
||||
// Existing desktop users keep settings in localStorage; remove them only
|
||||
// after the async store has accepted the migrated value.
|
||||
clearLegacyEditorSettings();
|
||||
@@ -1666,6 +1691,7 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
if (partial.exportRowLimit !== undefined) editorSettings.value.exportRowLimit = Math.min(2147483647, Math.max(100, Math.round(partial.exportRowLimit)));
|
||||
if (partial.queryExportKeysetOptimizationEnabled !== undefined) editorSettings.value.queryExportKeysetOptimizationEnabled = partial.queryExportKeysetOptimizationEnabled;
|
||||
if (partial.updateDownloadSource !== undefined) editorSettings.value.updateDownloadSource = normalizeUpdateDownloadSource(partial.updateDownloadSource);
|
||||
if (partial.ignoredUpdateVersion !== undefined) editorSettings.value.ignoredUpdateVersion = typeof partial.ignoredUpdateVersion === "string" ? partial.ignoredUpdateVersion : "";
|
||||
if (partial.toolbarItems !== undefined) editorSettings.value.toolbarItems = normalizeToolbarItems(partial.toolbarItems);
|
||||
if (partial.objectBrowserShowCheckbox !== undefined) editorSettings.value.objectBrowserShowCheckbox = partial.objectBrowserShowCheckbox === true;
|
||||
if (partial.objectBrowserViewMode !== undefined) editorSettings.value.objectBrowserViewMode = partial.objectBrowserViewMode === "grid" ? "grid" : "list";
|
||||
@@ -1677,16 +1703,45 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
|
||||
function updateEditorSettings(partial: Partial<EditorSettings>) {
|
||||
applyEditorSettingsPatch(partial);
|
||||
markEditorSettingsPatch(partial);
|
||||
if (!isEditorSettingsLoaded.value) {
|
||||
pendingEditorSettingsPatches.push(editorSettingsPatchSnapshot(partial));
|
||||
return;
|
||||
}
|
||||
saveEditorSettings(editorSettings.value);
|
||||
saveEditorSettings();
|
||||
}
|
||||
|
||||
async function persistEditorSettings(): Promise<void> {
|
||||
await initEditorSettings();
|
||||
await api.saveEditorSettings(editorSettingsSnapshot(editorSettings.value));
|
||||
await enqueueEditorSettingsSave();
|
||||
}
|
||||
|
||||
function updateEditorSettingsAndPersist(partial: Partial<EditorSettings>): Promise<void> {
|
||||
const update = editorSettingsAtomicUpdateQueue
|
||||
.catch(() => {})
|
||||
.then(async () => {
|
||||
await initEditorSettings();
|
||||
const previous = editorSettingsSnapshot(editorSettings.value);
|
||||
applyEditorSettingsPatch(partial);
|
||||
const revision = markEditorSettingsPatch(partial);
|
||||
try {
|
||||
await enqueueEditorSettingsSave();
|
||||
} catch (error) {
|
||||
const restored = editorSettingsSnapshot(editorSettings.value) as unknown as Record<string, unknown>;
|
||||
const previousSettings = previous as unknown as Record<string, unknown>;
|
||||
let changed = false;
|
||||
for (const key of Object.keys(partial) as (keyof EditorSettings)[]) {
|
||||
if (partial[key] === undefined || editorSettingsFieldRevisions.get(key) !== revision) continue;
|
||||
restored[key] = previousSettings[key];
|
||||
editorSettingsFieldRevisions.set(key, ++editorSettingsPatchRevision);
|
||||
changed = true;
|
||||
}
|
||||
if (changed) editorSettings.value = normalizeEditorSettings(restored);
|
||||
throw error;
|
||||
}
|
||||
});
|
||||
editorSettingsAtomicUpdateQueue = update.catch(() => {});
|
||||
return update;
|
||||
}
|
||||
|
||||
function updateColumnFormatter(key: string, formatter: ColumnFormatterConfig | undefined) {
|
||||
@@ -1752,6 +1807,7 @@ export const useSettingsStore = defineStore("settings", () => {
|
||||
mcpGlobalPolicy,
|
||||
initEditorSettings,
|
||||
updateEditorSettings,
|
||||
updateEditorSettingsAndPersist,
|
||||
persistEditorSettings,
|
||||
initDesktopSettings,
|
||||
updateDesktopSettings,
|
||||
|
||||
Reference in new issue
Block a user