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
404
|
import { type Result, ok } from "../util/result";
import type { CdpError } from "./errors";
import type { DialogInfo } from "./types";
import type { OwnershipRegistry } from "./ownership";
import type { CdpTransport } from "./transport";
import { type CdpMethod, type ParamsOf, type ResultOf, decodeResult } from "./commands";
import { createNetworkBuffer, type DrainResult, type NetworkFilter } from "./network-buffer";
import { createConsoleBuffer, type ConsoleDrainResult, type ConsoleFilter } from "./console-buffer";
import { attachTo } from "./attach";
import { getWindowId } from "./window";
// Per-tab state. One TabSession exists per known targetId.
// Dialog, page-info dirty flag, and CDP buffers are per-tab — switching
// tabs preserves the previous tab's data in its TabSession instead of
// clearing it.
type TabSession = {
sessionId: string;
targetId: string;
dialog: DialogInfo | null;
pageInfoDirty: boolean;
networkBuffer: ReturnType<typeof createNetworkBuffer>;
consoleBuffer: ReturnType<typeof createConsoleBuffer>;
// Stable element refs (e1, e2, …) → CDP backendNodeId, from the latest
// snapshot of this tab. Replaced wholesale on every snapshot — old refs are
// stale anyway, so this stays bounded (~50–60 KB worst case).
refMap: Map<string, number>;
// Per-ref signature ("role|name|value") from the latest snapshot, used as the
// baseline for the post-mutation auto-diff. Replaced alongside refMap.
refSig: Map<string, string>;
};
export type CdpSession = {
attachFirstPage(): Promise<Result<{ readonly targetId: string; readonly sessionId: string }, CdpError>>;
switchTo(targetId: string): Promise<Result<void, CdpError>>;
current(): { readonly sessionId: string; readonly targetId: string } | null;
/** Replace the active tab's ref map and ref signatures (from a fresh snapshot). */
setRefMap(refMap: Map<string, number>, refSig: Map<string, string>): void;
/** Resolve a ref (e.g. "e12") to its backendNodeId on the active tab, or undefined if unknown/stale. */
resolveRef(ref: string): number | undefined;
/** The active tab's prior ref signatures — baseline for the post-mutation diff. */
refSignatures(): ReadonlyMap<string, string>;
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;
};
/**
* Supplies the seed tab when attachFirstPage finds no owned tab to attach to.
* Injected by the client so that seeding goes through the target factory —
* which, with a profile pinned, opens the window inside that profile. Without
* it, attachFirstPage's own `Target.createTarget` would land in whichever
* profile currently has focus.
*
* The provider is responsible for its own ownership bookkeeping.
*/
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;
// Per-tab tracking: maps targetId → TabSession and sessionId → targetId for
// event routing. Lazy: a TabSession is created on the first visit to a tab.
const tabs = new Map<string, TabSession>();
const sessionIdToTargetId = new Map<string, string>();
let activeConsumer: Promise<void> = Promise.resolve();
// Event → TabSession resolver. Uses sessionId from CDP events to find the
// correct TabSession, falling back to the current targetId when no sessionId.
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()) {
// Filter: skip events from sessions we're not currently tracking.
// Target.targetDestroyed is browser-level (no sessionId) — always process.
if (ev.method !== "Target.targetDestroyed") {
if (ev.sessionId && ev.sessionId !== sessionId) continue;
}
if (ev.method === "Page.javascriptDialogOpening") {
const tab = targetId ? tabs.get(targetId) : undefined;
if (!tab) continue;
const params = ev.params as Partial<DialogInfo> | undefined;
tab.dialog = {
type: (params?.type as DialogInfo["type"]) ?? "alert",
message: params?.message ?? "",
...(params?.defaultPrompt !== undefined ? { defaultPrompt: params.defaultPrompt } : {}),
};
continue;
}
// Page.javascriptDialogClosed is intentionally NOT cleared here —
// the dialog stays in the buffer until takeDialog() is called.
// This prevents fast dismiss flows from dropping a dialog the agent
// was about to read. (Fix for spec §7 predictability bug #2.)
if (ev.method === "Page.frameNavigated" || ev.method === "Page.loadEventFired") {
const tab = targetId ? tabs.get(targetId) : undefined;
if (tab) tab.pageInfoDirty = true;
}
if (ev.method === "Target.targetCreated" && ownership) {
// Adopt tabs opened BY a tab we already own (window.open, target=_blank,
// popups). Chrome sets openerId to the opener target; if that opener is
// owned, the child belongs to this session's window and must be
// controllable + cleaned up. Targets the user opens themselves have no
// owned opener, so they are never adopted.
const info = (ev.params as { targetInfo?: { targetId?: string; type?: string; openerId?: string } } | undefined)?.targetInfo;
if (info?.type === "page" && info.targetId && info.openerId && ownership.has(info.openerId)) {
ownership.add(info.targetId);
}
}
if (ev.method === "Target.targetDestroyed" && ownership) {
const params = ev.params as { targetId?: string } | undefined;
if (params?.targetId) {
ownership.remove(params.targetId);
// Prune per-tab state for the destroyed target
const tab = tabs.get(params.targetId);
if (tab) {
sessionIdToTargetId.delete(tab.sessionId);
tabs.delete(params.targetId);
}
}
}
if (ev.method === "Network.requestWillBeSent") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestRequestWillBeSent(ev.params);
} else if (ev.method === "Network.responseReceived") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestResponseReceived(ev.params);
} else if (ev.method === "Network.loadingFinished") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestLoadingFinished(ev.params);
} else if (ev.method === "Network.loadingFailed") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.networkBuffer.ingestLoadingFailed(ev.params);
} else if (ev.method === "Runtime.consoleAPICalled") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.consoleBuffer.ingestConsoleApi(ev.params);
} else if (ev.method === "Log.entryAdded") {
const tab = resolveTab(ev.sessionId);
if (tab) tab.consoleBuffer.ingestLogEntry(ev.params);
}
}
};
const restartConsumer = (): void => {
activeConsumer = activeConsumer.then(() => consumeEvents()).catch((e: unknown) => {
// The .then() chain calls consumeEvents() which iterates the transport's
// events() AsyncIterable. The iterable resolves cleanly on close (returns
// {done:true}); any rejection here is an unexpected bug in the event
// handler, not a normal termination. Surface it on stderr so it's not lost.
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 — same rationale as inside consumeEvents:
// the agent may have a pending takeDialog() call that should still see it.
restartConsumer();
});
// TODO(perf): the four enable calls are sequential here for predictability.
// Switching to Promise.all over a single WS pipelines the round-trips and
// saves ~3× on tab-switch latency. Defer until session.ts has tests.
const enableDomains = async (sid: string): Promise<void> => {
for (const d of ["Page", "DOM", "Runtime", "Network", "Accessibility", "Log"]) {
await transport.request(`${d}.enable`, {}, { sessionId: sid });
}
};
// The one place `unknown` ends for every CDP call this session makes — its
// own internal bookkeeping calls (attach/switch) and the public
// call/callOnTarget/callBrowser all funnel through here. A single
// transport-then-decode implementation means a future change (tracing,
// error wrapping, the short-circuit on failure) lands in one place, and a
// new internal call site can't forget to decode.
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 session: CdpSession = {
async attachFirstPage() {
// Subscribe to Target.* events so we can react to targetDestroyed.
// Best-effort: failing to enable discovery is not fatal for attach.
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");
// Reconcile the persisted ownership set against live targets — drop dead IDs.
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);
if (survivors.length === 0) {
// No owned tab survived — the harness window is gone (user closed it,
// or Chrome restarted and reassigned all ids). The persisted windowId
// is now meaningless and could even collide with one of the user's
// windows, so drop it. attachFirstPage will mint a fresh window below.
ownership.setHarnessWindowId(undefined);
} else {
// Self-heal ownership from the window itself. We anchor on a tab we
// KNOW we own (a survivor) and re-adopt only its live window-mates —
// popups/children from last session, tabs reopened in our window.
// Ownership is thus DERIVED from the real window, never from the bare
// persisted integer (which Chrome may reassign to a user window on
// restart — anchoring on a survivor makes that misfire impossible).
const anchorId = survivors[0]!;
const anchorWin = await getWindowId(session, anchorId);
if (anchorWin.success) {
const anchorWindowId = anchorWin.data;
ownership.setHarnessWindowId(anchorWindowId); // refresh to the live id
const windows = await Promise.all(
allPages.map((p) =>
p.targetId === anchorId
? Promise.resolve(anchorWin)
: getWindowId(session, 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);
}
}
// Prune per-tab state for pages that no longer exist
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);
}
}
// Prefer attaching to a tab this session already owns. Falls back to
// creating a fresh harness-owned tab in a dedicated window — never
// grabs the user's foreground tab.
let pickTargetId: string | undefined;
if (ownership) {
const ownedLive = ownership.list().filter((id) => allPages.some((p) => p.targetId === id));
pickTargetId = ownedLive[0];
}
if (!pickTargetId && createSeedTarget) {
// Delegated seeding (see SeedTargetProvider): the provider creates the
// window in the right profile and records ownership itself.
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);
// Capture the real Chrome windowId — the durable identity of the
// window this session initialized (survives seed-tab closure).
const win = await getWindowId(session, created.data.targetId);
if (win.success) ownership.setHarnessWindowId(win.data);
}
}
const attached = await attachTo(session, pickTargetId);
if (!attached.success) return attached;
const attachedSessionId = attached.data;
sessionId = attachedSessionId;
targetId = pickTargetId;
await enableDomains(attachedSessionId);
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);
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 attachTo(session, tid);
if (!attached.success) return attached;
const attachedSessionId = attached.data;
// Reuse existing TabSession or create one on first visit
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) {
// Each Target.attachToTarget produces a new sessionId — update it.
sessionIdToTargetId.delete(existing.sessionId);
existing.sessionId = attachedSessionId;
sessionIdToTargetId.set(attachedSessionId, tid);
} else {
tabs.set(tid, tab);
await enableDomains(attachedSessionId);
sessionIdToTargetId.set(attachedSessionId, tid);
}
// Update global pointers to point at the new active tab
sessionId = tab.sessionId;
targetId = tid;
return ok(undefined);
},
current() {
return sessionId && targetId ? { sessionId, targetId } : null;
},
setRefMap(refMap, refSig) {
const tab = targetId ? tabs.get(targetId) : undefined;
if (!tab) return;
tab.refMap = refMap;
tab.refSig = refSig;
},
resolveRef(ref) {
const tab = targetId ? tabs.get(targetId) : undefined;
return tab?.refMap.get(ref);
},
refSignatures() {
const tab = targetId ? tabs.get(targetId) : undefined;
return tab?.refSig ?? 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 = targetId ? tabs.get(targetId) : undefined;
if (!tab) return null;
const d = tab.dialog;
tab.dialog = null;
return d;
},
drainPageInfoInvalidations() {
const tab = targetId ? tabs.get(targetId) : undefined;
if (!tab) return false;
const dirty = tab.pageInfoDirty;
tab.pageInfoDirty = false;
return dirty;
},
drainNetworkBuffer(filter) {
const tab = targetId ? tabs.get(targetId) : undefined;
if (!tab) return { records: [], total: 0, bufferOverflowed: false };
return tab.networkBuffer.drain(filter);
},
drainConsoleBuffer(filter) {
const tab = targetId ? tabs.get(targetId) : undefined;
if (!tab) return { records: [], total: 0, bufferOverflowed: false };
return tab.consoleBuffer.drain(filter);
},
};
return session;
};
|