cartethyia 2.4.4 → 2.4.6

package/scripts/cli/command/tray.ts

@@ -0,0 +1,165 @@
+import { isNewerRelease } from "../../../src/console/updates/version-compare";
+import { resolvePackagePath } from "../../../src/config/package-paths";
+import { resolvePort } from "../../../src/config/runtime";
+import { ensureDrainToken } from "../gateway/drain-token";
+import { startGateway } from "../gateway/spawn";
+import { stopGateway } from "../gateway/stop";
+import { readInstalledVersion, readLatestPublishedVersion } from "../support/version";
+import { reportTrayStartup } from "../support/startup-signal";
+import { createTray } from "../tray";
+import { openUrl } from "../ui/background";
+import { exportBackup, resetConsoleAccount } from "./admin";
+import { printUpdateInstructions } from "./update";
+
+/**
+ * Runs the gateway with a tray icon. The tray is platform-specific (`tray/`):
+ * on Windows it is a PowerShell NotifyIcon, because a Node tray library leaves
+ * an empty console tab open for the tray's whole lifetime, and that window is
+ * owned by Windows Terminal — not by this process, so it cannot be found and
+ * hidden from inside.
+ */
+export async function startTray(): Promise<void> {
+  const port = resolvePort();
+  const drainToken = ensureDrainToken();
+  const dashboardUrl = `http://127.0.0.1:${port}/console`;
+  const repositoryUrl = "https://github.com/risunCode/cartethyia";
+  const currentVersion = await readInstalledVersion();
+
+  let gateway: Bun.Subprocess | null = null;
+  let closing = false;
+  let busy = false;
+  let resetArmed = false;
+  let latestVersion: string | null = null;
+  let closePromise: Promise<void> | undefined;
+
+  const tray = createTray({
+    iconPath: resolvePackagePath(
+      "scripts",
+      "cli",
+      "tray",
+      "assets",
+      process.platform === "win32" ? "cartethyia.ico" : "cartethyia.png",
+    ),
+    tooltip: `Cartethyia ${currentVersion}`,
+    items: [
+      { kind: "action", id: "update", title: `Cartethyia ${currentVersion} \u00b7 checking\u2026`, enabled: true },
+      { kind: "separator" },
+      { kind: "action", id: "console", title: `Open Console \u00b7 ${dashboardUrl}` },
+      { kind: "action", id: "reset", title: "Reset console password" },
+      { kind: "action", id: "backup", title: "Backup" },
+      { kind: "separator" },
+      { kind: "action", id: "exit", title: "Exit" },
+    ],
+    onSelect: (id: string) => void handleSelect(id),
+    onExit: () => void close(1),
+  });
+
+  const close = (exitCode = 0): Promise<void> => {
+    if (closePromise) return closePromise;
+    closing = true;
+    closePromise = (async () => {
+      const current: Bun.Subprocess | null = gateway;
+      gateway = null;
+      if (current) await stopGateway(current, port, drainToken);
+      await tray.close();
+      process.exitCode = exitCode;
+    })();
+    return closePromise;
+  };
+
+  const refreshVersion = async (): Promise<void> => {
+    const fetched = await readLatestPublishedVersion();
+    if (closing) return;
+    latestVersion = fetched;
+    if (fetched === null) {
+      tray.update("update", `Cartethyia ${currentVersion} \u00b7 check for updates`, true);
+      return;
+    }
+    const newer = isNewerRelease(currentVersion, fetched);
+    tray.update(
+      "update",
+      newer
+        ? `Cartethyia ${currentVersion} \u00b7 update to ${fetched}`
+        : `Cartethyia ${currentVersion} \u00b7 up to date`,
+      // Always clickable: the row opens the repository, and only offers the
+      // update command when there is something newer.
+      true,
+    );
+  };
+
+  const runUpdate = async (): Promise<void> => {
+    if (busy) return;
+    busy = true;
+    const latest = await readLatestPublishedVersion();
+    await close();
+    printUpdateInstructions(currentVersion, latest);
+    process.exit(0);
+  };
+
+  async function handleSelect(id: string): Promise<void> {
+    if (closing) return;
+    if (id === "exit") return void (await close());
+    if (id === "console") return void (await openUrl(dashboardUrl));
+    if (id === "backup") {
+      const result = await exportBackup(port, drainToken);
+      if (result !== null) {
+        console.log(
+          `Backup written to ${result.path} (${(result.bytes / 1024).toFixed(1)} KiB). Telemetry is not included.`,
+        );
+      }
+      return;
+    }
+    if (id === "reset") {
+      // A tray click cannot ask for the typed confirmation the menu uses, so
+      // the first click arms the action and the second one runs it.
+      if (!resetArmed) {
+        resetArmed = true;
+        tray.update("reset", "Reset console password \u00b7 click again to delete", true);
+        return;
+      }
+      resetArmed = false;
+      tray.update("reset", "Reset console password", true);
+      await resetConsoleAccount(port, drainToken);
+      return;
+    }
+    if (id === "update") {
+      // Nothing to install: the row is the way to the repository instead.
+      if (latestVersion === null || !isNewerRelease(currentVersion, latestVersion)) {
+        await openUrl(repositoryUrl);
+        return;
+      }
+      await runUpdate();
+    }
+  }
+
+  process.once("SIGINT", () => void close());
+  process.once("SIGTERM", () => void close());
+
+  try {
+    await tray.ready();
+    gateway = await startGateway(port, drainToken);
+    // The launcher that spawned this tray is blocked on a signal file: it
+    // cannot read our stdio, because the tray is detached. Without this write
+    // it waits out its 60 s deadline and reports a failure for a tray that is
+    // running fine.
+    reportTrayStartup({ status: "ready", url: dashboardUrl });
+    console.log(`Cartethyia is running at ${dashboardUrl}`);
+    void refreshVersion();
+
+    while (!closing) {
+      const current: Bun.Subprocess | null = gateway;
+      if (!current) {
+        await Bun.sleep(100);
+        continue;
+      }
+      const code = await current.exited;
+      if (gateway !== current || closing) continue;
+      gateway = null;
+      console.error(`Cartethyia exited with code ${code}.`);
+      await close(code ?? 1);
+    }
+  } catch (error) {
+    await close(1);
+    throw error;
+  }
+}

