@ree-auz/nook 0.1.0 → 0.1.1

package/src/compose.mjs

@@ -1,123 +1,123 @@
-import { homedir } from "node:os";
-import spawn from "cross-spawn";
-import { isInside } from "./home.mjs";
-
-/**
- * Docker Compose labels every container it starts with its project and the
- * folder it ran in (com.docker.compose.project.working_dir), and labels the
- * volumes, networks and built images of that project too. So nk can tell what
- * a workspace started without the repository writing a remove hook.
- */
-const PROJECT = "com.docker.compose.project";
-const WORKING_DIR = "com.docker.compose.project.working_dir";
-
-export function dockerCli(args) {
-  // Run from the home folder, so Docker never holds a workspace folder open while it is being deleted.
-  const result = spawn.sync("docker", args, { cwd: homedir(), encoding: "utf8", timeout: 60000, windowsHide: true });
-  if (result.error) return { ok: false, out: "", err: result.error.code === "ENOENT" ? "not installed" : result.error.message };
-  return { ok: result.status === 0, out: result.stdout ?? "", err: (result.stderr ?? "").trim() };
-}
-
-const rows = (text) => text.split(/\r?\n/).filter(Boolean);
-
-/**
- * Compose projects started inside `path`. A project that also has containers
- * started from another folder is reported in `shared` and never removed: it
- * may be the main checkout's (production) project under the same name.
- */
-export function findComposeProjects(path, docker = dockerCli) {
-  const listed = docker(["container", "ls", "-a", "--filter", `label=${WORKING_DIR}`, "--format", `{{.ID}}\t{{.Label "${PROJECT}"}}\t{{.Label "${WORKING_DIR}"}}`]);
-  if (!listed.ok) return { unavailable: listed.err || "docker is not running", projects: [], shared: [] };
-  const byProject = new Map();
-  for (const row of rows(listed.out)) {
-    const [id, project, dir] = row.split("\t");
-    if (!project) continue;
-    const entry = byProject.get(project) ?? { inside: [], outside: [] };
-    (dir && isInside(dir, path) ? entry.inside : entry.outside).push(id);
-    byProject.set(project, entry);
-  }
-  const projects = [];
-  const shared = [];
-  for (const [name, { inside, outside }] of byProject) {
-    if (!inside.length) continue;
-    if (outside.length) {
-      shared.push(name);
-      continue;
-    }
-    const label = `label=${PROJECT}=${name}`;
-    const ids = (kind) => {
-      const result = docker([kind, "ls", "-q", "--filter", label]);
-      return result.ok ? [...new Set(rows(result.out))] : [];
-    };
-    projects.push({ name, containers: inside, volumes: ids("volume"), networks: ids("network"), images: ids("image") });
-  }
-  return { projects, shared };
-}
-
-const count = (n, word) => `${n} ${word}${n === 1 ? "" : "s"}`;
-
-export function describeProject(project) {
-  const parts = [count(project.containers.length, "container")];
-  if (project.volumes.length) parts.push(count(project.volumes.length, "volume"));
-  if (project.networks.length) parts.push(count(project.networks.length, "network"));
-  if (project.images.length) parts.push(count(project.images.length, "built image"));
-  return `Compose project ${project.name}: ${parts.join(", ")}`;
-}
-
-/** Removes containers (with their anonymous volumes), then volumes, networks and built images. */
-export function removeComposeProject(project, docker = dockerCli) {
-  const steps = [
-    project.containers.length && ["container", "rm", "-f", "-v", ...project.containers],
-    project.volumes.length && ["volume", "rm", "-f", ...project.volumes],
-    project.networks.length && ["network", "rm", ...project.networks],
-    project.images.length && ["image", "rm", "-f", ...project.images],
-  ].filter(Boolean);
-  for (const args of steps) {
-    const result = docker(args);
-    if (!result.ok) throw new Error(`docker ${args.slice(0, 2).join(" ")} failed: ${result.err}`);
-  }
-}
-
-/** Compose projects started somewhere under `root` whose folder is not one of `live` any more. */
-export function leftoverComposeProjects(root, live, docker = dockerCli) {
-  const listed = docker(["container", "ls", "-a", "--filter", `label=${WORKING_DIR}`, "--format", `{{.Label "${PROJECT}"}}\t{{.Label "${WORKING_DIR}"}}`]);
-  if (!listed.ok) return [];
-  const found = new Map();
-  for (const row of rows(listed.out)) {
-    const [project, dir] = row.split("\t");
-    if (project && dir && isInside(dir, root) && !live.some((path) => isInside(dir, path))) found.set(project, dir);
-  }
-  return [...found].map(([name, dir]) => ({ name, dir }));
-}
-
-/**
- * Every container, volume and network, and every image Compose built: what
- * `nk hooks test` compares before and after the hooks. Null without Docker.
- */
-export function dockerSnapshot(docker = dockerCli) {
-  const list = (args) => {
-    const result = docker(args);
-    if (!result.ok) return null;
-    return rows(result.out).map((row) => {
-      const [id, name] = row.split("\t");
-      return { id, name: name || id };
-    });
-  };
-  const snapshot = {
-    container: list(["container", "ls", "-a", "--format", "{{.ID}}\t{{.Names}}"]),
-    volume: list(["volume", "ls", "--format", "{{.Name}}"]),
-    network: list(["network", "ls", "--format", "{{.ID}}\t{{.Name}}"]),
-    image: list(["image", "ls", "--filter", `label=${PROJECT}`, "--format", "{{.ID}}\t{{.Repository}}:{{.Tag}}"]),
-  };
-  return Object.values(snapshot).some((items) => items === null) ? null : snapshot;
-}
-
-/** What `after` has that `before` did not: [{ kind, id, name }]. */
-export function snapshotDiff(before, after) {
-  const added = [];
-  for (const kind of Object.keys(after)) {
-    const known = new Set(before[kind].map((item) => item.id));
-    for (const item of after[kind]) if (!known.has(item.id)) added.push({ kind, ...item });
-  }
-  return added;
-}
+import { homedir } from "node:os";
+import spawn from "cross-spawn";
+import { isInside } from "./home.mjs";
+
+/**
+ * Docker Compose labels every container it starts with its project and the
+ * folder it ran in (com.docker.compose.project.working_dir), and labels the
+ * volumes, networks and built images of that project too. So nk can tell what
+ * a workspace started without the repository writing a remove hook.
+ */
+const PROJECT = "com.docker.compose.project";
+const WORKING_DIR = "com.docker.compose.project.working_dir";
+
+export function dockerCli(args) {
+  // Run from the home folder, so Docker never holds a workspace folder open while it is being deleted.
+  const result = spawn.sync("docker", args, { cwd: homedir(), encoding: "utf8", timeout: 60000, windowsHide: true });
+  if (result.error) return { ok: false, out: "", err: result.error.code === "ENOENT" ? "not installed" : result.error.message };
+  return { ok: result.status === 0, out: result.stdout ?? "", err: (result.stderr ?? "").trim() };
+}
+
+const rows = (text) => text.split(/\r?\n/).filter(Boolean);
+
+/**
+ * Compose projects started inside `path`. A project that also has containers
+ * started from another folder is reported in `shared` and never removed: it
+ * may be the main checkout's (production) project under the same name.
+ */
+export function findComposeProjects(path, docker = dockerCli) {
+  const listed = docker(["container", "ls", "-a", "--filter", `label=${WORKING_DIR}`, "--format", `{{.ID}}\t{{.Label "${PROJECT}"}}\t{{.Label "${WORKING_DIR}"}}`]);
+  if (!listed.ok) return { unavailable: listed.err || "docker is not running", projects: [], shared: [] };
+  const byProject = new Map();
+  for (const row of rows(listed.out)) {
+    const [id, project, dir] = row.split("\t");
+    if (!project) continue;
+    const entry = byProject.get(project) ?? { inside: [], outside: [] };
+    (dir && isInside(dir, path) ? entry.inside : entry.outside).push(id);
+    byProject.set(project, entry);
+  }
+  const projects = [];
+  const shared = [];
+  for (const [name, { inside, outside }] of byProject) {
+    if (!inside.length) continue;
+    if (outside.length) {
+      shared.push(name);
+      continue;
+    }
+    const label = `label=${PROJECT}=${name}`;
+    const ids = (kind) => {
+      const result = docker([kind, "ls", "-q", "--filter", label]);
+      return result.ok ? [...new Set(rows(result.out))] : [];
+    };
+    projects.push({ name, containers: inside, volumes: ids("volume"), networks: ids("network"), images: ids("image") });
+  }
+  return { projects, shared };
+}
+
+const count = (n, word) => `${n} ${word}${n === 1 ? "" : "s"}`;
+
+export function describeProject(project) {
+  const parts = [count(project.containers.length, "container")];
+  if (project.volumes.length) parts.push(count(project.volumes.length, "volume"));
+  if (project.networks.length) parts.push(count(project.networks.length, "network"));
+  if (project.images.length) parts.push(count(project.images.length, "built image"));
+  return `Compose project ${project.name}: ${parts.join(", ")}`;
+}
+
+/** Removes containers (with their anonymous volumes), then volumes, networks and built images. */
+export function removeComposeProject(project, docker = dockerCli) {
+  const steps = [
+    project.containers.length && ["container", "rm", "-f", "-v", ...project.containers],
+    project.volumes.length && ["volume", "rm", "-f", ...project.volumes],
+    project.networks.length && ["network", "rm", ...project.networks],
+    project.images.length && ["image", "rm", "-f", ...project.images],
+  ].filter(Boolean);
+  for (const args of steps) {
+    const result = docker(args);
+    if (!result.ok) throw new Error(`docker ${args.slice(0, 2).join(" ")} failed: ${result.err}`);
+  }
+}
+
+/** Compose projects started somewhere under `root` whose folder is not one of `live` any more. */
+export function leftoverComposeProjects(root, live, docker = dockerCli) {
+  const listed = docker(["container", "ls", "-a", "--filter", `label=${WORKING_DIR}`, "--format", `{{.Label "${PROJECT}"}}\t{{.Label "${WORKING_DIR}"}}`]);
+  if (!listed.ok) return [];
+  const found = new Map();
+  for (const row of rows(listed.out)) {
+    const [project, dir] = row.split("\t");
+    if (project && dir && isInside(dir, root) && !live.some((path) => isInside(dir, path))) found.set(project, dir);
+  }
+  return [...found].map(([name, dir]) => ({ name, dir }));
+}
+
+/**
+ * Every container, volume and network, and every image Compose built: what
+ * `nk hooks test` compares before and after the hooks. Null without Docker.
+ */
+export function dockerSnapshot(docker = dockerCli) {
+  const list = (args) => {
+    const result = docker(args);
+    if (!result.ok) return null;
+    return rows(result.out).map((row) => {
+      const [id, name] = row.split("\t");
+      return { id, name: name || id };
+    });
+  };
+  const snapshot = {
+    container: list(["container", "ls", "-a", "--format", "{{.ID}}\t{{.Names}}"]),
+    volume: list(["volume", "ls", "--format", "{{.Name}}"]),
+    network: list(["network", "ls", "--format", "{{.ID}}\t{{.Name}}"]),
+    image: list(["image", "ls", "--filter", `label=${PROJECT}`, "--format", "{{.ID}}\t{{.Repository}}:{{.Tag}}"]),
+  };
+  return Object.values(snapshot).some((items) => items === null) ? null : snapshot;
+}
+
+/** What `after` has that `before` did not: [{ kind, id, name }]. */
+export function snapshotDiff(before, after) {
+  const added = [];
+  for (const kind of Object.keys(after)) {
+    const known = new Set(before[kind].map((item) => item.id));
+    for (const item of after[kind]) if (!known.has(item.id)) added.push({ kind, ...item });
+  }
+  return added;
+}

