open-design/packages/host/tests/index.test.ts

import { readFileSync, readdirSync, statSync } from "node:fs";
import { dirname, join } from "node:path";
import { fileURLToPath } from "node:url";

import { describe, expect, it, vi } from "vitest";

import {
  OPEN_DESIGN_HOST_GLOBAL,
  OPEN_DESIGN_HOST_VERSION,
  clearHostBrowserData,
  checkHostUpdater,
  detectOpenDesignHostClientType,
  getLatestHostPreviewNavigationFailure,
  getHostUpdaterStatus,
  getOpenDesignHost,
  installHostUpdater,
  isOpenDesignHostAvailable,
  isOpenDesignHostBridge,
  normalizeOpenDesignHostProjectImportResult,
  openHostExternalUrl,
  pickAndImportHostProject,
  printHostPdf,
  openHostProjectPath,
  quitHostAfterUpdaterInstallerOpen,
  setHostUpdaterMenuLabels,
  setHostPetVisible,
  subscribeHostUpdaterOpenDialog,
  subscribeHostUpdater,
  subscribeHostPreviewNavigationFailure,
} from "../src/index.js";
import { createMockOpenDesignHost, installMockOpenDesignHost } from "../src/testing.js";

const hostRoot = dirname(dirname(fileURLToPath(import.meta.url)));

function filesUnder(dir: string): string[] {
  return readdirSync(dir).flatMap((entry) => {
    const path = join(dir, entry);
    const stat = statSync(path);
    if (stat.isDirectory()) return filesUnder(path);
    return /\.(ts|tsx|cts|mts)$/.test(path) ? [path] : [];
  });
}

