Files
orca/tests/e2e/multi-client-navigation-isolation.spec.ts
T
OrcaWinandOrcaWin fdcf887bf0 chore(lint): fix suppressed lint violations instead of ignoring them (#33294)
* chore(lint): remove disable directives that suppress nothing

Each was reported unused by the oxlint config that owns its rule (root,
casting, react-doctor, anti-slop, native-plugins), including 17 file-level
react-doctor blanket disables whose rule no longer fires. An unused
react-hooks disable was masking a react/purity finding in
useAgentBucketCounts (compiler rules skip functions with hook
suppressions); suppress that one explicitly where the code explains it.

* test(tab-bar): use typed tab/file fixtures instead of @ts-expect-error partials

* chore(lint): fix misc suppressed lint violations instead of disabling

- consistent-type-imports: the "vi.importActual requires inline import()"
  rationale was wrong; use typed vi.mock(import(...), importOriginal) or a
  type-only namespace import.
- no-control-regex: source-control commit/push failure summaries, shell PATH
  hydration, and ipynb ANSI parsing reuse the shared ansi-escape-sequences
  stripper and control-character pattern instead of private copies.
- no-explicit-any / no-useless-spread / no-this-alias: typed `this` in
  bridge test mocks, drop blanket file-level disables, drop a this-alias.

* refactor(main): replace avoidable type assertions with checked narrowing

17 production cast suppressions in main/wsl-guest removed: untrusted IPC
and RPC payloads (Jira issue update, WSL guest plugin install, handshake
type) now narrow through isRecord/type guards and build typed results;
redundant casts dropped; hand-rolled object checks and errno casts use the
existing isRecord / hasErrorCode helpers.

* refactor(renderer,mobile): replace avoidable type assertions with checked types

13 production cast suppressions removed: RPC failures read through the
`ok` discriminant instead of casting to RpcFailure; react-native-web host
refs narrowed with instanceof HTMLElement; redundant reply/diff casts
become checked annotations; the TUI agent param uses z.custom(isTuiAgent)
like its sibling schemas; the agent-status slice cast that hid missing
actions is gone so the creator's return type checks the whole slice.

* chore(lint): drop dead tiptap wrapper; scope anti-slop mocking rule to test support

- safe-react-node-view-renderer patched handleSelectionUpdate, which
  @tiptap/react 3.31.3 no longer has, so it always returned early. Use the
  stock ReactNodeViewRenderer.
- The anti-slop test override only matched *.test.{ts,tsx}, forcing
  file-level no-module-mocking disables in test harnesses and fixtures.
  Match *-test-harness, *-test-fixture(s), .test-fixture and *.test.mjs,
  then drop those disables and the now-redundant per-file exemptions.

* test: replace repeated cast suppressions with typed fixtures (main/shared/e2e)

Net -119 cast directives. Typed fixtures replace recurring casts:
unusedSshConnection/unusedOrcadHostTransport placeholders, a typed
readPersistedState harness read (exposed a test treating optional
httpProxyUrl as always set), real Response objects in fetch spies, an
updater main-window fixture, a CDP webContents adapter, one shared
releaseModuleExport for cross-version tests, and requireOverlayDir in
place of `as string` on possibly-undefined overlay paths.

* fix(runtime): validate loaded device rows and host scope instead of casting

Two cast suppressions claimed checks that did not happen:
- device-registry-file-read: "normalizeLoadedDeviceRow re-validates every
  field" was false; deviceId, token, name and timestamps were never
  checked. Rows without an identity are now dropped and the file is set
  aside through the existing corrupt-file path (registry reads as
  doubtful, so no revocation verdicts); a non-string token is stripped
  so the row stays listed but cannot authenticate.
- client-ui: "only optionality differs" was false; any string reached
  persisted workspaceHostScope. Narrow it with isWorkspaceHostScope and
  ignore unknown scopes (wire schema unchanged for mixed versions). The
  remaining cast now states what it actually covers.

* test(runtime,ipc): drop redundant cast suppressions; typed runtime store fixture

-98 cast directives across runtime/ipc tests: 61 casts that typecheck
without the assertion; a typed vi.fn for scoped invalidation; a
partialRuntimeStore fixture in place of `store as never` for
OrcaRuntimeService; typed worker terminal/authority builders in the
incarnation-fallback suite (the old stub lacked runtimeId, ptyId,
worktreeId and launchTokenHash) plus removal of stacked duplicate
directives there.

* chore(lint): typed vi.mock imports and explicit listener snapshot in shared-bucket tests

Remaining files from the misc-rule pass that overlapped other buckets:
codex-accounts mocks use the typed vi.mock(import(...)) form instead of
a consistent-type-imports disable; the daemon late-exit fixture copies
its listener set with Array.from instead of a no-useless-spread disable.

* refactor(github,mobile): narrow routing settings type; drop remaining avoidable casts

- work-item-routing cast a one-field object to AppState['settings'] under
  a claim that readers only consume activeRuntimeEnvironmentId. Return the
  existing RuntimeFocusSettings pick instead and narrow the cache-key
  chain's parameters, so the compiler enforces that claim.
- mobile file preview reads refusals through the RpcResponse `ok`
  discriminant rather than a cast.
- terminal document host-notify accepts `unknown` errors, removing the
  message-bridge cast.
- native chat readability drops a redundant repo-list cast.

* test(renderer): replace repeated cast suppressions with typed fixtures

-140 cast directives (and ~150 unsuppressed casts of the same shapes):
- mockPanePtyArgs owns the connectPanePty fixture casts, so a wrong
  argument order or fixture is now a type error; drop binding casts for
  members PanePtyBinding already declares.
- Seed AppState tab rows with the typed makeTerminalTab; this exposed a
  split direction 'row' that is not a TerminalPaneSplitDirection.
- Partial GlobalSettings use getDefaultSettings overrides; Jira-only
  stores use createTestStore; runtime environment rows/statuses come from
  a typed paired-runtime-environment fixture.

* chore(lint): drop no-module-mocking disable now covered by the test-fixture glob

* test(e2e): fix all 221 grandfathered e2e type errors; baseline to zero

The e2e typecheck baseline grandfathered 221 errors in 119 files. About a
third were tests drifted from the current API, several of which would
fail or mislead at runtime:
- terminal-shortcuts called a nonexistent xterm buffer method;
- the daemon-lifecycle fake lacked terminateOwnedTree, hidden by importing
  its type from a module that does not export it;
- arguments in the wrong position (listProcesses(hostId, opts), a dropped
  pty.write inputKind, an extra toWebTerminalSurfaceTabId argument);
- removed enum values ('drawer', 'idle', 'editor',
  'session-insecure-origin') and a launch_source the telemetry schema
  rejects;
- missing required fields (turnScope, childWorkOpen, providerIdentity,
  reviewLookupOutcome, runtimeServiceAccount behind an `as RelayConfig`);
- dead reads (tab.customTitle, bucket.targets, changedPixels).
Also lifts variables that narrowed to `never` after poll-callback
assignment, and adds a typed xterm render-dimensions accessor. Includes
the cross-version suites' shared releaseModuleExport adoption.

* chore(typecheck): gate the now-clean e2e typecheck in local lint

The e2e baseline is empty, so the ratchet now rejects any tests/ type
error. CI already runs it via run-ratchets; add it to pnpm lint's
explicit ratchet list and replace the stale 'not yet clean' note.

* test(mobile): typecheck every mobile test; baseline 105 files -> 0

mobile/tests-typecheck-baseline.txt grandfathered 105 test files (531
errors) whose types CI never checked. Contract changes had landed without
these tests following, and type pins in them silently checked nothing.

- Root cause: salvagedOptional (src/shared/zod-salvage.ts) cast away
  zod's optional marker, so every reply type built on it claimed
  salvaged fields were always present. Return a real ZodOptional;
  runtime is unchanged (the outer optional short-circuits undefined).
- Production now takes the port it uses: RpcOperationSender instead of
  RpcClient for send-only callers, a narrow fetch signature, and only the
  request fields push-receive reads.
- findAllByHostType/findByHostType replace `'Text' as never` lookups;
  stubRpcClient gives tests a typed RpcClient.
- Real test bugs: settings-host-client-lifecycle "relay" hosts were
  direct hosts (relayHostId no longer exists); two toEqualTypeOf pins
  could never hold; a recovery hook ran with an undefined scope key;
  a create-PR test cast to a never-imported type; "no URL" assertions
  passed on null; plus stale required props, args and enum values.

* test(e2e): parse workerStart result instead of casting it

* test(runtime): typed partial runtime stores with production-shaped fixture data

Route every partial store passed to OrcaRuntimeService through
partialRuntimeStore with typed row builders, removing 60 cast directives
that hid fixture data production never produces:
- paired-client-navigation-test-harness keyed setWorktreeMeta writes by
  `[object Object]` (it took an id where the store takes a target), so
  reads never saw them;
- invalid worktree lineage origin/capture and incomplete workspace lineage;
- getWorkspaceSession returning null where the store returns the default
  session; getGitHubCache returning undefined;
- orcad migration states missing migrationId/manifest/receipt, with a
  toEqual pinned to that incomplete shape;
- partial repos, metadata, folders, project groups and notification rows.

* refactor(renderer): resolve suppressed React hook lint instead of disabling it

109 of 187 react-hooks/react-doctor suppressions fixed:
- ~95 exhaustive-deps disables only hid stable refs and setters passed
  through controller objects; list them (identity never changes, so
  nothing re-runs), plus a few real stale closures (tabId/worktreeId).
- Effects keyed on one value that read the latest props now use
  useEffectEvent (WebConnect, skill freshness, Bitbucket dialog seeding,
  Landing preflight, automation catalog, structured-session recovery,
  file explorer).
- The conditional layout-owner hook is selected once at module load from
  the build constant instead of a rules-of-hooks disable that also hid
  the whole controller from compiler and react-doctor rules.
- A hook disable was masking a react/purity Date.now() in the palette's
  recent-tabs memo; sample it when the snapshot is captured.
- Three identical debounced-search effects share
  useTaskSearchDebouncedApply; layout snapshot merge helpers move out to
  stay under max-lines.
Remaining suppressions are mount-once resources, invalidation epochs,
deliberately keyed fields, and test harnesses that mock the dispatcher.

* chore(ratchet): exempt test harnesses and fixtures from the focus-read ratchet

The ratchet skipped *.test-fixture.ts but scanned *-test-harness,
*-test-fixture(s) and *.test-support files. Those seed settings with
getDefaultSettings (which the ratchet discovers as a focus reader) and
never route host work, so 17 baseline entries were false positives, and
replacing a test's `settings: {...} as never` with typed defaults tripped
it. Match the repo's test-support names and prune (which also drops one
stale entry), and rename the frame-ordering harness to *-test-harness like
its siblings. A blanket "-harness" match would also exempt
e2e-terminal-pty-harness, which production imports, so the names stay
explicit.

