src/cdp/session.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 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
import { map, type Result, err, ok } from "../util/result";
import { type CdpError, cdpError } from "./errors";
import type { DialogInfo } from "./types";
import type { OwnershipRegistry } from "./ownership";
import type { CdpTransport } from "./types";
import { type CdpMethod, type ParamsOf, type ResultOf, decodeResult } from "./commands";
import { decodeEvent } from "./events";
import { createNetworkBuffer, type DrainResult, type NetworkFilter } from "./network-buffer";
import { createConsoleBuffer, type ConsoleDrainResult, type ConsoleFilter } from "./console-buffer";
type TabSession = {
sessionId: string;
targetId: string;
dialog: DialogInfo | null;
pageInfoDirty: boolean;
networkBuffer: ReturnType<typeof createNetworkBuffer>;
consoleBuffer: ReturnType<typeof createConsoleBuffer>;
refMap: Map<string, number>;
refSig: Map<string, string>;
};
const dialogType = (raw: string): DialogInfo["type"] =>
raw === "confirm" || raw === "prompt" || raw === "beforeunload" ? raw : "alert";
export type CdpSession = {
attachFirstPage(): Promise<Result<{ readonly targetId: string; readonly sessionId: string }, CdpError>>;
attach(targetId: string): Promise<Result<string, CdpError>>;
windowId(targetId: string): Promise<Result<number, CdpError>>;
switchTo(targetId: string): Promise<Result<void, CdpError>>;
current(): { readonly sessionId: string; readonly targetId: string } | null;
setRefMap(refMap: Map<string, number>, refSig: Map<string, string>): void;
resolveRef(ref: string): number | undefined;
refSignatures(): ReadonlyMap<string, string>;
refMappings(): ReadonlyMap<string, number>;
call<M extends CdpMethod>(method: M, params?: ParamsOf<M>, opts?: { timeoutMs?: number }): Promise<Result<ResultOf<M>, CdpError>>;
callOnTarget<M extends CdpMethod>(method: M, params: ParamsOf<M>, sessionId: string, opts?: { timeoutMs?: number }): Promise<Result<ResultOf<M>, CdpError>>;
callBrowser<M extends CdpMethod>(method: M, params?: ParamsOf<M>, opts?: { timeoutMs?: number }): Promise<Result<ResultOf<M>, CdpError>>;
takeDialog(): DialogInfo | null;
drainPageInfoInvalidations(): boolean;
drainNetworkBuffer(filter: NetworkFilter): DrainResult;
drainConsoleBuffer(filter: ConsoleFilter): ConsoleDrainResult;
};
// Injected so seeding goes through the target factory; attachFirstPage's own `Target.createTarget` would land in whichever profile has focus.
export type SeedTargetProvider = () => Promise<Result<string, CdpError>>;
export const createCdpSession = (
transport: CdpTransport,
ownership?: OwnershipRegistry,
createSeedTarget?: SeedTargetProvider,
): CdpSession => {
let sessionId: string | null = null;
let targetId: string | null = null;
const tabs = new Map<string, TabSession>();
const sessionIdToTargetId = new Map<string, string>();
let activeConsumer: Promise<void> = Promise.resolve();
const resolveTab = (evSessionId?: string): TabSession | undefined => {
const tid = evSessionId ? sessionIdToTargetId.get(evSessionId) : targetId;
return tid ? tabs.get(tid) : undefined;
};
const consumeEvents = async (): Promise<void> => {
for await (const ev of transport.events()) {
if (ev.method !== "Target.targetDestroyed") {
if (ev.sessionId && !sessionIdToTargetId.has(ev.sessionId)) continue;
}
switch (ev.method) {
case "Page.javascriptDialogOpening": {
const tab = resolveTab(ev.sessionId);
if (!tab) break;
const decoded = decodeEvent(ev.method, ev.params);
tab.dialog = decoded.success
? {
type: dialogType(decoded.data.type),
message: decoded.data.message,
...(decoded.data.defaultPrompt !== undefined
? { defaultPrompt: decoded.data.defaultPrompt }
: {}),
}
: { type: "alert", message: "" };
break;
}
// Intentionally NOT cleared on javascriptDialogClosed: a fast dismiss would otherwise drop a dialog the agent was about to read.
case "Page.frameNavigated":
case "Page.loadEventFired": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.pageInfoDirty = true;
break;
}
case "Target.targetCreated": {
if (!ownership) break;
const decoded = decodeEvent(ev.method, ev.params);
if (!decoded.success) break;
const info = decoded.data.targetInfo;
if (info.type === "page" && info.targetId && info.openerId && ownership.has(info.openerId)) {
ownership.add(info.targetId);
}
break;
}
case "Target.targetDestroyed": {
if (!ownership) break;
const decoded = decodeEvent(ev.method, ev.params);
if (!decoded.success || !decoded.data.targetId) break;
const destroyed = decoded.data.targetId;
ownership.remove(destroyed);
const tab = tabs.get(destroyed);
if (tab) {
sessionIdToTargetId.delete(tab.sessionId);
tabs.delete(destroyed);
}
break;
}
case "Network.requestWillBeSent": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestRequestWillBeSent(ev.params);
break;
}
case "Network.responseReceived": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestResponseReceived(ev.params);
break;
}
case "Network.loadingFinished": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestLoadingFinished(ev.params);
break;
}
case "Network.loadingFailed": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestLoadingFailed(ev.params);
break;
}
case "Runtime.consoleAPICalled": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.consoleBuffer.ingestConsoleApi(ev.params);
break;
}
case "Log.entryAdded": {
const tab = resolveTab(ev.sessionId);
if (tab) tab.consoleBuffer.ingestLogEntry(ev.params);
break;
}
default:
break;
}
}
};
const restartConsumer = (): void => {
activeConsumer = activeConsumer.then(() => consumeEvents()).catch((e: unknown) => {
console.warn("[pi-browser-harness] CDP event consumer crashed:", e);
});
};
restartConsumer();
transport.onClose(() => {
sessionId = null;
targetId = null;
tabs.clear();
sessionIdToTargetId.clear();
// Do NOT clear `dialog` here: a pending takeDialog() must still see it.
restartConsumer();
});
const enableDomains = async (sid: string): Promise<void> => {
for (const d of ["Page", "DOM", "Runtime", "Network", "Accessibility", "Log"]) {
await transport.request(`${d}.enable`, {}, { sessionId: sid });
}
};
const req = async <M extends CdpMethod>(
method: M,
params: ParamsOf<M> | undefined,
sid: string | null,
opts: { timeoutMs?: number } = {},
): Promise<Result<ResultOf<M>, CdpError>> => {
const raw = await transport.request(method, { ...(params ?? {}) }, {
sessionId: sid,
...(opts.timeoutMs !== undefined ? { timeoutMs: opts.timeoutMs } : {}),
});
if (!raw.success) return raw;
return decodeResult(method, raw.data);
};
const attach = async (tid: string): Promise<Result<string, CdpError>> =>
map(await req("Target.attachToTarget", { targetId: tid, flatten: true }, null), (d) => d.sessionId);
const windowId = async (tid: string): Promise<Result<number, CdpError>> =>
map(await req("Browser.getWindowForTarget", { targetId: tid }, null), (d) => d.windowId);
const currentTab = (): TabSession | undefined => (targetId ? tabs.get(targetId) : undefined);
const session: CdpSession = {
async attachFirstPage() {
await req("Target.setDiscoverTargets", { discover: true }, null);
const targets = await req("Target.getTargets", {}, null);
if (!targets.success) return targets;
const allPages = targets.data.targetInfos.filter((t) => t.type === "page");
if (ownership) {
const live = new Set(allPages.map((p) => p.targetId));
const survivors = ownership.list().filter((id) => live.has(id));
if (survivors.length !== ownership.list().length) ownership.replaceAll(survivors);
const hw = ownership.harnessWindow();
if (hw && !live.has(hw)) ownership.setHarnessWindow(undefined);
const anchorId = survivors[0];
if (anchorId === undefined) {
ownership.setHarnessWindowId(undefined);
} else {
const anchorWin = await windowId(anchorId);
if (anchorWin.success) {
const anchorWindowId = anchorWin.data;
ownership.setHarnessWindowId(anchorWindowId);
const windows = await Promise.all(
allPages.map((p) =>
p.targetId === anchorId
? Promise.resolve(anchorWin)
: windowId(p.targetId),
),
);
allPages.forEach((p, i) => {
const r = windows[i];
if (r?.success && r.data === anchorWindowId) {
ownership.add(p.targetId);
}
});
}
if (!ownership.harnessWindow()) ownership.setHarnessWindow(anchorId);
}
}
const liveTargetIds = new Set(allPages.map((p) => p.targetId));
for (const tid of tabs.keys()) {
if (!liveTargetIds.has(tid)) {
const tab = tabs.get(tid);
if (tab) sessionIdToTargetId.delete(tab.sessionId);
tabs.delete(tid);
}
}
let pickTargetId: string | undefined;
if (ownership) {
const ownedLive = ownership.list().filter((id) => allPages.some((p) => p.targetId === id));
pickTargetId = ownedLive[0];
}
if (!pickTargetId && createSeedTarget) {
const seeded = await createSeedTarget();
if (!seeded.success) return seeded;
pickTargetId = seeded.data;
}
if (!pickTargetId) {
const created = await req(
"Target.createTarget",
{ url: "about:blank", ...(ownership ? { newWindow: true } : {}) },
null,
);
if (!created.success) return created;
pickTargetId = created.data.targetId;
if (ownership) {
ownership.setHarnessWindow(created.data.targetId);
ownership.add(created.data.targetId);
const win = await windowId(created.data.targetId);
if (win.success) ownership.setHarnessWindowId(win.data);
}
}
const attached = await attach(pickTargetId);
if (!attached.success) return attached;
const attachedSessionId = attached.data;
sessionId = attachedSessionId;
targetId = pickTargetId;
tabs.set(pickTargetId, {
sessionId: attachedSessionId,
targetId: pickTargetId,
dialog: null,
pageInfoDirty: false,
networkBuffer: createNetworkBuffer(),
consoleBuffer: createConsoleBuffer(),
refMap: new Map(),
refSig: new Map(),
});
sessionIdToTargetId.set(attachedSessionId, pickTargetId);
await enableDomains(attachedSessionId);
return ok({ targetId: pickTargetId, sessionId: attachedSessionId });
},
async switchTo(tid) {
const activated = await req("Target.activateTarget", { targetId: tid }, null);
if (!activated.success) return activated;
const attached = await attach(tid);
if (!attached.success) return attached;
const attachedSessionId = attached.data;
const existing = tabs.get(tid);
const tab: TabSession = existing ?? {
sessionId: attachedSessionId,
targetId: tid,
dialog: null,
pageInfoDirty: true,
networkBuffer: createNetworkBuffer(),
consoleBuffer: createConsoleBuffer(),
refMap: new Map(),
refSig: new Map(),
};
if (existing) {
sessionIdToTargetId.delete(existing.sessionId);
existing.sessionId = attachedSessionId;
} else {
tabs.set(tid, tab);
}
sessionIdToTargetId.set(attachedSessionId, tid);
await enableDomains(attachedSessionId);
sessionId = tab.sessionId;
targetId = tid;
return ok(undefined);
},
attach,
windowId,
current() {
return sessionId && targetId ? { sessionId, targetId } : null;
},
setRefMap(refMap, refSig) {
const tab = currentTab();
if (!tab) return;
tab.refMap = refMap;
tab.refSig = refSig;
},
resolveRef(ref) {
const tab = currentTab();
return tab?.refMap.get(ref);
},
refSignatures() {
const tab = currentTab();
return tab?.refSig ?? new Map();
},
refMappings() {
const tab = currentTab();
return tab?.refMap ?? new Map();
},
call(method, params, opts) {
return req(method, params, sessionId, opts);
},
callOnTarget(method, params, sid, opts) {
return req(method, params, sid, opts);
},
callBrowser(method, params, opts) {
return req(method, params, null, opts);
},
takeDialog() {
const tab = currentTab();
if (!tab) return null;
const d = tab.dialog;
tab.dialog = null;
return d;
},
drainPageInfoInvalidations() {
const tab = currentTab();
if (!tab) return false;
const dirty = tab.pageInfoDirty;
tab.pageInfoDirty = false;
return dirty;
},
drainNetworkBuffer(filter) {
const tab = currentTab();
if (!tab) return { records: [], total: 0, bufferOverflowed: false };
return tab.networkBuffer.drain(filter);
},
drainConsoleBuffer(filter) {
const tab = currentTab();
if (!tab) return { records: [], total: 0, bufferOverflowed: false };
return tab.consoleBuffer.drain(filter);
},
};
return session;
};
export const evaluateJson = async <T>(
session: CdpSession,
expression: string,
check: (v: unknown) => v is T,
opts?: { sessionId?: string | undefined; timeoutMs?: number | undefined },
): Promise<Result<T, CdpError>> => {
const params = {
expression,
returnByValue: true,
awaitPromise: true,
};
const callOpts = opts?.timeoutMs !== undefined ? { timeoutMs: opts.timeoutMs } : {};
const r = opts?.sessionId !== undefined
? await session.callOnTarget("Runtime.evaluate", params, opts.sessionId, callOpts)
: await session.call("Runtime.evaluate", params, callOpts);
if (!r.success) return r;
const { result, exceptionDetails } = r.data;
if (exceptionDetails !== undefined) {
return err(cdpError("remote_error", exceptionDetails.text, "Runtime.evaluate"));
}
const value = result.value;
if (!check(value)) {
return err(cdpError("invalid_response", `unexpected evaluate shape (type: ${result.type}) for: ${expression.slice(0, 60)}`, "Runtime.evaluate"));
}
return ok(value);
};
|