@tiens.nguyen/gu-cli 1.0.791 → 1.0.793

package/client-expert-api.mjs

@@ -27,9 +27,64 @@ import { readFileSync } from "node:fs";
 import { homedir } from "node:os";
 import { join } from "node:path";
 
-/** Where the local API listens. 4100 keeps clear of the hosted API and of Vite's 5173. */
-export const LOCAL_API_PORT = Number(process.env.GONEXT_LOCAL_API_PORT ?? "4100") || 4100;
-export const LOCAL_API_BASE = `http://127.0.0.1:${LOCAL_API_PORT}`;
+/** Where the local API listens by default. 4100 keeps clear of the hosted API and of Vite's 5173. */
+export const DEFAULT_LOCAL_API_PORT = 4100;
+/** The port setup had to move to, when 4100 belonged to another program (task #337). */
+export const API_PORT_FILE = join(homedir(), ".gonext", "local-api.port");
+
+const validPort = (v) => {
+  const n = Number.parseInt(String(v ?? "").trim(), 10);
+  return Number.isInteger(n) && n > 0 && n < 65536 ? n : null;
+};
+
+/**
+ * WHICH PORT THE LOCAL API USES, and why (task #337).
+ *
+ *   env   — GONEXT_LOCAL_API_PORT: someone chose it; gu never moves away from it on its own.
+ *   saved — ~/.gonext/local-api.port: 4100 was taken by ANOTHER PROGRAM when the API was first
+ *           started, and gu moved. Every later process — `gu`, `gu-cli api …`, the worker's
+ *           terminal — reads the same file, so they all follow the move.
+ *   default — 4100. A machine where 4100 was free has no file and behaves exactly as before.
+ *
+ * Pure: the file's text is passed in.
+ */
+export function resolveApiPort({ env = process.env, saved = "" } = {}) {
+  const fromEnv = validPort(env.GONEXT_LOCAL_API_PORT);
+  if (fromEnv) return { port: fromEnv, source: "env" };
+  const fromFile = validPort(saved);
+  if (fromFile) return { port: fromFile, source: "saved" };
+  return { port: DEFAULT_LOCAL_API_PORT, source: "default" };
+}
+
+function readSavedPort() {
+  try {
+    return readFileSync(API_PORT_FILE, "utf8");
+  } catch {
+    return "";
+  }
+}
+
+/**
+ * LIVE BINDINGS, not constants: thirty readers across gu take the port from these two names. When
+ * setup moves the API in THIS process they must all see the new port at once — an ES module's
+ * exported `let` does exactly that for every importer, and a default parameter reads it at call
+ * time. Other processes get it from the file when they start.
+ */
+export let LOCAL_API_PORT = resolveApiPort({ saved: readSavedPort() }).port;
+export let LOCAL_API_BASE = `http://127.0.0.1:${LOCAL_API_PORT}`;
+
+/** Use `port` from now on in this process (and, with save, in every later one). */
+export async function useApiPort(port, { save = true } = {}) {
+  const n = validPort(port);
+  if (!n) throw new Error(`not a port: ${port}`);
+  LOCAL_API_PORT = n;
+  LOCAL_API_BASE = `http://127.0.0.1:${n}`;
+  if (save) {
+    await mkdir(join(homedir(), ".gonext"), { recursive: true });
+    await writeFile(API_PORT_FILE, `${n}\n`, "utf8");
+  }
+  return n;
+}
 export const LOCAL_MONGO_URI = process.env.GONEXT_LOCAL_MONGO_URI || "mongodb://127.0.0.1:27017";
 export const LOCAL_DB_NAME = process.env.GONEXT_LOCAL_DB_NAME || "gu";
 
@@ -189,7 +244,39 @@ export function npmInstallCommand(platform = process.platform) {
   };
 }
 
