Files
orca/tests/e2e/helpers/workspace-layout-oracle-compare.ts
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

233 lines
8.8 KiB
TypeScript

// Compare runtime layout to each view, excluding viewer-owned selection, focus and sizes.
import { isTerminalOwnerPartition } from '../../../src/shared/workspace-layout/terminal-owner-invariants'
import type { LiveWorkspace } from './workspace-layout-oracle-feed'
import type { ClientView, DrawnLayout, DrawnTerminalSurface } from './workspace-layout-oracle-views'
type RuntimeTab = {
worktreeId: string
customTitle: string | null
panes: { leafId: string; ptyId: string | null }[]
}
/** Terminal tabs by id; a tab listed in two workspaces keeps both entries. */
function indexRuntimeTabs(entries: readonly LiveWorkspace[]): Map<string, RuntimeTab[]> {
const tabs = new Map<string, RuntimeTab[]>()
for (const { layout } of entries) {
for (const tab of layout.tabs) {
if (!tab.terminal) {
continue
}
const entry: RuntimeTab = {
worktreeId: layout.worktreeId,
customTitle: tab.customTitle,
panes: tab.terminal.panes.map((pane) => ({
leafId: pane.leafId,
ptyId: pane.ptyId ?? null
}))
}
tabs.set(tab.id, [...(tabs.get(tab.id) ?? []), entry])
}
}
return tabs
}
function worktreeEntries(entries: readonly LiveWorkspace[], worktreeId: string): LiveWorkspace[] {
return entries.filter((entry) => entry.layout.worktreeId === worktreeId)
}
function runtimeGroups(
entries: readonly LiveWorkspace[],
worktreeId: string
): Map<string, string[]> {
const groups = new Map<string, string[]>()
for (const { layout } of worktreeEntries(entries, worktreeId)) {
for (const group of layout.groups) {
groups.set(group.id, group.tabIds)
}
}
return groups
}
const orderText = (order: readonly string[]): string => JSON.stringify(order)
/** A binding to a terminal that is no longer running is a resume hint, not something shown. */
function shownPanes(
panes: readonly { leafId: string; ptyId: string | null }[],
livePtyIds: ReadonlySet<string>
): { leafId: string; ptyId: string | null }[] {
return panes.map((pane) => ({
leafId: pane.leafId,
ptyId: pane.ptyId && livePtyIds.has(pane.ptyId) ? pane.ptyId : null
}))
}
const panesText = (panes: readonly { leafId: string; ptyId: string | null }[]): string =>
JSON.stringify(panes.map((pane) => [pane.leafId, pane.ptyId]))
/** One surface per tab: a tab's terminal surface element can be nested, so keep the one with panes. */
function surfacesByTab(drawn: DrawnLayout): DrawnTerminalSurface[] {
const byTab = new Map<string, DrawnTerminalSurface>()
for (const surface of drawn.surfaces) {
const existing = byTab.get(surface.tabId)
if (!existing || existing.panes.length < surface.panes.length) {
byTab.set(surface.tabId, surface)
}
}
return [...byTab.values()].filter((surface) => surface.panes.length > 0)
}
/** The window draws the layouts of the partitions it owns (local and SSH); a remote mirror is not checked. */
export function compareDrawnToRuntime(
entries: readonly LiveWorkspace[],
drawn: DrawnLayout,
livePtyIds: ReadonlySet<string>
): string[] {
const owned = entries.filter((entry) => isTerminalOwnerPartition(entry.hostId))
const differences: string[] = []
const tabs = indexRuntimeTabs(owned)
const drawnWorktrees = new Set(drawn.strips.map((strip) => strip.worktreeId))
for (const worktreeId of drawnWorktrees) {
const groups = runtimeGroups(owned, worktreeId)
const strips = drawn.strips.filter((strip) => strip.worktreeId === worktreeId)
for (const strip of strips) {
const order = groups.get(strip.groupId)
if (!order) {
differences.push(`drawn group ${strip.groupId} is not in the runtime (${worktreeId})`)
} else if (orderText(order) !== orderText(strip.tabIds)) {
differences.push(
`group ${strip.groupId}: runtime order ${orderText(order)} but drawn ${orderText(strip.tabIds)}`
)
}
}
for (const groupId of groups.keys()) {
if (!strips.some((strip) => strip.groupId === groupId)) {
differences.push(`runtime group ${groupId} is not drawn (${worktreeId})`)
}
}
for (const tab of worktreeEntries(owned, worktreeId).flatMap(({ layout }) => layout.tabs)) {
if (!strips.some((strip) => strip.tabIds.includes(tab.id))) {
differences.push(`runtime ${tab.kind} tab ${tab.id} has no drawn tab (${worktreeId})`)
}
}
}
const shownBy = new Map<string, string>()
for (const surface of surfacesByTab(drawn)) {
const runtime = tabs.get(surface.tabId) ?? []
if (runtime.length === 0) {
differences.push(`drawn terminal tab ${surface.tabId} is not in the runtime`)
} else {
// Compared on running terminals only; both sides may keep or drop an exited binding.
const want = panesText(shownPanes(runtime[0]!.panes, livePtyIds))
const got = panesText(shownPanes(surface.panes, livePtyIds))
if (want !== got) {
differences.push(`tab ${surface.tabId}: runtime panes ${want} but drawn ${got}`)
}
}
for (const pane of surface.panes) {
const other = pane.ptyId ? shownBy.get(pane.ptyId) : undefined
if (other) {
differences.push(
`terminal ${pane.ptyId} is drawn in two panes: ${other} and ${pane.leafId}`
)
} else if (pane.ptyId) {
shownBy.set(pane.ptyId, pane.leafId)
}
}
}
return differences
}
export function compareClientToRuntime(
entries: readonly LiveWorkspace[],
view: ClientView
): string[] {
if (view.error || !view.tabs) {
return [`client view of ${view.worktreeId} failed: ${view.error ?? 'no snapshot'}`]
}
const differences: string[] = []
const tabs = indexRuntimeTabs(entries)
const runtimePanes = new Map<string, string | null>()
for (const [tabId, tabEntries] of tabs) {
for (const entry of tabEntries.filter(
(candidate) => candidate.worktreeId === view.worktreeId
)) {
for (const pane of entry.panes) {
runtimePanes.set(`${tabId}:${pane.leafId}`, pane.ptyId)
}
}
}
const clientPanes = new Map<string, string | null>()
for (const tab of view.tabs.tabs) {
if (tab.type !== 'terminal') {
continue
}
const key = `${tab.parentTabId}:${tab.leafId}`
if (clientPanes.has(key)) {
differences.push(`client lists pane ${key} twice`)
}
clientPanes.set(key, tab.ptyId ?? null)
const customTitle = tabs.get(tab.parentTabId)?.[0]?.customTitle
if (customTitle && tab.title !== customTitle) {
differences.push(
`client titles ${key} "${tab.title}" but the runtime named it "${customTitle}"`
)
}
}
for (const [key, ptyId] of runtimePanes) {
if (!clientPanes.has(key)) {
differences.push(`runtime pane ${key} is missing from the client`)
} else if ((clientPanes.get(key) ?? null) !== ptyId) {
differences.push(`pane ${key}: runtime shows ${ptyId}, client ${clientPanes.get(key)}`)
}
}
for (const key of clientPanes.keys()) {
if (!runtimePanes.has(key)) {
differences.push(`client pane ${key} is not in the runtime`)
}
}
// Groups carry every tab kind, so exact group orders compare editor, browser and agent tabs too.
const groups = runtimeGroups(entries, view.worktreeId)
const clientGroups = new Map(
(view.tabs.tabGroups ?? []).map((group) => [group.id, group.tabOrder])
)
const unmatchedRuntime = new Map([...groups].filter(([groupId]) => !clientGroups.has(groupId)))
for (const [groupId, order] of clientGroups) {
const want = groups.get(groupId)
if (want) {
if (orderText(want) !== orderText(order)) {
differences.push(
`group ${groupId}: runtime order ${orderText(want)} but client ${orderText(order)}`
)
}
continue
}
// The same tabs in the same order under another id is a renamed group, not a lost one.
const renamed = [...unmatchedRuntime].find(
([, runtime]) => orderText(runtime) === orderText(order)
)
if (renamed) {
unmatchedRuntime.delete(renamed[0])
differences.push(
`group id differs: runtime ${renamed[0]}, client ${groupId} (tabs ${orderText(order)})`
)
} else {
differences.push(`client group ${groupId} is not in the runtime`)
}
}
for (const groupId of unmatchedRuntime.keys()) {
differences.push(`runtime group ${groupId} is missing from the client`)
}
for (const terminal of view.terminals) {
const key = `${terminal.tabId}:${terminal.leafId}`
if (terminal.orphaned) {
differences.push(`terminal ${terminal.ptyId} is running with no pane (last at ${key})`)
} else if (!runtimePanes.has(key)) {
differences.push(`CLI lists terminal ${terminal.ptyId} at ${key}, which the runtime lacks`)
} else if (terminal.ptyId && runtimePanes.get(key) !== terminal.ptyId) {
differences.push(`CLI says ${key} runs ${terminal.ptyId}, runtime ${runtimePanes.get(key)}`)
}
}
return differences
}