OmniRoute/tests/unit/electron-packaging.test.ts

import assert from "node:assert/strict";
import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { pruneElectronRuntimeDocs } from "../../scripts/build/electronRuntimeDocs.mjs";

const ROOT = join(import.meta.dirname, "..", "..");

// The SECOND entry looks like a redundant duplicate of the first — it is not, and
// removing it ships a desktop app that cannot boot.
//
// electron-builder's file matcher hard-codes an exclusion of the source root's
// `node_modules` directory for extraResources/extraFiles, BEFORE any `filter`
// pattern is consulted (app-builder-lib/out/util/filter.js: `if (relative ===
// "node_modules") return false`). So `{ from: ".build/electron-standalone", to:
// "app", filter: ["**/*"] }` copies server.js, server-ws.mjs and every NESTED
// node_modules, but silently drops `.build/electron-standalone/node_modules` —
// the tree that holds `next`, `better-sqlite3` and the whole server closure.
//
// Pointing a second matcher AT the node_modules directory sidesteps the check
// (its relative paths never equal "node_modules") and is the only way to get that
// tree into `resources/app/node_modules`, which main.js also puts on the server's
// NODE_PATH.
//
// Regression history: #10325 "de-duplicated" the two entries into one on
// 2026-08-16; the packaged app then died on `Cannot find module 'next'` at
// resources/app/server.js. It went unnoticed for nine days because the Electron
// Package Smoke was already red on an earlier defect (lib/loginHeaderCapture.js
// missing from build.files since #9984), so the main process never got far enough
// to spawn the server.
test("electron build copies the standalone runtime AND its root node_modules into resources/app", () => {
  const electronPackage = JSON.parse(readFileSync(join(ROOT, "electron", "package.json"), "utf8"));

  const extraResources = electronPackage.build?.extraResources;
  assert.ok(Array.isArray(extraResources), "electron build.extraResources must be an array");

  const appResources = extraResources.filter(
    (resource) => resource?.to === "app" || resource?.to?.startsWith("app/")
  );

  assert.deepEqual(appResources, [
    {
      from: "../.build/electron-standalone",
      to: "app",
      filter: ["**/*", "node_modules/**/*"],
    },
    {
      from: "../.build/electron-standalone/node_modules",
      to: "app/node_modules",
      filter: ["**/*"],
    },
  ]);
});

test("electron standalone assembly normalizes Turbopack hashed external imports", () => {
  const prepareScript = readFileSync(
    join(ROOT, "scripts", "build", "prepare-electron-standalone.mjs"),
    "utf8"
  );

  assert.match(
    prepareScript,
    /assembleStandalone\(\{[\s\S]*?patchTurbopackChunks:\s*true,[\s\S]*?\}\);/,
    "Electron packages must strip Turbopack's hashed external package names before bundling"
  );
});

test("electron docs manifest prunes authoring payloads without removing runtime docs", () => {
  const bundleRoot = mkdtempSync(join(tmpdir(), "omniroute-electron-docs-"));
  const files = new Map([
    ["docs/openapi.yaml", "openapi: 3.1.0"],
    ["docs/guides/CODEX-CLI-CONFIGURATION.md", "# Codex CLI"],
    ["docs/i18n/ko/docs/guides/ELECTRON_GUIDE.md", "# Electron"],
    ["docs/i18n/ko/CHANGELOG.md", "translated release history"],
    ["docs/i18n/ko/README.md", "translated readme"],
    ["docs/i18n/ko/llm.txt", "translated llm summary"],
    ["docs/i18n/fr/CHANGELOG.md", "historique traduit"],
    ["docs/research/desktop-notes.md", "authoring notes"],
    ["docs/superpowers/plans/desktop-plan.md", "implementation plan"],
  ]);

  try {
    for (const [relativePath, content] of files) {
      const absolutePath = join(bundleRoot, relativePath);
      mkdirSync(join(absolutePath, ".."), { recursive: true });
      writeFileSync(absolutePath, content);
    }

    const result = pruneElectronRuntimeDocs(bundleRoot);

    // Only `docs/i18n/<locale>/docs/**` is read at runtime (the in-app docs
    // route, see src/lib/docsI18nPath.ts); every root-level mirror of a locale
    // is authoring material and leaves the bundle with the CHANGELOG.
    assert.deepEqual(result.removedPaths, [
      "docs/i18n/fr/CHANGELOG.md",
      "docs/i18n/ko/CHANGELOG.md",
      "docs/i18n/ko/README.md",
      "docs/i18n/ko/llm.txt",
      "docs/research",
      "docs/superpowers",
    ]);
    assert.equal(result.removedFiles, 6);
    assert.equal(
      result.removedBytes,
      Buffer.byteLength("translated release history") +
        Buffer.byteLength("translated readme") +
        Buffer.byteLength("translated llm summary") +
        Buffer.byteLength("historique traduit") +
        Buffer.byteLength("authoring notes") +
        Buffer.byteLength("implementation plan")
    );

    assert.equal(existsSync(join(bundleRoot, "docs/openapi.yaml")), true);
    assert.equal(existsSync(join(bundleRoot, "docs/guides/CODEX-CLI-CONFIGURATION.md")), true);
    assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/docs/guides/ELECTRON_GUIDE.md")), true);
    assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/CHANGELOG.md")), false);
    assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/README.md")), false);
    assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/llm.txt")), false);
    assert.equal(existsSync(join(bundleRoot, "docs/research")), false);
    assert.equal(existsSync(join(bundleRoot, "docs/superpowers")), false);

    assert.deepEqual(pruneElectronRuntimeDocs(bundleRoot), {
      removedFiles: 0,
      removedBytes: 0,
      removedPaths: [],
    });
  } finally {
    rmSync(bundleRoot, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
  }
});

test("electron bundle preparation applies the runtime docs manifest to its staging tree", () => {
  const prepareScript = readFileSync(
    join(ROOT, "scripts", "build", "prepare-electron-standalone.mjs"),
    "utf8"
  );

  assert.match(
    prepareScript,
    /pruneElectronRuntimeDocs\(ELECTRON_STANDALONE_DIR\)/,
    "Electron staging must prune authoring docs before electron-builder copies the bundle"
  );
});