refactor(browser): connect commands and contracts to defining owners (#40042)

This commit is contained in:
Neil
2026-11-08 16:44:56 -08:00
committed by GitHub
parent d5aa74110d
commit 6fcaa3c813
51 changed files with 407 additions and 494 deletions
@@ -1,8 +1,8 @@
import type { CdpTabState } from './cdp-tab-state'
import type { WebContents } from 'electron'
import type {
BrowserCaptureStartResult,
BrowserCaptureStopResult,
BrowserConsoleEntry,
BrowserConsoleResult,
BrowserCookie,
BrowserCookieDeleteResult,
@@ -12,27 +12,10 @@ import type {
BrowserInterceptDisableResult,
BrowserInterceptEnableResult,
BrowserInterceptedRequest,
BrowserNetworkEntry,
BrowserNetworkLogResult,
BrowserViewportResult
} from '../../../../shared/runtime-browser-contracts'
import type { CdpCommandSender, SnapshotResult } from '../snapshots/snapshot-engine'
export type CdpTabState = {
navigationId: string | null
snapshotResult: SnapshotResult | null
debuggerAttached: boolean
debuggerDetachListener: (() => void) | null
debuggerMessageListener: ((_event: unknown, method: string, params: unknown) => void) | null
iframeSessions: Map<string, string>
capturing: boolean
consoleLog: BrowserConsoleEntry[]
networkLog: BrowserNetworkEntry[]
intercepting: boolean
interceptPatterns: string[]
pausedRequests: Map<string, BrowserInterceptedRequest>
networkRequestMap: Map<string, BrowserNetworkEntry>
}
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
type ActiveCdpContext = {
guest: WebContents
@@ -1,135 +0,0 @@
import type { WebContents } from 'electron'
import type {
BrowserScreenshotResult,
BrowserScrollResult
} from '../../../../shared/runtime-browser-contracts'
import type { CdpTabState } from './cdp-auxiliary-commands'
import type { CdpCommandSender, RefEntry } from '../snapshots/snapshot-engine'
import type { CdpBridgeState, CdpQueuedCommand } from './cdp-bridge-state'
import type { CdpDebuggerLifecycle } from './cdp-debugger-lifecycle'
import type { CdpNavigationOperations } from './cdp-navigation-operations'
import type { CdpRefResolution } from './cdp-ref-resolution'
export type CdpScrollDirection = BrowserScrollResult extends { scrolled: infer Direction }
? Direction
: never
export type CdpScreenshotFormat = BrowserScreenshotResult extends { format: infer Format }
? Format
: never
export abstract class CdpBridgeCommandModule {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle,
private readonly refResolution: CdpRefResolution,
private readonly navigation: CdpNavigationOperations
) {}
protected get activeWebContentsId(): number | null {
return this.bridgeState.activeWebContentsId
}
protected set activeWebContentsId(webContentsId: number | null) {
this.bridgeState.activeWebContentsId = webContentsId
}
protected get tabState(): Map<string, CdpTabState> {
return this.bridgeState.tabState
}
protected get commandQueues(): Map<string, CdpQueuedCommand[]> {
return this.bridgeState.commandQueues
}
protected getActiveGuest(): WebContents {
return this.bridgeState.getActiveGuest()
}
protected getRegisteredTabs(): Map<string, number> {
return this.bridgeState.getRegisteredTabs()
}
protected resolveTabId(webContentsId: number): string {
return this.bridgeState.resolveTabId(webContentsId)
}
protected resolveTabIdSafe(webContentsId: number): string | null {
return this.bridgeState.resolveTabIdSafe(webContentsId)
}
protected getOrCreateTabState(tabId: string): CdpTabState {
return this.bridgeState.getOrCreateTabState(tabId)
}
protected removeDebuggerListeners(guest: WebContents, state: CdpTabState): void {
this.debuggerLifecycle.removeDebuggerListeners(guest, state)
}
protected ensureDebuggerAttached(guest: WebContents): Promise<void> {
return this.debuggerLifecycle.ensureDebuggerAttached(guest)
}
protected makeCdpSender(guest: WebContents, sessionId?: string): CdpCommandSender {
return this.debuggerLifecycle.makeCdpSender(guest, sessionId)
}
protected senderForRef(guest: WebContents, ref: RefEntry): CdpCommandSender {
return this.refResolution.senderForRef(guest, ref)
}
protected resolveRef(
guest: WebContents,
sender: CdpCommandSender,
ref: string
): Promise<RefEntry> {
return this.refResolution.resolveRef(guest, sender, ref)
}
protected scrollIntoView(sender: CdpCommandSender, backendNodeId: number): Promise<void> {
return this.refResolution.scrollIntoView(sender, backendNodeId)
}
protected getElementCenter(
sender: CdpCommandSender,
backendNodeId: number
): Promise<{ cx: number; cy: number }> {
return this.refResolution.getElementCenter(sender, backendNodeId)
}
protected getPageCoordinates(
guest: WebContents,
refEntry: RefEntry,
localCx: number,
localCy: number
): Promise<{ cx: number; cy: number }> {
return this.refResolution.getPageCoordinates(guest, refEntry, localCx, localCy)
}
protected getNavigationId(sender: CdpCommandSender): Promise<string> {
return this.navigation.getNavigationId(sender)
}
protected getPreviousHistoryEntryId(sender: CdpCommandSender): Promise<number> {
return this.navigation.getPreviousHistoryEntryId(sender)
}
protected waitForLoad(sender: CdpCommandSender, guest: WebContents): Promise<void> {
return this.navigation.waitForLoad(sender, guest)
}
protected waitForNetworkIdle(
guest: WebContents,
timeoutMs: number,
idleMs: number
): Promise<void> {
return this.navigation.waitForNetworkIdle(guest, timeoutMs, idleMs)
}
protected invalidateRefMap(webContentsId: number): void {
this.bridgeState.invalidateRefMap(webContentsId)
}
protected enqueueCommand<T>(execute: () => Promise<T>): Promise<T> {
return this.bridgeState.enqueueCommand(execute)
}
}
@@ -1,8 +1,9 @@
import type { WebContents } from 'electron'
import { CdpAuxiliaryCommands, type CdpTabState } from './cdp-auxiliary-commands'
import type { CdpCommandSender } from '../snapshots/snapshot-engine'
import { CdpAuxiliaryCommands } from './cdp-auxiliary-commands'
import type { CdpTabState } from './cdp-tab-state'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
import type { CdpBridgeState } from './cdp-bridge-state'
import { CdpDebuggerLifecycle } from './cdp-debugger-lifecycle'
import { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import { CdpElementStateCommands } from './cdp-element-state-commands'
import { CdpNavigationOperations } from './cdp-navigation-operations'
import { CdpPageCommands } from './cdp-page-commands'
@@ -23,13 +24,12 @@ export class CdpBridgeCommandSet {
const debuggerLifecycle = new CdpDebuggerLifecycle(bridgeState)
const navigation = new CdpNavigationOperations()
const refResolution = new CdpRefResolution(bridgeState, debuggerLifecycle, navigation)
const moduleArgs = [bridgeState, debuggerLifecycle, refResolution, navigation] as const
this.elements = new CdpElementStateCommands(...moduleArgs)
this.page = new CdpPageCommands(...moduleArgs)
this.pointer = new CdpPointerCommands(...moduleArgs)
this.tabs = new CdpTabCommands(...moduleArgs)
this.textInput = new CdpTextInputCommands(...moduleArgs)
this.elements = new CdpElementStateCommands(bridgeState, debuggerLifecycle, refResolution)
this.page = new CdpPageCommands(bridgeState, debuggerLifecycle, navigation)
this.pointer = new CdpPointerCommands(bridgeState, debuggerLifecycle, refResolution)
this.tabs = new CdpTabCommands(bridgeState, debuggerLifecycle)
this.textInput = new CdpTextInputCommands(bridgeState, debuggerLifecycle, refResolution)
this.auxiliary = new CdpAuxiliaryCommands({
run: <T>(
operation: (context: {
@@ -1,6 +1,6 @@
import { webContents } from 'electron'
import { BrowserError } from '../../browser-error'
import type { CdpTabState } from './cdp-auxiliary-commands'
import type { CdpTabState } from './cdp-tab-state'
export type CdpQueuedCommand = {
execute: () => Promise<unknown>
+2 -1
View File
@@ -34,7 +34,8 @@ import type {
BrowserWaitResult
} from '../../../../shared/runtime-browser-contracts'
import type { BrowserManager } from '../../guest-lifecycle/manager/browser-manager'
import type { CdpAuxiliaryCommands, CdpTabState } from './cdp-auxiliary-commands'
import type { CdpAuxiliaryCommands } from './cdp-auxiliary-commands'
import type { CdpTabState } from './cdp-tab-state'
import { CdpBridgeCommandSet } from './cdp-bridge-command-set'
import { CdpBridgeState } from './cdp-bridge-state'
import type { CdpQueuedCommand } from './cdp-bridge-state'
@@ -3,17 +3,25 @@ import type {
BrowserSelectResult,
BrowserUploadResult
} from '../../../../shared/runtime-browser-contracts'
import { CdpBridgeCommandModule } from './cdp-bridge-command-module'
import type { CdpBridgeState } from './cdp-bridge-state'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import type { CdpRefResolution } from './cdp-ref-resolution'
export class CdpElementStateCommands {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle,
private readonly refResolution: CdpRefResolution
) {}
export class CdpElementStateCommands extends CdpBridgeCommandModule {
uploadFile(element: string, filePaths: string[]): Promise<BrowserUploadResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await refSender('DOM.setFileInputFiles', {
files: filePaths,
backendNodeId: node.backendDOMNodeId
@@ -24,13 +32,13 @@ export class CdpElementStateCommands extends CdpBridgeCommandModule {
}
select(element: string, value: string): Promise<BrowserSelectResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
const { nodeId } = (await refSender('DOM.requestNode', {
backendNodeId: node.backendDOMNodeId
})) as { nodeId: number }
@@ -75,13 +83,13 @@ export class CdpElementStateCommands extends CdpBridgeCommandModule {
}
check(element: string, checked: boolean): Promise<BrowserCheckResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
const { nodeId } = (await refSender('DOM.requestNode', {
backendNodeId: node.backendDOMNodeId
@@ -97,9 +105,12 @@ export class CdpElementStateCommands extends CdpBridgeCommandModule {
})) as { result: { value: boolean } }
if (currentState.value !== checked) {
await this.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.getElementCenter(refSender, node.backendDOMNodeId)
const { cx, cy } = await this.getPageCoordinates(
await this.refResolution.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.refResolution.getElementCenter(
refSender,
node.backendDOMNodeId
)
const { cx, cy } = await this.refResolution.getPageCoordinates(
guest,
node,
localCenter.cx,
@@ -1,6 +1,6 @@
import type { WebContents } from 'electron'
import { BrowserError } from '../../browser-error'
import type { CdpCommandSender } from '../snapshots/snapshot-engine'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
export class CdpNavigationOperations {
async getNavigationId(sender: CdpCommandSender): Promise<string> {
@@ -1,6 +1,7 @@
import type { WebSocket } from 'ws'
import type { WebContents } from 'electron'
import { captureScreenshot, type CapturePaintHold } from './cdp-screenshot'
import { captureScreenshot } from './cdp-screenshot'
import type { CapturePaintHold } from '../debugger/guest-paint-hold'
import { buildPrintToPdfOptions, CdpPdfStreamStore } from './cdp-print-to-pdf'
import type { CdpClientResponseWriter } from '../transport/cdp-client-response-writer'
import { readRemoteCliAdmittedPage } from '../../routing/input-ownership/remote-cli-page-admission'
@@ -8,29 +8,39 @@ import type {
BrowserWaitResult
} from '../../../../shared/runtime-browser-contracts'
import { BrowserError } from '../../browser-error'
import {
CdpBridgeCommandModule,
type CdpScreenshotFormat,
type CdpScrollDirection
} from './cdp-bridge-command-module'
import type { CdpBridgeState } from './cdp-bridge-state'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import type { CdpNavigationOperations } from './cdp-navigation-operations'
import { buildSnapshot } from '../snapshots/snapshot-engine'
export class CdpPageCommands extends CdpBridgeCommandModule {
snapshot(): Promise<BrowserSnapshotResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
type CdpScrollDirection = BrowserScrollResult extends { scrolled: infer Direction }
? Direction
: never
const tabId = this.resolveTabId(guest.id)
const state = this.getOrCreateTabState(tabId)
type CdpScreenshotFormat = BrowserScreenshotResult extends { format: infer Format } ? Format : never
export class CdpPageCommands {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle,
private readonly navigation: CdpNavigationOperations
) {}
snapshot(): Promise<BrowserSnapshotResult> {
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const tabId = this.bridgeState.resolveTabId(guest.id)
const state = this.bridgeState.getOrCreateTabState(tabId)
const result = await buildSnapshot(sender, state.iframeSessions, (sessionId) =>
this.makeCdpSender(guest, sessionId)
this.debuggerLifecycle.makeCdpSender(guest, sessionId)
)
state.snapshotResult = result
const navId = await this.getNavigationId(sender)
const navId = await this.navigation.getNavigationId(sender)
state.navigationId = navId
return {
@@ -44,10 +54,10 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
}
goto(url: string): Promise<BrowserGotoResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const { errorText } = (await sender('Page.navigate', { url })) as {
errorText?: string
@@ -57,18 +67,18 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
throw new BrowserError('browser_navigation_failed', `Navigation failed: ${errorText}`)
}
await this.waitForLoad(sender, guest)
this.invalidateRefMap(guest.id)
await this.navigation.waitForLoad(sender, guest)
this.bridgeState.invalidateRefMap(guest.id)
return { url: guest.getURL(), title: guest.getTitle() }
})
}
scroll(direction: CdpScrollDirection, amount?: number): Promise<BrowserScrollResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
// JS scrolling avoids focus changes and unreliable wheel delivery in Electron webviews.
const expr = amount
@@ -81,19 +91,19 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
}
wait(timeoutMs: number): Promise<BrowserWaitResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
await this.ensureDebuggerAttached(guest)
await this.waitForNetworkIdle(guest, timeoutMs, 500)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
await this.navigation.waitForNetworkIdle(guest, timeoutMs, 500)
return { waited: true }
})
}
pdf(): Promise<BrowserPdfResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const { data } = (await sender('Page.printToPDF', {
printBackground: true
@@ -104,10 +114,10 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
}
fullPageScreenshot(format: CdpScreenshotFormat): Promise<BrowserScreenshotResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const metrics = (await sender('Page.getLayoutMetrics')) as {
cssContentSize?: { width: number; height: number }
@@ -136,40 +146,40 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
}
back(): Promise<{ url: string; title: string }> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
await sender('Page.navigateToHistoryEntry', {
entryId: await this.getPreviousHistoryEntryId(sender)
entryId: await this.navigation.getPreviousHistoryEntryId(sender)
})
await this.waitForLoad(sender, guest)
this.invalidateRefMap(guest.id)
await this.navigation.waitForLoad(sender, guest)
this.bridgeState.invalidateRefMap(guest.id)
return { url: guest.getURL(), title: guest.getTitle() }
})
}
reload(): Promise<{ url: string; title: string }> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
await sender('Page.reload')
await this.waitForLoad(sender, guest)
this.invalidateRefMap(guest.id)
await this.navigation.waitForLoad(sender, guest)
this.bridgeState.invalidateRefMap(guest.id)
return { url: guest.getURL(), title: guest.getTitle() }
})
}
screenshot(format: CdpScreenshotFormat): Promise<BrowserScreenshotResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const { data } = (await sender('Page.captureScreenshot', {
format
@@ -180,10 +190,10 @@ export class CdpPageCommands extends CdpBridgeCommandModule {
}
evaluate(expression: string): Promise<BrowserEvalResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const { result, exceptionDetails } = (await sender('Runtime.evaluate', {
expression,
@@ -1,8 +1,8 @@
import type { WebSocket } from 'ws'
import type { WebContents } from 'electron'
import type { CdpClientResponseWriter } from '../transport/cdp-client-response-writer'
import type { CdpSyntheticSessionRegistry } from './cdp-synthetic-session-registry'
import type { CdpDebuggerChannel } from './cdp-debugger-channel'
import type { CdpSyntheticSessionRegistry } from '../transport/cdp-synthetic-session-registry'
import type { CdpDebuggerChannel } from '../debugger/cdp-debugger-channel'
const LIFECYCLE_PRIMING_TIMEOUT_MS = 1_000
@@ -1,9 +1,10 @@
import type { WebContents } from 'electron'
import { BrowserError } from '../../browser-error'
import type { CdpTabState } from './cdp-auxiliary-commands'
import type { CdpCommandSender, RefEntry } from '../snapshots/snapshot-engine'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
import type { RefEntry } from '../snapshots/snapshot-engine'
import type { CdpBridgeState } from './cdp-bridge-state'
import type { CdpDebuggerLifecycle } from './cdp-debugger-lifecycle'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import type { CdpNavigationOperations } from './cdp-navigation-operations'
export class CdpRefResolution {
@@ -14,12 +15,14 @@ export class CdpRefResolution {
) {}
senderForRef(guest: WebContents, ref: RefEntry): CdpCommandSender {
return ref.sessionId ? this.makeCdpSender(guest, ref.sessionId) : this.makeCdpSender(guest)
return ref.sessionId
? this.debuggerLifecycle.makeCdpSender(guest, ref.sessionId)
: this.debuggerLifecycle.makeCdpSender(guest)
}
async resolveRef(guest: WebContents, sender: CdpCommandSender, ref: string): Promise<RefEntry> {
const tabId = this.resolveTabId(guest.id)
const state = this.getOrCreateTabState(tabId)
const tabId = this.bridgeState.resolveTabId(guest.id)
const state = this.bridgeState.getOrCreateTabState(tabId)
if (!state.snapshotResult) {
throw new BrowserError(
@@ -38,7 +41,7 @@ export class CdpRefResolution {
// Child sessions have independent history; parent navigation IDs cannot validate their refs.
if (!entry.sessionId) {
const currentNavId = await this.getNavigationId(sender)
const currentNavId = await this.navigation.getNavigationId(sender)
if (state.navigationId && currentNavId !== state.navigationId) {
state.snapshotResult = null
state.navigationId = null
@@ -49,7 +52,9 @@ export class CdpRefResolution {
}
}
const refSender = entry.sessionId ? this.makeCdpSender(guest, entry.sessionId) : sender
const refSender = entry.sessionId
? this.debuggerLifecycle.makeCdpSender(guest, entry.sessionId)
: sender
try {
await refSender('DOM.describeNode', { backendNodeId: entry.backendDOMNodeId })
return entry
@@ -94,9 +99,9 @@ export class CdpRefResolution {
guest: WebContents,
sessionId: string
): Promise<{ offsetX: number; offsetY: number }> {
const tabId = this.resolveTabId(guest.id)
const state = this.getOrCreateTabState(tabId)
const parentSender = this.makeCdpSender(guest)
const tabId = this.bridgeState.resolveTabId(guest.id)
const state = this.bridgeState.getOrCreateTabState(tabId)
const parentSender = this.debuggerLifecycle.makeCdpSender(guest)
for (const [targetId, sid] of state.iframeSessions) {
if (sid === sessionId) {
@@ -201,20 +206,4 @@ export class CdpRefResolution {
}
return null
}
private resolveTabId(webContentsId: number): string {
return this.bridgeState.resolveTabId(webContentsId)
}
private getOrCreateTabState(tabId: string): CdpTabState {
return this.bridgeState.getOrCreateTabState(tabId)
}
private makeCdpSender(guest: WebContents, sessionId?: string): CdpCommandSender {
return this.debuggerLifecycle.makeCdpSender(guest, sessionId)
}
private getNavigationId(sender: CdpCommandSender): Promise<string> {
return this.navigation.getNavigationId(sender)
}
}
@@ -1,3 +1,4 @@
import type { CapturePaintHold } from '../debugger/guest-paint-hold'
import type { WebContents } from 'electron'
import { sendGuestCdpCommand } from '../debugger/guest-cdp-command'
import {
@@ -5,9 +6,6 @@ import {
readRemoteCliAdmittedPage
} from '../../routing/input-ownership/remote-cli-page-admission'
/** Draws a hidden guest while a capture or agent input needs its frames; returns its release. */
export type CapturePaintHold = () => () => void
export const SCREENSHOT_TIMEOUT_MS = 8000
// Probe offsets leave time for the original capture to finish before the deadline.
const FRAME_PROBE_OFFSETS_MS = [250, 750, 1750, 3750]
@@ -5,22 +5,28 @@ import type {
BrowserTabSwitchResult
} from '../../../../shared/runtime-browser-contracts'
import { BrowserError } from '../../browser-error'
import { CdpBridgeCommandModule } from './cdp-bridge-command-module'
import type { CdpBridgeState } from './cdp-bridge-state'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
export class CdpTabCommands {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle
) {}
export class CdpTabCommands extends CdpBridgeCommandModule {
setActiveTab(webContentsId: number): void {
this.activeWebContentsId = webContentsId
this.bridgeState.activeWebContentsId = webContentsId
}
getActiveWebContentsId(): number | null {
return this.activeWebContentsId
return this.bridgeState.activeWebContentsId
}
getActivePageId(_worktreeId?: string): string | null {
if (!this.activeWebContentsId) {
if (!this.bridgeState.activeWebContentsId) {
return null
}
return this.resolveTabIdSafe(this.activeWebContentsId)
return this.bridgeState.resolveTabIdSafe(this.bridgeState.activeWebContentsId)
}
getPageInfo(
@@ -31,7 +37,7 @@ export class CdpTabCommands extends CdpBridgeCommandModule {
if (!resolvedPageId) {
return null
}
const webContentsId = this.getRegisteredTabs().get(resolvedPageId)
const webContentsId = this.bridgeState.getRegisteredTabs().get(resolvedPageId)
if (webContentsId == null) {
return null
}
@@ -50,7 +56,7 @@ export class CdpTabCommands extends CdpBridgeCommandModule {
const tabs: BrowserTabInfo[] = []
let index = 0
for (const [tabId, wcId] of this.getRegisteredTabs()) {
for (const [tabId, wcId] of this.bridgeState.getRegisteredTabs()) {
const guest = webContents.fromId(wcId)
if (!guest || guest.isDestroyed()) {
continue
@@ -60,7 +66,7 @@ export class CdpTabCommands extends CdpBridgeCommandModule {
index,
url: guest.getURL(),
title: guest.getTitle(),
active: wcId === this.activeWebContentsId
active: wcId === this.bridgeState.activeWebContentsId
})
index++
}
@@ -70,7 +76,7 @@ export class CdpTabCommands extends CdpBridgeCommandModule {
tabSwitch(index: number): BrowserTabSwitchResult {
// Keep indices aligned with tabList(), which skips destroyed guests.
const liveEntries = [...this.getRegisteredTabs()].filter(([_tabId, wcId]) => {
const liveEntries = [...this.bridgeState.getRegisteredTabs()].filter(([_tabId, wcId]) => {
const guest = webContents.fromId(wcId)
return guest && !guest.isDestroyed()
})
@@ -82,31 +88,31 @@ export class CdpTabCommands extends CdpBridgeCommandModule {
}
const [tabId, wcId] = liveEntries[index]
if (this.activeWebContentsId !== null) {
this.invalidateRefMap(this.activeWebContentsId)
if (this.bridgeState.activeWebContentsId !== null) {
this.bridgeState.invalidateRefMap(this.bridgeState.activeWebContentsId)
}
this.activeWebContentsId = wcId
this.bridgeState.activeWebContentsId = wcId
return { switched: index, browserPageId: tabId }
}
onTabClosed(webContentsId: number): void {
if (this.activeWebContentsId === webContentsId) {
this.activeWebContentsId = null
if (this.bridgeState.activeWebContentsId === webContentsId) {
this.bridgeState.activeWebContentsId = null
}
const tabId = this.resolveTabIdSafe(webContentsId)
const tabId = this.bridgeState.resolveTabIdSafe(webContentsId)
if (tabId) {
const state = this.tabState.get(tabId)
const state = this.bridgeState.tabState.get(tabId)
const guest = webContents.fromId(webContentsId)
if (state && guest) {
this.removeDebuggerListeners(guest, state)
this.debuggerLifecycle.removeDebuggerListeners(guest, state)
}
this.tabState.delete(tabId)
this.commandQueues.delete(tabId)
this.bridgeState.tabState.delete(tabId)
this.bridgeState.commandQueues.delete(tabId)
}
}
onTabChanged(webContentsId: number): void {
this.activeWebContentsId = webContentsId
this.bridgeState.activeWebContentsId = webContentsId
}
}
@@ -0,0 +1,22 @@
import type {
BrowserConsoleEntry,
BrowserInterceptedRequest,
BrowserNetworkEntry
} from '../../../../shared/runtime-browser-contracts'
import type { SnapshotResult } from '../snapshots/snapshot-engine'
export type CdpTabState = {
navigationId: string | null
snapshotResult: SnapshotResult | null
debuggerAttached: boolean
debuggerDetachListener: (() => void) | null
debuggerMessageListener: ((_event: unknown, method: string, params: unknown) => void) | null
iframeSessions: Map<string, string>
capturing: boolean
consoleLog: BrowserConsoleEntry[]
networkLog: BrowserNetworkEntry[]
intercepting: boolean
interceptPatterns: string[]
pausedRequests: Map<string, BrowserInterceptedRequest>
networkRequestMap: Map<string, BrowserNetworkEntry>
}
@@ -0,0 +1,4 @@
export type CdpCommandSender = (
method: string,
params?: Record<string, unknown>
) => Promise<unknown>
@@ -1,12 +1,9 @@
import { WebSocket } from 'ws'
import type { WebContents } from 'electron'
import {
acquireElectronDebugger,
type ElectronDebuggerLease
} from '../debugger/electron-debugger-lease'
import { acquireElectronDebugger, type ElectronDebuggerLease } from './electron-debugger-lease'
import type { CdpClientResponseWriter } from '../transport/cdp-client-response-writer'
import type { CdpSyntheticSessionRegistry } from './cdp-synthetic-session-registry'
import { sendGuestCdpCommand } from '../debugger/guest-cdp-command'
import type { CdpSyntheticSessionRegistry } from '../transport/cdp-synthetic-session-registry'
import { sendGuestCdpCommand } from './guest-cdp-command'
import { isOrcaFrameSessionTraffic } from '../input/guest-frame-input-sessions'
export class CdpDebuggerChannel {
@@ -1,6 +1,6 @@
import type { WebContents } from 'electron'
import type { BrowserNetworkEntry } from '../../../../shared/runtime-browser-contracts'
import type { CdpTabState } from './cdp-auxiliary-commands'
import type { CdpTabState } from '../commands/cdp-tab-state'
const CAPTURE_LOG_LIMIT = 1000
@@ -1,10 +1,10 @@
import type { WebContents } from 'electron'
import { BrowserError } from '../../browser-error'
import type { CdpTabState } from './cdp-auxiliary-commands'
import type { CdpCommandSender } from '../snapshots/snapshot-engine'
import type { CdpBridgeState } from './cdp-bridge-state'
import type { CdpTabState } from '../commands/cdp-tab-state'
import type { CdpCommandSender } from './cdp-command-sender'
import type { CdpBridgeState } from '../commands/cdp-bridge-state'
import { createCdpDebuggerMessageListener } from './cdp-debugger-events'
import { sendGuestCdpCommand } from '../debugger/guest-cdp-command'
import { sendGuestCdpCommand } from './guest-cdp-command'
export class CdpDebuggerLifecycle {
constructor(private readonly bridgeState: CdpBridgeState) {}
@@ -1,5 +1,5 @@
import type { WebContents } from 'electron'
import type { CapturePaintHold } from '../commands/cdp-screenshot'
import type { CapturePaintHold } from './guest-paint-hold'
import { isEmbeddedGuest } from '../input/guest-direct-key-input'
import {
readRecord,
@@ -0,0 +1,2 @@
/** Draws a hidden guest while a capture or agent input needs its frames; returns its release. */
export type CapturePaintHold = () => () => void
@@ -1,6 +1,6 @@
import { iterateBrowserTextInsertionChunks } from '../../../../shared/browser-text-insertion-chunks'
import { yieldToEventLoop } from '../../../../shared/event-loop-yield'
import type { CdpCommandSender } from '../snapshots/snapshot-engine'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
export async function insertTextThroughCdp(
sender: CdpCommandSender,
@@ -1,8 +1,8 @@
import type { WebSocket } from 'ws'
import type { WebContents } from 'electron'
import type { CdpClientResponseWriter } from '../transport/cdp-client-response-writer'
import type { CdpDebuggerChannel } from './cdp-debugger-channel'
import type { TextInsertionRoute } from '../input/guest-direct-key-input'
import type { CdpDebuggerChannel } from '../debugger/cdp-debugger-channel'
import type { TextInsertionRoute } from './guest-direct-key-input'
/** Replay DOM.focus before insertion because native focusing can blur the target. */
export class CdpDomFocusReplay {
@@ -1,23 +1,23 @@
import type { WebSocket } from 'ws'
import type { WebContents } from 'electron'
import type { CdpClientResponseWriter } from '../transport/cdp-client-response-writer'
import type { CdpDebuggerChannel } from './cdp-debugger-channel'
import type { CdpDebuggerChannel } from '../debugger/cdp-debugger-channel'
import type { CdpDomFocusReplay } from './cdp-dom-focus-replay'
import {
enablePageFocusEmulation,
isFocusRoutedCdpInput,
isFocusTakingCdpInput,
type AgentInputFocusGuard
} from '../input/agent-input-focus-guard'
} from './agent-input-focus-guard'
import {
dispatchPageKeyEvent,
isEmbeddedGuest,
routePageTextInsertion
} from '../input/guest-direct-key-input'
import type { GuestSessionCdpSender } from '../input/guest-frame-input-sessions'
import { withAgentInputInjection } from '../input/agent-input-injection'
} from './guest-direct-key-input'
import type { GuestSessionCdpSender } from './guest-frame-input-sessions'
import { withAgentInputInjection } from './agent-input-injection'
import type { AgentPointerInput } from '../../guest-lifecycle/page-activity/browser-agent-activity'
import type { CapturePaintHold } from './cdp-screenshot'
import type { CapturePaintHold } from '../debugger/guest-paint-hold'
import { waitForGuestFirstPaint } from '../debugger/guest-first-paint'
/** Shows the agent's pointer at an input's point and resolves once it has landed. */
@@ -3,21 +3,37 @@ import type {
BrowserDragResult,
BrowserHoverResult
} from '../../../../shared/runtime-browser-contracts'
import { CdpBridgeCommandModule } from '../commands/cdp-bridge-command-module'
import type { CdpBridgeState } from '../commands/cdp-bridge-state'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import type { CdpRefResolution } from '../commands/cdp-ref-resolution'
export class CdpPointerCommands {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle,
private readonly refResolution: CdpRefResolution
) {}
export class CdpPointerCommands extends CdpBridgeCommandModule {
click(element: string): Promise<BrowserClickResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await this.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.getElementCenter(refSender, node.backendDOMNodeId)
const { cx, cy } = await this.getPageCoordinates(guest, node, localCenter.cx, localCenter.cy)
await this.refResolution.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.refResolution.getElementCenter(
refSender,
node.backendDOMNodeId
)
const { cx, cy } = await this.refResolution.getPageCoordinates(
guest,
node,
localCenter.cx,
localCenter.cy
)
// Reveal hover-dependent targets before clicking.
await sender('Input.dispatchMouseEvent', { type: 'mouseMoved', x: cx, y: cy })
@@ -41,16 +57,24 @@ export class CdpPointerCommands extends CdpBridgeCommandModule {
}
hover(element: string): Promise<BrowserHoverResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
await this.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.getElementCenter(refSender, node.backendDOMNodeId)
const { cx, cy } = await this.getPageCoordinates(guest, node, localCenter.cx, localCenter.cy)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await this.refResolution.scrollIntoView(refSender, node.backendDOMNodeId)
const localCenter = await this.refResolution.getElementCenter(
refSender,
node.backendDOMNodeId
)
const { cx, cy } = await this.refResolution.getPageCoordinates(
guest,
node,
localCenter.cx,
localCenter.cy
)
await sender('Input.dispatchMouseEvent', { type: 'mouseMoved', x: cx, y: cy })
@@ -59,21 +83,29 @@ export class CdpPointerCommands extends CdpBridgeCommandModule {
}
drag(fromElement: string, toElement: string): Promise<BrowserDragResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const fromNode = await this.resolveRef(guest, sender, fromElement)
const toNode = await this.resolveRef(guest, sender, toElement)
const fromSender = this.senderForRef(guest, fromNode)
const toSender = this.senderForRef(guest, toNode)
const fromNode = await this.refResolution.resolveRef(guest, sender, fromElement)
const toNode = await this.refResolution.resolveRef(guest, sender, toElement)
const fromSender = this.refResolution.senderForRef(guest, fromNode)
const toSender = this.refResolution.senderForRef(guest, toNode)
await this.scrollIntoView(fromSender, fromNode.backendDOMNodeId)
const fromLocal = await this.getElementCenter(fromSender, fromNode.backendDOMNodeId)
const from = await this.getPageCoordinates(guest, fromNode, fromLocal.cx, fromLocal.cy)
const toLocal = await this.getElementCenter(toSender, toNode.backendDOMNodeId)
const to = await this.getPageCoordinates(guest, toNode, toLocal.cx, toLocal.cy)
await this.refResolution.scrollIntoView(fromSender, fromNode.backendDOMNodeId)
const fromLocal = await this.refResolution.getElementCenter(
fromSender,
fromNode.backendDOMNodeId
)
const from = await this.refResolution.getPageCoordinates(
guest,
fromNode,
fromLocal.cx,
fromLocal.cy
)
const toLocal = await this.refResolution.getElementCenter(toSender, toNode.backendDOMNodeId)
const to = await this.refResolution.getPageCoordinates(guest, toNode, toLocal.cx, toLocal.cy)
// Intermediate drag events are required by many drag-and-drop libraries.
await sender('Input.dispatchMouseEvent', { type: 'mouseMoved', x: from.cx, y: from.cy })
@@ -7,17 +7,25 @@ import type {
BrowserTypeResult
} from '../../../../shared/runtime-browser-contracts'
import { insertTextThroughCdp } from './browser-text-insertion'
import { CdpBridgeCommandModule } from '../commands/cdp-bridge-command-module'
import type { CdpBridgeState } from '../commands/cdp-bridge-state'
import type { CdpDebuggerLifecycle } from '../debugger/cdp-debugger-lifecycle'
import type { CdpRefResolution } from '../commands/cdp-ref-resolution'
export class CdpTextInputCommands {
constructor(
private readonly bridgeState: CdpBridgeState,
private readonly debuggerLifecycle: CdpDebuggerLifecycle,
private readonly refResolution: CdpRefResolution
) {}
export class CdpTextInputCommands extends CdpBridgeCommandModule {
fill(element: string, value: string): Promise<BrowserFillResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await refSender('DOM.focus', { backendNodeId: node.backendDOMNodeId })
@@ -54,10 +62,10 @@ export class CdpTextInputCommands extends CdpBridgeCommandModule {
}
type(input: string): Promise<BrowserTypeResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
await insertTextThroughCdp(sender, input)
return { typed: true }
@@ -65,13 +73,13 @@ export class CdpTextInputCommands extends CdpBridgeCommandModule {
}
focus(element: string): Promise<BrowserFocusResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await refSender('DOM.focus', { backendNodeId: node.backendDOMNodeId })
return { focused: element }
@@ -79,13 +87,13 @@ export class CdpTextInputCommands extends CdpBridgeCommandModule {
}
clear(element: string): Promise<BrowserClearResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
const { nodeId } = (await refSender('DOM.requestNode', {
backendNodeId: node.backendDOMNodeId
@@ -108,13 +116,13 @@ export class CdpTextInputCommands extends CdpBridgeCommandModule {
}
selectAll(element: string): Promise<BrowserSelectAllResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const node = await this.resolveRef(guest, sender, element)
const refSender = this.senderForRef(guest, node)
const node = await this.refResolution.resolveRef(guest, sender, element)
const refSender = this.refResolution.senderForRef(guest, node)
await refSender('DOM.focus', { backendNodeId: node.backendDOMNodeId })
await sender('Input.dispatchKeyEvent', {
@@ -133,10 +141,10 @@ export class CdpTextInputCommands extends CdpBridgeCommandModule {
}
keypress(key: string): Promise<BrowserKeypressResult> {
return this.enqueueCommand(async () => {
const guest = this.getActiveGuest()
const sender = this.makeCdpSender(guest)
await this.ensureDebuggerAttached(guest)
return this.bridgeState.enqueueCommand(async () => {
const guest = this.bridgeState.getActiveGuest()
const sender = this.debuggerLifecycle.makeCdpSender(guest)
await this.debuggerLifecycle.ensureDebuggerAttached(guest)
const keyDef = resolveKeyDefinition(key)
await sender('Input.dispatchKeyEvent', {
@@ -1,5 +1,5 @@
import type { SnapshotEntry } from './snapshot-ax-tree-walk'
import type { CdpCommandSender } from './snapshot-engine'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
// Find controls omitted from the accessibility tree, such as styled div buttons.
export async function findCursorInteractiveElements(
@@ -1,5 +1,6 @@
import { describe, expect, it, vi } from 'vitest'
import { buildSnapshot, type CdpCommandSender } from './snapshot-engine'
import { buildSnapshot } from './snapshot-engine'
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
type AXNode = {
nodeId: string
@@ -1,12 +1,8 @@
import type { CdpCommandSender } from '../debugger/cdp-command-sender'
import type { BrowserSnapshotRef } from '../../../../shared/runtime-browser-contracts'
import { walkTree, type AXNode, type SnapshotEntry } from './snapshot-ax-tree-walk'
import { findCursorInteractiveElements } from './snapshot-cursor-interactive-elements'
export type CdpCommandSender = (
method: string,
params?: Record<string, unknown>
) => Promise<unknown>
export type RefEntry = {
backendDOMNodeId: number
role: string
@@ -2,7 +2,7 @@ import type { WebSocket } from 'ws'
import type { ServerResponse } from 'node:http'
import type { WebContents } from 'electron'
import type { CdpClientResponseWriter } from './cdp-client-response-writer'
import type { CdpSyntheticSessionRegistry } from '../commands/cdp-synthetic-session-registry'
import type { CdpSyntheticSessionRegistry } from './cdp-synthetic-session-registry'
export class CdpTargetDiscovery {
constructor(
@@ -3,18 +3,18 @@ import { createServer, type Server } from 'node:http'
import { randomBytes } from 'node:crypto'
import type { WebContents } from 'electron'
import { CdpClientResponseWriter } from './cdp-client-response-writer'
import { CdpSyntheticSessionRegistry } from '../commands/cdp-synthetic-session-registry'
import { CdpSyntheticSessionRegistry } from './cdp-synthetic-session-registry'
import { CdpTargetDiscovery } from './cdp-target-discovery'
import { CdpDebuggerChannel } from '../commands/cdp-debugger-channel'
import { CdpDebuggerChannel } from '../debugger/cdp-debugger-channel'
import { CdpPageNavigationCommands } from '../commands/cdp-page-navigation-commands'
import { CdpDomFocusReplay } from '../commands/cdp-dom-focus-replay'
import { CdpDomFocusReplay } from '../input/cdp-dom-focus-replay'
import { CdpElementCapture } from '../commands/cdp-element-capture'
import { CdpPageCaptureCommands } from '../commands/cdp-page-capture-commands'
import type { CapturePaintHold } from '../commands/cdp-screenshot'
import type { CapturePaintHold } from '../debugger/guest-paint-hold'
import type { AgentInputFocusGuard } from '../input/agent-input-focus-guard'
import { CdpPageInputCommands, type ShowAgentPointer } from '../commands/cdp-page-input-commands'
import { CdpPageInputCommands, type ShowAgentPointer } from '../input/cdp-page-input-commands'
import { admitCdpProxyRequest, verifyCdpProxyUpgrade } from './cdp-loopback-request-guard'
import { parseCdpClientCommand } from '../commands/cdp-client-command'
import { parseCdpClientCommand } from './cdp-client-command'
import {
assertRemoteCliPageAccess,
runUnderRemoteCliPageAdmission
@@ -11,7 +11,7 @@ import {
closeBrowserClientHostComposition,
fenceBrowserClientHostComposition
} from './paired-runtime-browser-client-host-teardown'
import type { BrowserClientPageNetworkRoute } from '../../client-pages/lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientPageAuthorityIdentity as BrowserClientHostAuthorityTransitionInput } from '../../client-pages/execution/browser-client-page-command-executor-dependencies'
import {
type ComposedBrowserClientNetworkRoutes,
@@ -1,5 +1,5 @@
import type { BrowserClientHostLeaseAuthority } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type { BrowserClientPageNetworkRoute } from '../../client-pages/lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import { sameBrowserClientHostLeaseAuthority } from '../commands/browser-client-host-command-authority'
export type ComposedBrowserClientNetworkRoutes = {
@@ -1,21 +1,6 @@
import type { BrowserClientHostCommandEvent } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type {
BrowserClientPageRenderer,
BrowserClientPageRendererIdentity
} from '../lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import { BrowserClientPageCommandError } from './browser-client-page-command-failure'
export function browserClientPageIdentity(
page: Pick<BrowserClientHostCommandEvent, 'browserPageId' | 'pageHostGeneration'>,
partition: string
): BrowserClientPageRendererIdentity {
return {
partition,
browserPageId: page.browserPageId,
pageHostGeneration: page.pageHostGeneration
}
}
export function assertCurrentBrowserClientPageRenderer(renderer: BrowserClientPageRenderer): void {
if (
!Number.isInteger(renderer.rendererWebContentsId) ||
@@ -2,10 +2,8 @@ import type { BrowserClientAutomationMethod } from '../../../../shared/browser/c
import type { BrowserClientFileChannelTransport } from '../../client-hosts/file-transfers/browser-client-file-channel-transport'
import type { BrowserClientPageGuestBinding } from '../lifecycle/browser-client-page-guest-binding'
import type { BrowserClientUploadStaging } from '../../client-hosts/file-transfers/browser-client-upload-staging'
import type {
BrowserClientPageNetworkRoute,
BrowserClientPageRenderer
} from '../lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import type { BrowserRouteSessionRegistry } from '../../routing/sessions/browser-route-session-registry'
import type {
BrowserClientPageLifecycleRegistry,
@@ -9,10 +9,8 @@ import {
type BrowserClientHostCommandEvent
} from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type { BrowserClientAutomationResult as BrowserClientHostCommandResult } from '../../../../shared/browser/client-hosting/browser-client-automation-protocol'
import {
cleanupRetainedBrowserClientPage,
type BrowserClientPageRendererIdentity
} from '../lifecycle/browser-client-page-cleanup'
import { cleanupRetainedBrowserClientPage } from '../lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageRendererIdentity } from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
import { assertBrowserClientPageAdmission } from '../lifecycle/browser-client-page-admission'
import { createReservedBrowserClientPage } from '../lifecycle/browser-client-page-creation'
import { retireSupersededExecutionHostPages } from '../lifecycle/browser-client-page-execution-host-supersession'
@@ -279,7 +277,7 @@ export class BrowserClientPageCommandExecutor {
private async cleanupPage(
page: BrowserClientRetainedPage,
previousRendererPage?: BrowserClientPageRendererIdentity,
previousRendererPage?: Readonly<BrowserClientPageRendererIdentity>,
releaseUploads = true
): Promise<void> {
page.releaseAvailabilityWatch?.()
@@ -1,47 +1,19 @@
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import type { BrowserClientPageRendererIdentity } from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
import type { BrowserRouteGuestLifecycleClaim } from '../../routing/guest-authority/browser-route-page-authority'
import type { BrowserRouteSessionHandle } from '../../routing/sessions/browser-route-session-state'
import type { BrowserRouteProxyEndpoint } from '../../routing/sessions/browser-route-session-policy'
import type { BrowserRouteWebContentsRegistry } from '../../routing/guest-authority/browser-route-webcontents-registry'
import { browserClientPageIdentity } from '../execution/browser-client-page-command-admission'
import { browserClientPageIdentity } from '../renderer/browser-client-page-renderer-contract'
import type { BrowserClientRetainedPage } from './browser-client-page-retained-state'
export type BrowserClientPageNetworkRoute = {
key: string
executionHostIdentity: string
/** Pre-migration identity of the same host, so its existing partition can be adopted. */
legacyExecutionHostIdentity: string
proxyEndpoint: BrowserRouteProxyEndpoint
release(): void | Promise<void>
}
export type BrowserClientPageRendererIdentity = Readonly<{
partition: string
browserPageId: string
pageHostGeneration: number
}>
export type BrowserClientPageRenderer = {
rendererWebContentsId: number
isCurrent(): boolean
mountPage(
page: BrowserClientPageRendererIdentity,
signal: AbortSignal
): Promise<{ webContentsId: number }>
rekeyPage?(
previous: BrowserClientPageRendererIdentity,
next: BrowserClientPageRendererIdentity,
signal: AbortSignal
): Promise<void>
retirePage(page: BrowserClientPageRendererIdentity): void | Promise<void>
}
export async function cleanupBrowserClientPage(
routeWebContents: Pick<BrowserRouteWebContentsRegistry, 'beginGuestRetirement'>,
target: {
guestMayExist: boolean
lifecycleClaim: BrowserRouteGuestLifecycleClaim | null
renderer: BrowserClientPageRenderer | null
rendererPages: readonly BrowserClientPageRendererIdentity[]
rendererPages: readonly Readonly<BrowserClientPageRendererIdentity>[]
routeSession: BrowserRouteSessionHandle | null
route: BrowserClientPageNetworkRoute | null
}
@@ -94,7 +66,7 @@ export async function cleanupRetainedBrowserClientPage(
}): Promise<void>
releaseUploadStaging?(): void | Promise<void>
},
previousRendererPage?: BrowserClientPageRendererIdentity
previousRendererPage?: Readonly<BrowserClientPageRendererIdentity>
): Promise<void> {
const failures: unknown[] = []
try {
@@ -1,14 +1,12 @@
import type { BrowserClientHostCommandEvent } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import {
cleanupBrowserClientPage,
type BrowserClientPageNetworkRoute as RetainedNetworkRoute,
type BrowserClientPageRenderer
} from './browser-client-page-cleanup'
import { cleanupBrowserClientPage } from './browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute as RetainedNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import {
assertBrowserClientPageCommandNotAborted,
assertCurrentBrowserClientPageRenderer,
browserClientPageIdentity
assertCurrentBrowserClientPageRenderer
} from '../execution/browser-client-page-command-admission'
import { browserClientPageIdentity } from '../renderer/browser-client-page-renderer-contract'
import type { BrowserClientPageAuthorityIdentity } from '../execution/browser-client-page-command-executor-dependencies'
import { BrowserClientPageCommandError } from '../execution/browser-client-page-command-failure'
import type { BrowserClientPageGuestBinding } from './browser-client-page-guest-binding'
@@ -1,4 +1,4 @@
import type { BrowserClientPageNetworkRoute } from './browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientRetainedPage } from './browser-client-page-retained-state'
type SupersedingRoute = Pick<BrowserClientPageNetworkRoute, 'key' | 'executionHostIdentity'>
@@ -8,7 +8,7 @@ import {
type BrowserClientHostCommandEvent
} from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import { BrowserClientPageMetadataParams } from '../../../../shared/browser/client-hosting/browser-client-page-metadata-protocol'
import type { BrowserClientPageRenderer } from './browser-client-page-cleanup'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import { BrowserClientPageCommandError } from '../execution/browser-client-page-command-failure'
import type { BrowserRouteGuestLifecycleClaim } from '../../routing/guest-authority/browser-route-page-authority'
@@ -4,9 +4,9 @@ import type {
} from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import {
assertBrowserClientPageCommandNotAborted,
assertCurrentBrowserClientPageRenderer,
browserClientPageIdentity
assertCurrentBrowserClientPageRenderer
} from '../execution/browser-client-page-command-admission'
import { browserClientPageIdentity } from '../renderer/browser-client-page-renderer-contract'
import { sameBrowserClientPageAuthority } from '../../client-hosts/commands/browser-client-host-command-authority'
import { BrowserClientPageCommandError } from '../execution/browser-client-page-command-failure'
import {
@@ -17,7 +17,7 @@ import type {
BrowserClientPageLifecycleRegistry,
BrowserClientRetainedPage
} from './browser-client-page-retained-state'
import type { BrowserClientPageRendererIdentity } from './browser-client-page-cleanup'
import type { BrowserClientPageRendererIdentity } from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
type BrowserClientPageReconciliationContext = {
pages: Map<string, BrowserClientRetainedPage>
@@ -29,7 +29,7 @@ type BrowserClientPageReconciliationContext = {
retirePage: (browserPageId: string, pageHostGeneration: number) => Promise<boolean>
cleanupPage: (
page: BrowserClientRetainedPage,
previousRendererPage?: BrowserClientPageRendererIdentity
previousRendererPage?: Readonly<BrowserClientPageRendererIdentity>
) => Promise<void>
}
@@ -200,7 +200,7 @@ async function failClosedRekeyedPage(
context: BrowserClientPageReconciliationContext,
page: BrowserClientRetainedPage,
error: unknown,
previousRendererPage?: BrowserClientPageRendererIdentity
previousRendererPage?: Readonly<BrowserClientPageRendererIdentity>
): Promise<never> {
page.reconciling = false
page.retiring ??= context.cleanupPage(page, previousRendererPage)
@@ -1,8 +1,6 @@
import type { BrowserClientHostedPageInventory } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type {
BrowserClientPageNetworkRoute,
BrowserClientPageRenderer
} from './browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from '../../network/client-routes/browser-client-page-network-route'
import type { BrowserClientPageRenderer } from '../renderer/browser-client-page-renderer-contract'
import type {
BrowserRouteGuestLifecycleClaim,
BrowserRoutePageGuestIdentity
@@ -8,7 +8,7 @@ import {
type BrowserClientPageRendererReply as RendererReply,
type BrowserClientPageRendererRequest as RendererRequest
} from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
import type { BrowserClientPageRenderer } from '../lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageRenderer } from './browser-client-page-renderer-contract'
import {
readCurrentRendererFrame,
readRendererReplyRequestId,
@@ -0,0 +1,28 @@
import type { BrowserClientHostCommandEvent } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type { BrowserClientPageRendererIdentity } from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
export type BrowserClientPageRenderer = {
rendererWebContentsId: number
isCurrent(): boolean
mountPage(
page: Readonly<BrowserClientPageRendererIdentity>,
signal: AbortSignal
): Promise<{ webContentsId: number }>
rekeyPage?(
previous: Readonly<BrowserClientPageRendererIdentity>,
next: Readonly<BrowserClientPageRendererIdentity>,
signal: AbortSignal
): Promise<void>
retirePage(page: Readonly<BrowserClientPageRendererIdentity>): void | Promise<void>
}
export function browserClientPageIdentity(
page: Pick<BrowserClientHostCommandEvent, 'browserPageId' | 'pageHostGeneration'>,
partition: string
): Readonly<BrowserClientPageRendererIdentity> {
return {
partition,
browserPageId: page.browserPageId,
pageHostGeneration: page.pageHostGeneration
}
}
@@ -1,6 +1,6 @@
import { ipcMain } from 'electron'
import { BROWSER_CLIENT_PAGE_RENDERER_REPLY_CHANNEL } from '../../../../shared/browser/client-hosting/browser-client-page-renderer-protocol'
import type { BrowserClientPageRenderer } from '../lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageRenderer } from './browser-client-page-renderer-contract'
import { BrowserClientPageRendererBridgeRegistry } from './browser-client-page-renderer-bridge'
import type { BrowserClientPageRendererEndpoint } from './browser-client-page-renderer-reply-admission'
@@ -20,6 +20,7 @@ import {
} from './doc-preview-grant-registry'
import { getRuntimeEnvironmentRegistryRoot } from '../../ipc/runtime-environments/runtime-environment-registry-root'
import { readDocPreviewTerminalFile } from './doc-preview-terminal-file-reader'
import type { RuntimeDocPreviewReadParams } from './doc-preview-runtime-read-contract'
const DOC_PREVIEW_READ_TIMEOUT_MS = 15_000
// Why: under files.readDocPreviewChunk's 512 KiB cap, and a multiple of 3 so its base64 has no padding.
@@ -109,14 +110,6 @@ function toOutcome(source: PreviewFileBytes, contentType: string): DocPreviewRea
: UNSUPPORTED_ASSET_OUTCOME
}
export type RuntimeDocPreviewReadParams = {
worktree: string
relativePath: string
entryRelativePath: string
implicitRootRelativePath: string | null
authorizedRootRelativePaths: string[]
}
async function readRuntimeDocPreviewFile(
environmentId: string,
params: RuntimeDocPreviewReadParams
@@ -0,0 +1,7 @@
export type RuntimeDocPreviewReadParams = {
worktree: string
relativePath: string
entryRelativePath: string
implicitRootRelativePath: string | null
authorizedRootRelativePaths: string[]
}
@@ -8,7 +8,7 @@ import {
toRuntimeWorktreeRelativePath,
type DocPreviewGrant
} from './doc-preview-grant-registry'
import type { RuntimeDocPreviewReadParams } from './doc-preview-file-reader'
import type { RuntimeDocPreviewReadParams } from './doc-preview-runtime-read-contract'
import { resolveEnvironment } from '../../../shared/remote-runtime/host-store/runtime-environment-store'
const TIMEOUT_MS = 15_000
@@ -1,6 +1,6 @@
import type { BrowserHostLeaseAuthority } from '../../../../shared/browser/client-hosting/browser-client-host-protocol'
import type { BrowserNetworkExecutionHost } from '../../../../shared/browser/client-hosting/browser-network-execution-host'
import type { BrowserClientPageNetworkRoute } from '../../client-pages/lifecycle/browser-client-page-cleanup'
import type { BrowserClientPageNetworkRoute } from './browser-client-page-network-route'
import {
assertBrowserClientNetworkRouteAddress,
sameBrowserClientNetworkRouteAddress
@@ -0,0 +1,10 @@
import type { BrowserRouteProxyEndpoint } from '../../routing/sessions/browser-route-session-policy'
export type BrowserClientPageNetworkRoute = {
key: string
executionHostIdentity: string
/** Pre-migration identity of the same host, so its existing partition can be adopted. */
legacyExecutionHostIdentity: string
proxyEndpoint: BrowserRouteProxyEndpoint
release(): void | Promise<void>
}