mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2026-11-05 15:58:19 +00:00
vorotamoroz
9920da8f94
Reject explicit NFC settings before WebApp services start and when settings are loaded or saved. Preserve Legacy interoperability, and clarify host support and the Commonlib-first publication prerequisite.
414 lines
17 KiB
TypeScript
414 lines
17 KiB
TypeScript
import { MemoryValueStore } from "@vrtmrz/value-store";
|
|
import { LOG_LEVEL_INFO, type ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { LiveSyncBrowserServiceHubOptions } from "@/apps/browser/createLiveSyncBrowserServiceHub";
|
|
|
|
const runtimeMocks = vi.hoisted(() => {
|
|
const addLog = vi.fn();
|
|
const cleanup = vi.fn();
|
|
const currentSettings = vi.fn();
|
|
const getFiles = vi.fn();
|
|
const onLoad = vi.fn();
|
|
const onReady = vi.fn();
|
|
const onUnload = vi.fn();
|
|
const scanVault = vi.fn();
|
|
const scanDirectory = vi.fn();
|
|
const clearCache = vi.fn();
|
|
const collectFilesOnStorage = vi.fn();
|
|
const updateToDatabase = vi.fn();
|
|
const applicationReady = { value: false };
|
|
const isReady = vi.fn(() => applicationReady.value);
|
|
const markIsReady = vi.fn(() => {
|
|
applicationReady.value = true;
|
|
});
|
|
const onDatabaseInitialised = vi.fn();
|
|
const commitPendingFileEvents = vi.fn();
|
|
const p2p = {
|
|
replicator: {},
|
|
};
|
|
|
|
const serviceHub = {
|
|
API: { addLog, webCompatFetch: vi.fn() },
|
|
appLifecycle: { isReady, markIsReady },
|
|
control: { onLoad, onReady, onUnload },
|
|
databaseEvents: { onDatabaseInitialised },
|
|
fileProcessing: { commitPendingFileEvents },
|
|
setting: { currentSettings },
|
|
vault: { scanVault },
|
|
};
|
|
const platformModules = {
|
|
fileHandler: {},
|
|
storageAccess: {},
|
|
storageEventManager: { cleanup },
|
|
vaultAccess: {
|
|
fsapiAdapter: {
|
|
clearCache,
|
|
getFiles,
|
|
scanDirectory,
|
|
},
|
|
},
|
|
};
|
|
|
|
return {
|
|
addLog,
|
|
applicationReady,
|
|
options: undefined as LiveSyncBrowserServiceHubOptions<never> | undefined,
|
|
clearCache,
|
|
cleanup,
|
|
collectFilesOnStorage,
|
|
commitPendingFileEvents,
|
|
currentSettings,
|
|
getFiles,
|
|
isReady,
|
|
markIsReady,
|
|
onDatabaseInitialised,
|
|
onLoad,
|
|
onReady,
|
|
onUnload,
|
|
platformModules,
|
|
p2p,
|
|
scanDirectory,
|
|
scanVault,
|
|
serviceHub,
|
|
updateToDatabase,
|
|
};
|
|
});
|
|
|
|
vi.mock("@/apps/browser/createLiveSyncBrowserServiceHub", () => ({
|
|
createLiveSyncBrowserServiceHub: vi.fn((options: LiveSyncBrowserServiceHubOptions<never>) => {
|
|
runtimeMocks.options = options;
|
|
return runtimeMocks.serviceHub;
|
|
}),
|
|
}));
|
|
|
|
vi.mock("@/apps/webapp/serviceModules/FSAPIServiceModules", () => ({
|
|
initialiseServiceModulesFSAPI: vi.fn(() => runtimeMocks.platformModules),
|
|
}));
|
|
|
|
vi.mock("@/LiveSyncBaseCore", () => ({
|
|
LiveSyncBaseCore: class {
|
|
readonly serviceModules;
|
|
readonly services;
|
|
|
|
constructor(
|
|
services: typeof runtimeMocks.serviceHub,
|
|
initialisePlatformModules: (core: unknown, serviceHub: typeof runtimeMocks.serviceHub) => unknown,
|
|
_initialiseCoreModules: () => unknown[],
|
|
_getAddOns: () => unknown[],
|
|
initialiseFeatures: (core: unknown) => void
|
|
) {
|
|
this.services = services;
|
|
this.serviceModules = initialisePlatformModules(this, services);
|
|
initialiseFeatures(this);
|
|
}
|
|
},
|
|
}));
|
|
|
|
vi.mock("@vrtmrz/livesync-commonlib/compat/serviceFeatures/offlineScanner", () => ({
|
|
collectFilesOnStorage: runtimeMocks.collectFilesOnStorage,
|
|
updateToDatabase: runtimeMocks.updateToDatabase,
|
|
useOfflineScanner: vi.fn(),
|
|
}));
|
|
vi.mock("@/serviceFeatures/redFlag", () => ({
|
|
useRedFlagFeatures: vi.fn(),
|
|
}));
|
|
vi.mock("@vrtmrz/livesync-commonlib/compat/serviceFeatures/checkRemoteSize", () => ({
|
|
useCheckRemoteSize: vi.fn(),
|
|
}));
|
|
vi.mock("@vrtmrz/livesync-commonlib/compat/serviceFeatures/remoteConfig", () => ({
|
|
useRemoteConfiguration: vi.fn(),
|
|
}));
|
|
vi.mock("@vrtmrz/livesync-commonlib/compat/replication/trystero/useP2PReplicatorFeature", () => ({
|
|
useP2PReplicatorFeature: vi.fn(() => runtimeMocks.p2p),
|
|
}));
|
|
|
|
import { WebAppRuntime } from "@/apps/webapp/WebAppRuntime";
|
|
|
|
const unconfiguredSettings = {
|
|
couchDB_DBNAME: "",
|
|
isConfigured: false,
|
|
} as ObsidianLiveSyncSettings;
|
|
|
|
function createRootHandle(name = "runtime-vault"): FileSystemDirectoryHandle {
|
|
return { name } as FileSystemDirectoryHandle;
|
|
}
|
|
|
|
async function waitForMicrotasks(): Promise<void> {
|
|
await Promise.resolve();
|
|
await Promise.resolve();
|
|
}
|
|
|
|
describe("WebAppRuntime lifecycle", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
runtimeMocks.applicationReady.value = false;
|
|
runtimeMocks.options = undefined;
|
|
runtimeMocks.commitPendingFileEvents.mockResolvedValue(true);
|
|
runtimeMocks.currentSettings.mockReturnValue(unconfiguredSettings);
|
|
runtimeMocks.getFiles.mockResolvedValue([{ path: "one.md" }]);
|
|
runtimeMocks.onDatabaseInitialised.mockResolvedValue(true);
|
|
runtimeMocks.onLoad.mockResolvedValue(true);
|
|
runtimeMocks.onReady.mockResolvedValue(undefined);
|
|
runtimeMocks.onUnload.mockResolvedValue(undefined);
|
|
runtimeMocks.cleanup.mockResolvedValue(undefined);
|
|
runtimeMocks.clearCache.mockReturnValue(undefined);
|
|
runtimeMocks.collectFilesOnStorage.mockResolvedValue({
|
|
storageFileNameMap: {
|
|
"one.md": {
|
|
path: "one.md",
|
|
stat: { ctime: 1, mtime: 1, size: 3, type: "file" },
|
|
},
|
|
},
|
|
storageFileNames: ["one.md"],
|
|
storageFileNameCI2CS: { "one.md": "one.md" },
|
|
});
|
|
runtimeMocks.scanDirectory.mockResolvedValue(undefined);
|
|
runtimeMocks.scanVault.mockResolvedValue(false);
|
|
runtimeMocks.updateToDatabase.mockResolvedValue(undefined);
|
|
});
|
|
|
|
function settingsRoot(settings: Partial<ObsidianLiveSyncSettings>): FileSystemDirectoryHandle {
|
|
return {
|
|
name: "identity-test-vault",
|
|
getDirectoryHandle: async () => ({
|
|
getFileHandle: async () => ({
|
|
getFile: async () => new File([JSON.stringify(settings)], "settings.json"),
|
|
}),
|
|
}),
|
|
} as unknown as FileSystemDirectoryHandle;
|
|
}
|
|
|
|
it.each([undefined, 0] as const)("starts with supported legacy identity %s", async (version) => {
|
|
const runtime = new WebAppRuntime(settingsRoot({ pathNormalizationVersion: version }), {
|
|
deviceValues: new MemoryValueStore(),
|
|
});
|
|
await runtime.start();
|
|
expect(runtimeMocks.onLoad).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.scanDirectory).toHaveBeenCalledOnce();
|
|
await runtime.shutdown();
|
|
});
|
|
|
|
it.each([1, 2] as const)(
|
|
"rejects unsupported identity %s before constructing services or starting file work",
|
|
async (version) => {
|
|
const reportStatus = vi.fn();
|
|
const runtime = new WebAppRuntime(settingsRoot({ pathNormalizationVersion: version as 1 }), {
|
|
reportStatus,
|
|
deviceValues: new MemoryValueStore(),
|
|
});
|
|
await expect(runtime.start()).rejects.toThrow(/path identity|path normalisation/i);
|
|
expect(runtimeMocks.options).toBeUndefined();
|
|
expect(runtimeMocks.onLoad).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.onReady).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.scanDirectory).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.collectFilesOnStorage).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.updateToDatabase).not.toHaveBeenCalled();
|
|
expect(reportStatus).toHaveBeenCalledWith(
|
|
"error",
|
|
expect.stringMatching(/path identity|path normalisation/i)
|
|
);
|
|
}
|
|
);
|
|
|
|
it("rejects NFC during settings reload instead of substituting defaults", async () => {
|
|
const runtime = new WebAppRuntime(settingsRoot({ pathNormalizationVersion: 1 }), {
|
|
deviceValues: new MemoryValueStore(),
|
|
});
|
|
const options = (
|
|
runtime as unknown as { createServiceOptions(): LiveSyncBrowserServiceHubOptions<never> }
|
|
).createServiceOptions();
|
|
if (!options.settings) throw new Error("The runtime must provide settings callbacks");
|
|
await expect(options.settings.load()).rejects.toThrow(/WebApp supports Legacy path identity/);
|
|
});
|
|
|
|
it("rejects saving unsupported NFC settings before opening the settings directory", async () => {
|
|
const getDirectoryHandle = vi.fn();
|
|
const runtime = new WebAppRuntime(
|
|
{ name: "identity-test-vault", getDirectoryHandle } as unknown as FileSystemDirectoryHandle,
|
|
{ deviceValues: new MemoryValueStore() }
|
|
);
|
|
const options = (
|
|
runtime as unknown as { createServiceOptions(): LiveSyncBrowserServiceHubOptions<never> }
|
|
).createServiceOptions();
|
|
if (!options.settings) throw new Error("The runtime must provide settings callbacks");
|
|
await expect(
|
|
options.settings.save({ pathNormalizationVersion: 1 } as ObsidianLiveSyncSettings)
|
|
).rejects.toThrow(/WebApp supports Legacy path identity/);
|
|
expect(getDirectoryHandle).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("owns core start, directory scan, status reporting, and shutdown", async () => {
|
|
const reportStatus = vi.fn();
|
|
const runtime = new WebAppRuntime(createRootHandle(), { reportStatus, deviceValues: new MemoryValueStore() });
|
|
|
|
await runtime.start();
|
|
|
|
expect(runtimeMocks.onLoad).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.onReady).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.scanDirectory).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.getFiles).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.addLog).toHaveBeenCalledWith("Found 1 files", expect.anything(), "scan");
|
|
expect(reportStatus).toHaveBeenCalledWith(
|
|
"warning",
|
|
"Warning: Please configure CouchDB connection in settings"
|
|
);
|
|
expect(runtime.p2pPaneHost.services).toBe(runtimeMocks.serviceHub);
|
|
expect(runtime.p2pPaneHost.p2p).toBe(runtimeMocks.p2p);
|
|
expect(runtime.p2pPaneHost.showPeerMenu).toBeUndefined();
|
|
expect("p2pController" in runtime).toBe(false);
|
|
|
|
await runtime.shutdown();
|
|
|
|
expect(runtimeMocks.cleanup).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.onUnload).toHaveBeenCalledOnce();
|
|
});
|
|
|
|
it("finalises application readiness after importing local files for optional P2P", async () => {
|
|
const runtime = new WebAppRuntime(createRootHandle(), { deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
vi.clearAllMocks();
|
|
runtimeMocks.currentSettings.mockReturnValue(unconfiguredSettings);
|
|
runtimeMocks.collectFilesOnStorage.mockResolvedValue({
|
|
storageFileNameMap: {
|
|
"one.md": {
|
|
path: "one.md",
|
|
stat: { ctime: 1, mtime: 1, size: 3, type: "file" },
|
|
},
|
|
},
|
|
storageFileNames: ["one.md"],
|
|
storageFileNameCI2CS: { "one.md": "one.md" },
|
|
});
|
|
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(true);
|
|
|
|
expect(runtimeMocks.clearCache).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.scanDirectory).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.collectFilesOnStorage).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
services: runtimeMocks.serviceHub,
|
|
serviceModules: runtimeMocks.platformModules,
|
|
}),
|
|
unconfiguredSettings,
|
|
expect.any(Function)
|
|
);
|
|
expect(runtimeMocks.updateToDatabase).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.onDatabaseInitialised).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.commitPendingFileEvents).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.markIsReady).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.updateToDatabase.mock.invocationCallOrder[0]).toBeLessThan(
|
|
runtimeMocks.onDatabaseInitialised.mock.invocationCallOrder[0]
|
|
);
|
|
expect(runtimeMocks.onDatabaseInitialised.mock.invocationCallOrder[0]).toBeLessThan(
|
|
runtimeMocks.commitPendingFileEvents.mock.invocationCallOrder[0]
|
|
);
|
|
expect(runtimeMocks.commitPendingFileEvents.mock.invocationCallOrder[0]).toBeLessThan(
|
|
runtimeMocks.markIsReady.mock.invocationCallOrder[0]
|
|
);
|
|
expect(runtimeMocks.scanVault).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.currentSettings()).toBe(unconfiguredSettings);
|
|
expect(unconfiguredSettings.isConfigured).toBe(false);
|
|
});
|
|
|
|
it("does not publish readiness after a partial local-file import", async () => {
|
|
const runtime = new WebAppRuntime(createRootHandle(), { deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
vi.clearAllMocks();
|
|
runtimeMocks.collectFilesOnStorage.mockResolvedValue({
|
|
storageFileNameMap: {
|
|
"one.md": {
|
|
path: "one.md",
|
|
stat: { ctime: 1, mtime: 1, size: 3, type: "file" },
|
|
},
|
|
"two.md": {
|
|
path: "two.md",
|
|
stat: { ctime: 2, mtime: 2, size: 3, type: "file" },
|
|
},
|
|
},
|
|
storageFileNames: ["one.md", "two.md"],
|
|
storageFileNameCI2CS: { "one.md": "one.md", "two.md": "two.md" },
|
|
});
|
|
runtimeMocks.updateToDatabase
|
|
.mockRejectedValueOnce(new Error("one.md could not be imported"))
|
|
.mockResolvedValueOnce(undefined);
|
|
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(false);
|
|
|
|
expect(runtimeMocks.updateToDatabase).toHaveBeenCalledTimes(2);
|
|
expect(runtimeMocks.onDatabaseInitialised).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.commitPendingFileEvents).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.markIsReady).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not publish readiness when database initialisation rejects manual preparation", async () => {
|
|
const runtime = new WebAppRuntime(createRootHandle(), { deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
vi.clearAllMocks();
|
|
runtimeMocks.onDatabaseInitialised.mockResolvedValue(false);
|
|
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(false);
|
|
|
|
expect(runtimeMocks.onDatabaseInitialised).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.commitPendingFileEvents).not.toHaveBeenCalled();
|
|
expect(runtimeMocks.markIsReady).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not publish readiness when pending file events cannot be committed", async () => {
|
|
const runtime = new WebAppRuntime(createRootHandle(), { deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
vi.clearAllMocks();
|
|
runtimeMocks.commitPendingFileEvents.mockResolvedValue(false);
|
|
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(false);
|
|
|
|
expect(runtimeMocks.onDatabaseInitialised).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.commitPendingFileEvents).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.markIsReady).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not repeat readiness finalisation after a successful manual scan", async () => {
|
|
const runtime = new WebAppRuntime(createRootHandle(), { deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
vi.clearAllMocks();
|
|
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(true);
|
|
await expect(runtime.scanLocalFiles()).resolves.toBe(true);
|
|
|
|
expect(runtimeMocks.updateToDatabase).toHaveBeenCalledTimes(2);
|
|
expect(runtimeMocks.onDatabaseInitialised).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.commitPendingFileEvents).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.markIsReady).toHaveBeenCalledOnce();
|
|
});
|
|
|
|
it("rejects a failed core start after cleaning up the partial runtime", async () => {
|
|
runtimeMocks.onLoad.mockResolvedValue(false);
|
|
const reportStatus = vi.fn();
|
|
const runtime = new WebAppRuntime(createRootHandle(), { reportStatus, deviceValues: new MemoryValueStore() });
|
|
|
|
await expect(runtime.start()).rejects.toThrow("Failed to initialise LiveSync");
|
|
|
|
expect(runtimeMocks.cleanup).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.onUnload).toHaveBeenCalledOnce();
|
|
expect(reportStatus).toHaveBeenCalledWith(
|
|
"error",
|
|
"Error: Failed to start: Error: Failed to initialise LiveSync"
|
|
);
|
|
});
|
|
|
|
it("shuts down once before scheduling a host reload", async () => {
|
|
const scheduleReload = vi.fn();
|
|
const runtime = new WebAppRuntime(createRootHandle(), { scheduleReload, deviceValues: new MemoryValueStore() });
|
|
await runtime.start();
|
|
|
|
runtimeMocks.options?.restart?.schedule();
|
|
runtimeMocks.options?.restart?.schedule();
|
|
await waitForMicrotasks();
|
|
|
|
expect(runtimeMocks.options?.restart?.isScheduled?.()).toBe(true);
|
|
expect(runtimeMocks.cleanup).toHaveBeenCalledOnce();
|
|
expect(runtimeMocks.onUnload).toHaveBeenCalledOnce();
|
|
expect(scheduleReload).toHaveBeenCalledOnce();
|
|
expect(scheduleReload).toHaveBeenCalledWith(1_000);
|
|
expect(runtimeMocks.addLog).toHaveBeenCalledWith("Restart requested", LOG_LEVEL_INFO, "app-lifecycle");
|
|
});
|
|
});
|