@indigoai-us/hq-cli 5.77.6 → 5.77.7

package/src/utils/version-gate.ts

@@ -29,7 +29,7 @@
  */
 
 import { spawnSync } from "node:child_process";
-import { readFileSync } from "node:fs";
+import { existsSync, readdirSync, readFileSync, rmSync } from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import chalk from "chalk";
@@ -104,6 +104,109 @@ export function buildPrefixedInstallArgv(prefix: string): string[] {
   return ["install", "-g", "--prefix", prefix, LATEST_PACKAGE_SPEC];
 }
 
+/**
+ * Filesystem surface used by {@link cleanStalePartialInstall}. Injected so the
+ * cleanup logic is unit-testable without touching a real global prefix.
+ */
+export interface StaleInstallFs {
+  readdirSync: (dir: string) => string[];
+  existsSync: (target: string) => boolean;
+  readFileSync: (target: string, encoding: "utf-8") => string;
+  rmSync: (target: string, options: { recursive: boolean; force: boolean }) => void;
+}
+
+const nodeStaleInstallFs: StaleInstallFs = {
+  readdirSync: (dir) => readdirSync(dir),
+  existsSync,
+  readFileSync: (target, encoding) => readFileSync(target, encoding),
+  rmSync,
+};
+
+function isHealthyPackageDir(pkgDir: string, fs: StaleInstallFs): boolean {
+  try {
+    const pkg = JSON.parse(
+      fs.readFileSync(path.join(pkgDir, "package.json"), "utf-8"),
+    ) as { name?: unknown };
+    return pkg.name === CLI_NAME;
+  } catch {
+    return false; // missing / unreadable / malformed package.json ⇒ partial
+  }
+}
+
+/**
+ * Remove leftover artifacts from an interrupted `npm install -g` so a retry can
+ * succeed. npm unpacks a package into a `.<pkg>-<rand>` staging dir alongside
+ * the final location and then renames it into place; if a previous run was
+ * killed mid-rename (or a half-written package dir survives), every subsequent
+ * install fails with `ENOTEMPTY` because npm cannot atomically rename over the
+ * non-empty leftover. npm does not self-heal this — the stale dir must be
+ * removed first.
+ *
+ * To stay safe we only ever delete:
+ *   - dot-prefixed npm staging dirs for THIS package (`.hq-cli-*`), and
+ *   - a package dir whose `package.json` is missing/unreadable or whose `name`
+ *     is not exactly {@link CLI_NAME} (i.e. a genuinely partial/foreign dir).
+ *
+ * A healthy install (valid `package.json`, `name === CLI_NAME`) is never
+ * touched, so an ordinary version bump still flows through npm untouched.
+ *
+ * Returns the list of removed paths — empty when there was nothing to clean, so
+ * callers can gate a reinstall retry on `removed.length > 0`.
+ */
+export function cleanStalePartialInstall(
+  prefix: string,
+  fs: StaleInstallFs = nodeStaleInstallFs,
+): string[] {
+  const removed: string[] = [];
+  const slash = CLI_NAME.indexOf("/");
+  const scope = slash === -1 ? null : CLI_NAME.slice(0, slash);
+  const leaf = slash === -1 ? CLI_NAME : CLI_NAME.slice(slash + 1);
+  const stagingPrefix = `.${leaf}-`;
+
+  // Global npm keeps packages under `<prefix>/lib/node_modules` (unix) while a
+  // bare `--prefix` dir (windows / some sandboxes) uses `<prefix>/node_modules`.
+  const nmRoots = [
+    path.join(prefix, "lib", "node_modules"),
+    path.join(prefix, "node_modules"),
+  ];
+
+  for (const nmRoot of nmRoots) {
+    // For a scoped package the staging dir + final dir both live inside the
+    // scope dir (`.../@indigoai-us/.hq-cli-<rand>`, `.../@indigoai-us/hq-cli`).
+    const parentDir = scope ? path.join(nmRoot, scope) : nmRoot;
+    let entries: string[];
+    try {
+      entries = fs.readdirSync(parentDir);
+    } catch {
+      continue; // this node_modules / scope dir doesn't exist here
+    }
+
+    for (const entry of entries) {
+      if (!entry.startsWith(stagingPrefix)) continue;
+      const target = path.join(parentDir, entry);
+      try {
+        fs.rmSync(target, { recursive: true, force: true });
+        removed.push(target);
+      } catch {
+        // best-effort: a dir we can't remove (perms) just means the retry
+        // still fails and we fall through to the sudo / manual path.
+      }
+    }
+
+    const pkgDir = path.join(parentDir, leaf);
+    if (fs.existsSync(pkgDir) && !isHealthyPackageDir(pkgDir, fs)) {
+      try {
+        fs.rmSync(pkgDir, { recursive: true, force: true });
+        removed.push(pkgDir);
+      } catch {
+        // best-effort (see above)
+      }
+    }
+  }
+
+  return removed;
+}
+
 /**
  * Hit POST /v1/client-version/check. Returns the parsed body on 200, or
  * `null` on any failure (caller treats as "no gate"). Tight 3s timeout —
@@ -213,6 +316,7 @@ function enforceUpdateRequired(
     performUpdateString?: (command: string) => UpdateResult;
     resolvePrefix?: () => string | null;
     runner?: UpdateRunner;
+    cleanStale?: (prefix: string) => string[];
   } = {},
 ): never {
   const banner = chalk.red.bold(
@@ -262,6 +366,27 @@ function enforceUpdateRequired(
           : performUpdate(command!, runner);
       })();
 
+  // A partial/corrupt global install leaves npm unable to atomically rename its
+  // freshly-unpacked package over a leftover directory, so the install above
+  // fails with ENOTEMPTY (e.g. a prior interrupted `npm install -g` left a
+  // half-written `hq-cli` package dir or a `.hq-cli-<rand>` staging dir under
+  // the prefix's node_modules). npm cannot self-heal this. Remove the stale
+  // artifacts and retry the install ONCE. Guarded on `cleaned.length > 0` so a
+  // plain EACCES on an otherwise-healthy prefix falls straight through to the
+  // sudo retry below without a redundant reinstall attempt.
+  if (!result.ok && prefix) {
+    const cleaner = deps.cleanStale ?? cleanStalePartialInstall;
+    const cleaned = cleaner(prefix);
+    if (cleaned.length > 0) {
+      console.error(
+        chalk.dim(
+          `  Removing stale partial install artifacts and retrying: ${cleaned.join(", ")}`,
+        ),
+      );
+      result = performUpdateCommand("npm", primaryArgs, runner);
+    }
+  }
+
   // A root-owned global install (e.g. a system `/usr` install where the CLI runs
   // unprivileged — the outpost agent boxes) can't rewrite the prefix's bin dir,
   // so the install above fails with EACCES (`rename /usr/bin/hq`). Retry ONCE
@@ -341,6 +466,7 @@ export const __test__ = {
   ENDPOINT_PATH,
   FETCH_TIMEOUT_MS,
   buildPrefixedInstallArgv,
+  cleanStalePartialInstall,
   enforceUpdateRequired,
   npmPrefixFromPackageDir,
   performUpdate,