Files
orca/config/scripts/mobile-web-app/preview/mobile-web-app-preview-frame-readiness.mjs
OrcaWinandOrcaWin 7d6603aa17 [comment audit] Complete repository-wide comment cleanup (#33249)
* [comment audit] Align legacy failure-read counts with cached display

* [comment audit] Condense shared provider lifecycle and browser recovery comments [skip ci]

* [comment audit] Condense shared generation, path and preview comments [skip ci]

* [comment audit] Condense host, file and Git contract rationale [skip ci]

* [comment audit] Tighten Git lifecycle and provider contract comments [skip ci]

* [comment audit] Clarify shared host authority and launch isolation [skip ci]

* [comment audit] simplify local access mobile and native chat contracts [skip ci]

* [comment audit] simplify native chat presentation and state contracts [skip ci]

* [comment audit] simplify native runtime and provider contracts [skip ci]

* [comment audit] simplify migration and orchestration contracts [skip ci]

* [comment audit] simplify plugin trust and process capture rationale [skip ci]

* [comment audit] simplify terminal delivery and remote compatibility rationale [skip ci]

* [comment audit] clarify remote recovery and launch wire rationale [skip ci]

* [comment audit] shorten shared RPC compatibility and runtime evidence comments [skip ci]

* [comment audit] simplify secure storage shell startup and sidebar rationale [skip ci]

* [comment audit] clarify sidebar, skill and SSH invariants [skip ci]

* [comment audit] condense structured chat delivery and timing rationale [skip ci]

* [comment audit] condense terminal replay and telemetry invariants [skip ci]

* [comment audit] clarify launch permission and terminal delivery rationale [skip ci]

* [comment audit] clarify workspace ownership and layout contracts [skip ci]

* [comment audit] wait for fitted and painted SSH terminal links

* [comment audit] clarify layout persistence and session ownership [skip ci]

* [comment audit] clarify host routing and workspace lifecycle contracts [skip ci]

* [comment audit] clarify startup persistence and app lifetime comments [skip ci]

* [comment audit] clarify recovery and activity boundaries [skip ci]

* [comment audit] condense activity and artifact invariants [skip ci]

* [comment audit] condense automation authority contracts [skip ci]

* [comment audit] simplify automation scheduling and history contracts [skip ci]

* [comment audit] clarify browser chrome and annotation lifecycles [skip ci]

* [comment audit] clarify browser routing and retained guest ownership [skip ci]

* [comment audit] clarify browser recovery and document ownership comments [skip ci]

* [comment audit] restore hosted runners required by native IME fixtures

* [comment audit] shorten preview, palette and dashboard invariants [skip ci]

* [comment audit] clarify terminal preview, dashboard and retention comments [skip ci]

* [comment audit] clarify diff-note recovery and editor lifecycle comments [skip ci]

* [comment audit] shorten rich-text and combined-diff ownership comments [skip ci]

* [comment audit] shorten autosave, draft recovery and model ownership comments [skip ci]

* [comment audit] shorten save-queue, notebook and Markdown constraints [skip ci]

* [comment audit] shorten Monaco, PDF and rich Markdown safeguards [skip ci]

* [comment audit] clarify rich Markdown source and selection safeguards [skip ci]

* [comment audit] clarify editor loading and emulator stream lifetimes [skip ci]

* [comment audit] trim emulator and feature tour narration [skip ci]

* [comment audit] clarify floating workspace and GitHub cache ownership [skip ci]

* [comment audit] trim provider controls and Linear filter explanations [skip ci]

* [comment audit] clarify pairing and chat resume lifetimes [skip ci]

* [comment audit] clarify chat delivery and transcript lifetimes [skip ci]

* [comment audit] clarify session options and host-owned status [skip ci]

* [comment audit] clarify draft durability and live-status precedence [skip ci]

* [comment audit] Trim chat send and model ownership explanations [skip ci]

* [comment audit] Shorten transcript ownership and send recovery comments [skip ci]

* [comment audit] Simplify native chat composer and transcript hook comments [skip ci]

* [comment audit] Shorten native chat scroll and structured session explanations [skip ci]

* [comment audit] Trim workspace picker and onboarding commentary [skip ci]

* [comment audit] Simplify pet rendering, review cache and quick open comments [skip ci]

* [comment audit] Trim sidebar and session history explanations [skip ci]

* [comment audit] Condense session resume and review checks comments [skip ci]

* [comment audit] Shorten checks state and file explorer refresh comments [skip ci]

* [comment audit] Trim plugin bridge and source-control action rationale [skip ci]

* [comment audit] Trim source-control listing and review rationale [skip ci]

* [comment audit] Shorten sidebar lifecycle and explorer safeguards [skip ci]

* [comment audit] Condense Settings account and appearance rationale [skip ci]

* [comment audit] Trim pairing and repository Settings explanations [skip ci]

* [comment audit] Condense Settings search SSH and terminal safeguards [skip ci]

* [comment audit] Shorten Settings voice and provider ownership comments [skip ci]

* [comment audit] Condense Settings draft persistence and host-state rationale [skip ci]

* [comment audit] Trim Settings hooks and sidebar setup rationale [skip ci]

* [comment audit] Condense sidebar deletion and board-filter safeguards [skip ci]

* [comment audit] Condense worktree cards, host ownership and Markdown contracts [skip ci]

* [comment audit] Condense sidebar drag, folder and filtering contracts [skip ci]

* [comment audit] Condense sidebar parity, sleep and host ownership contracts [skip ci]

* [comment audit] Prune focus-read baseline after comment cleanup

* [comment audit] Clarify sidebar visibility, board drops and agent evidence [skip ci]

* [comment audit] Tighten sidebar listing, drag and reveal contracts [skip ci]

* [comment audit] Clarify viewport geometry and skill update safeguards [skip ci]

* [comment audit] Tighten skill inventory, usage and host status comments [skip ci]

* [comment audit] Clarify usage ownership and resource kill safeguards [skip ci]

* [comment audit] Tighten tab selection, rename and search contracts [skip ci]

* [comment audit] Tighten tab-strip geometry and drag ownership comments [skip ci]

* [comment audit] Tighten Tasks recovery, pagination and mutation comments [skip ci]

* [comment audit] Tighten provider loading and terminal recovery comments [skip ci]

* [comment audit] Tighten completion, cadence and PTY ownership comments [skip ci]

* [comment audit] Clarify terminal restore and parked-pane boundaries [skip ci]

* [comment audit] Tighten PTY startup and replay explanations [skip ci]

* [comment audit] Clarify PTY identity and delivery ownership [skip ci]

* [comment audit] Shorten remote reconnect and input replay rationale [skip ci]

* [comment audit] Condense terminal parking clipboard and file link comments [skip ci]

* [comment audit] Clarify IME ownership and trim trace history [skip ci]

* [comment audit] Shorten pane recovery and parked watcher explanations [skip ci]

* [comment audit] Condense snapshot replay and visibility recovery rationale [skip ci]

* [comment audit] Shorten terminal parking and keyboard ownership rationale [skip ci]

* [comment audit] Trim renderer lifecycle and menu rationale [skip ci]

* [comment audit] Condense workspace cleanup ownership and settlement notes [skip ci]

* [comment audit] Clarify renderer hook evidence and source ownership [skip ci]

* [comment audit] Tighten IPC ownership and reconnect explanations [skip ci]

* [comment audit] Trim renderer focus, paste and attention comments [skip ci]

* [comment audit] Shorten scroll, locale and agent lifecycle comments [skip ci]

* [comment audit] Trim agent launch, resume and ownership commentary [skip ci]

* [comment audit] Shorten account, browser and editor comments [skip ci]

* [comment audit] Clarify host-mirror waits, previews and input ownership [skip ci]

* [comment audit] Condense launch recovery and editor tokenization comments [skip ci]

* [comment audit] Condense workspace selection and terminal pane rationale [skip ci]

* [comment audit] Condense terminal fitting and rendering recovery comments [skip ci]

* [comment audit] Condense terminal input and host routing explanations [skip ci]

* [comment audit] Condense ownership and sleeping-session recovery rationale [skip ci]

* [comment audit] Condense structured launch and terminal link explanations [skip ci]

* [comment audit] Condense terminal ownership and workspace file routing rationale [skip ci]

* [comment audit] Condense session persistence and workspace activation rationale [skip ci]

* [comment audit] Condense workspace routing and browser ownership rationale [skip ci]

* [comment audit] Condense mirror recovery and layout authority rationale [skip ci]

* [comment audit] Condense runtime transport and file safety rationale [skip ci]

* [comment audit] Condense runtime graph and structured session rationale [skip ci]

* [comment audit] Condense browser creation and remote tab recovery rationale [skip ci]

* [comment audit] Condense snapshot authority and publisher recovery rationale [skip ci]

* [comment audit] Condense frame, startup and provider cache rationale [skip ci]

* [comment audit] Condense host twin and agent lifecycle rationale [skip ci]

* [comment audit] Condense browser authority and editor cleanup rationale [skip ci]

* [comment audit] Condense editor buffer identity and review cache rationale [skip ci]

* [comment audit] Condense provider lifetime and repository ownership rationale [skip ci]

* [comment audit] Condense reconnect, hydration and terminal retirement rationale [skip ci]

* [comment audit] Condense recovery, reconciliation and persistence rationale [skip ci]

* [comment audit] Condense cleanup ownership and listing admission rationale [skip ci]

* [comment audit] Condense teardown ordering and terminal ownership rationale [skip ci]

* [comment audit] Condense recovery ledger and web host-boundary rationale [skip ci]

* [comment audit] Condense web reconnect and credential lifecycle rationale [skip ci]

* [comment audit] Condense cloud rollout and assignment safety rationale [skip ci]

* [comment audit] Condense relay session and database recovery rationale [skip ci]

* [comment audit] Condense relay placement and protocol compatibility rationale [skip ci]

* [comment audit] Condense build and packaging constraints [skip ci]

* [comment audit] Condense CI gates and validation isolation rationale [skip ci]

* [comment audit] Condense catalog identity and browser validation rationale [skip ci]

* [comment audit] Condense mobile browser and frame-budget rationale [skip ci]

* [comment audit] Shorten mobile route and browser test explanations [skip ci]

* [comment audit] Condense editor and session seam test rationale [skip ci]

* [comment audit] Trim session and terminal closure history [skip ci]

* [comment audit] Shorten terminal browser and census explanations [skip ci]

* [comment audit] Preserve root-only E2E diagnostic baseline

* [comment audit] Condense mobile seam and HTML preview test rationale [skip ci]

* [comment audit] Condense preview instrumentation and render harness rationale [skip ci]

* [comment audit] Condense bundle contracts and native-build constraints [skip ci]

* [comment audit] Shorten native packaging and CI routing rationale [skip ci]

* [comment audit] Condense release tooling and benchmark constraints [skip ci]

* [comment audit] Condense packaging and platform gate rationale [skip ci]

* [comment audit] Shorten mobile route and history rationale [skip ci]

* [comment audit] Condense mobile browser and component rationale [skip ci]

* [comment audit] Shorten drawer and workspace-form rationale [skip ci]

* [comment audit] Trim mobile review and editor-document explanations [skip ci]

* [comment audit] Condense editor lifecycle and Markdown explanations [skip ci]

* [comment audit] Trim mobile file, diagnostics and dictation commentary [skip ci]

* [comment audit] Simplify mobile host-list and workspace-view explanations [skip ci]

* [comment audit] Clarify mobile shell lifetime and bridge delivery constraints [skip ci]

* [comment audit] Condense bridge stream, native request and audio rationale [skip ci]

* [comment audit] Reduce bridge schema and page-client commentary [skip ci]

* [comment audit] Tighten mobile page bridge contracts [skip ci]

* [comment audit] Clarify mobile cache and session constraints [skip ci]

* [comment audit] Condense mobile route and lifecycle rationale [skip ci]

* [comment audit] Tighten mobile shell hook timing rationale [skip ci]

* [comment audit] Clarify route handoff and notification compatibility [skip ci]

* [comment audit] Clarify push registration and dictation cleanup constraints [skip ci]

* [comment audit] Condense keyboard geometry and native media ownership rationale [skip ci]

* [comment audit] Tighten mobile chat scroll and composer concurrency rationale [skip ci]

* [comment audit] Condense mobile reply compatibility and upload ownership rationale [skip ci]

* [comment audit] Condense optimistic echo and scroll ownership rationale [skip ci]

* [comment audit] Tighten stream replay and queued session ownership rationale [skip ci]

* [comment audit] Condense mobile composer and reply-schema constraints [skip ci]

* [comment audit] Clarify mobile transcript recovery and session ownership [skip ci]

* [comment audit] Clarify mobile queue and source-control compatibility [skip ci]

* [comment audit] Condense storage and task launch constraints [skip ci]

* [comment audit] Clarify task schemas and terminal document ownership [skip ci]

* [comment audit] Tighten terminal input and viewport rationale [skip ci]

* [comment audit] Shorten terminal and RPC recorder contracts [skip ci]

* [comment audit] Condense recorder engine and connection contracts [skip ci]

* [comment audit] Shorten host credential and relay recovery comments [skip ci]

* [comment audit] Tighten pairing recovery and bundle transport rationale [skip ci]

* [comment audit] Clarify RPC delivery and workspace catalog boundaries [skip ci]

* [comment audit] Condense catalog and relay entry contracts [skip ci]

* [comment audit] Shorten shutdown and SSH relay delivery contracts [skip ci]

* [comment audit] Condense WSL relay and E2E regression rationale [skip ci]

* [comment audit] Shorten cross-version harness and renderer fixture explanations [skip ci]

* [comment audit] Condense paired-host and E2E lifecycle rationale [skip ci]

* [comment audit] Shorten layout oracle and regression explanations [skip ci]

* [comment audit] Condense paired recovery and ownership regression contracts [skip ci]

* [comment audit] Shorten restart, sidebar and SSH lifecycle contracts [skip ci]

* [comment audit] Condense terminal rendering and IME regression rationale [skip ci]

* [comment audit] Shorten terminal recovery and benchmark contracts [skip ci]

* [comment audit] Condense tooling and Windows lifecycle proof rationale [skip ci]

* [comment audit] Condense workflow routing and release rationale [skip ci]

* [comment audit] Condense mobile security and installer contracts [skip ci]

* [comment audit] Shorten native rationale and stylesheet workarounds [skip ci]

* [comment audit] Shorten Windows visibility probe rationale [skip ci]

* [comment audit] Condense embedded release and signing rationale [skip ci]

* [comment audit] Retain current main test behavior in final reconciliation [skip ci]

* [comment audit] Complete final comment review across current source inventory

* [comment audit] Handle consolidated audit reports before final CI

* [comment audit] Preserve credential storage census detail [skip ci]

* [comment audit] Scale broad changed E2E selections with verified timing shards

* [comment audit] Align E2E assertions with browser close and settled session metadata

* [comment audit] Match existing E2Es to current resource and windowing contracts

* [comment audit] Observe the shared server outage notice in reconnect coverage

* [comment audit] Make existing renderer probes measure settled tab and PTY work

* [comment audit] Align palette E2E selector with task search

* [comment audit] Refresh remaining palette search selectors

* [comment audit] Keep selector correction within selected audit specs

* [comment audit] Await emoji fixture settings inside renderer evaluation

* [comment audit] Cancel fixture fit retries between terminal tests

---------

Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
2026-10-25 04:05:46 -07:00

246 lines
9.5 KiB
JavaScript

// Poll main-world evaluate: Playwright selectors/functions need injected/isolated world whose creation can fail silently on stale Chrome frame.
// Resolve frame every attempt so late document commit replaces stale context; diagnosis separately probes utility world.
import { describePreviewFrame, untilAborted } from './mobile-web-app-preview-frame-diagnosis.mjs'
import { pollReportsUntil } from './mobile-web-app-preview-csp-reports.mjs'
export const POLL_MS = 25
const EVALUATE_MS = 1000
export function previewFrame(page) {
return page.frames().find((one) => one !== page.mainFrame()) ?? null
}
export const abandonAfter = (ms) =>
new Promise((resolve) => {
const timer = setTimeout(() => resolve(false), ms)
timer.unref?.()
})
// Return on case abort: untilAborted already printed diagnosis; late rejection would be unhandled.
export async function pollFrameUntil(page, predicate, signal) {
while (!signal?.aborted) {
const frame = previewFrame(page)
// Abandon unbounded evaluate when case ends so missing main context cannot outlive owning frame.
const met = frame
? await Promise.race([
frame.evaluate(predicate).catch(() => false),
abandonAfter(EVALUATE_MS)
])
: false
if (met) {
return
}
await abandonAfter(POLL_MS)
}
}
// Find actual frame, not URL: srcdoc URL can be empty on CI, and URL polling once timed out despite parsed artifact.
// Await artifact marker after mount/srcdoc/override commits; script arm awaits its own write, load arm awaits navigation away.
// reportReady/images await actual browser report or server requests instead of racing a fixed settle.
export async function waitForLoadedFrame(
page,
{
frameReady = 'artifact',
reportReady = null,
signal,
browserVersion,
arm,
sink,
nonce,
readImageHits,
describeRequests
}
) {
const reading = async (what) =>
`${what}: ${arm} | ${await describePreviewFrame(page, previewFrame(page), browserVersion)}`
await untilAborted(
pollFrameUntil(page, () => true, signal),
signal,
async () => await reading('no frame ever answered inside the page')
)
const frame = previewFrame(page)
if (!frame) {
return null
}
// Bind load wait to case abort; independent waitForLoadState timeout can outlive teardown.
await untilAborted(
pollFrameUntil(page, () => document.readyState === 'complete', signal),
signal,
async () => await reading('the frame never finished loading')
)
if (frameReady === 'script') {
await untilAborted(
pollFrameUntil(page, () => document.documentElement.dataset.ran === '1', signal),
signal,
async () => await reading("the artifact's script never ran inside the frame")
)
}
if (reportReady) {
// Wait browser CSP report, not in-frame listener that may attach late or never execute in sealed frame.
await untilAborted(
pollReportsUntil(sink, nonce, reportReady, signal),
signal,
async () =>
await reading(`the policy reported no ${String(reportReady)} refusal for this arm`)
)
}
if (frameReady !== 'load') {
await untilAborted(
pollFrameUntil(page, () => document.getElementById('marker') !== null, signal),
signal,
async () => await reading('the artifact never parsed inside the frame')
)
}
if (frameReady === 'images') {
await untilAborted(
pollHitsUntilAdmitted(readImageHits, signal),
signal,
async () => await reading(await describeAdmittedImages(page, readImageHits, describeRequests))
)
}
return previewFrame(page)
}
/** How long a painted frame may go on handing its input to the embedder before the arm gives up. */
const INPUT_ROUTING_MS = 10_000
/** Chromium may paint before its out-of-process iframe hit-test region arrives, sending clicks to the embedder.
* Alternate pointer positions until embedder iframe events stop; repeated identical moves may emit nothing.
* In-process engines route correctly on the first move. */
export async function waitForFrameInputRouting(page, clip, signal, arm) {
const started = Date.now()
const embedderSaw = async () => await page.evaluate(() => window.__embedderFramePointer ?? 0)
for (let step = 0; !signal?.aborted; step += 1) {
const before = await embedderSaw()
await page.mouse.move(clip.x + (step % 2), clip.y)
if ((await embedderSaw()) === before) {
return
}
if (Date.now() - started > INPUT_ROUTING_MS) {
throw new Error(
`[html-preview-render] ${arm} still handed its pointer input to the embedder after ${String(Date.now() - started)}ms`
)
}
await abandonAfter(POLL_MS)
}
}
const ADMITTED_IMAGE_PATHS = ['/css-bg.png', '/img.png']
// Poll listener in Node through arm-owned reader; require both admitted images instead of fixed 200ms settle that once saw only CSS background. Return on abort.
async function pollHitsUntilAdmitted(readImageHits, signal) {
while (!signal?.aborted) {
if (ADMITTED_IMAGE_PATHS.every((one) => readImageHits().includes(one))) {
return
}
await abandonAfter(POLL_MS)
}
}
// Diagnose complete/zero-width as failed decode, incomplete as inflight; currentSrc/loading distinguish unresolved/deferred URL from policy refusal.
async function describeAdmittedImages(page, readImageHits, describeRequests) {
const frame = previewFrame(page)
const image = frame
? await Promise.race([
frame
.evaluate(() => {
const element = document.getElementById('remote')
return element
? {
complete: element.complete,
naturalWidth: element.naturalWidth,
currentSrc: element.currentSrc,
loading: element.getAttribute('loading')
}
: null
})
.catch(() => 'the reading itself failed'),
abandonAfter(EVALUATE_MS)
])
: null
const reading = image === false ? 'the reading never answered' : image
// Browser request evidence distinguishes dropped-before-listener fetch from request never made.
const requests = (await describeRequests?.(frame)) ?? 'no request log for this arm'
return `the arm recorded ${JSON.stringify(readImageHits())} of ${JSON.stringify(ADMITTED_IMAGE_PATHS)}; #remote ${JSON.stringify(reading)}; ${requests}`
}
// No-navigation has no signal: allow two painted frames for dispatch plus 200ms for browser popup queue.
// Positive arms reading one on same counters keep absence checks honest; duration alone cannot prove observer works.
async function settleWithoutNavigation(page) {
await page.evaluate(
() =>
new Promise((resolve) => {
requestAnimationFrame(() => requestAnimationFrame(() => resolve()))
})
)
await page.waitForTimeout(200)
}
// Await expected navigation record itself; absence arms use bounded settle because nothing can signal no event.
export async function settleAfterMount(page, navigations, expectNavigation, signal, reading) {
if (expectNavigation === 'main-frame') {
return await waitForRecordedNavigation(page, navigations, (one) => one.main, signal, reading)
}
if (expectNavigation === 'frame') {
return await waitForRecordedNavigation(
page,
navigations,
(one) => !one.main && !one.foreign,
signal,
reading
)
}
return await settleWithoutNavigation(page)
}
// Expected navigation normally records at first check, including loaded runs; bound prevents missed 2s-actionability click consuming whole 120s case.
// Failure names arm/wait/click/frame; generous bound remains well inside case budget.
const NAVIGATION_RECORD_MS = 10_000
// Read after page request-event record; interception only refuses navigation.
// Round trips usually allow record before assertion even without wait; polling protects slower CI dispatch.
export async function waitForRecordedNavigation(
page,
navigations,
matches,
signal,
reading,
{ sampleEveryMs = 5000, boundMs = NAVIGATION_RECORD_MS } = {}
) {
// Reuse image/frame evidence for navigation arms that produced no request.
const read = async () =>
await describePreviewFrame(page, reading?.frame, reading?.browserVersion)
.then(async (frameReading) => {
const evidence = await reading?.describeRequests?.(reading?.frame)
return evidence ? `${frameReading} | ${evidence}` : frameReading
})
.catch((error) => `the reading itself failed: ${String(error).split('\n')[0]}`)
// Sample while waiting; reading after abort can lose teardown race and never print.
let latest = 'no reading was taken before the case ended'
const started = Date.now()
let since = started
// Include click outcome: clean click/no-navigation differs from rig actionability failure.
const absent = (waited, last) =>
`${reading?.arm ?? 'arm unknown'} waited ${String(waited)}ms for the navigation it expects ` +
`and recorded ${JSON.stringify(navigations)}; its action ` +
`${reading?.actError ? `failed with ${JSON.stringify(reading.actError)}` : 'reported no error'}` +
` | ${last}`
while (!navigations.some((one) => matches(one))) {
if (signal?.aborted) {
console.error(`[html-preview-render] ${absent(Date.now() - started, latest)}`)
return
}
const waited = Date.now() - started
if (waited > boundMs) {
// Read current frame at bound too; bound can be shorter than sampling interval, leaving placeholder otherwise.
throw new Error(`[html-preview-render] ${absent(waited, await read())}`)
}
if (Date.now() - since > sampleEveryMs) {
since = Date.now()
latest = await read()
}
await page.waitForTimeout(10)
}
}