-export function installApiDeps(apiDir, { onLine } = {}) {
+/**
+ * A DROPPED CONNECTION IS NOT A FAILED INSTALL (task #333). The Windows 11 test box fetched
+ * single packages in 30 s and then got "npm error network read ECONNRESET" — twice in a row, on
+ * the first install, which then stopped with "Run `gu` again". A rerun went through. npm keeps
+ * what it already downloaded, so trying again in place is cheap and is what the user would do.
+ * Only NETWORK failures are retried: a real error (a bad package, a full disk) fails the same way
+ * every time, and three copies of it would only bury it.
+ */
+export function isNetworkNpmError(text) {
+  return /\b(ECONNRESET|ETIMEDOUT|ECONNREFUSED|EAI_AGAIN|ENOTFOUND|ENETUNREACH|EPIPE|ERR_SOCKET_TIMEOUT)\b|socket hang up|network (read|request)/i.test(
+    String(text ?? "")
+  );
+}
+
+/** npm on Windows exits with a NEGATIVE errno that arrives unsigned: 4294963219 is -4077. */
+export function signedExitCode(code) {
+  return typeof code === "number" && code > 0x7fffffff ? code - 0x100000000 : code;
+}
+
+export const API_DEPS_ATTEMPTS = 3;
+
+export async function installApiDeps(apiDir, { onLine, attempts = API_DEPS_ATTEMPTS, once = installApiDepsOnce } = {}) {
+  for (let i = 1; ; i++) {
+    try {
+      return await once(apiDir, { onLine });
+    } catch (e) {
+      if (i >= attempts || !isNetworkNpmError(`${e?.output ?? ""}\n${e?.message ?? ""}`)) throw e;
+      onLine?.(`network error — trying again (${i + 1} of ${attempts}); what was downloaded is kept`);
+    }
+  }
+}
+
+function installApiDepsOnce(apiDir, { onLine } = {}) {
   const { cmd, args, shell, line } = npmInstallCommand();
   return new Promise((resolve, reject) => {
     let child;
@@ -212,7 +299,11 @@ export function installApiDeps(apiDir, { onLine } = {}) {
     });
     child.on("error", (e) => reject(new Error(`could not run ${cmd} in ${apiDir}: ${e.message}`)));
     child.on("exit", (code) =>
-      code === 0 ? resolve() : reject(new Error(`npm install failed (exit ${code}) ${err.slice(-400)}`))
+      code === 0
+        ? resolve()
+        : // `output` keeps ALL of stderr: the 400-char tail in the message had already lost the
+          // "ECONNRESET" line on the real Windows failure, so the retry never saw it.
+          reject(Object.assign(new Error(`npm install failed (exit ${signedExitCode(code)}) ${err.slice(-400)}`), { output: err }))
     );
   });
 }
@@ -257,6 +348,150 @@ export async function seedDatabase({
   }
 }
 
