@query-farm/vgi-rpc 0.6.4 → 0.7.0

package/src/launcher/serve-unix.ts

@@ -0,0 +1,385 @@
+// © Copyright 2025-2026, Query.Farm LLC - https://query.farm
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * AF_UNIX worker runner for vgi-rpc TypeScript.
+ *
+ * Bind a deterministic Unix-domain socket, accept connections one at a
+ * time (sequential listen, matching Python's `serve_unix`), and dispatch
+ * each via the existing {@link VgiRpcServer.serveOne} loop.  Implements
+ * the cross-language launcher contract:
+ *
+ * - Accept `--unix PATH` and `--idle-timeout SEC` (parsed by callers).
+ * - Emit `UNIX:<absolute-path>\n` to stdout once bind+listen succeed.
+ * - Self-terminate after `idleTimeout` seconds with zero connected
+ *   clients; the timer starts ticking only after a `startupGrace`
+ *   window so a slow first caller doesn't see the server vanish.
+ */
+
+import { existsSync, unlinkSync } from "node:fs";
+import { createServer, type Server, type Socket } from "node:net";
+import * as path from "node:path";
+import { schema as makeSchema, serializeBatch } from "../arrow/index.js";
+import { DESCRIBE_METHOD_NAME } from "../constants.js";
+import { buildDescribeBatch } from "../dispatch/describe.js";
+import { dispatchStream } from "../dispatch/stream.js";
+import { dispatchUnary } from "../dispatch/unary.js";
+import { RpcError, VersionError } from "../errors.js";
+import type { ExternalLocationConfig } from "../external.js";
+import type { Protocol } from "../protocol.js";
+import {
+  type CallStatistics,
+  type DispatchHook,
+  type DispatchInfo,
+  MethodType,
+  type ServeStartHook,
+  TransportKind,
+} from "../types.js";
+import { IpcStreamReader } from "../wire/reader.js";
+import { applyDefaults, parseRequest } from "../wire/request.js";
+import { buildErrorBatch } from "../wire/response.js";
+import { IpcStreamWriter } from "../wire/writer.js";
+
+const EMPTY_SCHEMA = makeSchema([]);
+
+/** Configuration for {@link serveUnix}. */
+export interface ServeUnixOptions {
+  /** Absolute path to the Unix socket file the worker should bind. */
+  unixPath: string;
+  /** Self-terminate after this many seconds with zero connected clients.
+   *  Default: 300.  `0` disables the timer (server runs until killed). */
+  idleTimeout?: number;
+  /** Grace period after `listen()` succeeds before the idle timer starts
+   *  ticking.  Default: 5 — gives the first launcher caller a chance to
+   *  connect after the `UNIX:<path>` announcement. */
+  startupGraceSeconds?: number;
+  /** Optional logical-service / protocol-contract version label. */
+  protocolVersion?: string;
+  /** Custom server identifier. */
+  serverId?: string;
+  /** Enable __describe__ method. Default: true. */
+  enableDescribe?: boolean;
+  /** Optional dispatch hook for observability. */
+  dispatchHook?: DispatchHook;
+  /** Optional external-storage config for large-batch externalisation. */
+  externalLocation?: ExternalLocationConfig;
+  /** Lifecycle hook fired once before the first dispatched request. */
+  onServeStart?: ServeStartHook;
+  /** Maximum sequential listen backlog. Mirrors Python's `serve_unix`
+   *  (`backlog=16`).  Default: 16. */
+  backlog?: number;
+  /** Called *after* `listen()` returns successfully but *before*
+   *  `UNIX:<path>` is printed.  The launcher uses this hook to write the
+   *  announcement only after we're sure the bind took. */
+  onBound?: (sockPath: string) => void;
+  /** Override the stream used for the `UNIX:<path>` line.  Defaults to
+   *  `process.stdout`. */
+  announcementSink?: NodeJS.WritableStream;
+}
+
+/** Handle returned by {@link serveUnix} for callers that want to stop the server. */
+export interface ServeUnixHandle {
+  readonly socketPath: string;
+  /** Shut down the listener and unlink the socket file. */
+  stop(): Promise<void>;
+  /** Promise that resolves when the server has stopped (idle timeout, stop(),
+   *  or a fatal error).  Mirrors Python's blocking `serve()` return. */
+  readonly done: Promise<void>;
+}
+
+/**
+ * Bind an AF_UNIX socket and serve `protocol` over per-connection IPC streams.
+ *
+ * Sequential listen — one client at a time, just like Python's `serve_unix`.
+ * Each connection gets its own dispatch loop and shares the protocol.
+ */
+export async function serveUnix(protocol: Protocol, options: ServeUnixOptions): Promise<ServeUnixHandle> {
+  const sockPath = path.resolve(options.unixPath);
+  const idleTimeoutS = options.idleTimeout ?? 300;
+  const startupGraceS = options.startupGraceSeconds ?? 5;
+  const protocolVersion = options.protocolVersion ?? "";
+  const serverId = options.serverId ?? crypto.randomUUID().replace(/-/g, "").slice(0, 12);
+  const enableDescribe = options.enableDescribe ?? true;
+  const dispatchHook = options.dispatchHook ?? null;
+  const externalConfig = options.externalLocation;
+  const onServeStart = options.onServeStart ?? null;
+  const backlog = options.backlog ?? 16;
+  const announcementSink = options.announcementSink ?? process.stdout;
+
+  // Defensive probe-then-bind: an existing live worker on this path means a
+  // peer launcher already won the race.  Refuse to bind so we don't take
+  // its connections.  (A stale path with no listener was unlinked by the
+  // launcher before spawning us, but a leftover from a co-launcher right
+  // now is possible.)
+  if (existsSync(sockPath)) {
+    try {
+      // Best-effort cleanup; bind below will surface any real conflict.
+      unlinkSync(sockPath);
+    } catch {
+      // ignore — let listen() fail with EADDRINUSE.
+    }
+  }
+
+  // Cache for __describe__ — Web-Crypto digest is async, so memoise.
+  let describePromise: Promise<{ batch: import("../arrow/index.js").VgiBatch; protocolHash: string }> | null = null;
+  function describeInfo(): Promise<{ batch: import("../arrow/index.js").VgiBatch; protocolHash: string }> {
+    if (!describePromise) {
+      describePromise = buildDescribeBatch(protocol.name, protocol.getMethods(), serverId).then(
+        ({ batch, metadata }) => ({
+          batch,
+          protocolHash: metadata.get("vgi_rpc.protocol_hash") ?? "",
+        }),
+      );
+    }
+    return describePromise;
+  }
+
+  // Lifecycle: only commit `serveStartFired` after the hook returns successfully.
+  let serveStartFired = false;
+  async function notifyTransport(): Promise<void> {
+    if (serveStartFired) return;
+    if (onServeStart) {
+      await onServeStart(TransportKind.UNIX);
+    }
+    serveStartFired = true;
+  }
+
+  const server: Server = createServer({ allowHalfOpen: false });
+
+  let activeConnections = 0;
+  let idleTimer: ReturnType<typeof setTimeout> | null = null;
+  let resolveDone: () => void = () => {};
+  let rejectDone: (err: unknown) => void = () => {};
+  const done = new Promise<void>((resolve, reject) => {
+    resolveDone = resolve;
+    rejectDone = reject;
+  });
+  let stopped = false;
+
+  function armIdleTimer(): void {
+    if (idleTimeoutS <= 0) return;
+    if (idleTimer) clearTimeout(idleTimer);
+    idleTimer = setTimeout(() => {
+      if (activeConnections === 0 && !stopped) {
+        void shutdown();
+      }
+    }, idleTimeoutS * 1000);
+  }
+
+  function disarmIdleTimer(): void {
+    if (idleTimer) {
+      clearTimeout(idleTimer);
+      idleTimer = null;
+    }
+  }
+
+  async function shutdown(): Promise<void> {
+    if (stopped) return;
+    stopped = true;
+    disarmIdleTimer();
+    await new Promise<void>((resolve) => {
+      server.close(() => resolve());
+    });
+    try {
+      unlinkSync(sockPath);
+    } catch {
+      // already gone
+    }
+    resolveDone();
+  }
+
+  server.on("connection", (socket) => {
+    activeConnections += 1;
+    disarmIdleTimer();
+    handleConnection(socket)
+      .catch((err) => {
+        // Per-connection errors must not take down the server — log to stderr
+        // and let the next connection proceed.
+        process.stderr.write(`vgi-rpc/unix: connection failed: ${(err as Error)?.message ?? err}\n`);
+      })
+      .finally(() => {
+        activeConnections -= 1;
+        socket.destroy();
+        if (activeConnections === 0 && !stopped) {
+          armIdleTimer();
+        }
+      });
+  });
+
+  server.on("error", (err) => {
+    if (stopped) return;
+    rejectDone(err);
+  });
+
+  async function handleConnection(socket: Socket): Promise<void> {
+    // The reader takes any Node Readable; sockets are duplex Readables.
+    const reader = await IpcStreamReader.create(socket);
+    // Build the writer over the Socket itself, not its raw fd. AF_UNIX
+    // sockets in Node are non-blocking; a fd-based writer would do
+    // `fs.writeSync` and busy-wait on EAGAIN whenever the ~8 KB kernel send
+    // buffer fills (trivial for any Arrow batch of meaningful size). That
+    // synchronous wait freezes the shared event loop and starves every
+    // *other* connection's handler — observed as 30 s `catalog_attach`
+    // timeouts from co-running unittest processes. Going through
+    // `socket.write` + `'drain'` lets the JS thread yield while the kernel
+    // drains the buffer.
+    const writer = new IpcStreamWriter(socket);
+
+    try {
+      // Fire on_serve_start lazily — first request retries on hook failure.
+      await notifyTransport();
+
+      while (true) {
+        try {
+          await serveOnce(reader, writer);
+        } catch (e: unknown) {
+          const err = e as { code?: string; message?: string };
+          // EOF/closed client → end this connection cleanly.
+          if (
+            err?.message?.includes("closed") ||
+            err?.message?.includes("Expected Schema Message") ||
+            err?.message?.includes("null or length 0") ||
+            err?.message?.includes("EOF") ||
+            err?.code === "EPIPE" ||
+            err?.code === "ERR_STREAM_PREMATURE_CLOSE" ||
+            err?.code === "ERR_STREAM_DESTROYED"
+          ) {
+            return;
+          }
+          throw e;
+        }
+      }
+    } finally {
+      try {
+        await reader.cancel();
+      } catch {
+        // already closed
+      }
+    }
+  }
+
+  async function serveOnce(reader: IpcStreamReader, writer: IpcStreamWriter): Promise<void> {
+    const stream = await reader.readStream();
+    if (!stream) {
+      throw new Error("EOF");
+    }
+    const { schema, batches } = stream;
+    if (batches.length === 0) {
+      const err = new RpcError("ProtocolError", "Request stream contains no batches", "");
+      const errBatch = buildErrorBatch(EMPTY_SCHEMA, err, serverId, null);
+      await writer.writeStream(EMPTY_SCHEMA, [errBatch]);
+      return;
+    }
+    const batch = batches[0];
+    let methodName: string;
+    let params: Record<string, unknown>;
+    let requestId: string | null;
+    try {
+      const parsed = parseRequest(schema, batch);
+      methodName = parsed.methodName;
+      params = parsed.params;
+      requestId = parsed.requestId;
+    } catch (e: unknown) {
+      const errBatch = buildErrorBatch(EMPTY_SCHEMA, e as Error, serverId, null);
+      await writer.writeStream(EMPTY_SCHEMA, [errBatch]);
+      if (e instanceof VersionError || e instanceof RpcError) return;
+      throw e;
+    }
+
+    if (methodName === DESCRIBE_METHOD_NAME && enableDescribe) {
+      const { batch: descBatch } = await describeInfo();
+      await writer.writeStream(descBatch.schema, [descBatch]);
+      return;
+    }
+
+    const methods = protocol.getMethods();
+    const method = methods.get(methodName);
+    if (!method) {
+      const available = [...methods.keys()].sort();
+      const err = new Error(`Unknown method: '${methodName}'. Available methods: [${available.join(", ")}]`);
+      const errBatch = buildErrorBatch(EMPTY_SCHEMA, err, serverId, requestId);
+      await writer.writeStream(EMPTY_SCHEMA, [errBatch]);
+      return;
+    }
+
+    const methodType = method.type === MethodType.UNARY ? "unary" : "stream";
+    let requestData: Uint8Array | undefined;
+    try {
+      requestData = serializeBatch(batch);
+    } catch {
+      // best-effort
+    }
+    const { protocolHash } = await describeInfo();
+    const info: DispatchInfo = {
+      method: methodName,
+      methodType,
+      serverId,
+      requestId,
+      protocol: protocol.name,
+      protocolHash,
+      protocolVersion,
+      kind: TransportKind.UNIX,
+      principal: "",
+      authDomain: "",
+      authenticated: false,
+      remoteAddr: "",
+      requestData,
+    };
+    const stats: CallStatistics = {
+      inputBatches: 0,
+      outputBatches: 0,
+      inputRows: 0,
+      outputRows: 0,
+      inputBytes: 0,
+      outputBytes: 0,
+    };
+
+    const token = dispatchHook?.onDispatchStart(info);
+    let dispatchError: Error | undefined;
+    applyDefaults(params, method.defaults);
+    try {
+      if (method.type === MethodType.UNARY) {
+        await dispatchUnary(method, params, writer, serverId, requestId, externalConfig, TransportKind.UNIX);
+      } else {
+        await dispatchStream(method, params, writer, reader, serverId, requestId, externalConfig, TransportKind.UNIX);
+      }
+    } catch (e) {
+      dispatchError = e instanceof Error ? e : new Error(String(e));
+      throw e;
+    } finally {
+      dispatchHook?.onDispatchEnd(token, info, stats, dispatchError);
+    }
+  }
+
+  // bind + listen
+  await new Promise<void>((resolve, reject) => {
+    server.listen({ path: sockPath, backlog }, () => resolve());
+    server.once("error", (err) => reject(err));
+  });
+
+  // Set a tight mode on the bound socket so peers from other UIDs can't
+  // even initiate a connection.
+  try {
+    const { chmodSync } = await import("node:fs");
+    chmodSync(sockPath, 0o600);
+  } catch {
+    // best-effort — operator-managed dirs may already be 0700
+  }
+
+  options.onBound?.(sockPath);
+  // Cross-language launcher contract: announce on stdout.
+  announcementSink.write(`UNIX:${sockPath}\n`);
+
+  // Start the idle timer with a startup grace window.
+  if (idleTimeoutS > 0) {
+    setTimeout(() => {
+      if (activeConnections === 0 && !stopped) armIdleTimer();
+    }, startupGraceS * 1000).unref?.();
+  }
+
+  return {
+    socketPath: sockPath,
+    stop: shutdown,
+    done,
+  };
+}

package/src/launcher/state.ts

@@ -0,0 +1,245 @@
+// © Copyright 2025-2026, Query.Farm LLC - https://query.farm
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * State directory + lock/sock/meta path layout for the AF_UNIX worker
+ * launcher.  Mirrors `vgi_rpc.launcher` so cross-language tooling
+ * resolves to identical filesystem locations.
+ */
+
+import { existsSync, mkdirSync, readFileSync, statSync, unlinkSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import * as path from "node:path";
+
+import { computeHash } from "./hash.js";
+
+/** Filesystem layout for one worker tuple: `<state_dir>/<hash>.{lock,sock,meta}`. */
+export interface SocketPaths {
+  lockPath: string;
+  sockPath: string;
+  metaPath: string;
+}
+
+export function socketPaths(stateDir: string, hashId: string): SocketPaths {
+  return {
+    lockPath: path.join(stateDir, `${hashId}.lock`),
+    sockPath: path.join(stateDir, `${hashId}.sock`),
+    metaPath: path.join(stateDir, `${hashId}.meta`),
+  };
+}
+
+/**
+ * Resolve the per-user state directory used for lockfiles + sockets.
+ *
+ * - Linux: `$XDG_RUNTIME_DIR/vgi-rpc/` when set (systemd-managed,
+ *   auto-cleaned on logout); otherwise `$TMPDIR/vgi-rpc-$UID/`.
+ * - macOS / BSD: `$TMPDIR/vgi-rpc-$UID/`.
+ * - Windows: `$TMP/vgi-rpc/`.
+ *
+ * The directory is created mode 0700 if missing.  On POSIX, we refuse to
+ * operate on a directory not owned by the current user — defends against
+ * a hijacked `/tmp/vgi-rpc-$UID` left by an attacker.
+ */
+export function defaultStateDir(): string {
+  let base: string;
+  if (process.platform === "win32") {
+    base = path.join(tmpdir(), "vgi-rpc");
+  } else {
+    const xdg = process.env.XDG_RUNTIME_DIR;
+    if (xdg) {
+      base = path.join(xdg, "vgi-rpc");
+    } else {
+      const uid = typeof process.geteuid === "function" ? process.geteuid() : 0;
+      base = path.join(tmpdir(), `vgi-rpc-${uid}`);
+    }
+  }
+  mkdirSync(base, { recursive: true, mode: 0o700 });
+  if (process.platform !== "win32" && typeof process.geteuid === "function") {
+    // Tighten mode every call (cheap + idempotent) and refuse a hijacked dir.
+    try {
+      // chmodSync is in node:fs; using statSync is enough to read the owner.
+      const st = statSync(base);
+      if (st.uid !== process.geteuid()) {
+        throw new Error(`state directory ${base} is not owned by current user`);
+      }
+    } catch (err) {
+      if ((err as { code?: string })?.code === "ENOENT") {
+        // Race with the mkdirSync above — leave it to the next caller.
+      } else {
+        throw err;
+      }
+    }
+  }
+  return base;
+}
+
+// ---------------------------------------------------------------------------
+// Meta file
+// ---------------------------------------------------------------------------
+
+/** Best-effort write of human-readable launch metadata.  Used by `--status`. */
+export function writeMeta(metaPath: string, workerArgv: readonly string[], cwd: string, sockPath: string): void {
+  const payload = {
+    cmd: [...workerArgv],
+    cwd,
+    socket: sockPath,
+    started_at: Date.now() / 1000,
+    launcher_pid: process.pid,
+  };
+  try {
+    writeFileSync(metaPath, JSON.stringify(payload, null, 2), { encoding: "utf8", mode: 0o600 });
+  } catch {
+    // observability is best-effort
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Status / GC
+// ---------------------------------------------------------------------------
+
+export interface StatusRow {
+  hashId: string;
+  cmd: string[];
+  cwd: string;
+  socket: string;
+  startedAt: number | null;
+  alive: boolean;
+}
+
+export interface GcResult {
+  /** Hash IDs of stale entries that were removed. */
+  cleaned: string[];
+  /** Hash IDs whose lockfile is currently held (a launch is in flight or the
+   *  worker is alive). */
+  skippedInUse: string[];
+}
+
+/** Probe whether anyone is currently accepting on `sockPath`. */
+export async function probeSocket(sockPath: string, timeoutMs = 2000): Promise<boolean> {
+  if (!existsSync(sockPath)) return false;
+  // Lazy require so workerd / browser bundles that never call probeSocket
+  // don't trip on `node:net`.
+  const net = await import("node:net");
+  return new Promise<boolean>((resolve) => {
+    const sock = net.createConnection({ path: sockPath });
+    const timer = setTimeout(() => {
+      sock.destroy();
+      resolve(false);
+    }, timeoutMs);
+    sock.once("connect", () => {
+      clearTimeout(timer);
+      sock.end();
+      resolve(true);
+    });
+    sock.once("error", () => {
+      clearTimeout(timer);
+      resolve(false);
+    });
+  });
+}
+
+function tryReadMeta(metaPath: string): { cmd: string[]; cwd: string; startedAt: number | null } {
+  try {
+    const raw = readFileSync(metaPath, "utf8");
+    const meta = JSON.parse(raw);
+    return {
+      cmd: Array.isArray(meta.cmd) ? meta.cmd.map(String) : [],
+      cwd: typeof meta.cwd === "string" ? meta.cwd : "",
+      startedAt: typeof meta.started_at === "number" ? meta.started_at : null,
+    };
+  } catch {
+    return { cmd: [], cwd: "", startedAt: null };
+  }
+}
+
+/** List one row per `<hash>.lock` in `stateDir`.  Read-only; takes no locks. */
+export async function statusRows(stateDir: string): Promise<StatusRow[]> {
+  const { readdirSync } = await import("node:fs");
+  const rows: StatusRow[] = [];
+  let entries: string[];
+  try {
+    entries = readdirSync(stateDir);
+  } catch {
+    return rows;
+  }
+  for (const name of entries.sort()) {
+    if (!name.endsWith(".lock")) continue;
+    const hashId = name.slice(0, -5);
+    const { sockPath, metaPath } = socketPaths(stateDir, hashId);
+    const meta = tryReadMeta(metaPath);
+    rows.push({
+      hashId,
+      cmd: meta.cmd,
+      cwd: meta.cwd,
+      socket: sockPath,
+      startedAt: meta.startedAt,
+      alive: await probeSocket(sockPath),
+    });
+  }
+  return rows;
+}
+
+/**
+ * Remove `<hash>.lock`/`.sock`/`.meta` triples whose worker is no longer
+ * accepting connections.
+ *
+ * @param tryAcquire Function provided by the lock module so we don't pull
+ *  the lock implementation into a circular import.  Returns a release
+ *  callback when the lock can be acquired non-blocking, or `null` when
+ *  it's already held (the worker is alive or another launch is in flight).
+ */
+export async function gcStateDir(
+  stateDir: string,
+  tryAcquire: (lockPath: string) => Promise<(() => void) | null>,
+  options?: { limit?: number; excludeHash?: string },
+): Promise<GcResult> {
+  const { readdirSync } = await import("node:fs");
+  const cleaned: string[] = [];
+  const skipped: string[] = [];
+  const limit = options?.limit ?? null;
+  const excludeHash = options?.excludeHash ?? null;
+
+  let entries: string[];
+  try {
+    entries = readdirSync(stateDir);
+  } catch {
+    return { cleaned, skippedInUse: skipped };
+  }
+
+  let seen = 0;
+  for (const name of entries.sort()) {
+    if (!name.endsWith(".lock")) continue;
+    if (limit !== null && seen >= limit) break;
+    seen += 1;
+    const hashId = name.slice(0, -5);
+    if (excludeHash !== null && hashId === excludeHash) continue;
+
+    const { lockPath, sockPath, metaPath } = socketPaths(stateDir, hashId);
+    const release = await tryAcquire(lockPath);
+    if (release === null) {
+      skipped.push(hashId);
+      continue;
+    }
+    try {
+      if (await probeSocket(sockPath)) {
+        // Worker is alive but didn't hold its own lock — odd, but leave it.
+        continue;
+      }
+      for (const p of [sockPath, metaPath, lockPath]) {
+        try {
+          unlinkSync(p);
+        } catch {
+          // best-effort
+        }
+      }
+      cleaned.push(hashId);
+    } finally {
+      release();
+    }
+  }
+  return { cleaned, skippedInUse: skipped };
+}
+
+/** Re-export for callers that want canonical hashing without going through the
+ *  launch entry point. */
+export { computeHash };