From 6dd79f7c3bafacba54acb2840f8655fcb05318bf Mon Sep 17 00:00:00 2001 From: Aman Kumar <145339995+amankumarsingh77@users.noreply.github.com> Date: Sat, 25 Jul 2026 00:23:05 +0530 Subject: feat: pin the agent to a chosen browser profile (#16) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: pin the agent to a chosen browser profile (#15) Harness tabs were created with a bare Target.createTarget, which places them in Chrome's defaultBrowserContextId — and that value follows window focus. Which profile the agent acted as therefore depended on which browser window the user last clicked, so the same task could run as a work account on one run and a personal account on the next. /browser-profile lists the connected browser's profiles as "Name (email)" and pins one to ~/.pi/agent/browser-harness.json, so the choice outlives the session. The same picker appears on first browser_setup when nothing is pinned; with no interactive UI, or on cancel, setup continues with a note and the previous behavior. Chrome offers no direct route to another profile: Target.createTarget rejects a foreign browserContextId, and openerId does not inherit the opener's context. The window is opened through the browser's own command line (--profile-directory, handed to the running browser by Chromium's ProcessSingleton) and identified by a unique file:// sentinel page, since a bare about:blank#token argument is discarded. Further tabs come from window.open evaluated with userGesture: true — the only CDP-reachable way to place a tab in a non-default browser context — correlated by a unique token so concurrent isolated tabs stay distinct. A failed handshake is reported, never silently redirected to another profile. All four tab-creation sites now funnel through cdp/target-factory, so open_urls and the isolated tabs behind web_search / read_page cannot run with a different profile's cookies than the visible tabs. Also fixed along the way: snap Chromium is discovered, Windows uses %LOCALAPPDATA%, browsers launched with an explicit --user-data-dir are found, the running browser is chosen by ranking candidates against the connected user-data-dir rather than taking the first process found, and an installed-but-closed browser no longer reads as running. CI runs the profile suites and a real-browser end-to-end test on ubuntu, macOS, and Windows — profile discovery is the one part of the harness whose behavior genuinely differs per OS. Co-Authored-By: Claude Opus 4.8 (1M context) * fix: single-flight harness window creation Isolated tabs run concurrently (browser_read_page is registered unserialized), so several could each find "no harness window" and create one — two blank windows before this feature, two LAUNCHED profile windows after it. ensureHarnessWindow now shares one in-flight creation per client. Sharing introduces a second hazard: freshlyCreated is a claim on the seed tab, and if every waiter received it, they would all drive the same tab. Only the caller that started the creation keeps the claim; the rest open their own tab beside it. Covered by test/manual/profile-concurrency-test.ts (five concurrent isolated tabs, pinned and unpinned: distinct targets, one window, correct profile), wired into CI on Linux only — the coordination is pure JS and identical across platforms. Co-Authored-By: Claude Opus 4.8 (1M context) * fix: tilde expansion differs by purpose on Windows CI on windows-latest caught this: join("~", "x") yields "~\x" there, and expandTilde only handled "~/". The two uses are not the same, so they no longer share a helper. The agent dir stays byte-compatible with pi's own expandTildePath ("~/" only, every platform) — being more lenient would put the pin file somewhere pi never looks. $CHROME_USER_DATA_DIR is ours to interpret, so it accepts "~\" as well, which is what a Windows user would type. Co-Authored-By: Claude Opus 4.8 (1M context) --------- Co-authored-by: Claude Opus 4.8 (1M context) --- src/cdp/discovery.ts | 96 ++++++++++++++++++++++------------------------------ 1 file changed, 40 insertions(+), 56 deletions(-) (limited to 'src/cdp/discovery.ts') diff --git a/src/cdp/discovery.ts b/src/cdp/discovery.ts index 1b35418..295df20 100644 --- a/src/cdp/discovery.ts +++ b/src/cdp/discovery.ts @@ -1,61 +1,24 @@ import { readFile, stat } from "node:fs/promises"; -import { homedir } from "node:os"; import { join } from "node:path"; import { connect as netConnect } from "node:net"; import { request as httpRequest } from "node:http"; import { type Result, err, ok } from "../util/result"; +import { userDataDirCandidates } from "../profile/paths"; import { type CdpError, cdpError } from "./errors"; const PORT_PROBE_DEADLINE_MS = 30_000; const PORT_PROBE_INTERVAL_MS = 1_000; -const profileDirs = (): ReadonlyArray => { - const home = homedir(); - return [ - // macOS — Chrome (all channels), Chromium, Brave, Edge - join(home, "Library/Application Support/Google/Chrome"), - join(home, "Library/Application Support/Google/Chrome Beta"), - join(home, "Library/Application Support/Google/Chrome Dev"), - join(home, "Library/Application Support/Google/Chrome Canary"), - join(home, "Library/Application Support/Chromium"), - join(home, "Library/Application Support/BraveSoftware/Brave-Browser"), - join(home, "Library/Application Support/BraveSoftware/Brave-Browser-Beta"), - join(home, "Library/Application Support/BraveSoftware/Brave-Browser-Nightly"), - join(home, "Library/Application Support/BraveSoftware/Brave-Browser-Dev"), - join(home, "Library/Application Support/Microsoft Edge"), - join(home, "Library/Application Support/Microsoft Edge Beta"), - join(home, "Library/Application Support/Microsoft Edge Dev"), - join(home, "Library/Application Support/Microsoft Edge Canary"), - // Linux — Chrome (all channels), Chromium, Brave, Edge - join(home, ".config/google-chrome"), - join(home, ".config/google-chrome-beta"), - join(home, ".config/google-chrome-unstable"), - join(home, ".config/chromium"), - join(home, ".config/chromium-browser"), - join(home, ".config/BraveSoftware/Brave-Browser"), - join(home, ".config/BraveSoftware/Brave-Browser-Beta"), - join(home, ".config/BraveSoftware/Brave-Browser-Nightly"), - join(home, ".config/microsoft-edge"), - join(home, ".config/microsoft-edge-beta"), - join(home, ".config/microsoft-edge-dev"), - // Linux flatpak - join(home, ".var/app/org.chromium.Chromium/config/chromium"), - join(home, ".var/app/com.google.Chrome/config/google-chrome"), - join(home, ".var/app/com.brave.Browser/config/BraveSoftware/Brave-Browser"), - join(home, ".var/app/com.microsoft.Edge/config/microsoft-edge"), - // Windows — Chrome, Chromium, Brave, Edge - join(home, "AppData/Local/Google/Chrome/User Data"), - join(home, "AppData/Local/Google/Chrome Beta/User Data"), - join(home, "AppData/Local/Google/Chrome Dev/User Data"), - join(home, "AppData/Local/Google/Chrome SxS/User Data"), - join(home, "AppData/Local/Chromium/User Data"), - join(home, "AppData/Local/BraveSoftware/Brave-Browser/User Data"), - join(home, "AppData/Local/BraveSoftware/Brave-Browser-Beta/User Data"), - join(home, "AppData/Local/Microsoft/Edge/User Data"), - join(home, "AppData/Local/Microsoft/Edge Beta/User Data"), - join(home, "AppData/Local/Microsoft/Edge Dev/User Data"), - join(home, "AppData/Local/Microsoft/Edge SxS/User Data"), - ]; +/** + * A live CDP endpoint plus, when discovery went through a DevToolsActivePort + * file, the user-data-dir that file lives in. That directory is the browser's + * profile registry (`Local State`) — Chromium writes DevToolsActivePort to + * chrome::DIR_USER_DATA — so it is what profile selection enumerates. + * Undefined when the endpoint came from BU_CDP_WS or a bare port probe. + */ +export type CdpEndpoint = { + readonly wsUrl: string; + readonly userDataDir?: string; }; const probePort = (port: number): Promise> => @@ -144,10 +107,20 @@ const fallbackPorts = (): ReadonlyArray => { return Array.from(ports); }; -type Candidate = { readonly port: number; readonly path: string; readonly mtimeMs: number }; +type Candidate = { + readonly port: number; + readonly path: string; + readonly mtimeMs: number; + /** The user-data-dir whose DevToolsActivePort produced this candidate. */ + readonly userDataDir: string; +}; -export const discoverWsUrl = async (): Promise> => { - const dirs = profileDirs(); +/** + * Locate a live CDP endpoint, reporting the user-data-dir it belongs to when + * that is knowable. `discoverWsUrl` is the URL-only view of the same walk. + */ +export const discoverEndpoint = async (): Promise> => { + const dirs = userDataDirCandidates(); // Phase 1: collect every readable DevToolsActivePort candidate up front, // rather than committing to the first one found. A single browser writes one @@ -190,7 +163,7 @@ export const discoverWsUrl = async (): Promise> => { // a Result error. Skip such entries. const portNum = Number(port); if (!Number.isInteger(portNum) || portNum <= 0 || portNum >= 65536) continue; - candidates.push({ port: portNum, path, mtimeMs }); + candidates.push({ port: portNum, path, mtimeMs, userDataDir: base }); } // Phase 2: no readable candidate — probe well-known ports directly. Covers @@ -201,7 +174,9 @@ export const discoverWsUrl = async (): Promise> => { for (const port of fallbackPorts()) { if (!(await isPortLive(port))) continue; const live = await queryLiveWsUrl(port); - if (live) return ok(live); + // No DevToolsActivePort file was involved, so the user-data-dir behind + // this endpoint is unknown — profile selection stays unavailable. + if (live) return ok({ wsUrl: live }); } const permHint = readErrors.length > 0 ? `\n\nDevToolsActivePort reads were denied (${readErrors.join(", ")}); if you're running in a sandbox, grant read access to those files or set BU_CDP_WS / BU_CDP_PORTS to bypass file discovery.` @@ -232,7 +207,7 @@ export const discoverWsUrl = async (): Promise> => { // /json/version. Some browsers disable that HTTP endpoint when remote // debugging is toggled only via chrome://inspect (rather than a launch flag), // so fall back to the WS path written in DevToolsActivePort. - let lastErr: Result | null = null; + let lastErr: Result | null = null; for (const c of ordered) { const ready = await waitForPort(c.port); if (!ready.success) { @@ -240,7 +215,7 @@ export const discoverWsUrl = async (): Promise> => { continue; } const liveUrl = await queryLiveWsUrl(c.port); - return ok(liveUrl ?? `ws://127.0.0.1:${c.port}${c.path}`); + return ok({ wsUrl: liveUrl ?? `ws://127.0.0.1:${c.port}${c.path}`, userDataDir: c.userDataDir }); } // Every discovered candidate was stale/unreachable. Before giving up, try the @@ -250,8 +225,17 @@ export const discoverWsUrl = async (): Promise> => { for (const port of fallbackPorts()) { if (byPort.has(port) || !(await isPortLive(port))) continue; const liveUrl = await queryLiveWsUrl(port); - if (liveUrl) return ok(liveUrl); + if (liveUrl) return ok({ wsUrl: liveUrl }); } return lastErr ?? err(cdpError("discovery_failed", "no live DevTools endpoint among discovered candidates")); }; + +/** + * URL-only view of {@link discoverEndpoint}, kept as the stable entry point for + * callers that don't care which user-data-dir answered. + */ +export const discoverWsUrl = async (): Promise> => { + const endpoint = await discoverEndpoint(); + return endpoint.success ? ok(endpoint.data.wsUrl) : endpoint; +}; -- cgit v1.2.3