Gabriel Brown
d96863b687
colour -> color, behaviour -> behavior, centre -> center, favourite -> favorite, and about twenty other pairs, applied consistently across comments, docs, error/UI copy, and a handful of QML identifiers that used the British spelling as their actual name: SystemSettings' serialiseValue/serialiseTable/normaliseGradient, Displays' normaliseModes, Wallpaper's normalisePolicy, SettingsBackup's serialiseHomeState, DateTime's ntpSynchronised property, Clipboard's _normalise helper, and ShortcutCapture's cancelled signal (with its onCancelled handler in ShortcutsPage.qml). Every call site and the two tests that assert on the literal source text (settings-ownership and settings-backup-live contracts) were updated in lockstep. Left untouched: config/dot/espanso/match/packages/misspell-en/ is a vendored third-party autocorrect dictionary -- its entries are typo corrections, not our prose, and rewriting them would fight the package's own purpose (and any future re-sync from upstream). The already-American `favorites` property (Home page pinned accessories) was never actually misspelled -- only nearby comments and error strings said "favourites" -- so no data migration was needed there. Claude-Session: https://claude.ai/code/session_01E6TJUAh41HaP25MVHWkhRZ
57 lines
2.8 KiB
QML
57 lines
2.8 KiB
QML
// Exercises Migrations.applyWith against fixture steps and prints a verdict per
|
|
// case. Run by tests/quickshell/migrations-contract.sh.
|
|
//
|
|
// Fixture steps rather than the real list: the real one is empty until the
|
|
// first breaking schema change, and a mechanism that has never been run against
|
|
// a failing step is not one to discover the behavior of during an upgrade.
|
|
|
|
import Quickshell
|
|
import QtQuick
|
|
import qs.config
|
|
|
|
ShellRoot {
|
|
Component.onCompleted: {
|
|
const steps = [
|
|
{ version: 2, describe: "add b", migrate: v => { v.b = (v.a ?? 0) + 1; return v; } },
|
|
{ version: 3, describe: "add c", migrate: v => { v.c = "three"; return v; } },
|
|
{ version: 4, describe: "explode", migrate: v => { throw new Error("boom"); } }
|
|
];
|
|
const results = {};
|
|
|
|
// No version at all: a file written before versioning. Stamped, never
|
|
// migrated.
|
|
let r = Migrations.applyWith({ a: 1 }, steps, 3, 1);
|
|
results.unversioned = { v: r.values.schemaVersion, migrated: r.migrated,
|
|
changed: r.changed, untouched: r.values.b === undefined };
|
|
|
|
// Older file: every step above its version runs, in order.
|
|
r = Migrations.applyWith({ a: 1, schemaVersion: 1 }, steps, 3, 1);
|
|
results.upgrade = { v: r.values.schemaVersion, b: r.values.b, c: r.values.c,
|
|
count: r.applied.length, migrated: r.migrated };
|
|
|
|
// Already current: nothing runs.
|
|
r = Migrations.applyWith({ schemaVersion: 3, keep: "me" }, steps, 3, 1);
|
|
results.current = { v: r.values.schemaVersion, migrated: r.migrated,
|
|
kept: r.values.keep === "me", b: r.values.b === undefined };
|
|
|
|
// From the future: left completely alone, including its unknown keys.
|
|
r = Migrations.applyWith({ schemaVersion: 9, futureKey: "x" }, steps, 3, 1);
|
|
results.future = { v: r.values.schemaVersion, migrated: r.migrated,
|
|
changed: r.changed, kept: r.values.futureKey === "x" };
|
|
|
|
// A failing step stops at the last good version rather than losing the
|
|
// file or skipping past the failure forever.
|
|
r = Migrations.applyWith({ schemaVersion: 1, a: 5 }, steps, 4, 1);
|
|
results.failure = { v: r.values.schemaVersion, b: r.values.b, c: r.values.c,
|
|
kept: r.values.a === 5, count: r.applied.length };
|
|
|
|
// Unknown keys survive a migration: rolling back to an older Panama
|
|
// must not discard a newer version's settings.
|
|
r = Migrations.applyWith({ schemaVersion: 1, unknownFromFuture: true }, steps, 3, 1);
|
|
results.preserved = { kept: r.values.unknownFromFuture === true };
|
|
|
|
console.info("PANAMA-MIGRATIONS " + JSON.stringify(results));
|
|
Qt.callLater(() => Qt.quit());
|
|
}
|
|
}
|