describe("open-design host contract", () => {
  it("stays independent from daemon/web contracts", () => {
    const pkg = JSON.parse(readFileSync(join(hostRoot, "package.json"), "utf8")) as {
      dependencies?: Record<string, string>;
      devDependencies?: Record<string, string>;
      optionalDependencies?: Record<string, string>;
      peerDependencies?: Record<string, string>;
    };
    expect({
      ...pkg.dependencies,
      ...pkg.devDependencies,
      ...pkg.optionalDependencies,
      ...pkg.peerDependencies,
    }).not.toHaveProperty("@open-design/contracts");

    const offenders = filesUnder(join(hostRoot, "src")).filter((path) =>
      readFileSync(path, "utf8").includes("@open-design/contracts"),
    );
    expect(offenders).toEqual([]);
  });

  it("recognizes the canonical bridge shape", () => {
    const host = createMockOpenDesignHost();
    expect(isOpenDesignHostBridge(host)).toBe(true);
    expect(host.version).toBe(OPEN_DESIGN_HOST_VERSION);
  });

  it("rejects legacy or incomplete bridge shapes", () => {
    expect(isOpenDesignHostBridge({ version: OPEN_DESIGN_HOST_VERSION })).toBe(false);
    expect(isOpenDesignHostBridge({ ...createMockOpenDesignHost(), version: 1 })).toBe(false);
    expect(isOpenDesignHostBridge({
      ...createMockOpenDesignHost(),
      browser: {},
    })).toBe(false);
    expect(isOpenDesignHostBridge({
      ...createMockOpenDesignHost(),
      capture: {},
    })).toBe(false);
    expect(isOpenDesignHostBridge({
      ...createMockOpenDesignHost(),
      shell: { openExternal: async () => ({ ok: true }) },
    })).toBe(false);
    expect(isOpenDesignHostBridge({
      ...createMockOpenDesignHost(),
      updater: { status: async () => createMockOpenDesignHost().updater.status() },
    })).toBe(false);
    const { "clear-cache": _clearCache, ...updaterWithoutClearCache } = createMockOpenDesignHost().updater;
    expect(isOpenDesignHostBridge({
      ...createMockOpenDesignHost(),
      updater: updaterWithoutClearCache,
    })).toBe(false);
  });

  it("reads the bridge through the package-owned global accessor", () => {
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost();
    expect(getOpenDesignHost(scope)?.client.type).toBe("desktop");
    expect(isOpenDesignHostAvailable(scope)).toBe(true);
    expect(detectOpenDesignHostClientType(scope)).toBe("desktop");
  });

  it("falls back to web when no host is installed", () => {
    expect(getOpenDesignHost({})).toBeNull();
    expect(isOpenDesignHostAvailable({})).toBe(false);
    expect(detectOpenDesignHostClientType({})).toBe("web");
  });

  it("wraps host action throws into structured failures", async () => {
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost({
      shell: {
        openPath: vi.fn(async () => {
          throw new Error("failed");
        }),
      },
    });

    await expect(openHostProjectPath("project-1", scope)).resolves.toEqual({
      ok: false,
      reason: "failed",
    });
  });

  it("normalizes privileged project-import results into host-owned identifiers", () => {
    const result = normalizeOpenDesignHostProjectImportResult({
      ok: true,
      response: {
        project: {
          id: "project-1",
          name: "Imported project",
          resolvedDir: "/private/path/that-must-not-cross",
        },
        conversationId: "conversation-1",
        entryFile: "index.html",
      },
    });

    expect(result).toEqual({
      ok: true,
      projectId: "project-1",
      conversationId: "conversation-1",
      entryFile: "index.html",
    });
    expect(JSON.stringify(result)).not.toContain("resolvedDir");
  });

  it("accepts imported folders with no detected entry file", () => {
    const result = normalizeOpenDesignHostProjectImportResult({
      ok: true,
      response: {
        project: {
          id: "project-1",
          name: "Imported source repo",
          resolvedDir: "/private/path/that-must-not-cross",
        },
        conversationId: "conversation-1",
        entryFile: null,
      },
    });

    expect(result).toEqual({
      ok: true,
      projectId: "project-1",
      conversationId: "conversation-1",
      entryFile: null,
    });
    expect(JSON.stringify(result)).not.toContain("resolvedDir");
  });

  it("preserves canceled and structured failure project-import results", () => {
    expect(normalizeOpenDesignHostProjectImportResult({ canceled: true, ok: false })).toEqual({
      canceled: true,
      ok: false,
    });
    expect(normalizeOpenDesignHostProjectImportResult({
      ok: false,
      reason: "daemon returned HTTP 500",
      details: { code: "boom" },
    })).toEqual({
      ok: false,
      reason: "daemon returned HTTP 500",
      details: { code: "boom" },
    });
  });

  it("rejects malformed successful project-import results before they reach web callers", () => {
    expect(normalizeOpenDesignHostProjectImportResult({
      ok: true,
      response: {
        project: { id: "project-1" },
        conversationId: "conversation-1",
      },
    })).toEqual({
      ok: false,
      reason: "daemon import response did not include host project identifiers",
      details: {
        project: { id: "project-1" },
        conversationId: "conversation-1",
      },
    });
  });

  it("routes all host actions through package-owned helpers", async () => {
    const openExternal = vi.fn(async () => ({ ok: true as const }));
    const openPath = vi.fn(async () => ({ ok: true as const }));
    const clearData = vi.fn(async () => ({ ok: true as const }));
    const pickAndImport = vi.fn(async () => ({
      ok: true as const,
      projectId: "project-2",
      conversationId: "conversation-2",
      entryFile: "app.html",
    }));
    const print = vi.fn(async () => ({ ok: true as const }));
    const setVisible = vi.fn();
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost({
      browser: { clearData },
      shell: { openExternal, openPath },
      project: { pickAndImport },
      pdf: { print },
      pet: { setVisible },
    });

    await expect(openHostExternalUrl("https://example.com", scope)).resolves.toEqual({ ok: true });
    await expect(openHostProjectPath("project-2", scope)).resolves.toEqual({ ok: true });
    await expect(clearHostBrowserData({ cookies: true }, scope)).resolves.toEqual({ ok: true });
    await expect(pickAndImportHostProject({ skillId: "skill-1" }, scope)).resolves.toMatchObject({
      ok: true,
      projectId: "project-2",
    });
    await expect(printHostPdf("<html></html>", "nonce", { deck: true }, scope)).resolves.toEqual({ ok: true });
    expect(setHostPetVisible(true, scope)).toEqual({ ok: true });

    expect(openExternal).toHaveBeenCalledWith("https://example.com");
    expect(openPath).toHaveBeenCalledWith("project-2");
    expect(clearData).toHaveBeenCalledWith({ cookies: true });
    expect(pickAndImport).toHaveBeenCalledWith({ skillId: "skill-1" });
    expect(print).toHaveBeenCalledWith("<html></html>", "nonce", { deck: true });
    expect(setVisible).toHaveBeenCalledWith(true);
  });

  it("routes updater status, actions, and subscriptions through package-owned helpers", async () => {
    const status = {
      arch: "arm64",
      availableVersion: "1.0.1-beta.1",
      capabilities: {
        canApplyInPlace: false,
        canDownload: true,
        canOpenInstaller: true,
        requiresManualInstall: true,
      },
      channel: "beta" as const,
      currentVersion: "1.0.0-beta.0",
      downloadPath: "/tmp/Open Design Beta.dmg",
      enabled: true,
      mode: "package-launcher" as const,
      platform: "darwin",
      state: "downloaded" as const,
      supported: true,
    };
    const check = vi.fn(async () => status);
    const install = vi.fn(async () => status);
    const quit = vi.fn(async () => ({ ok: true as const }));
    const statusFn = vi.fn(async () => status);
    const unsubscribe = vi.fn();
    const subscribe = vi.fn(() => unsubscribe);
    const unsubscribeOpenDialog = vi.fn();
    const subscribeOpenDialog = vi.fn(() => unsubscribeOpenDialog);
    const setMenuLabels = vi.fn(async () => ({ ok: true as const }));
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost({
      updater: { check, install, quit, setMenuLabels, status: statusFn, subscribe, subscribeOpenDialog },
    });

    await expect(getHostUpdaterStatus({ payload: { source: "mount" } }, scope)).resolves.toEqual({
      ok: true,
      status,
    });
    await expect(checkHostUpdater({ payload: { source: "button" } }, scope)).resolves.toEqual({
      ok: true,
      status,
    });
    await expect(installHostUpdater({ payload: { source: "popup" } }, scope)).resolves.toEqual({
      ok: true,
      status,
    });
    await expect(quitHostAfterUpdaterInstallerOpen({ payload: { source: "opened-popup" } }, scope)).resolves.toEqual({
      ok: true,
    });

    const listener = vi.fn();
    expect(subscribeHostUpdater(listener, scope)).toBe(unsubscribe);
    const openDialogListener = vi.fn();
    expect(subscribeHostUpdaterOpenDialog(openDialogListener, scope)).toBe(unsubscribeOpenDialog);
    await expect(setHostUpdaterMenuLabels({
      check: "Check for Updates…",
      checking: "Checking for Updates…",
      downloading: "Downloading Update…",
      install: "Install Update…",
      installing: "Installing Update…",
      restart: "Restart to Update OpenDesign…",
    }, scope)).resolves.toEqual({ ok: true });
    expect(statusFn).toHaveBeenCalledWith({ payload: { source: "mount" } });
    expect(check).toHaveBeenCalledWith({ payload: { source: "button" } });
    expect(install).toHaveBeenCalledWith({ payload: { source: "popup" } });
    expect(quit).toHaveBeenCalledWith({ payload: { source: "opened-popup" } });
    expect(subscribe).toHaveBeenCalledWith(listener);
    expect(subscribeOpenDialog).toHaveBeenCalledWith(openDialogListener);
    expect(setMenuLabels).toHaveBeenCalledOnce();
  });

  it("routes optional preview navigation failure subscriptions", () => {
    const failure = {
      errorCode: -3,
      eventId: 1,
      frameName: "od-artifact-preview-srcdoc-preview-host-1",
      occurredAtMs: 1234,
      validatedUrl: "about:srcdoc",
    };
    const unsubscribe = vi.fn();
    const subscribeNavigationFailure = vi.fn(() => unsubscribe);
    const getLatestNavigationFailure = vi.fn(() => failure);
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost({
      preview: { getLatestNavigationFailure, subscribeNavigationFailure },
    });
    const listener = vi.fn();

    expect(getLatestHostPreviewNavigationFailure(scope)).toBe(failure);
    expect(getLatestNavigationFailure).toHaveBeenCalledOnce();
    expect(subscribeHostPreviewNavigationFailure(listener, scope)).toBe(unsubscribe);
    expect(subscribeNavigationFailure).toHaveBeenCalledWith(listener);
    expect(getLatestHostPreviewNavigationFailure({})).toBeNull();
    expect(subscribeHostPreviewNavigationFailure(listener, {})).toEqual(expect.any(Function));
  });

  it("wraps updater action throws into structured failures", async () => {
    const scope: Record<string, unknown> = {};
    scope[OPEN_DESIGN_HOST_GLOBAL] = createMockOpenDesignHost({
      updater: {
        check: vi.fn(async () => {
          throw new Error("updater failed");
        }),
      },
    });

    await expect(checkHostUpdater(undefined, scope)).resolves.toEqual({
      ok: false,
      reason: "updater failed",
    });
  });

  it("installs and restores test hosts without exposing callers to the global key", () => {
    const scope: Record<string, unknown> = {};
    const restore = installMockOpenDesignHost({ scope });
    expect(getOpenDesignHost(scope)).not.toBeNull();
    restore();
    expect(getOpenDesignHost(scope)).toBeNull();
  });
});