package/scripts/cli/command/update.ts

@@ -0,0 +1,23 @@
+/**
+ * The update path, which prints a command rather than running one.
+ *
+ * npm cannot replace this package's directory while a process is executing out
+ * of it: on Windows the rename fails with EBUSY and npm exits 14. Stopping the
+ * gateway is not enough either, because the CLI or tray itself is the process
+ * holding the directory. So every caller stops, prints the command, and exits —
+ * the same shape 9router uses.
+ */
+export function updateCommand(): string {
+  return "npm install --global cartethyia@latest --prefer-online";
+}
+
+/** Prints the "run this now" block after Cartethyia has stopped. */
+export function printUpdateInstructions(from: string, to: string | null): void {
+  console.log("");
+  console.log(`Update available: ${from} \u2192 ${to ?? "latest"}`);
+  console.log("");
+  console.log("Run this now that Cartethyia has stopped:");
+  console.log("");
+  console.log(`   ${updateCommand()}`);
+  console.log("");
+}

package/scripts/cli/{runtime-state.ts → gateway/drain-token.ts}

@@ -1,78 +1,78 @@
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-
-/**
- * The install's drain token, persisted in the config directory.
- *
- * Why it persists instead of being generated per run: `cartethyia stop` runs in
- * a different process, possibly minutes later, and the token is the only way it
- * can authenticate to a gateway it did not start. A token regenerated on each
- * start could never match the gateway that is actually running, which is why
- * `stop` reported "no gateway found" or a 401 on a live gateway.
- *
- * It is kept out of `.env` on purpose: it authorises a shutdown, so it belongs
- * in a machine-written file the operator never hand-edits and never commits.
- * Mode 0600 where the platform honours it.
- */
-const RUNTIME_STATE_FILE = "runtime.json";
-
-interface RuntimeState {
-  readonly drainToken: string;
-}
-
-function statePath(): string | null {
-  const configDir = process.env.CARTETHYIA_CONFIG_DIR;
-  return configDir ? join(configDir, RUNTIME_STATE_FILE) : null;
-}
-
-function readState(): RuntimeState | null {
-  const path = statePath();
-  if (path === null || !existsSync(path)) return null;
-  try {
-    const parsed: unknown = JSON.parse(readFileSync(path, "utf8"));
-    if (
-      parsed !== null &&
-      typeof parsed === "object" &&
-      "drainToken" in parsed &&
-      typeof parsed.drainToken === "string" &&
-      parsed.drainToken.length > 0
-    ) {
-      return { drainToken: parsed.drainToken };
-    }
-  } catch {
-    // A corrupt or stale state file reads as "no token".
-  }
-  return null;
-}
-
-/**
- * Returns the install's drain token, creating and persisting one on first use.
- *
- * Every start calls this, so a gateway started from the menu, from `tray`, or
- * from `cartethyia start` all authenticate with the same token and `stop`
- * always has the one that works.
- */
-export function ensureDrainToken(): string {
-  const existing = readState();
-  if (existing !== null) return existing.drainToken;
-
-  const token = crypto.randomUUID().replace(/-/g, "") + crypto.randomUUID().replace(/-/g, "");
-  const path = statePath();
-  if (path !== null) {
-    try {
-      writeFileSync(path, JSON.stringify({ drainToken: token }), {
-        encoding: "utf8",
-        mode: 0o600,
-      });
-    } catch {
-      // A read-only config directory still yields a usable in-process token;
-      // only `stop` from another process is lost.
-    }
-  }
-  return token;
-}
-
-/** The persisted token, or null when this install has never started. */
-export function readPersistedDrainToken(): string | null {
-  return readState()?.drainToken ?? null;
-}
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+/**
+ * The install's drain token, persisted in the config directory.
+ *
+ * Why it persists instead of being generated per run: the tray that "Hide to
+ * tray" starts runs in a different process and drains the gateway through the
+ * loopback endpoint, so the token has to match across processes. A token
+ * regenerated on each start could never authenticate against a gateway another
+ * process had started.
+ *
+ * It is kept out of `.env` on purpose: it authorises a shutdown, so it belongs
+ * in a machine-written file the operator never hand-edits and never commits.
+ * Mode 0600 where the platform honours it.
+ */
+const RUNTIME_STATE_FILE = "runtime.json";
+
+interface RuntimeState {
+  readonly drainToken: string;
+}
+
+function statePath(): string | null {
+  const configDir = process.env.CARTETHYIA_CONFIG_DIR;
+  return configDir ? join(configDir, RUNTIME_STATE_FILE) : null;
+}
+
+function readState(): RuntimeState | null {
+  const path = statePath();
+  if (path === null || !existsSync(path)) return null;
+  try {
+    const parsed: unknown = JSON.parse(readFileSync(path, "utf8"));
+    if (
+      parsed !== null &&
+      typeof parsed === "object" &&
+      "drainToken" in parsed &&
+      typeof parsed.drainToken === "string" &&
+      parsed.drainToken.length > 0
+    ) {
+      return { drainToken: parsed.drainToken };
+    }
+  } catch {
+    // A corrupt or stale state file reads as "no token".
+  }
+  return null;
+}
+
+/**
+ * Returns the install's drain token, creating and persisting one on first use.
+ *
+ * Every start calls this, so a gateway started from the menu, from `tray`, or
+ * from `cartethyia start` all authenticate with the same token and `stop`
+ * always has the one that works.
+ */
+export function ensureDrainToken(): string {
+  const existing = readState();
+  if (existing !== null) return existing.drainToken;
+
+  const token = crypto.randomUUID().replace(/-/g, "") + crypto.randomUUID().replace(/-/g, "");
+  const path = statePath();
+  if (path !== null) {
+    try {
+      writeFileSync(path, JSON.stringify({ drainToken: token }), {
+        encoding: "utf8",
+        mode: 0o600,
+      });
+    } catch {
+      // A read-only config directory still yields a usable in-process token;
+      // only `stop` from another process is lost.
+    }
+  }
+  return token;
+}
+
+/** The persisted token, or null when this install has never started. */
+export function readPersistedDrainToken(): string | null {
+  return readState()?.drainToken ?? null;
+}

