import { type AddressInfo, createServer } from "node:net"; import { fetch as realFetch } from "undici"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; let testPort = 0; let cdpBaseUrl = ""; let reachable = false; let cfgAttachOnly = false; let createTargetId: string | null = null; let prevGatewayPort: string | undefined; const cdpMocks = vi.hoisted(() => ({ createTargetViaCdp: vi.fn(async () => { throw new Error("cdp disabled"); }), snapshotAria: vi.fn(async () => ({ nodes: [{ ref: "1", role: "link", name: "x", depth: 0 }], })), })); const pwMocks = vi.hoisted(() => ({ armDialogViaPlaywright: vi.fn(async () => {}), armFileUploadViaPlaywright: vi.fn(async () => {}), clickViaPlaywright: vi.fn(async () => {}), closePageViaPlaywright: vi.fn(async () => {}), closePlaywrightBrowserConnection: vi.fn(async () => {}), downloadViaPlaywright: vi.fn(async () => ({ url: "https://example.com/report.pdf", suggestedFilename: "report.pdf", path: "/tmp/report.pdf", })), dragViaPlaywright: vi.fn(async () => {}), evaluateViaPlaywright: vi.fn(async () => "ok"), fillFormViaPlaywright: vi.fn(async () => {}), getConsoleMessagesViaPlaywright: vi.fn(async () => []), hoverViaPlaywright: vi.fn(async () => {}), scrollIntoViewViaPlaywright: vi.fn(async () => {}), navigateViaPlaywright: vi.fn(async () => ({ url: "https://example.com" })), pdfViaPlaywright: vi.fn(async () => ({ buffer: Buffer.from("pdf") })), pressKeyViaPlaywright: vi.fn(async () => {}), responseBodyViaPlaywright: vi.fn(async () => ({ url: "https://example.com/api/data", status: 200, headers: { "content-type": "application/json" }, body: '{"ok":true}', })), resizeViewportViaPlaywright: vi.fn(async () => {}), selectOptionViaPlaywright: vi.fn(async () => {}), setInputFilesViaPlaywright: vi.fn(async () => {}), snapshotAiViaPlaywright: vi.fn(async () => ({ snapshot: "ok" })), takeScreenshotViaPlaywright: vi.fn(async () => ({ buffer: Buffer.from("png"), })), typeViaPlaywright: vi.fn(async () => {}), waitForDownloadViaPlaywright: vi.fn(async () => ({ url: "https://example.com/report.pdf", suggestedFilename: "report.pdf", path: "/tmp/report.pdf", })), waitForViaPlaywright: vi.fn(async () => {}), })); function makeProc(pid = 123) { const handlers = new Map void>>(); return { pid, killed: false, exitCode: null as number | null, on: (event: string, cb: (...args: unknown[]) => void) => { handlers.set(event, [...(handlers.get(event) ?? []), cb]); return undefined; }, emitExit: () => { for (const cb of handlers.get("exit") ?? []) { cb(0); } }, kill: () => { return true; }, }; } const proc = makeProc(); vi.mock("../config/config.js", async (importOriginal) => { const actual = await importOriginal(); return { ...actual, loadConfig: () => ({ browser: { enabled: true, color: "#FF4500", attachOnly: cfgAttachOnly, headless: true, defaultProfile: "openclaw", profiles: { openclaw: { cdpPort: testPort + 1, color: "#FF4500" }, }, }, }), writeConfigFile: vi.fn(async () => {}), }; }); const launchCalls = vi.hoisted(() => [] as Array<{ port: number }>); vi.mock("./chrome.js", () => ({ isChromeCdpReady: vi.fn(async () => reachable), isChromeReachable: vi.fn(async () => reachable), launchOpenClawChrome: vi.fn(async (_resolved: unknown, profile: { cdpPort: number }) => { launchCalls.push({ port: profile.cdpPort }); reachable = true; return { pid: 123, exe: { kind: "chrome", path: "/fake/chrome" }, userDataDir: "/tmp/openclaw", cdpPort: profile.cdpPort, startedAt: Date.now(), proc, }; }), resolveOpenClawUserDataDir: vi.fn(() => "/tmp/openclaw"), stopOpenClawChrome: vi.fn(async () => { reachable = false; }), })); vi.mock("./cdp.js", () => ({ createTargetViaCdp: cdpMocks.createTargetViaCdp, normalizeCdpWsUrl: vi.fn((wsUrl: string) => wsUrl), snapshotAria: cdpMocks.snapshotAria, getHeadersWithAuth: vi.fn(() => ({})), appendCdpPath: vi.fn((cdpUrl: string, path: string) => { const base = cdpUrl.replace(/\/$/, ""); const suffix = path.startsWith("/") ? path : `/${path}`; return `${base}${suffix}`; }), })); vi.mock("./pw-ai.js", () => pwMocks); vi.mock("../media/store.js", () => ({ ensureMediaDir: vi.fn(async () => {}), saveMediaBuffer: vi.fn(async () => ({ path: "/tmp/fake.png" })), })); vi.mock("./screenshot.js", () => ({ DEFAULT_BROWSER_SCREENSHOT_MAX_BYTES: 128, DEFAULT_BROWSER_SCREENSHOT_MAX_SIDE: 64, normalizeBrowserScreenshot: vi.fn(async (buf: Buffer) => ({ buffer: buf, contentType: "image/png", })), })); async function getFreePort(): Promise { while (true) { const port = await new Promise((resolve, reject) => { const s = createServer(); s.once("error", reject); s.listen(0, "127.0.0.1", () => { const assigned = (s.address() as AddressInfo).port; s.close((err) => (err ? reject(err) : resolve(assigned))); }); }); if (port < 65535) { return port; } } } function makeResponse( body: unknown, init?: { ok?: boolean; status?: number; text?: string }, ): Response { const ok = init?.ok ?? true; const status = init?.status ?? 200; const text = init?.text ?? ""; return { ok, status, json: async () => body, text: async () => text, } as unknown as Response; } describe("browser control server", () => { beforeAll(async () => { reachable = false; cfgAttachOnly = false; createTargetId = null; launchCalls.length = 0; cdpMocks.createTargetViaCdp.mockImplementation(async () => { if (createTargetId) { return { targetId: createTargetId }; } throw new Error("cdp disabled"); }); for (const fn of Object.values(pwMocks)) { fn.mockClear(); } for (const fn of Object.values(cdpMocks)) { fn.mockClear(); } testPort = await getFreePort(); cdpBaseUrl = `http://127.0.0.1:${testPort + 1}`; prevGatewayPort = process.env.OPENCLAW_GATEWAY_PORT; process.env.OPENCLAW_GATEWAY_PORT = String(testPort - 2); // Minimal CDP JSON endpoints used by the server. let putNewCalls = 0; vi.stubGlobal( "fetch", vi.fn(async (url: string, init?: RequestInit) => { const u = String(url); if (u.includes("/json/list")) { if (!reachable) { return makeResponse([]); } return makeResponse([ { id: "abcd1234", title: "Tab", url: "https://example.com", webSocketDebuggerUrl: "ws://127.0.0.1/devtools/page/abcd1234", type: "page", }, { id: "abce9999", title: "Other", url: "https://other", webSocketDebuggerUrl: "ws://127.0.0.1/devtools/page/abce9999", type: "page", }, ]); } if (u.includes("/json/new?")) { if (init?.method === "PUT") { putNewCalls += 1; if (putNewCalls === 1) { return makeResponse({}, { ok: false, status: 405, text: "" }); } } return makeResponse({ id: "newtab1", title: "", url: "about:blank", webSocketDebuggerUrl: "ws://127.0.0.1/devtools/page/newtab1", type: "page", }); } if (u.includes("/json/activate/")) { return makeResponse("ok"); } if (u.includes("/json/close/")) { return makeResponse("ok"); } return makeResponse({}, { ok: false, status: 500, text: "unexpected" }); }), ); }); afterAll(async () => { vi.unstubAllGlobals(); vi.restoreAllMocks(); if (prevGatewayPort === undefined) { delete process.env.OPENCLAW_GATEWAY_PORT; } else { process.env.OPENCLAW_GATEWAY_PORT = prevGatewayPort; } const { stopBrowserControlServer } = await import("./server.js"); await stopBrowserControlServer(); }); it("covers primary control routes, validation, and profile compatibility", async () => { const { startBrowserControlServerFromConfig } = await import("./server.js"); const started = await startBrowserControlServerFromConfig(); expect(started?.port).toBe(testPort); const base = `http://127.0.0.1:${testPort}`; const s1 = (await realFetch(`${base}/`).then((r) => r.json())) as { running: boolean; pid: number | null; }; expect(s1.running).toBe(false); expect(s1.pid).toBe(null); expect(s1.profile).toBe("openclaw"); const tabsWhenStopped = (await realFetch(`${base}/tabs`).then((r) => r.json())) as { running: boolean; tabs: unknown[]; }; expect(tabsWhenStopped.running).toBe(false); expect(Array.isArray(tabsWhenStopped.tabs)).toBe(true); const focusStopped = await realFetch(`${base}/tabs/focus`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ targetId: "abcd" }), }); expect(focusStopped.status).toBe(409); const startedPayload = (await realFetch(`${base}/start`, { method: "POST" }).then((r) => r.json(), )) as { ok: boolean; profile?: string }; expect(startedPayload.ok).toBe(true); expect(startedPayload.profile).toBe("openclaw"); const s2 = (await realFetch(`${base}/`).then((r) => r.json())) as { running: boolean; pid: number | null; chosenBrowser: string | null; }; expect(s2.running).toBe(true); expect(s2.pid).toBe(123); expect(s2.chosenBrowser).toBe("chrome"); expect(launchCalls.length).toBeGreaterThan(0); const tabs = (await realFetch(`${base}/tabs`).then((r) => r.json())) as { running: boolean; tabs: Array<{ targetId: string }>; }; expect(tabs.running).toBe(true); expect(tabs.tabs.length).toBeGreaterThan(0); const openedDefault = (await realFetch(`${base}/tabs/open`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ url: "https://example.com" }), }).then((r) => r.json())) as { targetId?: string }; expect(openedDefault.targetId).toBe("newtab1"); createTargetId = "abcd1234"; const openedViaCdp = (await realFetch(`${base}/tabs/open`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ url: "https://example.com" }), }).then((r) => r.json())) as { targetId?: string }; expect(openedViaCdp.targetId).toBe("abcd1234"); createTargetId = null; const focusAmbiguous = await realFetch(`${base}/tabs/focus`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ targetId: "abc" }), }); expect(focusAmbiguous.status).toBe(409); const focusMissing = await realFetch(`${base}/tabs/focus`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ targetId: "zzz" }), }); expect(focusMissing.status).toBe(404); const [navMissing, clickMissingRef, scrollSelectorUnsupported, dialogMissingAccept] = await Promise.all([ realFetch(`${base}/navigate`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }), realFetch(`${base}/act`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ kind: "click" }), }), realFetch(`${base}/act`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ kind: "scrollIntoView", selector: "button.save" }), }), realFetch(`${base}/hooks/dialog`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }), ]); expect(navMissing.status).toBe(400); expect(clickMissingRef.status).toBe(400); expect(scrollSelectorUnsupported.status).toBe(400); expect(dialogMissingAccept.status).toBe(400); const snapDefault = (await realFetch(`${base}/snapshot?format=wat`).then((r) => r.json())) as { ok: boolean; format?: string; }; expect(snapDefault.ok).toBe(true); expect(snapDefault.format).toBe("ai"); const snapAi = (await realFetch(`${base}/snapshot?format=ai&maxChars=0`).then((r) => r.json(), )) as { ok: boolean; format?: string }; expect(snapAi.ok).toBe(true); expect(snapAi.format).toBe("ai"); const [call] = pwMocks.snapshotAiViaPlaywright.mock.calls.at(-1) ?? []; expect(call).toEqual({ cdpUrl: cdpBaseUrl, targetId: "abcd1234", }); const snapAmbiguous = await realFetch(`${base}/snapshot?format=aria&targetId=abc`); expect(snapAmbiguous.status).toBe(409); const screenshotBadCombo = await realFetch(`${base}/screenshot`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ fullPage: true, element: "body" }), }); expect(screenshotBadCombo.status).toBe(400); const delAmbiguous = await realFetch(`${base}/tabs/abc`, { method: "DELETE" }); expect(delAmbiguous.status).toBe(409); const profiles = (await realFetch(`${base}/profiles`).then((r) => r.json())) as { profiles: Array<{ name: string }>; }; expect(profiles.profiles.some((profile) => profile.name === "openclaw")).toBe(true); const tabsByProfile = (await realFetch(`${base}/tabs?profile=openclaw`).then((r) => r.json(), )) as { running: boolean; tabs: unknown[]; }; expect(tabsByProfile.running).toBe(true); expect(Array.isArray(tabsByProfile.tabs)).toBe(true); const openByProfile = (await realFetch(`${base}/tabs/open?profile=openclaw`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ url: "https://example.com" }), }).then((r) => r.json())) as { targetId?: string }; expect(openByProfile.targetId).toBe("newtab1"); const unknownProfile = await realFetch(`${base}/tabs?profile=unknown`); expect(unknownProfile.status).toBe(404); const unknownPayload = (await unknownProfile.json()) as { error: string }; expect(unknownPayload.error).toContain("not found"); const stopped = (await realFetch(`${base}/stop`, { method: "POST" }).then((r) => r.json())) as { ok: boolean; profile?: string; }; expect(stopped.ok).toBe(true); expect(stopped.profile).toBe("openclaw"); const missing = await realFetch(`${base}/tabs/open`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); expect(missing.status).toBe(400); }); });