+/**
+ * WHO IS ON A PORT → "free" | "gu" | "other" (task #337).
+ *
+ * "gu" is anything that answers /api/health the way this API does — usable or not, this home's
+ * or another's: it is our program and moving away from it would start a second one. "other" is a
+ * port that accepts a connection and is not that: someone else's server. Only "other" is a
+ * reason to move.
+ */
+export async function whoHoldsPort(port, { fetchImpl = fetch, connects = tcpConnects } = {}) {
+  try {
+    const res = await fetchImpl(`http://127.0.0.1:${port}/api/health`, { signal: AbortSignal.timeout(2500) });
+    const body = await res.json().catch(() => null);
+    if (body && typeof body === "object" && ("dataBackend" in body || "persistence" in body)) return "gu";
+    return "other";
+  } catch {
+    return (await connects(port)) ? "other" : "free";
+  }
+}
+
+/** Does anything accept a TCP connection on 127.0.0.1:port? */
+async function tcpConnects(port, timeoutMs = 1500) {
+  const net = await import("node:net");
+  return new Promise((resolve) => {
+    const sock = net.connect({ host: "127.0.0.1", port });
+    const done = (v) => {
+      sock.destroy();
+      resolve(v);
+    };
+    sock.setTimeout(timeoutMs, () => done(false));
+    sock.once("connect", () => done(true));
+    sock.once("error", () => done(false));
+  });
+}
+
+/** Can a server be opened on `port` right now? The only honest test of "free". */
+async function canListen(port) {
+  const net = await import("node:net");
+  return new Promise((resolve) => {
+    const srv = net.createServer();
+    srv.once("error", () => resolve(false));
+    srv.listen(port, () => srv.close(() => resolve(true)));
+  });
+}
+
+/** How many ports after the taken one are tried before asking the system for any free one. */
+export const API_PORT_TRIES = 10;
+
+/** The first port after `taken` that a server can open — else one the system picks. */
+export async function findFreePort(taken, { isFree = canListen, tries = API_PORT_TRIES, anyFree = systemFreePort } = {}) {
+  for (let p = taken + 1; p <= taken + tries && p < 65536; p++) {
+    if (await isFree(p)) return p;
+  }
+  return anyFree();
+}
+
+async function systemFreePort() {
+  const net = await import("node:net");
+  return new Promise((resolve, reject) => {
+    const srv = net.createServer();
+    srv.once("error", reject);
+    srv.listen(0, () => {
+      const { port } = srv.address();
+      srv.close(() => resolve(port));
+    });
+  });
+}
+
+/**
+ * What to do about the port before starting the API. Pure.
+ *   use    — it is free, or gu's own API is already there.
+ *   move   — another program has it and nobody insisted on this port.
+ *   refuse — another program has it and GONEXT_LOCAL_API_PORT asked for exactly this port:
+ *            an explicit choice is not overridden, it is reported.
+ */
+export function portDecision({ holder, source }) {
+  if (holder !== "other") return "use";
+  return source === "env" ? "refuse" : "move";
+}
+
+/**
+ * MAKE SURE THE API HAS A PORT IT CAN OPEN, moving off one that belongs to another program.
+ *
+ * The first install used to end in "The API started but is not usable: not up yet" when 4100
+ * was somebody else's — the API could not bind, and nothing said why. Now gu says which program
+ * has the port, takes the next free one, REMEMBERS it (API_PORT_FILE), and re-points worker.env
+ * when there is one, so the terminal and the worker follow.
+ *
+ * → { moved, port, from?, holder? }. Never throws: a port problem must not hide the real error.
+ */
+export async function settleApiPort({
+  log = (l) => console.log(l),
+  env = process.env,
+  holds = whoHoldsPort,
+  nameOf = null,
+  freePort = findFreePort,
+} = {}) {
+  const from = LOCAL_API_PORT;
+  try {
+    const source = resolveApiPort({ env, saved: readSavedPort() }).source;
+    const holder = await holds(from);
+    const action = portDecision({ holder, source });
+    if (action === "use") return { moved: false, port: from };
+    // The program's name when the system gives it; on Windows it often does not (seen live),
+    // and "another program (another program)" is not a sentence.
+    const name = (await (nameOf ?? (await import("./mongo-native.mjs")).portHolder)(from).catch(() => null)) || "";
+    const who = name || "another program";
+    if (action === "refuse") {
+      log(`  Port ${from} (set by GONEXT_LOCAL_API_PORT) is in use by ${who}.`);
+      log("  Stop that program, or choose another port, then run gu again.");
+      return { moved: false, port: from, holder: who, refused: true };
+    }
+    const to = await freePort(from);
+    await useApiPort(to);
+    log(`  Port ${from} is used by another program${name ? ` (${name})` : ""} — gu's API uses ${to}.`);
+    // An install that was already working: its terminal and its worker read worker.env. The
+    // worker read it ONCE, at start, so it is restarted — or it would poll the old port forever.
+    if (await repointWorkerEnv(from, to)) {
+      try {
+        const ctl = await import("./daemon-control.mjs");
+        if ((await ctl.daemonStatus()).running) {
+          await ctl.stopDaemon();
+          await ctl.startDaemon();
+          log("  · restarted the background worker so it uses the new port");
+        }
+      } catch {
+        log("  · restart the background worker to pick up the new port: gu-cli restart");
+      }
+    }
+    return { moved: true, port: to, from, holder: who };
+  } catch {
+    return { moved: false, port: from };
+  }
+}
+
+/** worker.env pointed at the local API on the old port → point it at the new one. */
+async function repointWorkerEnv(from, to) {
+  const path = join(GONEXT_DIR, "worker.env");
+  const text = await readFile(path, "utf8").catch(() => "");
+  const re = new RegExp(`^(GONEXT_API_BASE=https?://(?:127\\.0\\.0\\.1|localhost)):${from}\\b`, "m");
+  if (!re.test(text)) return false;
+  await writeFile(path, text.replace(re, `$1:${to}`));
+  return true;
+}
+
 /**
  * Start the API so it OUTLIVES this terminal — including an SSH session.
  *
@@ -271,8 +506,16 @@ export async function startLocalApi({
   port = LOCAL_API_PORT,
   mongoUri = localMongoUri(),
   dbName = LOCAL_DB_NAME,
+  log = (l) => console.log(l),
 } = {}) {
   await mkdir(GONEXT_DIR, { recursive: true });
+  // Every start goes through here — setup, `gu-cli api start|restart|upgrade`, doctor, the
+  // terminal's own restart — so this is where a port taken by another program is noticed.
+  // A caller that named a port keeps it.
+  if (port === LOCAL_API_PORT) {
+    const settled = await settleApiPort({ log });
+    port = settled.port;
+  }
   const res = await spawnSurviving({
     cmd: process.execPath,
     args: ["index.js"],
@@ -286,7 +529,7 @@ export async function startLocalApi({
   // we spawned. Recorded after the server is up, by the caller's waitForApi.
   const pid = res.pid ?? null;
   if (pid) await writeFile(API_PID_FILE, String(pid) + "\n").catch(() => {});
-  return { pid, how: res.how };
+  return { pid, how: res.how, port };
 }
 
 /** Record whoever is serving the port, so `api stop` has something to stop. */