package/scripts/cli/gateway/spawn.ts

@@ -0,0 +1,101 @@
+import { openSync } from "node:fs";
+import { join } from "node:path";
+import { PACKAGE_ROOT, resolvePackagePath } from "../../../src/config/package-paths";
+
+/**
+ * Starts the gateway and resolves once it answers its own health probe.
+ *
+ * The child is attached by default. A detached child cannot be killed from an
+ * `exit` handler on Windows (measured: `kill()` runs, the gateway keeps
+ * serving), and a terminal's Ctrl-C only reaches children in the same process
+ * group. Staying attached means Ctrl-C and the `exit` backstop both stop the
+ * gateway. "Hide to tray" passes `detached: true` because that gateway must
+ * outlive this process.
+ */
+export async function startGateway(
+  port: number,
+  drainToken: string,
+  options: { readonly detached?: boolean } = {},
+): Promise<Bun.Subprocess> {
+  // Starting a second gateway on the same port used to fail with "stopped
+  // before becoming ready (exit code 1)", which says nothing about the real
+  // cause. Probe the port first and say what is actually there.
+  const existing = await fetch(`http://127.0.0.1:${port}/health`, {
+    signal: AbortSignal.timeout(1_000),
+  }).catch(() => null);
+  if (existing !== null) {
+    throw new Error(
+      `Cartethyia is already running on port ${port}. Open http://127.0.0.1:${port}/console, or stop the terminal that started it.`,
+    );
+  }
+  // The gateway logs a startup phase line per stage. In menu mode those lines
+  // would scroll through the same terminal the menu is drawing on, so they go
+  // to a file instead and the operator sees only the menu.
+  const configDir = process.env.CARTETHYIA_CONFIG_DIR;
+  let logFd: number | null = null;
+  if (configDir) {
+    try {
+      logFd = openSync(join(configDir, "gateway.log"), "a");
+    } catch {
+      // A read-only config directory costs only the log, not startup.
+    }
+  }
+  const child = Bun.spawn(
+    [process.execPath, "run", resolvePackagePath("src", "main.ts")],
+    {
+      cwd: PACKAGE_ROOT,
+      env: { ...process.env, CARTETHYIA_DRAIN_TOKEN: drainToken },
+      // "ignore", not "inherit": the gateway does not read stdin, and in menu
+      // mode the menu is the only stdin consumer. With "inherit" the gateway
+      // held the fd and swallowed every keypress after the first, so the menu
+      // rendered but never received Enter.
+      stdin: "ignore",
+      stdout: logFd ?? "ignore",
+      // stderr goes to the same file: "inherit" ties the gateway to the
+      // terminal, so closing that terminal took the gateway down with it and
+      // "Hide to tray" left nothing running.
+      stderr: logFd ?? "ignore",
+      detached: options.detached === true,
+    },
+  );
+  const startupController = new AbortController();
+  const ready = (async (): Promise<void> => {
+    const deadline = Date.now() + 30_000;
+    while (!startupController.signal.aborted && Date.now() < deadline) {
+      try {
+        const response = await fetch(`http://127.0.0.1:${port}/health`, {
+          signal: AbortSignal.timeout(500),
+        });
+        if (response.ok) {
+          const body: unknown = await response.json();
+          if (body !== null && typeof body === "object" && "status" in body && body.status === "ok") return;
+        }
+      } catch {
+        // The gateway is not accepting health requests yet.
+      }
+      await Bun.sleep(250);
+    }
+    if (startupController.signal.aborted) throw new Error("Cartethyia exited before becoming ready");
+    throw new Error("Cartethyia did not open its configured port within 30 seconds");
+  })();
+  const exitedEarly = child.exited.then((code) => {
+    startupController.abort();
+    return { status: "exit" as const, code };
+  });
+  const readyResult = ready.then(
+    () => ({ status: "ready" as const }),
+    (error: unknown) => ({ status: "failure" as const, error }),
+  );
+  try {
+    const result = await Promise.race([readyResult, exitedEarly]);
+    if (result.status === "exit") {
+      throw new Error(`Cartethyia stopped before becoming ready (exit code ${result.code})`);
+    }
+    if (result.status === "failure") throw result.error;
+    return child;
+  } catch (error) {
+    child.kill();
+    await child.exited;
+    throw error;
+  }
+}

