@openpalm/lib 0.11.0-rc.3 → 0.11.0

package/src/control-plane/ui-assets.test.ts

@@ -1,9 +1,14 @@
-import { describe, it, expect, beforeEach, afterEach } from "bun:test";
+import { describe, it, expect, beforeEach, afterEach, spyOn, mock } from "bun:test";
 import { mkdtempSync, rmSync, mkdirSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
 import { existsSync, readFileSync } from "node:fs";
-import { resolveUiBuildDir, readUiBuildVersion, UI_VERSION_STAMP, seedOpenPalmDir, SKELETON_VERSION_STAMP } from "./ui-assets.js";
+import { createHash } from "node:crypto";
+import {
+  resolveUiBuildDir, readUiBuildVersion, UI_VERSION_STAMP,
+  seedOpenPalmDir, SKELETON_VERSION_STAMP,
+  uiUpdateChannel, checkAndUpdateUiBuild,
+} from "./ui-assets.js";
 
 let root = "";
 let opHome = "";
@@ -128,3 +133,201 @@ describe("seedOpenPalmDir — version guard (P2)", () => {
     expect(readFileSync(stamp(), "utf-8").trim()).toBe("v2");
   });
 });
+
+// ── uiUpdateChannel ───────────────────────────────────────────────────────────
+
+describe("uiUpdateChannel", () => {
+  it("returns 'latest' for a stable version", () => {
+    expect(uiUpdateChannel("0.11.0")).toBe("latest");
+    expect(uiUpdateChannel("1.0.0")).toBe("latest");
+  });
+
+  it("returns 'next' for a prerelease version (contains '-')", () => {
+    expect(uiUpdateChannel("0.11.0-rc.2")).toBe("next");
+    expect(uiUpdateChannel("0.11.0-beta.5")).toBe("next");
+    expect(uiUpdateChannel("1.0.0-alpha.1")).toBe("next");
+  });
+});
+
+// ── npm integrity verification (via checkAndUpdateUiBuild) ────────────────────
+//
+// We mock globalThis.fetch to avoid real network calls.  The integrity paths
+// are exercised through checkAndUpdateUiBuild → downloadNpmUiBundle (for the
+// missing-integrity and mismatch cases) and through checkAndUpdateUiBuild
+// returning {updated:false} early (for the up-to-date case).
+
+/** Build a correct sha512 SRI string for the given bytes. */
+function makeSri(data: Uint8Array): string {
+  const digest = createHash("sha512").update(data).digest("base64");
+  return `sha512-${digest}`;
+}
+
+describe("npm integrity verification (fail-closed)", () => {
+  let savedFetch: typeof globalThis.fetch;
+
+  beforeEach(() => {
+    savedFetch = globalThis.fetch;
+    // Set forceRemote context: no local build available for these tests.
+    // (data/ui has no index.js, bundledUi dir exists but is empty → no local build)
+  });
+
+  afterEach(() => {
+    globalThis.fetch = savedFetch;
+  });
+
+  it("throws when the manifest has no integrity hash (fail-closed)", async () => {
+    // manifest fetch returns a version with no integrity
+    globalThis.fetch = async (_url: string | URL | Request) => {
+      const url = String(typeof _url === "string" ? _url : (_url as Request).url ?? _url);
+      if (url.includes("registry.npmjs.org")) {
+        return new Response(
+          JSON.stringify({
+            version: "0.11.0",
+            dist: { tarball: "https://registry.npmjs.org/tarball.tgz" },
+            // integrity intentionally omitted
+          }),
+          { status: 200, headers: { "Content-Type": "application/json" } }
+        );
+      }
+      // tarball fetch — should NOT be reached because we throw before it
+      return new Response("not-reached", { status: 200 });
+    };
+
+    const result = await checkAndUpdateUiBuild("0.11.0-beta.1", join(dataUi, ".."));
+    // Missing integrity → non-fatal error path
+    expect(result.updated).toBe(false);
+    expect(result.error).toMatch(/no integrity hash/i);
+  });
+
+  it("throws when the tarball bytes do not match the stated integrity hash", async () => {
+    const fakeData = new Uint8Array([1, 2, 3, 4]);
+    const wrongSri = `sha512-${Buffer.from("wrong").toString("base64")}`;
+
+    globalThis.fetch = async (_url: string | URL | Request) => {
+      const url = String(typeof _url === "string" ? _url : (_url as Request).url ?? _url);
+      if (url.includes("registry.npmjs.org") && !url.includes("tarball")) {
+        return new Response(
+          JSON.stringify({
+            version: "0.99.0",  // newer than anything on disk
+            dist: { tarball: "https://registry.npmjs.org/tarball.tgz", integrity: wrongSri },
+          }),
+          { status: 200, headers: { "Content-Type": "application/json" } }
+        );
+      }
+      // tarball response — bytes deliberately do NOT match wrongSri
+      return new Response(fakeData, { status: 200 });
+    };
+
+    const result = await checkAndUpdateUiBuild("0.11.0", join(dataUi, ".."));
+    expect(result.updated).toBe(false);
+    expect(result.error).toMatch(/integrity mismatch/i);
+  });
+});
+
+// ── checkAndUpdateUiBuild ─────────────────────────────────────────────────────
+
+describe("checkAndUpdateUiBuild", () => {
+  let savedFetch: typeof globalThis.fetch;
+
+  beforeEach(() => {
+    savedFetch = globalThis.fetch;
+  });
+
+  afterEach(() => {
+    globalThis.fetch = savedFetch;
+  });
+
+  /** Make a minimal npm manifest response for a given version. */
+  function manifestResponse(version: string, integrity?: string) {
+    return new Response(
+      JSON.stringify({
+        version,
+        dist: {
+          tarball: "https://registry.npmjs.org/tarball.tgz",
+          ...(integrity !== undefined ? { integrity } : {}),
+        },
+      }),
+      { status: 200, headers: { "Content-Type": "application/json" } }
+    );
+  }
+
+  it("returns {updated:false} when the npm channel version is not newer than on-disk stamp", async () => {
+    // Seed data/ui with a stamped build
+    makeBuild(dataUi, "0.11.0");
+
+    globalThis.fetch = async () => manifestResponse("0.11.0"); // same version
+    const result = await checkAndUpdateUiBuild("0.11.0", join(opHome, "data"));
+    expect(result.updated).toBe(false);
+    expect(result.latestVersion).toBe("0.11.0");
+    expect(result.error).toBeUndefined();
+  });
+
+  it("returns {updated:false} when the npm channel version is older than on-disk stamp", async () => {
+    makeBuild(dataUi, "0.12.0");
+
+    globalThis.fetch = async () => manifestResponse("0.11.0"); // older
+    const result = await checkAndUpdateUiBuild("0.12.0", join(opHome, "data"));
+    expect(result.updated).toBe(false);
+    expect(result.latestVersion).toBe("0.11.0");
+  });
+
+  it("returns {updated:false, error} when the manifest fetch rejects (non-fatal)", async () => {
+    globalThis.fetch = async () => { throw new Error("network failure"); };
+
+    const result = await checkAndUpdateUiBuild("0.11.0", join(opHome, "data"));
+    expect(result.updated).toBe(false);
+    expect(result.latestVersion).toBeNull();
+    expect(result.error).toMatch(/network failure/i);
+  });
+
+  it("returns {updated:false, error} when the registry returns a non-OK status", async () => {
+    globalThis.fetch = async () => new Response("not found", { status: 404 });
+
+    const result = await checkAndUpdateUiBuild("0.11.0", join(opHome, "data"));
+    expect(result.updated).toBe(false);
+    expect(result.error).toBeDefined();
+  });
+
+  it("attempts an update when the on-disk build is unstamped (legacy data/ui)", async () => {
+    // Unstamped data/ui — cannot compare, so it should try to refresh from npm.
+    // We give it a manifest with missing integrity so it fails non-fatally
+    // (avoids needing a real tarball), but we confirm it DID attempt the download.
+    makeBuild(dataUi, null); // unstamped
+
+    let manifestFetched = false;
+    globalThis.fetch = async (_url: string | URL | Request) => {
+      const url = String(typeof _url === "string" ? _url : (_url as Request).url ?? _url);
+      if (url.includes("registry.npmjs.org")) {
+        manifestFetched = true;
+        // Return a manifest without integrity so downloadNpmUiBundle throws
+        return manifestResponse("0.11.1");
+      }
+      return new Response("", { status: 200 });
+    };
+
+    const result = await checkAndUpdateUiBuild("0.11.0", join(opHome, "data"));
+    expect(manifestFetched).toBe(true);
+    // non-fatal: missing integrity → error path
+    expect(result.updated).toBe(false);
+    expect(result.error).toBeDefined();
+  });
+
+  it("attempts an update when npm has a newer version than the on-disk stamp", async () => {
+    makeBuild(dataUi, "0.11.0");
+
+    let manifestFetched = false;
+    globalThis.fetch = async (_url: string | URL | Request) => {
+      const url = String(typeof _url === "string" ? _url : (_url as Request).url ?? _url);
+      if (url.includes("registry.npmjs.org")) {
+        manifestFetched = true;
+        return manifestResponse("0.12.0"); // newer — no integrity → non-fatal error
+      }
+      return new Response("", { status: 200 });
+    };
+
+    const result = await checkAndUpdateUiBuild("0.11.0", join(opHome, "data"));
+    expect(manifestFetched).toBe(true);
+    expect(result.updated).toBe(false);
+    expect(result.error).toMatch(/no integrity hash/i);
+  });
+});