package/src/config.mjs

@@ -1,115 +1,115 @@
-import { mkdirSync, readFileSync, renameSync, rmSync, statSync, writeFileSync } from "node:fs";
-import { dirname } from "node:path";
-import { parse, stringify } from "smol-toml";
-import { NookError } from "./errors.mjs";
-
-export function emptyConfig() {
-  return { agents: {}, repos: {} };
-}
-
-export function loadConfig(file) {
-  let text;
-  try {
-    text = readFileSync(file, "utf8");
-  } catch (error) {
-    if (error.code === "ENOENT") return emptyConfig();
-    throw error;
-  }
-  let data;
-  try {
-    data = parse(text);
-  } catch (error) {
-    throw new NookError(`Cannot read ${file}: ${error.message}`);
-  }
-  data.agents ??= {};
-  data.repos ??= {};
-  for (const repo of Object.values(data.repos)) {
-    repo.workspaces ??= {};
-    repo.hooks ??= {};
-  }
-  return data;
-}
-
-export function saveConfig(file, config) {
-  mkdirSync(dirname(file), { recursive: true });
-  const temp = `${file}.${process.pid}.tmp`;
-  writeFileSync(temp, stringify(config) + "\n");
-  renameSync(temp, file);
-}
-
-// Several nk may run at once (an agent per Linear issue): config.toml changes under a lock, so no
-// two get the same ports and none writes over what another just recorded.
-const STALE_MS = 30_000;
-const WAIT_MS = 15_000;
-
-function tryLock(lock) {
-  try {
-    mkdirSync(lock);
-    return true;
-  } catch (error) {
-    if (error.code !== "EEXIST") throw error;
-    try {
-      // A lock left by an nk that was killed: no update takes this long.
-      if (Date.now() - statSync(lock).mtimeMs > STALE_MS) rmSync(lock, { recursive: true, force: true });
-    } catch {}
-    return false;
-  }
-}
-
-const busy = (lock) => new NookError(`Another nk is updating its config and did not finish. If no nk is running, delete ${lock}`);
-
-/** Runs fn while holding the lock on `file`. */
-export function withLockSync(file, fn) {
-  const lock = `${file}.lock`;
-  mkdirSync(dirname(file), { recursive: true });
-  const until = Date.now() + WAIT_MS;
-  while (!tryLock(lock)) {
-    if (Date.now() > until) throw busy(lock);
-    Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 50);
-  }
-  try {
-    return fn();
-  } finally {
-    rmSync(lock, { recursive: true, force: true });
-  }
-}
-
-/** Async form, for updates that wait on something (checking that ports are free). */
-export async function withLock(file, fn) {
-  const lock = `${file}.lock`;
-  mkdirSync(dirname(file), { recursive: true });
-  const until = Date.now() + WAIT_MS;
-  while (!tryLock(lock)) {
-    if (Date.now() > until) throw busy(lock);
-    await new Promise((done) => setTimeout(done, 50));
-  }
-  try {
-    return await fn();
-  } finally {
-    rmSync(lock, { recursive: true, force: true });
-  }
-}
-
-const isObject = (value) => value !== null && typeof value === "object" && !Array.isArray(value);
-const same = (a, b) => JSON.stringify(a) === JSON.stringify(b);
-
-/** Applies to `target` what changed from `base` to `current`: keys added, removed or changed, at any depth. */
-export function applyChanges(base, current, target) {
-  for (const key of new Set([...Object.keys(base), ...Object.keys(current)])) {
-    if (!(key in current)) delete target[key];
-    else if (!(key in base)) target[key] = structuredClone(current[key]);
-    else if (isObject(base[key]) && isObject(current[key]) && isObject(target[key])) applyChanges(base[key], current[key], target[key]);
-    else if (!same(base[key], current[key])) target[key] = structuredClone(current[key]);
-  }
-  return target;
-}
-
-/** Makes `target` equal to `source`, keeping the objects `target` already has, so references to them stay live. */
-export function syncInPlace(target, source) {
-  for (const key of Object.keys(target)) if (!(key in source)) delete target[key];
-  for (const [key, value] of Object.entries(source)) {
-    if (isObject(target[key]) && isObject(value)) syncInPlace(target[key], value);
-    else target[key] = structuredClone(value);
-  }
-  return target;
-}
+import { mkdirSync, readFileSync, renameSync, rmSync, statSync, writeFileSync } from "node:fs";
+import { dirname } from "node:path";
+import { parse, stringify } from "smol-toml";
+import { NookError } from "./errors.mjs";
+
+export function emptyConfig() {
+  return { agents: {}, repos: {} };
+}
+
+export function loadConfig(file) {
+  let text;
+  try {
+    text = readFileSync(file, "utf8");
+  } catch (error) {
+    if (error.code === "ENOENT") return emptyConfig();
+    throw error;
+  }
+  let data;
+  try {
+    data = parse(text);
+  } catch (error) {
+    throw new NookError(`Cannot read ${file}: ${error.message}`);
+  }
+  data.agents ??= {};
+  data.repos ??= {};
+  for (const repo of Object.values(data.repos)) {
+    repo.workspaces ??= {};
+    repo.hooks ??= {};
+  }
+  return data;
+}
+
+export function saveConfig(file, config) {
+  mkdirSync(dirname(file), { recursive: true });
+  const temp = `${file}.${process.pid}.tmp`;
+  writeFileSync(temp, stringify(config) + "\n");
+  renameSync(temp, file);
+}
+
+// Several nk may run at once (an agent per Linear issue): config.toml changes under a lock, so no
+// two get the same ports and none writes over what another just recorded.
+const STALE_MS = 30_000;
+const WAIT_MS = 15_000;
+
+function tryLock(lock) {
+  try {
+    mkdirSync(lock);
+    return true;
+  } catch (error) {
+    if (error.code !== "EEXIST") throw error;
+    try {
+      // A lock left by an nk that was killed: no update takes this long.
+      if (Date.now() - statSync(lock).mtimeMs > STALE_MS) rmSync(lock, { recursive: true, force: true });
+    } catch {}
+    return false;
+  }
+}
+
+const busy = (lock) => new NookError(`Another nk is updating its config and did not finish. If no nk is running, delete ${lock}`);
+
+/** Runs fn while holding the lock on `file`. */
+export function withLockSync(file, fn) {
+  const lock = `${file}.lock`;
+  mkdirSync(dirname(file), { recursive: true });
+  const until = Date.now() + WAIT_MS;
+  while (!tryLock(lock)) {
+    if (Date.now() > until) throw busy(lock);
+    Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 50);
+  }
+  try {
+    return fn();
+  } finally {
+    rmSync(lock, { recursive: true, force: true });
+  }
+}
+
+/** Async form, for updates that wait on something (checking that ports are free). */
+export async function withLock(file, fn) {
+  const lock = `${file}.lock`;
+  mkdirSync(dirname(file), { recursive: true });
+  const until = Date.now() + WAIT_MS;
+  while (!tryLock(lock)) {
+    if (Date.now() > until) throw busy(lock);
+    await new Promise((done) => setTimeout(done, 50));
+  }
+  try {
+    return await fn();
+  } finally {
+    rmSync(lock, { recursive: true, force: true });
+  }
+}
+
+const isObject = (value) => value !== null && typeof value === "object" && !Array.isArray(value);
+const same = (a, b) => JSON.stringify(a) === JSON.stringify(b);
+
+/** Applies to `target` what changed from `base` to `current`: keys added, removed or changed, at any depth. */
+export function applyChanges(base, current, target) {
+  for (const key of new Set([...Object.keys(base), ...Object.keys(current)])) {
+    if (!(key in current)) delete target[key];
+    else if (!(key in base)) target[key] = structuredClone(current[key]);
+    else if (isObject(base[key]) && isObject(current[key]) && isObject(target[key])) applyChanges(base[key], current[key], target[key]);
+    else if (!same(base[key], current[key])) target[key] = structuredClone(current[key]);
+  }
+  return target;
+}
+
+/** Makes `target` equal to `source`, keeping the objects `target` already has, so references to them stay live. */
+export function syncInPlace(target, source) {
+  for (const key of Object.keys(target)) if (!(key in source)) delete target[key];
+  for (const [key, value] of Object.entries(source)) {
+    if (isObject(target[key]) && isObject(value)) syncInPlace(target[key], value);
+    else target[key] = structuredClone(value);
+  }
+  return target;
+}