package/scripts/cli/gateway/stop.ts

@@ -0,0 +1,51 @@
+/**
+ * Stops a gateway this process started, gracefully where possible.
+ *
+ * The drain endpoint is the only graceful path: it lets in-flight responses
+ * finish. The OS-level kill is the fallback, and it is reached whenever the
+ * endpoint is unreachable — which is also what happens when the gateway is
+ * already on its way out, so a failure here is not necessarily an error the
+ * operator needs to act on.
+ */
+export async function stopGateway(
+  current: Bun.Subprocess,
+  port: number,
+  drainToken: string,
+): Promise<void> {
+  let drainAccepted = false;
+  try {
+    const response = await fetch(`http://127.0.0.1:${port}/admin/drain`, {
+      method: "POST",
+      headers: { "x-drain-token": drainToken },
+      signal: AbortSignal.timeout(2_000),
+    });
+    drainAccepted = response.status === 202;
+  } catch {
+    // The process may already be exiting; fall back to its OS-level termination.
+  }
+  if (!drainAccepted) {
+    console.error("Could not request a graceful gateway drain; terminating the gateway process.");
+    current.kill();
+    await current.exited;
+    return;
+  }
+
+  // The drain is bounded: a gateway that accepted the request but never exits
+  // would otherwise hang the CLI. 30 s is the drain budget `src/main.ts` uses.
+  // The timer is cleared unconditionally afterwards — leaving it pending keeps
+  // the event loop alive for its full 30 s after the gateway is already gone,
+  // which made every `carte` exit take half a minute.
+  let timer: Timer | undefined;
+  const drained = await Promise.race([
+    current.exited,
+    new Promise<null>((resolveExit) => {
+      timer = setTimeout(() => resolveExit(null), 30_000);
+    }),
+  ]);
+  clearTimeout(timer);
+  if (drained === null) {
+    console.error("Graceful drain timed out; terminating the gateway process.");
+    current.kill();
+    await current.exited;
+  }
+}

