Skip to content

armgit / qm

Public Imported from GitHub
0

Multiplayer agent harness for work.

5.7 KB
Raw Blame
import { test } from "node:test";
import assert from "node:assert/strict";
import { mkdtempSync, rmSync } from "node:fs";
import { connect, createServer } from "node:net";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { Child } from "../scripts/dev/supervisor/children.ts";
import { portAvailable, portHolders, tcpPortOpen } from "../scripts/dev/lib/proc.ts";
import { sleep } from "../scripts/dev/lib/util.ts";
import type { ChildSpec } from "../scripts/dev/lib/types.ts";

const FAKE = join(import.meta.dirname, "../scripts/dev/test-helpers/fake-child.mjs");

async function freeTcpPort(): Promise<number> {
  return await new Promise((resolve) => {
    const server = createServer();
    server.listen(0, "127.0.0.1", () => {
      const port = (server.address() as { port: number }).port;
      server.close(() => resolve(port));
    });
  });
}

function spec(lock: string, port: number, extraArgs: string[] = []): ChildSpec {
  return {
    name: "web",
    cwd: lock,
    argv: ["node", FAKE, `--port=${port}`, ...extraArgs],
    env: { PATH: process.env.PATH ?? "" },
    port,
    readiness: { kind: "log", pattern: `fake-child ready on :${port}` },
    health: { kind: "tcp", port },
    stopGraceMs: 2000,
  };
}

test("child starts, reports ready via log pattern, and stops with the port released", async () => {
  const lock = mkdtempSync(join(tmpdir(), "qm-child-"));
  const port = await freeTcpPort();
  const child = new Child(
    spec(lock, port),
    lock,
    () => {},
    () => {},
  );
  const res = await child.start();
  assert.equal(res.ok, true);
  assert.equal(child.state, "healthy");
  assert.equal(await tcpPortOpen(port), true);
  assert.equal(await child.probeHealth(), true);
  await child.stop();
  assert.equal(child.state, "stopped");
  assert.equal(await tcpPortOpen(port), false);
  rmSync(lock, { recursive: true, force: true });
});

test("a crashed child is auto-restarted with backoff", async () => {
  const lock = mkdtempSync(join(tmpdir(), "qm-child-"));
  const port = await freeTcpPort();
  const crashes: number[] = [];
  const child = new Child(
    spec(lock, port, ["--crashAfter=1500"]),
    lock,
    () => {},
    () => crashes.push(Date.now()),
  );
  assert.equal((await child.start()).ok, true);
  const deadline = Date.now() + 10_000;
  while (Date.now() < deadline && crashes.length === 0) await sleep(100);
  assert.ok(crashes.length >= 1, "child crash was observed");
  while (Date.now() < deadline && child.state !== "healthy") await sleep(100);
  assert.equal(child.state, "healthy");
  assert.ok(child.restarts >= 1);
  await child.stop();
  rmSync(lock, { recursive: true, force: true });
});

test("startup leaves occupied ports untouched and retries after they become free", async () => {
  const lock = mkdtempSync(join(tmpdir(), "qm-child-"));
  const port = await freeTcpPort();
  const server = createServer();
  await new Promise<void>((resolve) => server.listen(port, "127.0.0.1", resolve));
  const child = new Child(
    spec(lock, port),
    lock,
    () => {},
    () => {},
  );
  try {
    assert.equal(await portAvailable(port), false);
    const res = await child.start();
    assert.equal(res.ok, false);
    assert.match(res.detail ?? "", /exited during startup/);
    assert.equal(child.proc, null);
    assert.equal(child.status().state, "crashed");
    assert.equal(server.listening, true);
    assert.equal(await tcpPortOpen(port), true);
    await new Promise<void>((resolve) => server.close(() => resolve()));
    const deadline = Date.now() + 5000;
    while (Date.now() < deadline && child.state !== "healthy") await sleep(100);
    assert.equal(child.state, "healthy");
    assert.ok(child.restarts >= 1);
  } finally {
    if (server.listening) await new Promise<void>((resolve) => server.close(() => resolve()));
    await child.stop();
    rmSync(lock, { recursive: true, force: true });
  }
});

test("port availability rejects IPv6 listeners", async () => {
  const server = createServer();
  await new Promise<void>((resolve, reject) => {
    server.once("error", reject);
    server.listen({ port: 0, host: "::1", ipv6Only: true }, resolve);
  });
  try {
    assert.equal(await portAvailable((server.address() as { port: number }).port), false);
    assert.equal(server.listening, true);
  } finally {
    await new Promise<void>((resolve) => server.close(() => resolve()));
  }
});

test("stop escalates to SIGKILL for a TERM-ignoring child", async () => {
  const lock = mkdtempSync(join(tmpdir(), "qm-child-"));
  const port = await freeTcpPort();
  const child = new Child(
    spec(lock, port, ["--ignoreTerm"]),
    lock,
    () => {},
    () => {},
  );
  assert.equal((await child.start()).ok, true);
  const before = Date.now();
  await child.stop();
  assert.equal(child.state, "stopped");
  assert.equal(await tcpPortOpen(port), false);
  assert.ok(Date.now() - before < 8000);
  rmSync(lock, { recursive: true, force: true });
});

test("port ownership excludes clients connected to the listener", async () => {
  const lock = mkdtempSync(join(tmpdir(), "qm-child-"));
  const port = await freeTcpPort();
  const child = new Child(
    spec(lock, port),
    lock,
    () => {},
    () => {},
  );
  let client: ReturnType<typeof connect> | undefined;
  try {
    assert.equal((await child.start()).ok, true);
    client = connect(port, "127.0.0.1");
    await new Promise<void>((resolve, reject) => {
      client!.once("connect", resolve);
      client!.once("error", reject);
    });
    const holders = portHolders(port);
    assert.ok(holders.includes(child.proc!.pid!));
    assert.ok(!holders.includes(process.pid), "the connected client must never be a cleanup target");
  } finally {
    client?.destroy();
    await child.stop();
    rmSync(lock, { recursive: true, force: true });
  }
});