Align host settings with the 1.0 lifecycle

This commit is contained in:
vorotamoroz
2026-07-20 13:20:48 +00:00
parent 52e7bd25da
commit 80d1416a81
28 changed files with 360 additions and 57 deletions
@@ -3,8 +3,12 @@ import { DEFAULT_SETTINGS } from "@vrtmrz/livesync-commonlib/compat/common/types
import { ensureLocalDatabaseMaintenancePrerequisites } from "./maintenancePrerequisites";
function createPrerequisites(settingsOverride: Partial<typeof DEFAULT_SETTINGS> = {}) {
const askSelectStringDialogue = vi.fn<() => Promise<"Apply and continue" | "Cancel" | false | undefined>>(
async () => "Apply and continue"
const askSelectStringDialogue = vi.fn(
async (
_message: string,
_buttons: readonly ["Apply and continue", "Cancel"],
_options: { title: string; defaultAction: "Cancel" }
): Promise<"Apply and continue" | "Cancel" | false | undefined> => "Apply and continue"
);
const applyPartial = vi.fn(async () => undefined);
const settings = {
@@ -18,13 +22,12 @@ function createPrerequisites(settingsOverride: Partial<typeof DEFAULT_SETTINGS>
}
describe("LocalDatabaseMaintenance prerequisites", () => {
it("asks to apply missing prerequisite settings before maintenance actions", async () => {
it("asks to disable on-demand chunk fetching before maintenance actions", async () => {
const { settings, askSelectStringDialogue, applyPartial } = createPrerequisites();
const result = await ensureLocalDatabaseMaintenancePrerequisites({
operationName: "Garbage Collection",
settings: {
doNotUseFixedRevisionForChunks: settings.doNotUseFixedRevisionForChunks,
readChunksOnline: settings.readChunksOnline,
},
askSelectStringDialogue,
@@ -42,11 +45,11 @@ describe("LocalDatabaseMaintenance prerequisites", () => {
);
expect(applyPartial).toHaveBeenCalledWith(
{
doNotUseFixedRevisionForChunks: true,
readChunksOnline: false,
},
true
);
expect(vi.mocked(askSelectStringDialogue).mock.calls[0]?.[0]).not.toContain("Compute revisions for chunks");
});
it("cancels maintenance actions when prerequisite changes are rejected", async () => {
@@ -56,7 +59,6 @@ describe("LocalDatabaseMaintenance prerequisites", () => {
const result = await ensureLocalDatabaseMaintenancePrerequisites({
operationName: "Garbage Collection",
settings: {
doNotUseFixedRevisionForChunks: settings.doNotUseFixedRevisionForChunks,
readChunksOnline: settings.readChunksOnline,
},
askSelectStringDialogue,
@@ -76,7 +78,6 @@ describe("LocalDatabaseMaintenance prerequisites", () => {
const result = await ensureLocalDatabaseMaintenancePrerequisites({
operationName: "Garbage Collection",
settings: {
doNotUseFixedRevisionForChunks: settings.doNotUseFixedRevisionForChunks,
readChunksOnline: settings.readChunksOnline,
},
askSelectStringDialogue,
@@ -86,4 +87,24 @@ describe("LocalDatabaseMaintenance prerequisites", () => {
expect(askSelectStringDialogue).not.toHaveBeenCalled();
expect(applyPartial).not.toHaveBeenCalled();
});
it("does not treat the obsolete fixed-revision key as a maintenance prerequisite", async () => {
const { settings, askSelectStringDialogue, applyPartial } = createPrerequisites({
doNotUseFixedRevisionForChunks: false,
readChunksOnline: false,
});
const result = await ensureLocalDatabaseMaintenancePrerequisites({
operationName: "Garbage Collection",
settings: {
readChunksOnline: settings.readChunksOnline,
},
askSelectStringDialogue,
applyPartial,
});
expect(result).toBe(true);
expect(askSelectStringDialogue).not.toHaveBeenCalled();
expect(applyPartial).not.toHaveBeenCalled();
});
});
@@ -2,7 +2,7 @@ import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat
type MaintenancePrerequisiteSettings = Pick<
ObsidianLiveSyncSettings,
"doNotUseFixedRevisionForChunks" | "readChunksOnline"
"readChunksOnline"
>;
type MaintenancePrerequisiteOptions = {
@@ -23,14 +23,10 @@ export async function ensureLocalDatabaseMaintenancePrerequisites({
applyPartial,
}: MaintenancePrerequisiteOptions): Promise<boolean> {
const requiredSettings = {
doNotUseFixedRevisionForChunks: true,
readChunksOnline: false,
} satisfies MaintenancePrerequisiteSettings;
const missing = [
...(settings.doNotUseFixedRevisionForChunks ? [] : ["- Compute revisions for chunks: On (currently Off)"]),
...(settings.readChunksOnline ? ["- Fetch chunks on demand: Off (currently On)"] : []),
];
const missing = settings.readChunksOnline ? ["- Fetch chunks on demand: Off (currently On)"] : [];
if (missing.length == 0) return true;
@@ -117,7 +117,6 @@ const PRESERVED_SYNC_SETTING_KEYS = [
const NEW_VAULT_RECOMMENDATION_KEYS = [
"syncMaxSizeInMB",
"chunkSplitterVersion",
"doNotUseFixedRevisionForChunks",
"usePluginSyncV2",
"handleFilenameCaseSensitive",
"E2EEAlgorithm",
@@ -48,6 +48,7 @@ function compatibilityPause(): CompatibilityPause {
currentVersion: 10,
isFromFutureSchema: false,
resumable: true,
reviewReasons: migration().reviewReasons,
},
],
};
@@ -105,7 +106,6 @@ describe("Review Harness contract", () => {
...preservedSyncSettings,
syncMaxSizeInMB: NEW_VAULT_SETTINGS.syncMaxSizeInMB,
chunkSplitterVersion: NEW_VAULT_SETTINGS.chunkSplitterVersion,
doNotUseFixedRevisionForChunks: NEW_VAULT_SETTINGS.doNotUseFixedRevisionForChunks,
usePluginSyncV2: NEW_VAULT_SETTINGS.usePluginSyncV2,
handleFilenameCaseSensitive: NEW_VAULT_SETTINGS.handleFilenameCaseSensitive,
E2EEAlgorithm: NEW_VAULT_SETTINGS.E2EEAlgorithm,
@@ -31,6 +31,7 @@ function compatibilityPause(): CompatibilityPause {
currentVersion: 10,
isFromFutureSchema: false,
resumable: true,
reviewReasons: migration().reviewReasons,
},
],
};