@flrande/browserctl 0.5.0-dev.22.1 → 0.6.0

package/apps/browserctl/src/daemon-client.test.ts

@@ -1,512 +0,0 @@
-import { createServer, type AddressInfo } from "node:net";
-import { dirname, join, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { mkdirSync, rmSync, writeFileSync } from "node:fs";
-
-import { afterEach, describe, expect, it, vi } from "vitest";
-
-import { DAEMON_STARTUP_ARGUMENT } from "./commands/common";
-import { callDaemonTool, getDaemonStatus, stopDaemon } from "./daemon-client";
-
-type CapturedRequest = {
-  id: string;
-  name: string;
-  traceId: string;
-  arguments: Record<string, unknown>;
-};
-
-const ORIGINAL_DAEMON_PORT = process.env.BROWSERCTL_DAEMON_PORT;
-const ORIGINAL_AUTH_TOKEN = process.env.BROWSERCTL_AUTH_TOKEN;
-const ORIGINAL_DAEMON_STARTUP_TIMEOUT_MS = process.env.BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS;
-const ORIGINAL_DAEMON_REQUEST_TIMEOUT_MS = process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS;
-const TEST_PID_PORTS = new Set<number>();
-
-function resolveRuntimeDirForTests(): string {
-  const currentFile = fileURLToPath(import.meta.url);
-  return resolve(dirname(currentFile), "../../../.browserctl-runtime");
-}
-
-function resolvePidFileForTests(port: number): string {
-  return join(resolveRuntimeDirForTests(), `daemon-${port}.pid`);
-}
-
-function writePidRecordForTests(port: number, record: number | { pid: number; authToken?: string }): void {
-  mkdirSync(resolveRuntimeDirForTests(), { recursive: true });
-  writeFileSync(
-    resolvePidFileForTests(port),
-    typeof record === "number" ? String(record) : JSON.stringify(record),
-    { encoding: "utf8" }
-  );
-  TEST_PID_PORTS.add(port);
-}
-
-afterEach(() => {
-  if (ORIGINAL_DAEMON_PORT === undefined) {
-    delete process.env.BROWSERCTL_DAEMON_PORT;
-  } else {
-    process.env.BROWSERCTL_DAEMON_PORT = ORIGINAL_DAEMON_PORT;
-  }
-
-  if (ORIGINAL_AUTH_TOKEN === undefined) {
-    delete process.env.BROWSERCTL_AUTH_TOKEN;
-  } else {
-    process.env.BROWSERCTL_AUTH_TOKEN = ORIGINAL_AUTH_TOKEN;
-  }
-
-  if (ORIGINAL_DAEMON_STARTUP_TIMEOUT_MS === undefined) {
-    delete process.env.BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS;
-  } else {
-    process.env.BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS = ORIGINAL_DAEMON_STARTUP_TIMEOUT_MS;
-  }
-
-  if (ORIGINAL_DAEMON_REQUEST_TIMEOUT_MS === undefined) {
-    delete process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS;
-  } else {
-    process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS = ORIGINAL_DAEMON_REQUEST_TIMEOUT_MS;
-  }
-
-  for (const port of TEST_PID_PORTS) {
-    rmSync(resolvePidFileForTests(port), { force: true });
-  }
-  TEST_PID_PORTS.clear();
-  vi.restoreAllMocks();
-});
-
-async function withDaemonHarness(
-  run: (state: { port: number; requests: CapturedRequest[] }) => Promise<void>,
-  options: {
-    responseDelayMs?: number;
-  } = {}
-): Promise<void> {
-  const responseDelayMs = options.responseDelayMs ?? 0;
-  const requests: CapturedRequest[] = [];
-  const server = createServer((socket) => {
-    socket.setEncoding("utf8");
-    let buffer = "";
-
-    socket.on("data", (chunk: string) => {
-      buffer += chunk;
-
-      let lineBreakIndex = buffer.indexOf("\n");
-      while (lineBreakIndex >= 0) {
-        const line = buffer.slice(0, lineBreakIndex).trim();
-        buffer = buffer.slice(lineBreakIndex + 1);
-
-        if (line.length === 0) {
-          lineBreakIndex = buffer.indexOf("\n");
-          continue;
-        }
-
-        const request = JSON.parse(line) as CapturedRequest;
-        requests.push(request);
-        const respond = () => {
-          socket.write(
-            `${JSON.stringify({
-              id: request.id,
-              ok: true,
-              traceId: request.traceId,
-              sessionId:
-                typeof request.arguments.sessionId === "string"
-                  ? request.arguments.sessionId
-                  : "cli:test",
-              data: {
-                ok: true
-              }
-            })}\n`
-          );
-        };
-        if (responseDelayMs > 0) {
-          setTimeout(respond, responseDelayMs);
-        } else {
-          respond();
-        }
-
-        lineBreakIndex = buffer.indexOf("\n");
-      }
-    });
-  });
-
-  await new Promise<void>((resolve, reject) => {
-    server.once("error", reject);
-    server.listen(0, "127.0.0.1", () => {
-      server.off("error", reject);
-      resolve();
-    });
-  });
-
-  const address = server.address() as AddressInfo;
-
-  try {
-    await run({ port: address.port, requests });
-  } finally {
-    await new Promise<void>((resolve, reject) => {
-      server.close((error) => {
-        if (error !== undefined) {
-          reject(error);
-          return;
-        }
-
-        resolve();
-      });
-    });
-  }
-}
-
-async function reservePortForTests(): Promise<number> {
-  const server = createServer();
-
-  await new Promise<void>((resolve, reject) => {
-    server.once("error", reject);
-    server.listen(0, "127.0.0.1", () => {
-      server.off("error", reject);
-      resolve();
-    });
-  });
-
-  const address = server.address() as AddressInfo;
-  await new Promise<void>((resolve, reject) => {
-    server.close((error) => {
-      if (error !== undefined) {
-        reject(error);
-        return;
-      }
-      resolve();
-    });
-  });
-
-  return address.port;
-}
-
-async function startDaemonHarnessOnPort(
-  port: number,
-  requests: CapturedRequest[],
-  options: {
-    responseDelayMs?: number;
-  } = {}
-): Promise<() => Promise<void>> {
-  const responseDelayMs = options.responseDelayMs ?? 0;
-  const server = createServer((socket) => {
-    socket.setEncoding("utf8");
-    let buffer = "";
-
-    socket.on("data", (chunk: string) => {
-      buffer += chunk;
-
-      let lineBreakIndex = buffer.indexOf("\n");
-      while (lineBreakIndex >= 0) {
-        const line = buffer.slice(0, lineBreakIndex).trim();
-        buffer = buffer.slice(lineBreakIndex + 1);
-
-        if (line.length === 0) {
-          lineBreakIndex = buffer.indexOf("\n");
-          continue;
-        }
-
-        const request = JSON.parse(line) as CapturedRequest;
-        requests.push(request);
-        const respond = () => {
-          socket.write(
-            `${JSON.stringify({
-              id: request.id,
-              ok: true,
-              traceId: request.traceId,
-              sessionId:
-                typeof request.arguments.sessionId === "string"
-                  ? request.arguments.sessionId
-                  : "cli:test",
-              data: {
-                ok: true
-              }
-            })}\n`
-          );
-        };
-        if (responseDelayMs > 0) {
-          setTimeout(respond, responseDelayMs);
-        } else {
-          respond();
-        }
-
-        lineBreakIndex = buffer.indexOf("\n");
-      }
-    });
-  });
-
-  await new Promise<void>((resolve, reject) => {
-    server.once("error", reject);
-    server.listen(port, "127.0.0.1", () => {
-      server.off("error", reject);
-      resolve();
-    });
-  });
-
-  return async () =>
-    await new Promise<void>((resolve, reject) => {
-      server.close((error) => {
-        if (error !== undefined) {
-          reject(error);
-          return;
-        }
-        resolve();
-      });
-    });
-}
-
-async function importDaemonClientWithMockedSpawn(
-  spawnImplementation: () => {
-    pid: number;
-    unref(): void;
-  }
-): Promise<{
-  callDaemonToolWithMock: typeof callDaemonTool;
-  spawnMock: ReturnType<typeof vi.fn>;
-}> {
-  vi.resetModules();
-  const spawnMock = vi.fn(spawnImplementation);
-  vi.doMock("node:child_process", () => ({
-    spawn: spawnMock
-  }));
-  const daemonClientModule = await import("./daemon-client");
-  return {
-    callDaemonToolWithMock: daemonClientModule.callDaemonTool,
-    spawnMock
-  };
-}
-
-describe("daemon client auth token forwarding", () => {
-  it("includes env token in daemon status probes", async () => {
-    await withDaemonHarness(async ({ port, requests }) => {
-      process.env.BROWSERCTL_DAEMON_PORT = String(port);
-      process.env.BROWSERCTL_AUTH_TOKEN = "env-token";
-
-      const status = await getDaemonStatus();
-
-      expect(status.running).toBe(true);
-      expect(requests).toHaveLength(1);
-      expect(requests[0]).toMatchObject({
-        name: "browser.status",
-        arguments: {
-          sessionId: "cli:daemon-status",
-          authToken: "env-token"
-        }
-      });
-    });
-  });
-
-  it("includes env token in tool calls when not explicitly provided", async () => {
-    await withDaemonHarness(async ({ port, requests }) => {
-      process.env.BROWSERCTL_DAEMON_PORT = String(port);
-      process.env.BROWSERCTL_AUTH_TOKEN = "env-token";
-
-      await callDaemonTool("browser.tab.list", {
-        sessionId: "cli:test"
-      });
-
-      expect(requests).toHaveLength(1);
-      expect(requests[0]).toMatchObject({
-        name: "browser.tab.list",
-        arguments: {
-          sessionId: "cli:test",
-          authToken: "env-token"
-        }
-      });
-    });
-  });
-
-  it("preserves explicit authToken in tool calls", async () => {
-    await withDaemonHarness(async ({ port, requests }) => {
-      process.env.BROWSERCTL_DAEMON_PORT = String(port);
-      process.env.BROWSERCTL_AUTH_TOKEN = "env-token";
-
-      await callDaemonTool("browser.tab.list", {
-        sessionId: "cli:test",
-        authToken: "cli-token"
-      });
-
-      expect(requests).toHaveLength(1);
-      expect(requests[0]).toMatchObject({
-        name: "browser.tab.list",
-        arguments: {
-          sessionId: "cli:test",
-          authToken: "cli-token"
-        }
-      });
-    });
-  });
-
-  it("does not forward internal daemon startup metadata as tool arguments", async () => {
-    await withDaemonHarness(async ({ port, requests }) => {
-      process.env.BROWSERCTL_DAEMON_PORT = String(port);
-
-      await callDaemonTool("browser.tab.list", {
-        sessionId: "cli:test",
-        [DAEMON_STARTUP_ARGUMENT]: {
-          managedLocal: {
-            browserName: "chromium",
-            channel: "msedge"
-          }
-        }
-      });
-
-      expect(requests).toHaveLength(1);
-      expect(requests[0].arguments).toMatchObject({
-        sessionId: "cli:test"
-      });
-      expect(requests[0].arguments).not.toHaveProperty(DAEMON_STARTUP_ARGUMENT);
-    });
-  });
-
-  it("reuses persisted daemon auth token when env token is missing", async () => {
-    await withDaemonHarness(async ({ port, requests }) => {
-      process.env.BROWSERCTL_DAEMON_PORT = String(port);
-      delete process.env.BROWSERCTL_AUTH_TOKEN;
-      writePidRecordForTests(port, {
-        pid: 12345,
-        authToken: "persisted-token"
-      });
-
-      const status = await getDaemonStatus();
-
-      expect(status.running).toBe(true);
-      expect(requests).toHaveLength(1);
-      expect(requests[0]).toMatchObject({
-        name: "browser.status",
-        arguments: {
-          sessionId: "cli:daemon-status",
-          authToken: "persisted-token"
-        }
-      });
-    });
-  });
-
-  it("avoids killing stale pid records when daemon cannot be verified", async () => {
-    const unreachablePort = 45999;
-    writePidRecordForTests(unreachablePort, {
-      pid: 70001,
-      authToken: "persisted-token"
-    });
-
-    const killSpy = vi.spyOn(process, "kill").mockImplementation(() => true);
-    const stopResult = await stopDaemon(unreachablePort);
-
-    expect(stopResult).toMatchObject({
-      stopped: false,
-      port: unreachablePort,
-      pid: 70001
-    });
-    expect(killSpy).not.toHaveBeenCalled();
-  });
-});
-
-describe("daemon client timeout env branches", () => {
-  it("applies BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS to daemon responses", async () => {
-    await withDaemonHarness(
-      async ({ port }) => {
-        process.env.BROWSERCTL_DAEMON_PORT = String(port);
-        process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS = "10";
-
-        await expect(
-          callDaemonTool("browser.tab.list", {
-            sessionId: "cli:timeout"
-          })
-        ).rejects.toThrow("Timed out waiting for daemon response after 10ms");
-      },
-      {
-        responseDelayMs: 80
-      }
-    );
-  });
-
-  it("falls back to default request timeout when env value is invalid", async () => {
-    await withDaemonHarness(
-      async ({ port, requests }) => {
-        process.env.BROWSERCTL_DAEMON_PORT = String(port);
-        process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS = "-1";
-
-        await expect(
-          callDaemonTool("browser.tab.list", {
-            sessionId: "cli:timeout-fallback"
-          })
-        ).resolves.toEqual({
-          ok: true
-        });
-        expect(requests).toHaveLength(1);
-      },
-      {
-        responseDelayMs: 80
-      }
-    );
-  });
-
-  it("applies BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS while polling spawned daemon readiness", async () => {
-    const unavailablePort = await reservePortForTests();
-    TEST_PID_PORTS.add(unavailablePort);
-    process.env.BROWSERCTL_DAEMON_PORT = String(unavailablePort);
-    process.env.BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS = "50";
-    process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS = "20";
-
-    const { callDaemonToolWithMock, spawnMock } = await importDaemonClientWithMockedSpawn(() => ({
-      pid: 424242,
-      unref: vi.fn()
-    }));
-
-    try {
-      const startedAt = Date.now();
-      await expect(
-        callDaemonToolWithMock("browser.status", {
-          sessionId: "cli:startup-timeout"
-        })
-      ).rejects.toThrow(`Daemon did not become ready on port ${unavailablePort}:`);
-      expect(spawnMock).toHaveBeenCalledTimes(1);
-      expect(Date.now() - startedAt).toBeLessThan(1_500);
-    } finally {
-      vi.doUnmock("node:child_process");
-      vi.resetModules();
-    }
-  });
-
-  it("falls back to default startup timeout when env value is invalid", async () => {
-    const port = await reservePortForTests();
-    TEST_PID_PORTS.add(port);
-    process.env.BROWSERCTL_DAEMON_PORT = String(port);
-    process.env.BROWSERCTL_DAEMON_STARTUP_TIMEOUT_MS = "-1";
-    process.env.BROWSERCTL_DAEMON_REQUEST_TIMEOUT_MS = "50";
-
-    const requests: CapturedRequest[] = [];
-    let closeServer: (() => Promise<void>) | undefined;
-    let startupError: unknown;
-    const startupTimer = setTimeout(() => {
-      void startDaemonHarnessOnPort(port, requests)
-        .then((close) => {
-          closeServer = close;
-        })
-        .catch((error) => {
-          startupError = error;
-        });
-    }, 300);
-
-    const { callDaemonToolWithMock, spawnMock } = await importDaemonClientWithMockedSpawn(() => ({
-      pid: 434343,
-      unref: vi.fn()
-    }));
-
-    try {
-      await expect(
-        callDaemonToolWithMock("browser.status", {
-          sessionId: "cli:startup-fallback"
-        })
-      ).resolves.toEqual({
-        ok: true
-      });
-      expect(spawnMock).toHaveBeenCalledTimes(1);
-      expect(requests.some((request) => request.name === "browser.status")).toBe(true);
-      expect(startupError).toBeUndefined();
-    } finally {
-      clearTimeout(startupTimer);
-      if (closeServer !== undefined) {
-        await closeServer();
-      }
-      vi.doUnmock("node:child_process");
-      vi.resetModules();
-    }
-  });
-});