Files
orca/tests/e2e/terminal-layout-parity-snapshot.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

264 lines
9.4 KiB
TypeScript

/**
* Normalize and compare terminal layout parity captures (see terminal-layout-parity.spec.ts).
* Volatile values become structural labels so two runs of one commit compare equal.
*/
export const TERMINAL_LAYOUT_PARITY_OUT_ENV = 'ORCA_TERMINAL_LAYOUT_PARITY_OUT'
export type RawParityCheckpoint = {
label: string
renderer: unknown
persisted: unknown
/** How the app exited before `persisted` was read; a forced kill skips the final save. */
exit?: { code: number | null; signal: string | null }
}
export type RawParityCapture = {
scenario: string
/** Absolute machine paths to replace with stable labels, e.g. the seeded repo → `<repo>`. */
pathLabels: Record<string, string>
checkpoints: RawParityCheckpoint[]
}
/** A named bug this branch fixes, and the capture paths (prefixes) its fix is allowed to change. */
export type DeclaredParityDifference = {
scenario: string
bugId: string
paths: string[]
reason: string
}
/** A path main itself does not reproduce run to run; compared differences there are reported, not failed. */
export type UnstableOnMainPath = { scenario: string; paths: string[]; evidence: string }
export type ParityDifference = { scenario: string; path: string; base: unknown; head: unknown }
export type ParityReport = {
undeclared: ParityDifference[]
declared: (ParityDifference & { bugId: string })[]
unstableOnMain: ParityDifference[]
/** Declarations whose fix produced no difference: the claimed fix was not observed. */
unusedDeclarations: DeclaredParityDifference[]
}
type Json = null | boolean | number | string | Json[] | { [key: string]: Json }
// UUIDs, and the per-spawn suffix of local PTY ids (`<worktreeId>@@1e2745c7`).
const ID_SOURCE = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|@@[0-9a-f]{8}\\b'
// `createdAt`, `lastFocusedAt`, and maps of them such as `lastVisitedAtByWorktreeId`.
const TIME_KEY = /(?:At|Time|timestamp)(?:By[A-Za-z]+)?$/
const PROCESS_KEY = /^(?:pid|port|processId)$/i
// Scrollback text depends on prompt timing, not layout; keep presence only.
const OPAQUE_TEXT_PARENT_KEYS = new Set(['buffersByLeafId', 'localOnlyScrollbackByTabId'])
function findIds(text: string): string[] {
return (text.match(new RegExp(ID_SOURCE, 'gi')) ?? []).map((id) => id.toLowerCase())
}
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value)
}
/** Labels each volatile id by where it first appears in ordered structure, never by its value. */
class IdLabeler {
private readonly labels = new Map<string, string>()
label(id: string): string {
let label = this.labels.get(id)
if (!label) {
label = `${id.startsWith('@@') ? '@@' : ''}#${this.labels.size + 1}`
this.labels.set(id, label)
}
return label
}
knows(key: string): boolean {
return findIds(key).every((id) => this.labels.has(id))
}
replaceIn(text: string): string {
return text.replace(new RegExp(ID_SOURCE, 'gi'), (id) => this.label(id.toLowerCase()))
}
// Visit arrays in order and keys sorted; label ids in ordered structures before visiting id-keyed maps so random key order cannot choose labels.
visit(root: unknown): void {
const pending: [string, unknown][] = []
const walk = (value: unknown): void => {
if (typeof value === 'string') {
findIds(value).forEach((id) => this.label(id))
} else if (Array.isArray(value)) {
value.forEach(walk)
} else if (isRecord(value)) {
for (const key of Object.keys(value).sort()) {
if (findIds(key).length === 0) {
walk(value[key])
} else {
pending.push([key, value[key]])
}
}
}
}
walk(root)
while (pending.length > 0) {
const ready = pending.filter(([key]) => this.knows(key))
// Fallback for ids seen only as keys: raw order, the one place a label can depend on value.
const next =
ready.length > 0 ? ready : [pending.toSorted((a, b) => a[0].localeCompare(b[0]))[0]!]
const rank = (key: string): string =>
this.replaceIn(key).replace(/\d+/g, (n) => n.padStart(6, '0'))
next.sort((a, b) => rank(a[0]).localeCompare(rank(b[0])))
for (const entry of next) {
pending.splice(pending.indexOf(entry), 1)
findIds(entry[0]).forEach((id) => this.label(id))
walk(entry[1])
}
}
}
}
function replacePaths(text: string, pathLabels: [string, string][]): string {
let result = text
for (const [machinePath, label] of pathLabels) {
result = result.split(machinePath).join(label)
}
return result
}
function normalizeValue(
value: unknown,
key: string,
parentKey: string,
labeler: IdLabeler,
pathLabels: [string, string][]
): Json {
if (typeof value === 'string') {
return OPAQUE_TEXT_PARENT_KEYS.has(parentKey)
? '<text>'
: labeler.replaceIn(replacePaths(value, pathLabels))
}
if (typeof value === 'number') {
if (TIME_KEY.test(key) || TIME_KEY.test(parentKey)) {
return '<time>'
}
return PROCESS_KEY.test(key) ? '<process>' : value
}
if (Array.isArray(value)) {
return value.map((item) => normalizeValue(item, key, parentKey, labeler, pathLabels))
}
if (isRecord(value)) {
const entries = Object.entries(value).map(([childKey, child]): [string, Json] => [
labeler.replaceIn(replacePaths(childKey, pathLabels)),
normalizeValue(child, childKey, key, labeler, pathLabels)
])
return Object.fromEntries(entries.sort((a, b) => a[0].localeCompare(b[0])))
}
return typeof value === 'boolean' || value === null ? value : null
}
/** One labeler per capture so a tab keeps its label from renderer to disk to restart. */
export function normalizeParityCapture(capture: RawParityCapture): Json {
const labeler = new IdLabeler()
const pathLabels = Object.entries(capture.pathLabels).sort((a, b) => b[0].length - a[0].length)
for (const checkpoint of capture.checkpoints) {
labeler.visit(checkpoint.renderer)
labeler.visit(checkpoint.persisted)
}
return capture.checkpoints.map((checkpoint) => ({
label: checkpoint.label,
exit: checkpoint.exit ?? null,
renderer: normalizeValue(checkpoint.renderer, 'renderer', '', labeler, pathLabels),
persisted: normalizeValue(checkpoint.persisted, 'persisted', '', labeler, pathLabels)
}))
}
// An absent map and an empty one mean the same; which one a save writes depends on its writer.
function isEmpty(value: Json | undefined): boolean {
return (
value === undefined ||
(Array.isArray(value) ? value.length === 0 : isRecord(value) && Object.keys(value).length === 0)
)
}
function isEmptyPair(base: Json | undefined, head: Json | undefined): boolean {
return isEmpty(base) && isEmpty(head)
}
function diffJson(
base: Json | undefined,
head: Json | undefined,
path: string,
out: [string, Json | undefined, Json | undefined][]
): void {
if (JSON.stringify(base) === JSON.stringify(head) || isEmptyPair(base, head)) {
return
}
if (Array.isArray(base) && Array.isArray(head)) {
for (let index = 0; index < Math.max(base.length, head.length); index += 1) {
diffJson(base[index], head[index], `${path}[${index}]`, out)
}
return
}
if (isRecord(base) && isRecord(head)) {
for (const key of new Set([...Object.keys(base), ...Object.keys(head)])) {
diffJson(base[key], head[key], `${path}.${key}`, out)
}
return
}
out.push([path, base, head])
}
function matchesPath(path: string, prefix: string): boolean {
return path === prefix || path.startsWith(`${prefix}.`) || path.startsWith(`${prefix}[`)
}
export function compareParityCaptures(
base: Map<string, RawParityCapture>,
head: Map<string, RawParityCapture>,
declarations: readonly DeclaredParityDifference[],
unstableOnMain: readonly UnstableOnMainPath[] = []
): ParityReport {
const report: ParityReport = {
undeclared: [],
declared: [],
unstableOnMain: [],
unusedDeclarations: []
}
const covers = (entry: { scenario: string; paths: string[] }, scenario: string, path: string) =>
entry.scenario === scenario && entry.paths.some((prefix) => matchesPath(path, prefix))
const used = new Set<DeclaredParityDifference>()
for (const scenario of [...new Set([...base.keys(), ...head.keys()])].sort()) {
const baseCapture = base.get(scenario)
const headCapture = head.get(scenario)
const found: [string, Json | undefined, Json | undefined][] = []
diffJson(
baseCapture ? normalizeParityCapture(baseCapture) : undefined,
headCapture ? normalizeParityCapture(headCapture) : undefined,
'',
found
)
for (const [path, baseValue, headValue] of found) {
const difference = {
scenario,
path,
base: baseValue === undefined ? '<missing>' : baseValue,
head: headValue === undefined ? '<missing>' : headValue
}
const declaration = declarations.find((entry) => covers(entry, scenario, path))
if (declaration) {
used.add(declaration)
report.declared.push({ ...difference, bugId: declaration.bugId })
} else if (unstableOnMain.some((entry) => covers(entry, scenario, path))) {
report.unstableOnMain.push(difference)
} else {
report.undeclared.push(difference)
}
}
}
report.unusedDeclarations = declarations.filter((entry) => !used.has(entry))
return report
}
export function isParityClean(report: ParityReport): boolean {
return report.undeclared.length === 0 && report.unusedDeclarations.length === 0
}