obsidian-livesync/test/e2e-obsidian/runner/readiness.ts

import { evalObsidianJson } from "./cli.ts";

export type PluginReadiness = {
    status: "ready" | "pending";
    pluginId: string;
    pluginVersion: string;
    vaultName: string;
    enabled?: boolean;
    pluginKeys?: string[];
    loadingPluginId?: string;
};

export async function waitForPluginReady(
    cliBinary: string,
    env: NodeJS.ProcessEnv,
    timeoutMs = Number(process.env.E2E_OBSIDIAN_READY_TIMEOUT_MS ?? 20000)
): Promise<PluginReadiness> {
    const deadline = Date.now() + timeoutMs;
    let lastOutput = "";
    while (Date.now() < deadline) {
        try {
            const readiness = await evalObsidianJson<PluginReadiness>(
                cliBinary,
                [
                    "(async()=>JSON.stringify({",
                    "status:!!app.plugins.plugins['obsidian-livesync']?'ready':'pending',",
                    "pluginId:'obsidian-livesync',",
                    "pluginVersion:app.plugins.manifests['obsidian-livesync']?.version,",
                    "vaultName:app.vault.getName(),",
                    "enabled:app.plugins.enabledPlugins?.has?.('obsidian-livesync'),",
                    "pluginKeys:Object.keys(app.plugins.plugins),",
                    "loadingPluginId:app.plugins.loadingPluginId",
                    "}))()",
                ].join(""),
                env
            );
            lastOutput = JSON.stringify(readiness);
            if (readiness.status === "ready") {
                return readiness as PluginReadiness & { status: "ready" };
            }
        } catch (error) {
            lastOutput = error instanceof Error ? error.message : String(error);
            // Keep polling until Obsidian exposes the vault-side CLI and plug-in state.
        }
        await new Promise((resolve) => setTimeout(resolve, 500));
    }
    throw new Error(`Timed out waiting for Self-hosted LiveSync readiness through Obsidian CLI.\n${lastOutput}`);
}