package/scripts/cli/main.ts

@@ -0,0 +1,94 @@
+import { mkdirSync } from "node:fs";
+import { resolveUserConfigDir } from "../../src/config/package-paths";
+import { ENV_PATH, readEnvFile } from "./support/env";
+import { MINIMUM_BUN_VERSION, assertBunVersion } from "./support/bun";
+import { printUpdateInstructions } from "./command/update";
+import { reportTrayStartup } from "./support/startup-signal";
+
+process.env.CARTETHYIA_CONFIG_DIR ??= resolveUserConfigDir();
+
+const HELP = `Cartethyia ${MINIMUM_BUN_VERSION}+ (Bun is required)
+
+Usage:
+  carte                  start, then show an arrow-key menu (no GUI needed)
+  carte --tray           start with a system-tray icon instead
+  cartethyia setup [--non-interactive]
+  cartethyia start
+  cartethyia menu
+  cartethyia doctor
+  cartethyia update
+
+carte starts the gateway in the background and leaves only the console menu on
+your terminal — Open Console, Reset password, Backup, Update, Hide to tray,
+Exit. Arrow keys and Enter; no desktop environment needed, so it works over SSH
+and headless. Exiting the menu drains the gateway.
+carte --tray uses a system-tray icon instead, which needs a graphical session.
+Stop a gateway whose terminal is gone with Ctrl-C in that terminal.
+Setup explains Lite (embedded SQLite) and Full (external PostgreSQL), then saves
+configuration under the current user's Cartethyia config directory.
+`;
+
+/** Loads the user's `.env` into the environment without overriding it. */
+async function loadUserConfig(): Promise<void> {
+  const configDir = process.env.CARTETHYIA_CONFIG_DIR;
+  if (!configDir) throw new Error("Cartethyia config directory could not be resolved");
+  mkdirSync(configDir, { recursive: true });
+  const values = await readEnvFile(ENV_PATH);
+  for (const [key, value] of Object.entries(values)) {
+    if (!process.env[key]) process.env[key] = value;
+  }
+}
+
+async function main(): Promise<void> {
+  assertBunVersion();
+  const [command] = process.argv.slice(2);
+  if (command === "setup" || command === "start" || command === "tray" || command === "menu" || command === "doctor") {
+    await loadUserConfig();
+  }
+
+  switch (command) {
+    case "setup": {
+      const { setup } = await import("./command/setup");
+      await setup();
+      return;
+    }
+    case "start": {
+      const { startForeground } = await import("./command/start");
+      await startForeground();
+      return;
+    }
+    case "menu": {
+      const { startMenu } = await import("./command/console-menu");
+      await startMenu();
+      return;
+    }
+    case "tray": {
+      const { startTray } = await import("./command/tray");
+      await startTray();
+      return;
+    }
+    case "doctor": {
+      const { doctor } = await import("./command/doctor");
+      await doctor();
+      return;
+    }
+    case "update":
+      printUpdateInstructions("this install", null);
+      return;
+    case "--help":
+    case "-h":
+    case undefined:
+      console.log(HELP);
+      return;
+    default:
+      console.error(`Unknown command: ${command}\n\n${HELP}`);
+      process.exitCode = 2;
+  }
+}
+
+main().catch((error: unknown) => {
+  const message = error instanceof Error ? error.message : "unknown error";
+  if (process.argv[2] === "tray") reportTrayStartup({ status: "failed", message });
+  console.error(`Cartethyia failed: ${message}`);
+  process.exitCode = 1;
+});

