src/client.ts (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
import { Type } from "typebox";
import { Compile } from "typebox/compile";
import { parseJson } from "./schemas/parse";
import { type Result, err, ok } from "./util/result";
import { safeJs } from "./util/js-template";
import { type Mutex, createMutex } from "./util/mutex";
import { discoverEndpoint } from "./cdp/discovery";
import { type CdpError, cdpError } from "./cdp/errors";
import type { CdpTransport } from "./cdp/types";
import { type CdpSession, createCdpSession } from "./cdp/session";
import { type OwnershipRegistry, createOwnershipRegistry } from "./cdp/ownership";
import { ensureHarnessWindow, openHarnessTab } from "./cdp/target-factory";
import { seedProfileWindow } from "./profile/bind";
import type { ProfilePin } from "./profile/store";
import type { DaemonStatus, DialogInfo, PageInfo, TabInfo } from "./cdp/types";
export type BrowserClientOptions = {
readonly namespace: string;
readonly transport: CdpTransport;
readonly remote?: { readonly cdpUrl: string; readonly browserId: string };
readonly initialOwnership?: {
readonly ownedTargetIds?: ReadonlyArray<string>;
readonly harnessWindowTargetId?: string;
readonly harnessWindowId?: number;
};
readonly profilePin?: ProfilePin | null;
readonly onOwnershipChange?: (snapshot: {
readonly ownedTargetIds: ReadonlyArray<string>;
readonly harnessWindowTargetId: string | undefined;
readonly harnessWindowId: number | undefined;
}) => void;
};
export type BrowserClient = {
readonly namespace: string;
ensureAlive(): Promise<Result<void, CdpError>>;
status(): DaemonStatus;
start(): Promise<Result<void, CdpError>>;
stop(): Promise<void>;
detach(): Promise<void>;
closeOwnedTabs(): Promise<void>;
evaluateJs(expression: string, sessionId?: string): Promise<Result<unknown, CdpError>>;
pageInfo(): Promise<Result<PageInfo | { readonly dialog: DialogInfo }, CdpError>>;
takeDialog(): DialogInfo | null;
listTabs(includeInternal?: boolean): Promise<Result<ReadonlyArray<TabInfo>, CdpError>>;
switchTab(targetId: string): Promise<Result<void, CdpError>>;
newTab(url?: string): Promise<Result<string, CdpError>>;
closeTab(targetId: string): Promise<Result<void, CdpError>>;
owns(targetId: string): boolean;
ownership(): OwnershipRegistry;
current(): { readonly sessionId: string; readonly targetId: string } | null;
session(): CdpSession;
transport(): CdpTransport;
userDataDir(): string | undefined;
profilePin(): ProfilePin | null;
setProfilePin(pin: ProfilePin | null): void;
profileContextId(): string | undefined;
setProfileContextId(contextId: string | undefined): void;
seedPinnedProfileWindow(): Promise<Result<string, CdpError>>;
mutationMutex(): Mutex;
};
const HEALTH_TTL_MS = 30_000;
const PAGE_INFO_TTL_MS = 1_000;
const PageInfoPayload = Type.Object({
url: Type.String(),
title: Type.String(),
w: Type.Number(),
h: Type.Number(),
sx: Type.Number(),
sy: Type.Number(),
pw: Type.Number(),
ph: Type.Number(),
});
const pageInfoValidator = Compile(PageInfoPayload);
const parsePageInfoPayload = (raw: string): Result<PageInfo, CdpError> => {
const parsed = parseJson(raw, pageInfoValidator);
if (!parsed.success) {
return err(cdpError("invalid_response", `page info payload is invalid: ${parsed.error}`));
}
const o = parsed.data;
return ok({
url: o.url,
title: o.title,
width: o.w,
height: o.h,
scrollX: o.sx,
scrollY: o.sy,
pageWidth: o.pw,
pageHeight: o.ph,
});
};
export const createBrowserClient = (opts: BrowserClientOptions): BrowserClient => {
const transport = opts.transport;
const ownershipInit: { ownedTargetIds?: ReadonlyArray<string>; harnessWindowTargetId?: string; harnessWindowId?: number } = {};
if (opts.initialOwnership?.ownedTargetIds !== undefined) {
ownershipInit.ownedTargetIds = opts.initialOwnership.ownedTargetIds;
}
if (opts.initialOwnership?.harnessWindowTargetId !== undefined) {
ownershipInit.harnessWindowTargetId = opts.initialOwnership.harnessWindowTargetId;
}
if (opts.initialOwnership?.harnessWindowId !== undefined) {
ownershipInit.harnessWindowId = opts.initialOwnership.harnessWindowId;
}
const ownership = createOwnershipRegistry(ownershipInit);
if (opts.onOwnershipChange) {
const cb = opts.onOwnershipChange;
ownership.onChange(() => {
cb({
ownedTargetIds: ownership.list(),
harnessWindowTargetId: ownership.harnessWindow(),
harnessWindowId: ownership.harnessWindowId(),
});
});
}
const session = createCdpSession(transport, ownership, async () => {
const window = await ensureHarnessWindow(api);
return window.success ? ok(window.data.targetId) : window;
});
const mutationMutex = createMutex();
let lastHealth = 0;
let pageCaches = new Map<string, { readonly info: PageInfo; readonly at: number }>();
let remote: BrowserClientOptions["remote"] | null = opts.remote ?? null;
let userDataDir: string | undefined;
let profilePin: ProfilePin | null = opts.profilePin ?? null;
let profileContextId: string | undefined;
// With a pin set the window must exist BEFORE anything attaches, or attachFirstPage's bare Target.createTarget lands in the focus-derived default profile.
const seedIfPinned = async (): Promise<Result<void, CdpError>> => {
if (!profilePin) return ok(undefined);
const window = await ensureHarnessWindow(api);
if (!window.success) return window;
return ok(undefined);
};
const start = async (): Promise<Result<void, CdpError>> => {
if (transport.state() === "open" && session.current()) return ok(undefined);
let wsUrl: string;
if (remote?.cdpUrl) {
wsUrl = remote.cdpUrl;
} else {
const discovered = await discoverEndpoint();
if (!discovered.success) return discovered;
wsUrl = discovered.data.wsUrl;
userDataDir = discovered.data.userDataDir;
}
const connected = await transport.connect(wsUrl, { timeoutMs: 10_000 });
if (!connected.success) return connected;
const newBrowserId: string = wsUrl.split("/").pop() ?? "unknown";
if (!remote || remote.browserId !== newBrowserId) {
profileContextId = undefined;
}
remote = { cdpUrl: wsUrl, browserId: newBrowserId };
const seeded = await seedIfPinned();
if (!seeded.success) {
await transport.close();
return seeded;
}
const attached = await session.attachFirstPage();
if (!attached.success) {
await transport.close();
return attached;
}
lastHealth = Date.now();
pageCaches.clear();
return ok(undefined);
};
const stop = async (): Promise<void> => {
await transport.close();
pageCaches.clear();
lastHealth = 0;
};
const ensureAlive = async (): Promise<Result<void, CdpError>> => {
if (transport.state() !== "open" || !session.current()) {
await stop();
return start();
}
if (Date.now() - lastHealth < HEALTH_TTL_MS) return ok(undefined);
const probe = await transport.request("Target.getTargets", {}, { sessionId: null, timeoutMs: 2_000 });
if (!probe.success) {
await stop();
return start();
}
lastHealth = Date.now();
const jsProbe = await session.call("Runtime.evaluate", {
expression: "1", returnByValue: true,
}, { timeoutMs: 2_000 });
if (!jsProbe.success && jsProbe.error.kind === "session_not_found") {
const seeded = await seedIfPinned();
if (!seeded.success) return seeded;
const reattached = await session.attachFirstPage();
if (reattached.success) {
pageCaches.clear();
return ok(undefined);
}
await stop();
return start();
}
return ok(undefined);
};
const evaluateJs = async (expression: string, sessionId?: string): Promise<Result<unknown, CdpError>> => {
// Wrap only when the trimmed source *starts with* `return` — matching the substring anywhere silently turned expressions mentioning it into `undefined`.
const trimmed = expression.trim();
const isReturnStatement = /^return[\s(]/.test(trimmed);
const wrapped = isReturnStatement ? `(function(){${expression}})()` : expression;
const r = sessionId
? await session.callOnTarget("Runtime.evaluate", { expression: wrapped, returnByValue: true, awaitPromise: true }, sessionId)
: await session.call("Runtime.evaluate", { expression: wrapped, returnByValue: true, awaitPromise: true });
if (!r.success) return r;
if (r.data.exceptionDetails !== undefined) {
return err(cdpError("remote_error", `JS evaluation failed: ${JSON.stringify(r.data.exceptionDetails)}`, "Runtime.evaluate"));
}
return ok(r.data.result.value);
};
const readPageInfo = async (): Promise<Result<PageInfo, CdpError>> => {
const dirty = session.drainPageInfoInvalidations();
const currentTid = session.current()?.targetId;
const cached = currentTid ? pageCaches.get(currentTid) : undefined;
if (cached && !dirty && Date.now() - cached.at < PAGE_INFO_TTL_MS) return ok(cached.info);
const expr = safeJs`JSON.stringify((function(){var e=document.documentElement||{scrollWidth:0,scrollHeight:0};return {url:location.href,title:document.title,w:innerWidth,h:innerHeight,sx:scrollX,sy:scrollY,pw:e.scrollWidth,ph:e.scrollHeight};})())`;
const raw = await evaluateJs(expr);
if (!raw.success) return raw;
if (typeof raw.data !== "string") return err(cdpError("invalid_response", "page info evaluation did not return a string"));
const info = parsePageInfoPayload(raw.data);
if (!info.success) return info;
if (currentTid) pageCaches.set(currentTid, { info: info.data, at: Date.now() });
return ok(info.data);
};
const pageInfo = async (): Promise<Result<PageInfo | { readonly dialog: DialogInfo }, CdpError>> => {
const d = session.takeDialog();
if (d) return ok({ dialog: d });
return readPageInfo();
};
const listTabs = async (includeInternal = true): Promise<Result<ReadonlyArray<TabInfo>, CdpError>> => {
const r = await session.callBrowser("Target.getTargets");
if (!r.success) return r;
const tabs = r.data.targetInfos
.filter((t) => t.type === "page")
.filter((t) => includeInternal || !t.url.startsWith("chrome://"))
.map((t): TabInfo => ({
targetId: t.targetId,
title: t.title,
url: t.url,
owned: ownership.has(t.targetId),
}));
const live = new Set(tabs.map((t) => t.targetId));
const owned = ownership.list();
const survivors = owned.filter((id) => live.has(id));
if (survivors.length !== owned.length) ownership.replaceAll(survivors);
const hw = ownership.harnessWindow();
if (hw && !live.has(hw)) ownership.setHarnessWindow(undefined);
for (const tid of pageCaches.keys()) {
if (!live.has(tid)) pageCaches.delete(tid);
}
return ok(tabs);
};
const switchTab = async (targetId: string): Promise<Result<void, CdpError>> => {
const r = await session.switchTo(targetId);
if (!r.success) return r;
await session.call("Runtime.evaluate", {
expression: safeJs`if(!document.title.startsWith('🟢'))document.title='🟢 '+document.title`,
});
return ok(undefined);
};
const newTab = async (url?: string): Promise<Result<string, CdpError>> => {
const tabsResult = await listTabs(true);
if (!tabsResult.success) return tabsResult;
const window = await ensureHarnessWindow(api);
if (!window.success) return window;
let tabId: string;
if (window.data.freshlyCreated) {
tabId = window.data.targetId;
} else {
const opened = await openHarnessTab(api, window.data.targetId);
if (!opened.success) return opened;
tabId = opened.data;
}
const switched = await switchTab(tabId);
if (!switched.success) return switched;
if (url && url !== "about:blank") {
const nav = await session.call("Page.navigate", { url });
if (!nav.success) return nav;
}
return ok(tabId);
};
const closeTab = async (targetId: string): Promise<Result<void, CdpError>> => {
const r = await session.callBrowser("Target.closeTarget", { targetId });
if (!r.success) return r;
ownership.remove(targetId);
return ok(undefined);
};
const closeOwnedTabs = async (): Promise<void> => {
for (const id of ownership.list()) {
await session.callBrowser("Target.closeTarget", { targetId: id }).catch(() => {});
ownership.remove(id);
}
ownership.setHarnessWindow(undefined);
ownership.setHarnessWindowId(undefined);
};
const status = (): DaemonStatus => ({
alive: transport.state() === "open" && session.current() !== null,
sessionId: session.current()?.sessionId ?? null,
namespace: opts.namespace,
...(remote?.browserId !== undefined ? { remoteBrowserId: remote.browserId } : {}),
});
const detach = async (): Promise<void> => {
const cur = session.current();
if (!cur) return;
await transport.request("Target.detachFromTarget", { sessionId: cur.sessionId }, { sessionId: null });
};
const api: BrowserClient = {
namespace: opts.namespace,
ensureAlive, status, start, stop, detach, closeOwnedTabs,
evaluateJs, pageInfo,
takeDialog: () => session.takeDialog(),
listTabs, switchTab, newTab, closeTab,
owns: (id: string) => ownership.has(id),
ownership: () => ownership,
current: () => session.current(),
session: () => session,
transport: () => transport,
userDataDir: () => userDataDir,
profilePin: () => profilePin,
setProfilePin: (pin) => {
const changed = pin === null
? profilePin !== null
: profilePin === null || profilePin.userDataDir !== pin.userDataDir || profilePin.profileDir !== pin.profileDir;
profilePin = pin;
if (changed) {
profileContextId = undefined;
}
},
profileContextId: () => profileContextId,
setProfileContextId: (contextId) => {
profileContextId = contextId;
},
seedPinnedProfileWindow: async () => {
if (!profilePin) {
return err(cdpError("discovery_failed", "no browser profile is selected — run /browser-profile"));
}
return seedProfileWindow(api, profilePin);
},
mutationMutex: () => mutationMutex,
};
return api;
};
|