import { describe, expect, it } from "vitest"; import { DEFAULT_EDITOR_SETTINGS, type EditorSettings } from "@/stores/settingsStore"; import { EDITOR_SETTINGS_DRAFT_KEYS } from "../editorSettingsDraft"; import { buildSettingsTransferFilename, collectTransferCategories, parseSettingsTransferFile, serializeSettingsTransfer, SETTINGS_TRANSFER_FORMAT_VERSION, transferCategoryForKey } from "../settingsTransfer"; function fileWith(editor: Record, overrides: Record = {}): string { return JSON.stringify({ formatVersion: SETTINGS_TRANSFER_FORMAT_VERSION, app: { name: "dbx", version: "1.2.3" }, exportedAt: "2026-09-06T00:00:00.000Z", settings: { editor }, ...overrides, }); } describe("settingsTransfer", () => { it("builds a dated transfer filename", () => { expect(buildSettingsTransferFilename(new Date(2026, 8, 6))).toBe("dbx-settings-2026-09-06.json"); }); it("round-trips the default settings through serialize and parse", () => { const text = serializeSettingsTransfer(DEFAULT_EDITOR_SETTINGS, { appVersion: "1.2.3" }); const result = parseSettingsTransferFile(text); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.appVersion).toBe("1.2.3"); expect(Object.keys(result.value.editorSettings).sort()).toEqual([...EDITOR_SETTINGS_DRAFT_KEYS].sort()); expect(result.value.editorSettings.pageSize).toBe(DEFAULT_EDITOR_SETTINGS.pageSize); expect(result.value.editorSettings.snippets).toEqual(DEFAULT_EDITOR_SETTINGS.snippets); expect(result.value.categories).toContain("snippets"); expect(result.value.categories).toContain("shortcuts"); }); it("keeps connection timeout ownership out of the payload", () => { const text = serializeSettingsTransfer(DEFAULT_EDITOR_SETTINGS); expect(text).not.toContain("connectTimeoutInheritConnectionIds"); expect(text).not.toContain("queryTimeoutInheritConnectionIds"); }); it("rejects invalid JSON", () => { const result = parseSettingsTransferFile("{ not json"); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("invalid-json"); }); it("rejects unsupported format versions", () => { const result = parseSettingsTransferFile(fileWith({}, { formatVersion: 99 })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("unsupported-version"); expect(result.error.detail).toBe("99"); }); it("rejects wrong-typed fields", () => { const result = parseSettingsTransferFile(fileWith({ fontSize: "big" })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("invalid-fields"); expect(result.error.detail).toContain("fontSize"); }); it("rejects out-of-domain enum values", () => { const result = parseSettingsTransferFile(fileWith({ updateDownloadSource: "evil" })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("invalid-fields"); expect(result.error.detail).toContain("updateDownloadSource"); }); it("rejects out-of-range numbers that the normalizer clamps", () => { const result = parseSettingsTransferFile(fileWith({ sidebarIndent: 99999 })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("invalid-fields"); expect(result.error.detail).toContain("sidebarIndent"); }); it("rejects pass-through numeric fields outside the editor font range", () => { const zero = parseSettingsTransferFile(fileWith({ fontSize: 0 })); expect(zero.ok).toBe(false); if (zero.ok) return; expect(zero.error.detail).toContain("fontSize"); const huge = parseSettingsTransferFile(fileWith({ fontSize: 100 })); expect(huge.ok).toBe(false); }); it("accepts in-range fractional editor font sizes", () => { const result = parseSettingsTransferFile(fileWith({ fontSize: 13.5 })); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.fontSize).toBe(13.5); }); it("rejects pass-through layout enums", () => { const result = parseSettingsTransferFile(fileWith({ appLayout: "invalid" })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.code).toBe("invalid-fields"); expect(result.error.detail).toContain("appLayout"); }); it("rejects pass-through boolean flags with non-boolean values", () => { const result = parseSettingsTransferFile(fileWith({ wordWrap: "yes" })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.detail).toContain("wordWrap"); }); it("rejects toolbar items whose known keys are not booleans", () => { const result = parseSettingsTransferFile(fileWith({ toolbarItems: { dataTransfer: "yes" } })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.detail).toContain("toolbarItems"); }); it("rejects toolbar flags that the normalizer would coerce", () => { const result = parseSettingsTransferFile(fileWith({ toolbarItems: { exclusiveRightSidebarPanels: "no" } })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.detail).toContain("toolbarItems"); }); it("rejects empty active custom theme ids", () => { const result = parseSettingsTransferFile(fileWith({ activeCustomThemeId: " " })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.detail).toContain("activeCustomThemeId"); }); it("imports only the keys present in the file", () => { const result = parseSettingsTransferFile(fileWith({ theme: DEFAULT_EDITOR_SETTINGS.theme })); expect(result.ok).toBe(true); if (!result.ok) return; expect(Object.keys(result.value.editorSettings)).toEqual(["theme"]); expect(result.value.categories).toEqual(["appearance"]); }); it("round-trips persistent filter editor expansion as a data setting", () => { const result = parseSettingsTransferFile(fileWith({ dataGridKeepFilterEditorExpanded: true })); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.dataGridKeepFilterEditorExpanded).toBe(true); expect(result.value.categories).toEqual(["data"]); expect(transferCategoryForKey("dataGridKeepFilterEditorExpanded")).toBe("data"); }); it("migrates the legacy auto-hide filter preference from older exports", () => { const expanded = parseSettingsTransferFile(fileWith({ dataGridAutoHideFilterBuilder: false })); expect(expanded.ok).toBe(true); if (expanded.ok) expect(expanded.value.editorSettings.dataGridKeepFilterEditorExpanded).toBe(true); const collapsed = parseSettingsTransferFile(fileWith({ dataGridAutoHideFilterBuilder: true })); expect(collapsed.ok).toBe(true); if (collapsed.ok) expect(collapsed.value.editorSettings.dataGridKeepFilterEditorExpanded).toBe(false); }); it("ignores unknown fields instead of importing them", () => { const result = parseSettingsTransferFile( fileWith({ theme: DEFAULT_EDITOR_SETTINGS.theme, notARealSetting: "injected", connectTimeoutInheritConnectionIds: ["conn-1"], }), ); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings).not.toHaveProperty("notARealSetting"); expect(result.value.editorSettings).not.toHaveProperty("connectTimeoutInheritConnectionIds"); }); it("sanitizes object fields through the store normalizer", () => { const result = parseSettingsTransferFile(fileWith({ shortcuts: {} })); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.shortcuts).toEqual(DEFAULT_EDITOR_SETTINGS.shortcuts); }); it("rejects files without importable settings", () => { const result = parseSettingsTransferFile(fileWith({ notARealSetting: true })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("empty-settings"); }); it("rejects oversized files", () => { const result = parseSettingsTransferFile("x".repeat(5 * 1024 * 1024 + 1)); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.code).toBe("too-large"); }); it("maps every whitelisted key to a display category", () => { for (const key of EDITOR_SETTINGS_DRAFT_KEYS) { expect(transferCategoryForKey(key), key).toBeDefined(); } expect(transferCategoryForKey("notARealSetting")).toBeUndefined(); }); it("round-trips the wallpaper settings under the appearance category", () => { const settings: EditorSettings = { ...DEFAULT_EDITOR_SETTINGS, backgroundImage: { ...DEFAULT_EDITOR_SETTINGS.backgroundImage, filePath: "/data/background-image.png", fileName: "wall.png", opacity: 0.42 }, }; const result = parseSettingsTransferFile(serializeSettingsTransfer(settings)); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.backgroundImage).toEqual(settings.backgroundImage); expect(transferCategoryForKey("backgroundImage")).toBe("appearance"); }); it("collects categories in display order without duplicates", () => { expect(collectTransferCategories(["snippets", "theme", "shortcuts", "fontFamily"])).toEqual(["appearance", "shortcuts", "snippets"]); }); it("does not mutate the shared defaults while validating", () => { const before = JSON.stringify(DEFAULT_EDITOR_SETTINGS) as string; parseSettingsTransferFile(fileWith({ shortcuts: { hijacked: true }, customThemes: [{ id: "x" }] })); expect(JSON.stringify(DEFAULT_EDITOR_SETTINGS)).toBe(before); }); it("accepts a serialized draft of arbitrary settings unchanged", () => { const settings = { ...DEFAULT_EDITOR_SETTINGS, theme: DEFAULT_EDITOR_SETTINGS.theme, pageSize: 200, snippets: [{ id: "s1", label: "L", prefix: "p", body: "SELECT 1", enabled: true }], } as EditorSettings; const result = parseSettingsTransferFile(serializeSettingsTransfer(settings)); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.pageSize).toBe(200); expect(result.value.editorSettings.snippets).toEqual(settings.snippets); }); it("round-trips table default sorting settings", () => { const settings = { ...DEFAULT_EDITOR_SETTINGS, tableOpenSortMode: "database", tableDatabaseSortDirection: "desc", tableLocalSortDirection: "asc", } as EditorSettings; const result = parseSettingsTransferFile(serializeSettingsTransfer(settings)); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.tableOpenSortMode).toBe("database"); expect(result.value.editorSettings.tableDatabaseSortDirection).toBe("desc"); expect(result.value.editorSettings.tableLocalSortDirection).toBe("asc"); expect(transferCategoryForKey("tableOpenSortMode")).toBe("data"); }); it("rejects custom theme items that lack id or name", () => { const validTheme = { ...DEFAULT_EDITOR_SETTINGS.customThemes[0] }; const idless = parseSettingsTransferFile(fileWith({ customThemes: [{ ...validTheme, id: "" }] })); expect(idless.ok).toBe(false); if (idless.ok) return; expect(idless.error.detail).toContain("customThemes"); const unnamed = parseSettingsTransferFile(fileWith({ customThemes: [{ ...validTheme, name: undefined }] })); expect(unnamed.ok).toBe(false); if (unnamed.ok) return; expect(unnamed.error.detail).toContain("customThemes"); }); it("rejects custom theme items with wrong-typed colors", () => { const validTheme = DEFAULT_EDITOR_SETTINGS.customThemes[0]; const result = parseSettingsTransferFile( fileWith({ customThemes: [{ ...validTheme, id: "t1", name: "T1", colors: { ...validTheme.colors, keyword: 5 } }], }), ); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("customThemes"); }); it("rejects custom theme items with wrong-typed optional background and foreground colors", () => { const validTheme = DEFAULT_EDITOR_SETTINGS.customThemes[0]; const background = parseSettingsTransferFile( fileWith({ customThemes: [{ ...validTheme, id: "t1", name: "T1", colors: { ...validTheme.colors, background: {} } }], }), ); expect(background.ok).toBe(false); if (background.ok) return; expect(background.error.detail).toContain("customThemes"); const foreground = parseSettingsTransferFile( fileWith({ customThemes: [{ ...validTheme, id: "t1", name: "T1", colors: { ...validTheme.colors, foreground: 5 } }], }), ); expect(foreground.ok).toBe(false); }); it("accepts custom theme items with optional background and foreground colors", () => { const base = DEFAULT_EDITOR_SETTINGS.customThemes[0]; const validTheme = { ...base, id: "t1", name: "T1", colors: { ...base.colors, background: "#282c34", foreground: "#abb2bf" } }; const result = parseSettingsTransferFile(fileWith({ customThemes: [validTheme] })); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.customThemes).toEqual([validTheme]); }); it("rejects null custom theme items instead of crashing", () => { const result = parseSettingsTransferFile(fileWith({ customThemes: [null] })); expect(result.ok).toBe(false); if (!result.ok) return; expect(result.error.code).toBe("invalid-fields"); expect(result.error.detail).toContain("customThemes"); }); it("accepts complete custom themes and data grid color schemes", () => { const validTheme = { ...DEFAULT_EDITOR_SETTINGS.customThemes[0], id: "t1", name: "T1" }; const scheme = { id: "s1", name: "S1", colors: { integer: "#1d4ed8", numeric: "#0e7490", string: "#166534", boolean: "#c2410c", temporal: "#7e22ce", structured: "#be185d", identifier: "#92400e", binary: "#b91c1c", spatial: "#047857" }, }; const result = parseSettingsTransferFile(fileWith({ customThemes: [validTheme], dataGridTypeColorSchemes: [scheme] })); expect(result.ok).toBe(true); if (!result.ok) return; expect(result.value.editorSettings.customThemes).toEqual([validTheme]); expect(result.value.editorSettings.dataGridTypeColorSchemes).toEqual([scheme]); }); it("rejects data grid color schemes claiming the reserved auto id", () => { const result = parseSettingsTransferFile(fileWith({ dataGridTypeColorSchemes: [{ id: "auto", name: "S" }] })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("dataGridTypeColorSchemes"); }); it("rejects malformed snippet items instead of substituting defaults", () => { const result = parseSettingsTransferFile(fileWith({ snippets: [{}] })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("snippets"); }); it("rejects malformed sql shortcut items", () => { const result = parseSettingsTransferFile(fileWith({ sqlShortcuts: [{ id: "s1" }] })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("sqlShortcuts"); }); it("rejects non-string entries in string array settings", () => { const redis = parseSettingsTransferFile(fileWith({ redisKeyTemplates: [5] })); expect(redis.ok).toBe(false); if (redis.ok) return; expect(redis.error.detail).toContain("redisKeyTemplates"); const prefixes = parseSettingsTransferFile(fileWith({ sidebarHiddenTablePrefixes: [null] })); expect(prefixes.ok).toBe(false); if (prefixes.ok) return; expect(prefixes.error.detail).toContain("sidebarHiddenTablePrefixes"); }); it("rejects formatter settings missing a required option", () => { const partialFormatter: Record = { ...DEFAULT_EDITOR_SETTINGS.sqlFormatter }; delete partialFormatter.keywordCase; const result = parseSettingsTransferFile(fileWith({ sqlFormatter: partialFormatter })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("sqlFormatter"); }); it("rejects malformed sql variable syntax overrides", () => { const result = parseSettingsTransferFile(fileWith({ sqlVariableSyntaxOverrides: { mysql: { positional: "yes" } } })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("sqlVariableSyntaxOverrides"); }); it("rejects shortcut overrides whose known keys are not strings", () => { const result = parseSettingsTransferFile(fileWith({ shortcuts: { executeSql: 5 } })); expect(result.ok).toBe(false); if (result.ok) return; expect(result.error.detail).toContain("shortcuts"); }); it("maps csvQuoteMode into the data category", () => { expect(transferCategoryForKey("csvQuoteMode")).toBe("data"); expect(collectTransferCategories(["csvQuoteMode", "pageSize"])).toEqual(["data"]); }); });