package/client-expert-run.mjs

@@ -20,11 +20,13 @@ import { homedir } from "node:os";
 import { join } from "node:path";
 import { promisify } from "node:util";
 import { createHash } from "node:crypto";
+import { localModeNodeProblem } from "./node-version.mjs";
 import {
   apiDepsInstalled,
   installApiDeps,
   seedDatabase,
   startLocalApi,
+  settleApiPort,
   waitForApi,
   probeLocalApi,
   writeWorkerEnv,
@@ -515,7 +517,7 @@ export async function preflightLocalMongo({
   log("\n  " + red("gu: MongoDB is not answering") + dim(` at ${host}:${port}`) +
     red(mongo.installed || mongo.silentPort || !local ? "." : " — it is not installed on this machine."));
   log(dim("  Local mode keeps your conversations, models and keys in that database, so"));
-  log(dim("  nothing can start without it. The API on :4100 is fine — it is waiting on this."));
+  log(dim(`  nothing can start without it. The API on :${LOCAL_API_PORT} is fine — it is waiting on this.`));
   if (!local) {
     log(dim(`\n  That database is on another machine (${host}). Start it there, then run gu again.\n`));
     return { ok: false, fixed: false, installed: false };
@@ -925,6 +927,16 @@ export function markInterruptedOnExit(getState, stepId) {
   };
 }
 
+/** The last few non-empty lines of the API log, clipped to the screen — [] when there is none. */
+export async function apiLogTail(file, { lines = 3, width = 72 } = {}) {
+  try {
+    const all = (await readFile(file, "utf8")).split(/\r?\n/).map((l) => l.trim()).filter(Boolean);
+    return all.slice(-lines).map((l) => (l.length > width ? l.slice(0, width - 1) + "…" : l));
+  } catch {
+    return [];
+  }
+}
+
 export async function runClientExpertSetup({
   ask,
   // #301/#300: a MASKED line reader (API keys, the MongoDB password). Absent → no key is asked.
@@ -940,6 +952,15 @@ export async function runClientExpertSetup({
     return { complete: false, stoppedAt: "gate" };
   }
 
+  // BEFORE ANYTHING IS INSTALLED (task #333): the API needs a newer Node than gu does. Not part
+  // of the gate on purpose — a gate "no" makes the first run settle on Cloud mode for good,
+  // while the fix here is a Node upgrade, after which `gu` must resume Local setup.
+  const nodeProblem = localModeNodeProblem(process.version, machine.platform);
+  if (nodeProblem) {
+    console.log("\n  " + red("✗ ") + nodeProblem + "\n");
+    return { complete: false, stoppedAt: "node" };
+  }
+
   let state = await loadState();
   const mongo = await probeMongo();
   const probe = {
@@ -1165,13 +1186,27 @@ export async function runClientExpertSetup({
   // --- the API itself -------------------------------------------------------------------
   let health = await probeLocalApi(LOCAL_API_PORT);
   if (!health.ok) {
-    console.log("\n  " + bold(`Starting the local API on port ${LOCAL_API_PORT}`));
-    await startLocalApi({ apiDir, mongoUri });
-    health = await waitForApi({ port: LOCAL_API_PORT });
+    // THE PORT FIRST (task #337): 4100 may belong to another program on this machine. Settled
+    // before the "Starting…" line so that line names the port the API will really use —
+    // LOCAL_API_PORT and LOCAL_API_BASE are live and change with it.
+    console.log("");
+    const settled = await settleApiPort({ log: (l) => console.log(l) });
+    console.log("  " + bold(`Starting the local API on port ${LOCAL_API_PORT}`));
+    if (!settled.refused) {
+      await startLocalApi({ apiDir, mongoUri });
+      health = await waitForApi({ port: LOCAL_API_PORT });
+    }
   }
   if (!health.ok) {
     // apiIsUsable, not a 200: a wrong DATA_BACKEND answers 200 and stores nothing.
     console.log("\n  " + red("✗ ") + `The API started but is not usable: ${health.why}`);
+    // WHAT THE API SAID, not only where it said it (task #333): on Windows the whole log was
+    // one line, "Access is denied.", and the screen showed only a path to go and open.
+    const said = await apiLogTail(API_LOG_FILE);
+    if (said.length) {
+      console.log(dim("  The last thing its log says:"));
+      for (const l of said) console.log(dim("    " + l));
+    }
     console.log(dim(`  Its log is ${API_LOG_FILE}`));
     console.log(dim("  Run `gu` again to retry — nothing else has been changed.\n"));
     state = recordStep(state, "api-running", "failed", { reason: health.why });

package/client-expert-setup.mjs

@@ -834,12 +834,30 @@ export function validateLicenseVerdict({ licenseToken, expertAvailable }, result
  * validateLicenseToken by default; injectable for tests. Never throws — a validation that errors
  * is treated as unverifiable, not a crash.
  */
+/**
+ * What to say when a license token could not be CONFIRMED (#102) — it is still used: the licence
+ * is soft, and an outage never blocks a paid user. But "couldn't reach the license server" was
+ * printed when the server had been reached and answered HTTP 502; say which it was.
+ * `detail` is validateLicenseToken's: "http-NNN" | "timeout" | "network" | "bad-response" | …
+ */
+export function licenseUnverifiedLine(detail) {
+  const http = /^http-(\d{3})$/.exec(String(detail ?? ""));
+  if (http) return `The license server answered with an error (HTTP ${http[1]}), so the token was not confirmed — showing the menu anyway.`;
+  if (detail === "bad-response") return "The license server sent an unexpected answer, so the token was not confirmed — showing the menu anyway.";
+  return "Couldn't reach the license server to confirm the token — showing the menu anyway.";
+}
+
 export async function promptForLicenseToken(ask, initialToken, {
   validate = validateLicenseToken,
   validateOpts = {},
   warn = (msg) => console.log(msg),
   maxTries = 5,
+  // A MASKED reader (#100). A license token is a credential — whoever holds one can renew it —
+  // and the plain reader echoed it into the terminal and its scrollback (and into a test log).
+  // The first run and the REPL both have one; without it (a caller that has none) it is `ask`.
+  askSecret = null,
 } = {}) {
+  const read = typeof askSecret === "function" ? askSecret : ask;
   let token = String(initialToken ?? "").trim();
   for (let attempt = 0; attempt < maxTries; attempt += 1) {
     // Format gate first — a malformed token is warned about WITHOUT a network round-trip.
@@ -851,7 +869,9 @@ export async function promptForLicenseToken(ask, initialToken, {
       if (result.ok || result.reason === "unverified") return { token, result, declined: false };
       warn(`  That license token was not accepted (${result.detail ?? result.reason}).`);
     }
-    const again = String(await ask("  Paste a pro license token to choose a hosted mode, or press Enter to keep this machine private: ") ?? "").trim();
+    // Esc in the masked reader resolves with a symbol (SKIP_ALL): that is "no token", like Enter.
+    const typed = await read("  Paste a pro license token to choose a hosted mode, or press Enter to keep this machine private: ");
+    const again = typeof typed === "string" ? typed.trim() : "";
     if (!again) return { token: "", result: null, declined: true };
     token = again;
   }

package/first-run-steps.mjs

@@ -169,3 +169,29 @@ export function truncateDetail(detail, max = 160) {
   if (oneLine.length <= max) return oneLine;
   return "…" + oneLine.slice(oneLine.length - (max - 1));
 }
+
+/**
+ * Ctrl+C or Ctrl+D while a first-run question is waiting (task #333).
+ *
+ * `interrupt` (Ctrl+C): when setup has a step in progress it registered a SIGINT listener on the
+ * process (markInterruptedOnExit) that records where it stopped and exits — hand over to it.
+ * Otherwise say so and exit 130 here. `eof` (Ctrl+D): input is over; nothing more can be asked.
+ *
+ * Everything it touches is passed in, so the branches are tested without a terminal.
+ */
+export function stopFirstRun({ reason, hasProcessListener, emitSigint, log, exit, style = {} }) {
+  const yellow = style.yellow ?? ((t) => t);
+  const dim = style.dim ?? ((t) => t);
+  if (reason === "interrupt") {
+    if (hasProcessListener) {
+      emitSigint();
+      return;
+    }
+    log("\n\n  " + yellow("Stopped.") + dim(" Run `gu` again and setup continues from this step.\n"));
+    exit(130); // 128 + SIGINT
+    return;
+  }
+  log("\n\n  " + dim("input ended (Ctrl+D) — nothing further will be asked or started."));
+  log("  " + dim("Run `gu` again and setup continues from this step.\n"));
+  exit(0);
+}

package/gu-cli.mjs

@@ -134,6 +134,8 @@ Usage:
   gu-cli workspace revert [runId]          # undo an agent run's file edits from its backups
   gu-cli mongo migrate-from-docker         # macOS: move a Docker MongoDB to native (Homebrew)
   gu-cli clear [--scratch|--keep-history] [--yes]  # back to a fresh machine (asks first)
+  gu-cli fix-path                          # macOS/Linux: put npm's global bin folder on PATH
+                                               #   (what the install does, if npm skipped it)
   gu-cli fix-powershell [--check]          # Windows: drop PowerShell's built-in \`gu\` alias
                                                #   (it is Get-Unique and shadows this CLI)
   gu-cli rag plan [path]                   # is RAG worth it here? files/chars/chunks → estimated index time
@@ -1054,6 +1056,42 @@ if (args[0] === "token-usage" || args[0] === "tokens") {
   process.exit(0);
 }
 
+// `gu-cli fix-path` — put npm's global bin folder on PATH (task #333). The same repair the
+// postinstall does, for when npm did not run it: run through install-path.mjs itself, with the
+// prefix worked out from where this file is installed, so there is one implementation.
+if (args[0] === "fix-path") {
+  if (process.platform === "win32") {
+    console.log("  Nothing to fix here — on Windows npm's folder is on PATH through the registry.");
+    console.log("  If `gu` is not found in PowerShell: gu-cli fix-powershell");
+    process.exit(0);
+  }
+  const { globalPrefixOf } = await import("./install-path.mjs");
+  const { fileURLToPath } = await import("node:url");
+  const { dirname, join } = await import("node:path");
+  const here = dirname(fileURLToPath(import.meta.url));
+  const prefix = globalPrefixOf(here);
+  if (!prefix) {
+    console.log(`  This gu is not a global npm install (${here}) — there is no PATH to fix.`);
+    process.exit(0);
+  }
+  const binDir = join(prefix, "bin");
+  if ((process.env.PATH || "").split(":").includes(binDir)) {
+    console.log(`  Nothing to fix — ${binDir} is already on PATH.`);
+    process.exit(0);
+  }
+  const { spawnSync } = await import("node:child_process");
+  const { CI: _ci, ...env } = process.env;
+  const r = spawnSync(process.execPath, [join(here, "install-path.mjs")], {
+    encoding: "utf8",
+    env: { ...env, npm_config_prefix: prefix, npm_config_global: "true" },
+  });
+  const said = `${r.stdout ?? ""}${r.stderr ?? ""}`.trim();
+  // It prints only when it wrote something. Silence means the line is already in the profile
+  // and this terminal simply predates it.
+  console.log(said || `  Your shell profile already adds ${binDir} to PATH — open a new terminal.`);
+  process.exit(r.status ?? 0);
+}
+
 // `gu-cli fix-powershell` — drop PowerShell's built-in `gu` alias so the command works there.
 // ASKS FIRST and never runs as part of an install: a PowerShell profile is the user's file, and
 // a CLI that edits it unannounced is one that surprises people. --check only reports.