* test: merge duplicate shared/constants imports

* revert(file-explorer): restore original tree load effects pending SSH e2e investigation

* test(runtime): drop RuntimeStore cast now that the fixture is typed

---------

Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
2026-10-24 19:37:19 -07:00

372 lines
13 KiB
TypeScript

import { openSidebarProjectDialog } from './helpers/sidebar-project-dialog'
import { execFileSync } from 'node:child_process'
import { randomUUID } from 'node:crypto'
import { mkdtempSync, rmSync } from 'node:fs'
import os from 'node:os'
import path from 'node:path'
import type { ElectronApplication, Page } from '@stablyai/playwright-test'
import { test, expect } from './helpers/orca-app'
import { worktreeRow, worktreeRowSurface } from './worktree-row-locators'
type RuntimePairingOffer = {
deviceId: string
webClientUrl: string
}
type TestWorktreeIds = {
host: string
clientA: string
clientB: string
clientA2: string
}
const isPairedBrowserRun = process.env.ORCA_E2E_WEB_CLIENT === '1'
test.skip(
!isPairedBrowserRun,
'Run with pnpm test:e2e:multi-client-navigation so the paired web client is built'
)
function addGitWorktree(repoPath: string, branchName: string): void {
const worktreePath = path.join(path.dirname(repoPath), `e2e-test-${branchName}`)
execFileSync('git', ['worktree', 'add', '-b', branchName, worktreePath], {
cwd: repoPath,
stdio: 'pipe'
})
}
async function loadTestWorktreeIds(
hostPage: Page,
branchA: string,
branchB: string
): Promise<TestWorktreeIds | null> {
return hostPage.evaluate(
async ({ branchA, branchB }) => {
const store = window.__store
if (!store) {
return null
}
const repo = store.getState().repos[0]
if (!repo) {
return null
}
await store.getState().fetchWorktrees(repo.id)
const worktrees = store.getState().worktreesByRepo[repo.id] ?? []
const host = worktrees.find((worktree) => worktree.branch === 'refs/heads/e2e-secondary')
const clientA = worktrees.find((worktree) => worktree.branch === `refs/heads/${branchA}`)
const clientB = worktrees.find((worktree) => worktree.branch === `refs/heads/${branchB}`)
const clientA2 = worktrees.find((worktree) => worktree.isMainWorktree)
if (!host || !clientA || !clientB || !clientA2) {
return null
}
return {
host: host.id,
clientA: clientA.id,
clientB: clientB.id,
clientA2: clientA2.id
}
},
{ branchA, branchB }
)
}
async function createPairingOffer(hostPage: Page): Promise<RuntimePairingOffer> {
return hostPage.evaluate(async () => {
const offer = await window.api.mobile.getRuntimePairingUrl({
address: '127.0.0.1',
rotate: true
})
if (!offer.available || !offer.webClientUrl) {
const reason = offer.available ? 'web client URL is missing' : 'runtime server is unavailable'
throw new Error(`Runtime web client pairing failed: ${reason}`)
}
return { deviceId: offer.deviceId, webClientUrl: offer.webClientUrl }
})
}
async function openPairedClient(
electronApp: ElectronApplication,
offer: RuntimePairingOffer,
visibleWorktreeId: string
): Promise<Page> {
const pagePromise = electronApp.waitForEvent('window')
await electronApp.evaluate(
async ({ BrowserWindow }, { partition, url }) => {
const clientWindow = new BrowserWindow({
height: 1200,
show: false,
width: 1440,
webPreferences: {
contextIsolation: true,
nodeIntegration: false,
partition,
sandbox: true
}
})
await clientWindow.loadURL(url)
},
{
partition: `e2e-paired-client-${randomUUID()}`,
url: offer.webClientUrl
}
)
const page = await pagePromise
await expect(page.locator('[data-worktree-sidebar]')).toBeVisible({ timeout: 30_000 })
await expect(worktreeRow(page, visibleWorktreeId)).toBeVisible({ timeout: 30_000 })
return page
}
async function selectWorktree(page: Page, worktreeId: string): Promise<void> {
await worktreeRowSurface(page, worktreeId).click()
await expectActiveWorktree(page, worktreeId)
}
async function expectActiveWorktree(page: Page, worktreeId: string): Promise<void> {
await expect(page.locator('[data-rendered-active-worktree-id]')).toHaveAttribute(
'data-rendered-active-worktree-id',
worktreeId
)
}
test('keeps two paired browser clients and the host on independent worktrees', async ({
orcaPage,
electronApp,
testRepoPath
}) => {
const suffix = randomUUID().slice(0, 8)
const branchA = `e2e-client-a-${suffix}`
const branchB = `e2e-client-b-${suffix}`
addGitWorktree(testRepoPath, branchA)
addGitWorktree(testRepoPath, branchB)
await expect
.poll(() => loadTestWorktreeIds(orcaPage, branchA, branchB), {
timeout: 30_000,
message: 'Expected host plus three client-selectable worktrees'
})
.not.toBeNull()
// Playwright's matcher does not narrow the polled value for TypeScript.
const ids = await loadTestWorktreeIds(orcaPage, branchA, branchB)
if (!ids) {
throw new Error('Test worktrees disappeared after discovery')
}
await selectWorktree(orcaPage, ids.host)
let clientA: Page | null = null
let clientB: Page | null = null
try {
const offerA = await createPairingOffer(orcaPage)
clientA = await openPairedClient(electronApp, offerA, ids.clientA)
await selectWorktree(clientA, ids.clientA)
// Why: rotation preserves used grants, so B is issued only after A has completed pairing.
const offerB = await createPairingOffer(orcaPage)
expect(offerB.deviceId).not.toBe(offerA.deviceId)
clientB = await openPairedClient(electronApp, offerB, ids.clientB)
await selectWorktree(clientB, ids.clientB)
await expectActiveWorktree(clientA, ids.clientA)
await expectActiveWorktree(orcaPage, ids.host)
await selectWorktree(clientA, ids.clientA2)
await expectActiveWorktree(clientB, ids.clientB)
await expectActiveWorktree(orcaPage, ids.host)
} finally {
await clientB?.close()
await clientA?.close()
}
})
test('keeps a paired client workspace create-with-agent off the other client and the host', async ({
orcaPage,
electronApp,
testRepoPath
}) => {
const suffix = randomUUID().slice(0, 8)
const branchA = `e2e-create-a-${suffix}`
const branchB = `e2e-create-b-${suffix}`
addGitWorktree(testRepoPath, branchA)
addGitWorktree(testRepoPath, branchB)
await expect
.poll(() => loadTestWorktreeIds(orcaPage, branchA, branchB), {
timeout: 30_000,
message: 'Expected host plus client-selectable worktrees'
})
.not.toBeNull()
const ids = await loadTestWorktreeIds(orcaPage, branchA, branchB)
if (!ids) {
throw new Error('Test worktrees disappeared after discovery')
}
await selectWorktree(orcaPage, ids.host)
let clientA: Page | null = null
let clientB: Page | null = null
try {
const offerA = await createPairingOffer(orcaPage)
clientA = await openPairedClient(electronApp, offerA, ids.clientA)
await selectWorktree(clientA, ids.clientA)
const offerB = await createPairingOffer(orcaPage)
clientB = await openPairedClient(electronApp, offerB, ids.clientB)
await selectWorktree(clientB, ids.clientB)
// Client A creates a workspace with a startup command, which is the only remote
// create shape the renderer sends `activate: true` for (STA-2802's field trigger).
const createdWorktreeId = await clientA.evaluate(async (name) => {
const store = window.__store
if (!store) {
throw new Error('paired client store unavailable')
}
const state = store.getState()
const repoId = state
.allWorktrees()
.find((worktree) => worktree.id === state.activeWorktreeId)?.repoId
if (!repoId) {
throw new Error('active worktree has no repo')
}
const result = await state.createWorktree(
repoId,
name,
undefined,
'skip',
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
undefined,
{ command: 'echo sta-2802-startup' }
)
return result.worktree.id
}, `e2e-created-${suffix}`)
// Shared catalog state must still reach the observer...
await expect(worktreeRow(clientB, createdWorktreeId)).toBeVisible({ timeout: 30_000 })
// ...while its view stays exactly where its own user left it.
await expectActiveWorktree(clientB, ids.clientB)
await expectActiveWorktree(orcaPage, ids.host)
// The creator can still reach and open what it made, and doing so still moves nobody
// else. This drives the store action directly, so the composer's automatic
// self-navigation on create is covered by worktree-creation-flow.test.ts and by the
// host-side composer journey in worktree.spec.ts, not here.
await selectWorktree(clientA, createdWorktreeId)
await expectActiveWorktree(clientB, ids.clientB)
await expectActiveWorktree(orcaPage, ids.host)
// The observer keeps its own navigation authority afterwards.
await selectWorktree(clientB, ids.clientA2)
await expectActiveWorktree(clientA, createdWorktreeId)
await expectActiveWorktree(orcaPage, ids.host)
} finally {
await clientB?.close()
await clientA?.close()
}
})
test('shows only provider-backed creation actions in paired web', async ({
electronApp,
orcaPage
}, testInfo) => {
const visibleWorktreeId = await orcaPage.evaluate(
() => window.__store?.getState().activeWorktreeId
)
if (!visibleWorktreeId) {
throw new Error('Host worktree was not active before paired web validation')
}
const offer = await createPairingOffer(orcaPage)
const client = await openPairedClient(electronApp, offer, visibleWorktreeId)
try {
await selectWorktree(client, visibleWorktreeId)
await expect
.poll(() =>
client.evaluate(() => {
const state = window.__store?.getState()
if (!state) {
return false
}
const worktree = state
.allWorktrees()
.find((candidate) => candidate.id === state.activeWorktreeId)
const environmentId = worktree?.runtimeOwnerEnvironmentId
return environmentId
? state.runtimeStatusByEnvironmentId
.get(environmentId)
?.status?.capabilities?.includes('browser.screencast.v1') === true
: false
})
)
.toBe(true)
await client.getByRole('button', { name: 'New tab' }).first().click()
await expect(client.getByRole('menuitem', { name: /New Terminal/i })).toBeVisible()
await expect(client.getByRole('menuitem', { name: /New Browser Tab/i })).toBeVisible()
await expect(client.getByRole('menuitem', { name: /New Markdown/i })).toBeVisible()
await expect(client.getByRole('menuitem', { name: /Mobile Emulator/i })).toHaveCount(0)
const screenshotPath = testInfo.outputPath('paired-web-provider-backed-create-menu.png')
await client.screenshot({ path: screenshotPath })
await testInfo.attach('paired-web-provider-backed-create-menu', {
path: screenshotPath,
contentType: 'image/png'
})
} finally {
await client.close()
}
})
test('routes Add Project folder browsing through the paired host', async ({
electronApp,
orcaPage,
registerPostElectronShutdownCleanup
}) => {
const hostFolder = mkdtempSync(path.join(os.tmpdir(), 'orca-paired-web-folder-'))
const folderName = path.basename(hostFolder)
registerPostElectronShutdownCleanup(async () => {
rmSync(hostFolder, { recursive: true, force: true })
})
const visibleWorktreeId = await orcaPage.evaluate(
() => window.__store?.getState().activeWorktreeId
)
if (!visibleWorktreeId) {
throw new Error('Host worktree was not active before paired web validation')
}
const offer = await createPairingOffer(orcaPage)
const client = await openPairedClient(electronApp, offer, visibleWorktreeId)
try {
await openSidebarProjectDialog(client)
const addDialog = client.getByRole('dialog', { name: /Add a project/i })
await expect(addDialog).toBeVisible()
await expect(addDialog).not.toContainText('Local Mac')
await addDialog.getByRole('button', { name: /Browse folder/i }).click()
const browser = client.getByRole('dialog', { name: /Browse host filesystem/i })
await expect(browser).toBeVisible()
await expect(browser.getByRole('button', { name: /Select folder/i })).toBeVisible()
await browser.getByRole('button', { name: /^Cancel$/i }).click()
const manualPathDialog = client.getByRole('dialog', { name: /Open host project/i })
await manualPathDialog.locator('#server-project-path').fill(hostFolder)
await manualPathDialog.getByRole('button', { name: /Open as Folder/i }).click()
await expect(manualPathDialog).toBeHidden({ timeout: 30_000 })
await expect(
client.locator('[data-worktree-sidebar]').getByText(folderName, { exact: true }).first()
).toBeVisible({ timeout: 30_000 })
} finally {
await client.close()
}
})