package/scripts/cli/support/bun.ts

@@ -0,0 +1,27 @@
+/** Minimum Bun the repository declares in `package.json` `engines`. */
+export const MINIMUM_BUN_VERSION = "1.4.0";
+
+/**
+ * True when `actual` is at least `minimum`, compared as dotted integers.
+ * A non-numeric segment reads as 0, so a malformed version fails closed
+ * against a real minimum instead of passing.
+ */
+export function bunVersionAtLeast(actual: string, minimum: string): boolean {
+  const left = actual.split(".").map((part) => Number.parseInt(part, 10) || 0);
+  const right = minimum.split(".").map((part) => Number.parseInt(part, 10) || 0);
+  const length = Math.max(left.length, right.length);
+  for (let i = 0; i < length; i += 1) {
+    const a = left[i] ?? 0;
+    const b = right[i] ?? 0;
+    if (a !== b) return a > b;
+  }
+  return true;
+}
+
+/** Throws unless the running Bun satisfies the declared minimum. */
+export function assertBunVersion(): void {
+  if (bunVersionAtLeast(Bun.version, MINIMUM_BUN_VERSION)) return;
+  throw new Error(
+    `Bun ${MINIMUM_BUN_VERSION} or newer is required (found ${Bun.version}). Install it from https://bun.sh and run this command again.`,
+  );
+}