package/src/control-plane/ui-assets.ts

@@ -4,11 +4,12 @@
  * These functions are consumed by both the CLI and the Electron shell — they
  * must use only Node.js-compatible APIs (no Bun.spawn, Bun.write, etc.).
  *
- * Source resolution order (same for UI build and .openpalm/):
+ * Source resolution order (UI build and .openpalm/ skeleton):
  *   1. OPENPALM_REPO_ROOT env var — explicit dev override
  *   2. Relative to import.meta.url — works for `bun run` / source installs
  *   3. Relative to process.execPath — works for compiled Bun binary in repo
- *   4. null → GitHub release download
+ *   4. null → remote download (the UI build from the @openpalm/ui npm registry
+ *      tarball; the .openpalm skeleton from the GitHub repo tarball)
  */
 import {
   existsSync, mkdirSync, readdirSync, copyFileSync,
@@ -175,7 +176,7 @@ export async function seedOpenPalmDir(
 
 /**
  * Locate the compiled SvelteKit UI build on disk.
- * Returns null when not found — triggers GitHub download in seedUiBuild.
+ * Returns null when not found — triggers the npm registry download in seedUiBuild.
  */
 export function resolveLocalUiBuild(): string | null {
   return resolveLocalCandidate(
@@ -230,7 +231,8 @@ export function readUiBuildVersion(dir: string): string | null {
  * Resolve which UI build to run.
  *
  * Two channels exist: the bundled build (shipped inside the AppImage / source
- * tree) and `data/ui` (operator-updatable, seeded from GitHub releases). To fix
+ * tree) and `data/ui` (operator-updatable, seeded from the @openpalm/ui npm
+ * registry tarball). To fix
  * the stale-`data/ui` shadowing bug AND stay forward-compatible with updating the
  * UI without shipping a new app (D5), selection is VERSION-AWARE:
  *

package/src/index.ts

@@ -39,6 +39,15 @@ export {
   backupOpenPalmHome,
 } from "./control-plane/backup.js";
 
+// ── Layout migration harness ────────────────────────────────────────────────
+export {
+  ensureMigrated,
+  MigrationError,
+  CURRENT_LAYOUT_VERSION,
+  LAYOUT_VERSION_KEY,
+} from "./control-plane/migrations.js";
+export type { MigrationReport } from "./control-plane/migrations.js";
+
 // ── Registry Catalog ─────────────────────────────────────────────────────
 export type {
   AddonMutationResult,
@@ -307,16 +316,6 @@ export {
   summarizeComposeStderr,
 } from "./control-plane/compose-errors.js";
 
-// ── Stack Spec (v2) ──────────────────────────────────────────────────────
-export type {
-  StackSpec,
-} from "./control-plane/stack-spec.js";
-export {
-  STACK_SPEC_FILENAME,
-  writeStackSpec,
-  readStackSpec,
-} from "./control-plane/stack-spec.js";
-
 // ── Spec-to-Env Derivation ──────────────────────────────────────────────
 export type { VoiceVarsConfig } from "./control-plane/spec-to-env.js";
 export {

package/src/control-plane/stack-spec.test.ts

@@ -1,98 +0,0 @@
-/**
- * Stack spec parser tests.
- *
- * Verifies that readStackSpec / writeStackSpec produce consistent results.
- */
-import { describe, it, expect, beforeEach, afterEach } from "bun:test";
-import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-import { tmpdir } from "node:os";
-import {
-  readStackSpec,
-  writeStackSpec,
-  STACK_SPEC_FILENAME,
-} from "./stack-spec.js";
-import type { StackSpec } from "./stack-spec.js";
-
-let configDir: string;
-
-beforeEach(() => {
-  configDir = mkdtempSync(join(tmpdir(), "stack-spec-test-"));
-});
-
-afterEach(() => {
-  rmSync(configDir, { recursive: true, force: true });
-});
-
-const MINIMAL_SPEC: StackSpec = { version: 2 };
-
-// ── readStackSpec / writeStackSpec round-trip ────────────────────────────
-
-describe("readStackSpec / writeStackSpec round-trip", () => {
-  it("round-trips a minimal spec", () => {
-    writeStackSpec(configDir, MINIMAL_SPEC);
-    const read = readStackSpec(configDir);
-    expect(read).not.toBeNull();
-    expect(read!.version).toBe(2);
-  });
-
-  it("round-trips enabled addons", () => {
-    writeStackSpec(configDir, { version: 2, addons: ['chat', 'api'] });
-    expect(readStackSpec(configDir)).toEqual({ version: 2, addons: ['api', 'chat'] });
-  });
-
-  it("writes to the canonical filename", () => {
-    writeStackSpec(configDir, MINIMAL_SPEC);
-    const expectedPath = join(configDir, STACK_SPEC_FILENAME);
-    expect(expectedPath).toBe(join(configDir, "stack.yml"));
-    expect(readStackSpec(configDir)).not.toBeNull();
-  });
-
-  it("ignores legacy capabilities fields on read", () => {
-    // On upgraded installs, old stack.yml may have capabilities — should still parse
-    writeFileSync(join(configDir, STACK_SPEC_FILENAME),
-      "version: 2\ncapabilities:\n  llm: openai/gpt-4o\n  embeddings:\n    provider: openai\n    model: text-embedding-3-small\n    dims: 1536\n"
-    );
-    const read = readStackSpec(configDir);
-    expect(read).not.toBeNull();
-    expect(read!.version).toBe(2);
-  });
-});
-
-// ── readStackSpec edge cases ────────────────────────────────────────────
-
-describe("readStackSpec edge cases", () => {
-  it("returns null for missing file", () => {
-    expect(readStackSpec(configDir)).toBeNull();
-  });
-
-  it("returns null for v1 format (connections array)", () => {
-    writeFileSync(join(configDir, STACK_SPEC_FILENAME), "version: 1\nconnections: []\n");
-    expect(readStackSpec(configDir)).toBeNull();
-  });
-
-  it("returns null for corrupt YAML", () => {
-    writeFileSync(join(configDir, STACK_SPEC_FILENAME), "{{invalid yaml");
-    expect(readStackSpec(configDir)).toBeNull();
-  });
-
-  it("returns valid spec for version 2 with no other fields", () => {
-    writeFileSync(join(configDir, STACK_SPEC_FILENAME), "version: 2\n");
-    const spec = readStackSpec(configDir);
-    expect(spec).not.toBeNull();
-    expect(spec!.version).toBe(2);
-  });
-
-  it("ignores malformed addon names", () => {
-    writeFileSync(join(configDir, STACK_SPEC_FILENAME), "version: 2\naddons:\n  - chat\n  - ../bad\n  - API\n");
-    expect(readStackSpec(configDir)).toEqual({ version: 2, addons: ['chat'] });
-  });
-});
-
-// ── STACK_SPEC_FILENAME ───────────────────────────────────────────────────
-
-describe("STACK_SPEC_FILENAME", () => {
-  it("is stack.yml", () => {
-    expect(STACK_SPEC_FILENAME).toBe("stack.yml");
-  });
-});

package/src/control-plane/stack-spec.ts

@@ -1,88 +0,0 @@
-/**
- * Stack specification file (stack.yml) management.
- *
- * The stack spec is a YAML document used as a version marker for the
- * OpenPalm installation schema. AI provider configuration lives in
- * config/akm/config.json (managed via the admin AKM tab).
- *
- * v2: capabilities removed — LLM/embedding now live in akm config.
- */
-import { mkdirSync, writeFileSync, readFileSync, existsSync } from "node:fs";
-import { stringify as yamlStringify, parse as yamlParse } from "yaml";
-
-// ── StackSpec v2 ────────────────────────────────────────────────────────
-
-export type StackSpec = {
-  version: 2;
-  addons?: string[];
-};
-
-const ADDON_NAME_RE = /^[a-z0-9][a-z0-9-]{0,62}$/;
-
-// ── Constants ───────────────────────────────────────────────────────────
-
-export const STACK_SPEC_FILENAME = "stack.yml";
-
-export const SPEC_DEFAULTS = {
-  ports: {
-    assistant: 3800,
-    hostUi: 3880,
-    assistantSsh: 2222,
-  },
-  image: {
-    namespace: "openpalm",
-    tag: "latest",
-  },
-} as const;
-
-// ── Read / Write ────────────────────────────────────────────────────────
-
-export function writeStackSpec(configDir: string, spec: StackSpec): void {
-  mkdirSync(configDir, { recursive: true });
-  const content = yamlStringify(spec, { indent: 2 });
-  writeFileSync(`${configDir}/${STACK_SPEC_FILENAME}`, content);
-}
-
-/**
- * Read the stack spec. Returns null for missing or corrupt files.
- * Only the version field is checked; legacy capability fields are ignored.
- */
-export function readStackSpec(configDir: string): StackSpec | null {
-  const path = `${configDir}/${STACK_SPEC_FILENAME}`;
-  if (!existsSync(path)) return null;
-
-  let raw: unknown;
-  try {
-    raw = yamlParse(readFileSync(path, "utf-8"), { maxAliasCount: 100 });
-  } catch {
-    return null;
-  }
-  if (typeof raw !== "object" || raw === null) return null;
-  const obj = raw as Record<string, unknown>;
-  if (obj.version !== 2) return null;
-  const spec: StackSpec = { version: 2 };
-  if (Array.isArray(obj.addons)) {
-    const addons = obj.addons
-      .filter((value): value is string => typeof value === 'string' && ADDON_NAME_RE.test(value))
-      .filter((value, index, all) => all.indexOf(value) === index)
-      .sort();
-    if (addons.length > 0) spec.addons = addons;
-  }
-  return spec;
-}
-
-export function listStackSpecAddons(configDir: string): string[] {
-  return readStackSpec(configDir)?.addons ?? [];
-}
-
-export function setStackSpecAddon(configDir: string, name: string, enabled: boolean): void {
-  if (!ADDON_NAME_RE.test(name)) throw new Error(`Invalid addon name: ${name}`);
-  const current = readStackSpec(configDir) ?? { version: 2 };
-  const addons = new Set(current.addons ?? []);
-  if (enabled) addons.add(name);
-  else addons.delete(name);
-  const next: StackSpec = { version: 2 };
-  const sorted = [...addons].sort();
-  if (sorted.length > 0) next.addons = sorted;
-  writeStackSpec(configDir, next);
-}