openclaw/src/tui/tui-launch.test.ts

// Covers TUI launch argument and environment construction.
import type { ChildProcess, SpawnOptions } from "node:child_process";
import { EventEmitter } from "node:events";
import { afterEach, beforeEach, describe, expect, it, type MockInstance, vi } from "vitest";

const spawnMock = vi.hoisted(() => vi.fn());
const detachMock = vi.hoisted(() => vi.fn());
let pauseSpy: MockInstance;
let resumeSpy: MockInstance;

vi.mock("node:child_process", () => ({
  spawn: spawnMock,
}));

vi.mock("../process/child-process-bridge.js", () => ({
  attachChildProcessBridge: vi.fn(() => ({ detach: detachMock })),
}));

import { launchTuiCli } from "./tui-launch.js";

const originalArgv = [...process.argv];
const originalExecArgv = [...process.execArgv];

function createChildProcess(): ChildProcess {
  return new EventEmitter() as ChildProcess;
}

function expectSpawned(expectedArgs: string[]): SpawnOptions {
  expect(spawnMock).toHaveBeenCalledOnce();
  const call = spawnMock.mock.calls[0] as [string, string[], SpawnOptions] | undefined;
  if (!call) {
    throw new Error("missing spawn call");
  }
  const [command, args, options] = call;
  expect(command).toBe(process.execPath);
  expect(args).toEqual(expectedArgs);
  return options;
}

describe("launchTuiCli", () => {
  beforeEach(() => {
    process.argv = [...originalArgv];
    process.argv[1] = "/repo/openclaw.mjs";
    process.execArgv.length = 0;
    spawnMock.mockReset();
    detachMock.mockReset();
    pauseSpy = vi.spyOn(process.stdin, "pause").mockImplementation(() => process.stdin);
    resumeSpy = vi.spyOn(process.stdin, "resume").mockImplementation(() => process.stdin);
    vi.spyOn(process.stdin, "isPaused").mockReturnValue(false);
  });

  afterEach(() => {
    process.argv = [...originalArgv];
    process.execArgv.length = 0;
    process.execArgv.push(...originalExecArgv);
    vi.restoreAllMocks();
  });

  it("filters inherited inspector flags when relaunching TUI", async () => {
    process.execArgv.push(
      "--import",
      "tsx",
      "--inspect",
      "127.0.0.1:9231",
      "--inspect=127.0.0.1:9229",
      "--inspect-brk",
      "--inspect-wait=0",
      "--inspect-port",
      "9230",
      "--no-warnings",
    );
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({
      url: "ws://127.0.0.1:18789",
      token: "test-token",
      password: "test-password",
      deliver: false,
    });

    const options = expectSpawned([
      "--import",
      "tsx",
      "--no-warnings",
      "/repo/openclaw.mjs",
      "tui",
      "--url",
      "ws://127.0.0.1:18789",
      "--token",
      "test-token",
      "--password",
      "test-password",
    ]);
    expect(options.stdio).toBe("inherit");
  });

  it("passes local mode through to the relaunched TUI", async () => {
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({ local: true, deliver: false });

    const options = expectSpawned(["/repo/openclaw.mjs", "tui", "--local"]);
    expect(options.stdio).toBe("inherit");
  });

  it("passes initial message and timeout through to the relaunched TUI", async () => {
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({
      local: true,
      deliver: false,
      message: "Wake up, my friend!",
      timeoutMs: 300_000,
    });

    const options = expectSpawned([
      "/repo/openclaw.mjs",
      "tui",
      "--local",
      "--message",
      "Wake up, my friend!",
      "--timeout-ms",
      "300000",
    ]);
    expect(options.stdio).toBe("inherit");
  });

  it("keeps parent stdin paused after the relaunched TUI exits", async () => {
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({ deliver: false });

    expect(pauseSpy).toHaveBeenCalledOnce();
    expect(resumeSpy).not.toHaveBeenCalled();
  });

  it("launches compiled CLI shapes without repeating the current command", async () => {
    process.argv[1] = "setup";
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({ deliver: false });

    const options = expectSpawned(["tui"]);
    expect(options.stdio).toBe("inherit");
  });

  it("passes gateway connection options as TUI arguments without mutating env", async () => {
    const child = createChildProcess();
    spawnMock.mockImplementation((_cmd: string, _args: string[], _opts: SpawnOptions) => {
      queueMicrotask(() => child.emit("exit", 0, null));
      return child;
    });

    await launchTuiCli({
      deliver: false,
      url: "ws://127.0.0.1:18789",
      token: "resolved-token",
    });

    const options = expectSpawned([
      "/repo/openclaw.mjs",
      "tui",
      "--url",
      "ws://127.0.0.1:18789",
      "--token",
      "resolved-token",
    ]);
    expect(options.env).toBe(process.env);
  });
});