Files
orca/tests/e2e/helpers/headless-layout-oracle-hosts.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

253 lines
8.9 KiB
TypeScript

// Keep profile and pairing port stable across Node-orcad/Electron-serve restarts so existing client streams reconnect.
import { existsSync, mkdirSync, mkdtempSync, realpathSync, rmSync, writeFileSync } from 'node:fs'
import { createServer, type AddressInfo } from 'node:net'
import os from 'node:os'
import path from 'node:path'
import { RuntimeClient } from '../../../src/cli/runtime/client'
import { resolveBundledOrcadRuntime } from '../../../src/main/orcad/orcad-bundled-runtime'
import { runProcess } from '@orca/process-host'
import { NODE_RUNTIME_PIN } from '../../../src/shared/node-runtime-pin'
import { cleanupE2EDaemons } from './electron-process-shutdown'
import { launchHeadlessPairedRuntimeHost } from './headless-paired-runtime-host'
import { cliServeProfile, spawnUntilReady, type ReadyProcess } from './orca-serve-cli-host'
export type HeadlessHostKind = 'orcad' | 'electron'
type RestartOptions = { cold?: boolean; whileStopped?: () => void | Promise<void> }
export type HeadlessOracleHost = {
kind: HeadlessHostKind
userDataDir: string
/** Scratch root for this host's profile and paired-client state. */
scratch: string
pairingUrl: string
/** Run by `dispose`, after the host stops. */
cleanups: (() => void)[]
/**
* Stops serve and starts it again on the same profile and port; `cold` also kills the PTY daemon.
* `whileStopped` runs with no serve process alive, the only safe time to edit the profile.
*/
restart: (options?: RestartOptions) => Promise<void>
dispose: () => Promise<void>
}
const ORCAD_SLOT = path.resolve('out/orcad')
const PROFILE_REMOVAL = { recursive: true, force: true, maxRetries: 50, retryDelay: 100 }
/** The pinned Node an unpackaged `out/orcad` runs on (its natives are built for it). */
export function orcadNodeExecutable(): string | null {
if (!existsSync(path.join(ORCAD_SLOT, 'orcad.js'))) {
return null
}
const packaged = resolveBundledOrcadRuntime(ORCAD_SLOT)
if (packaged) {
return packaged
}
const dir = `node-v${NODE_RUNTIME_PIN.version}-${process.platform}-${process.arch}`
const bin =
process.platform === 'win32'
? path.resolve('out/node-runtime-cache', dir, 'node.exe')
: path.resolve('out/node-runtime-cache', dir, 'bin', 'node')
return existsSync(bin) ? bin : null
}
async function reserveLoopbackPort(): Promise<number> {
const probe = createServer()
await new Promise<void>((resolve, reject) => {
probe.once('error', reject)
probe.listen(0, '127.0.0.1', () => resolve())
})
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: a TCP listen on a host address reports an AddressInfo.
const { port } = probe.address() as AddressInfo
await new Promise<void>((resolve) => probe.close(() => resolve()))
return port
}
function parseOrcadReadiness(stdout: string): { pairingUrl: string; daemon: string } | null {
const newline = stdout.indexOf('\n')
if (newline === -1) {
return null
}
const ready: unknown = JSON.parse(stdout.slice(0, newline))
const pairing = ready && typeof ready === 'object' && 'pairing' in ready ? ready.pairing : null
const url = pairing && typeof pairing === 'object' && 'url' in pairing ? pairing.url : null
const health = ready && typeof ready === 'object' && 'health' in ready ? ready.health : null
const daemon =
health && typeof health === 'object' && 'terminalDaemon' in health
? JSON.stringify(health.terminalDaemon)
: 'missing'
return typeof url === 'string' ? { pairingUrl: url, daemon } : { pairingUrl: '', daemon }
}
type StartedHost = Omit<HeadlessOracleHost, 'cleanups'>
async function startOrcadHost(scratch: string, node: string): Promise<StartedHost> {
const profile = cliServeProfile(scratch)
const port = await reserveLoopbackPort()
const env = { ...profile.env, ORCA_USER_DATA: profile.userDataDir }
const launch = (): Promise<ReadyProcess<{ pairingUrl: string; daemon: string }>> =>
spawnUntilReady({
label: 'orcad serve',
program: node,
args: [
path.join(ORCAD_SLOT, 'orcad.js'),
'--bind',
'127.0.0.1',
'--port',
String(port),
'--json'
],
env,
timeoutMs: 120_000,
parseReady: parseOrcadReadiness
})
let serve: ReadyProcess<{ pairingUrl: string; daemon: string }> | null = await launch()
if (!serve.ready.pairingUrl || !serve.ready.daemon.includes('"live"')) {
await serve.stop()
await cleanupE2EDaemons(profile.userDataDir)
throw new Error(`orcad serve is not usable: ${serve.ready.daemon}\n${serve.stderr()}`)
}
return {
kind: 'orcad',
userDataDir: profile.userDataDir,
scratch,
pairingUrl: serve.ready.pairingUrl,
restart: async ({ cold, whileStopped } = {}) => {
// SIGTERM is orcad's graceful stop and leaves the PTY daemon running.
await serve?.stop()
serve = null
if (cold) {
await cleanupE2EDaemons(profile.userDataDir)
}
await whileStopped?.()
serve = await launch()
},
dispose: async () => {
await serve?.stop()
serve = null
await cleanupE2EDaemons(profile.userDataDir)
rmSync(scratch, PROFILE_REMOVAL)
}
}
}
async function startElectronHost(scratch: string): Promise<StartedHost> {
const host = await launchHeadlessPairedRuntimeHost({
pinnedServePort: true,
userDataParent: scratch
})
return {
kind: 'electron',
userDataDir: host.userDataDir,
scratch,
pairingUrl: host.offer.pairingUrl,
restart: ({ cold, whileStopped } = {}) =>
host.restartServeProcess({
betweenProcesses: async () => {
if (cold) {
await cleanupE2EDaemons(host.userDataDir)
}
await whileStopped?.()
}
}),
dispose: async () => {
await host.dispose()
rmSync(scratch, PROFILE_REMOVAL)
}
}
}
/** Unix sockets live in userData and macOS caps their path at 104 bytes; a short dir in $HOME fits. */
function profileParent(): string {
const tmp = os.tmpdir()
if (process.platform === 'win32' || tmp.length <= 32) {
return tmp
}
const parent = path.join(os.homedir(), '.orca-lo')
mkdirSync(parent, { recursive: true })
return parent
}
export async function startHeadlessOracleHost(kind: HeadlessHostKind): Promise<HeadlessOracleHost> {
const scratch = mkdtempSync(path.join(profileParent(), 'lo-'))
try {
const node = kind === 'orcad' ? orcadNodeExecutable() : null
if (kind === 'orcad' && !node) {
throw new Error('out/orcad or its pinned Node is missing (pnpm build:orcad)')
}
const started = node ? await startOrcadHost(scratch, node) : await startElectronHost(scratch)
const cleanups: (() => void)[] = []
return {
...started,
cleanups,
dispose: async () => {
await started.dispose()
cleanups.forEach((cleanup) => cleanup())
}
}
} catch (error) {
rmSync(scratch, PROFILE_REMOVAL)
throw error
}
}
/** The local CLI's client: reads the runtime's metadata file in the profile. */
export function cliClient(host: HeadlessOracleHost): RuntimeClient {
return new RuntimeClient(host.userDataDir, 30_000, null, null)
}
/** A client paired over the host's WebSocket offer, with its own client-side state directory. */
export function pairedClient(host: HeadlessOracleHost, name: string): RuntimeClient {
const dir = path.join(host.scratch, `client-${name}`)
mkdirSync(dir, { recursive: true })
return new RuntimeClient(dir, 30_000, host.pairingUrl, null)
}
async function git(cwd: string, args: string[]): Promise<void> {
const result = await runProcess({ program: 'git', args, cwd, timeoutMs: 30_000 })
if (result.code !== 0) {
throw new Error(`git ${args.join(' ')} failed: ${result.stderr}`)
}
}
/** A one-commit git repo added to the runtime; resolves the id of its main worktree. */
export async function addRepoWorktree(
host: HeadlessOracleHost,
client: RuntimeClient
): Promise<string> {
// The runtime lists a worktree by its real path; macOS's temp dir is behind a symlink.
const repoPath = realpathSync(mkdtempSync(path.join(os.tmpdir(), 'layout-oracle-repo-')))
host.cleanups.push(() => rmSync(repoPath, PROFILE_REMOVAL))
writeFileSync(path.join(repoPath, 'README.md'), 'layout oracle\n')
await git(repoPath, ['init', '-q'])
await git(repoPath, ['add', 'README.md'])
await git(repoPath, [
'-c',
'user.name=Layout Oracle',
'-c',
'user.email=oracle@example.invalid',
'commit',
'-q',
'-m',
'init'
])
const added = await client.call<{ repo: { id: string } }>('repo.add', {
path: repoPath,
kind: 'git'
})
const repoId = added.result.repo.id
const deadline = Date.now() + 30_000
while (Date.now() < deadline) {
const listed = await client.call<{ worktrees: { id: string }[] }>('worktree.list', {
repo: `id:${repoId}`
})
const worktreeId = listed.result.worktrees[0]?.id
if (worktreeId) {
return worktreeId
}
await new Promise((settle) => setTimeout(settle, 300))
}
throw new Error(`repo ${repoId} never listed a worktree`)
}