Files
archived-orca/tests/e2e/helpers/orcad-convert-flow.ts
T
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

232 lines
8.5 KiB
TypeScript

import type { Page } from '@stablyai/playwright-test'
import { expect } from './orca-app'
import { readPersistedProfileState } from './persisted-profile-state'
import { findOrcadMigrationSourceCutoverForTarget } from '../../../src/main/ssh/orcad-migration-cutover-journal'
import { RuntimeClient } from '../../../src/cli/runtime/client'
const CONVERT_TIMEOUT_MS = 8 * 60_000
const RECONNECT_STEP_TIMEOUT_MS = 6 * 60_000
// Bound each connect/disconnect step so a hang identifies its phase.
export async function reconnect(page: Page, targetId: string): Promise<string> {
for (const step of ['disconnect', 'connect'] as const) {
const run = page.evaluate(
async ({ id, step }) => {
try {
if (step === 'disconnect') {
await window.api.ssh.disconnect({ targetId: id })
return ''
}
const state = await window.api.ssh.connect({ targetId: id })
return JSON.stringify(state?.managedServer ?? null)
} catch (error) {
return `${step} threw: ${String(error)}`
}
},
{ id: targetId, step }
)
let timer: ReturnType<typeof setTimeout> | undefined
const result = await Promise.race([
run,
new Promise<null>((resolve) => {
timer = setTimeout(() => resolve(null), RECONNECT_STEP_TIMEOUT_MS)
})
]).finally(() => clearTimeout(timer))
if (result === null) {
const main = await page.evaluate(
async (id) => JSON.stringify(await window.api.ssh.getState({ targetId: id })),
targetId
)
throw new Error(`ssh ${step} hung; main state ${main}`)
}
// Why: callers parse the connect's JSON, which would hide the error text behind a parse error.
if (result.startsWith(`${step} threw:`)) {
const main = await page.evaluate(
async (id) => JSON.stringify(await window.api.ssh.getState({ targetId: id })),
targetId
)
throw new Error(`${result}; main state ${main}`)
}
if (step === 'connect') {
return result
}
}
return ''
}
export function managedServer(page: Page, targetId: string): Promise<unknown> {
return page.evaluate(
(id) => window.__store?.getState().sshConnectionStates.get(id)?.managedServer ?? null,
targetId
)
}
function isManaged(server: unknown): boolean {
return (
typeof server === 'object' && server !== null && 'kind' in server && server.kind === 'managed'
)
}
function sourceRows(
userData: string,
targetId: string
): { repos: number; folderWorkspaces: number } {
const state = readPersistedProfileState(userData)
const count = (rows: unknown): number =>
(Array.isArray(rows) ? rows : []).filter((row) => row?.connectionId === targetId).length
return { repos: count(state.repos), folderWorkspaces: count(state.folderWorkspaces) }
}
function targetLeases(userData: string, targetId: string): { state?: unknown }[] {
const leases = readPersistedProfileState(userData).sshRemotePtyLeases
return (Array.isArray(leases) ? leases : []).filter((lease) => lease?.targetId === targetId)
}
export async function serverCall(
page: Page,
selector: string,
method: string,
params?: unknown
): Promise<string> {
// Why a long budget: a fresh server's first session inventory restores every migrated tab.
const response = await page.evaluate((args) => window.api.runtimeEnvironments.call(args), {
selector,
method,
params,
timeoutMs: 120_000
})
const text = JSON.stringify(response)
expect(response, `${method} on the managed server: ${text.slice(0, 2_000)}`).toMatchObject({
ok: true
})
return text
}
/** A path as it appears inside a JSON response: Windows backslashes arrive escaped. */
function jsonText(value: string): string {
return JSON.stringify(value).slice(1, -1)
}
export type ConvertedHost = {
targetId: string
worktreeId: string
repoPath: string
folderPath: string
sessionFilePath: string
}
export async function convertAndRetain(
page: Page,
userData: string,
host: ConvertedHost
): Promise<void> {
const connected = await reconnect(page, host.targetId)
// Polls the whole state so a timeout reports why the host stayed on the relay.
await expect
.poll(
async () => {
const server = await managedServer(page, host.targetId)
if (isManaged(server)) {
return 'managed'
}
const leases = targetLeases(userData, host.targetId)
const journal = findOrcadMigrationSourceCutoverForTarget(userData, host.targetId)
const mainState = await page.evaluate(
async (id) => (await window.api.ssh.getState({ targetId: id }))?.managedServer ?? null,
host.targetId
)
return JSON.stringify({
server,
mainState,
connected,
leases,
journal: journal && { phase: journal.phase, updatedAt: journal.updatedAt }
})
},
{ timeout: CONVERT_TIMEOUT_MS }
)
.toBe('managed')
const environments = await page.evaluate(() => window.api.runtimeEnvironments.list())
const environment = environments.find((entry) => {
const deployment = entry.orcadDeployment
return deployment && deployment.kind !== 'wsl' && deployment.sshTargetId === host.targetId
})
expect(environment, 'a managed server registered for the host').toBeTruthy()
expect(await serverCall(page, environment!.id, 'repo.list')).toContain(jsonText(host.repoPath))
expect(await serverCall(page, environment!.id, 'folderWorkspace.list')).toContain(
jsonText(host.folderPath)
)
await expect
.poll(
async () =>
await serverCall(page, environment!.id, 'session.tabs.list', {
worktree: `id:${host.worktreeId}`
}),
{ timeout: 30_000 }
)
.toContain(jsonText(host.sessionFilePath))
// A fresh managed server answers the whole inventory too, instead of waiting on a renderer.
expect(await serverCall(page, environment!.id, 'session.tabs.listAll', {})).toContain(
jsonText(host.sessionFilePath)
)
// Keep source state for downgrade, hidden across repeated connects.
const expectRetained = async (): Promise<void> => {
expect(findOrcadMigrationSourceCutoverForTarget(userData, host.targetId)).toMatchObject({
phase: 'destination-committed',
sourceRetainedAt: expect.any(String)
})
expect(sourceRows(userData, host.targetId)).toEqual({ repos: 1, folderWorkspaces: 1 })
const listed = await page.evaluate(async (id) => {
const repos = await window.api.repos.list()
return repos.filter((repo) => repo.connectionId === id).length
}, host.targetId)
expect(listed, 'retained source rows stay hidden').toBe(0)
// The CLI, the phone and paired clients list through this desktop's runtime, not the renderer.
const persisted = readPersistedProfileState(userData).repos
const sourceRepoIds = new Set(
(Array.isArray(persisted) ? persisted : [])
.filter((repo) => repo?.connectionId === host.targetId)
.map((repo) => repo.id)
)
const runtime = new RuntimeClient(userData, 30_000, null, null)
const repos = (await runtime.call<{ repos: { id: string }[] }>('repo.list')).result.repos
const folders = (
await runtime.call<{ folderWorkspaces: { connectionId?: string | null }[] }>(
'folderWorkspace.list'
)
).result.folderWorkspaces
const ps = (
await runtime.call<{
worktrees: { repoId: string }[]
hostScope?: { hostIds: string[]; omittedHostIds: string[] }
}>('worktree.ps')
).result
const worktrees = ps.worktrees
// The old code named the converted host as "not covered", sending a user to a hidden host.
expect(ps.hostScope, 'runtime worktree.ps reports its host scope').toBeTruthy()
expect(
[...ps.hostScope!.hostIds, ...ps.hostScope!.omittedHostIds],
'runtime worktree.ps never names the converted host'
).not.toContain(`ssh:${encodeURIComponent(host.targetId)}`)
expect(
repos.filter((repo) => sourceRepoIds.has(repo.id)),
'runtime repo.list'
).toEqual([])
expect(
folders.filter((folder) => folder.connectionId === host.targetId),
'runtime folderWorkspace.list'
).toEqual([])
expect(
worktrees.filter((worktree) => sourceRepoIds.has(worktree.repoId)),
'runtime worktree.ps'
).toEqual([])
}
await expectRetained()
await reconnect(page, host.targetId)
await expect.poll(() => managedServer(page, host.targetId).then(isManaged)).toBe(true)
await expectRetained()
expect(await serverCall(page, environment!.id, 'repo.list')).toContain(jsonText(host.repoPath))
}