Files
orca/tests/e2e/source-control-create-pr.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

296 lines
9.9 KiB
TypeScript

import type { Locator, Page } from '@stablyai/playwright-test'
import { test, expect } from './helpers/orca-app'
import { waitForActiveWorktree, waitForSessionReady } from './helpers/store'
import type { CreateHostedReviewResult } from '../../src/shared/hosted-review'
type CreatePRPayload = {
repoPath: string
input: {
provider: string
base: string
head?: string
title: string
body?: string
draft?: boolean
}
}
async function openSourceControl(page: Page, expectedWorktreeId: string): Promise<void> {
await page.evaluate((expectedWorktreeId) => {
const state = window.__store?.getState()
if (state && state.activeWorktreeId !== expectedWorktreeId) {
state.setActiveWorktree(expectedWorktreeId)
}
state?.setRightSidebarOpen(true)
state?.setRightSidebarTab('source-control')
}, expectedWorktreeId)
await expect
.poll(
async () =>
page.evaluate((expectedWorktreeId) => {
const store = window.__store
if (!store) {
return false
}
const state = store.getState()
if (state.activeWorktreeId !== expectedWorktreeId) {
state.setActiveWorktree(expectedWorktreeId)
}
state.setRightSidebarOpen(true)
state.setRightSidebarTab('source-control')
const current = store.getState()
const activeWorktree = Object.values(current.worktreesByRepo)
.flat()
.some((entry) => entry.id === expectedWorktreeId)
return (
activeWorktree &&
current.activeWorktreeId === expectedWorktreeId &&
current.rightSidebarOpen &&
current.rightSidebarTab === 'source-control'
)
}, expectedWorktreeId),
{ timeout: 5_000 }
)
.toBe(true)
const sourceControlTab = page.getByRole('button', { name: /Source Control/ })
await expect(sourceControlTab).toBeVisible()
await sourceControlTab.click()
}
async function forceCreatePREligibleStatus(
page: Page,
worktreeId: string,
branch: string
): Promise<void> {
await page.evaluate(
({ worktreeId, branch }) => {
window.__store?.setState((current) => ({
remoteStatusesByWorktree: {
...current.remoteStatusesByWorktree,
[worktreeId]: {
hasUpstream: true,
upstreamName: `origin/${branch}`,
ahead: 0,
behind: 0
}
}
}))
},
{ worktreeId, branch }
)
}
function getCreatePRComposer(page: Page): Locator {
const titleInput = page.getByRole('textbox', { name: 'Pull request title' })
const descriptionLabelPredicate =
'translate(@aria-label, "ABCDEFGHIJKLMNOPQRSTUVWXYZ", "abcdefghijklmnopqrstuvwxyz")=' +
'"pull request description"'
return titleInput.locator(
`
xpath=ancestor::*[.//textarea[${descriptionLabelPredicate}]
and .//button[normalize-space(.)="Create PR"]][1]
`.trim()
)
}
function getCreatePRComposerSubmitButton(page: Page): Locator {
// Why: the header and composer currently share the same accessible name.
// Anchor to the field container so this submits the editable composer.
return getCreatePRComposer(page).getByRole('button', { name: 'Create PR' })
}
async function seedCreatePREligibleBranch(
page: Page,
options: { createResult?: CreateHostedReviewResult } = {}
): Promise<{ branch: string; worktreeId: string }> {
return page.evaluate(async ({ createResult }) => {
const store = window.__store
if (!store) {
throw new Error('window.__store is not available')
}
const state = store.getState()
const worktrees = Object.values(state.worktreesByRepo).flat()
const worktree = worktrees.find(
(entry) => entry.branch.replace(/^refs\/heads\//, '') === 'e2e-secondary'
)
if (!worktree) {
throw new Error('seeded e2e-secondary worktree not found')
}
// Why: the worker-scoped test repo can accumulate extra non-main
// worktrees; use the seeded secondary worktree as the stable PR target.
state.setActiveWorktree(worktree.id)
const repo = state.repos.find((entry) => entry.id === worktree.repoId)
if (!repo) {
throw new Error('active repo not found')
}
const branch = worktree.branch.replace(/^refs\/heads\//, '')
const pr = {
number: 73,
title: 'Create PR from E2E',
state: 'open' as const,
url: 'https://github.com/acme/orca/pull/73',
checksStatus: 'pending' as const,
updatedAt: '2026-05-15T00:00:00.000Z',
mergeable: 'UNKNOWN' as const
}
const eligibility = {
provider: 'github' as const,
review: null,
canCreate: true,
blockedReason: null,
nextAction: null,
reviewLookupOutcome: 'not_found' as const,
defaultBaseRef: 'origin/main',
head: branch
}
;(window as unknown as { __createPRPayloads: CreatePRPayload[] }).__createPRPayloads = []
store.setState((current) => ({
repos: current.repos.map((candidate) =>
candidate.id === repo.id ? { ...candidate, worktreeBaseRef: 'origin/main' } : candidate
),
gitStatusByWorktree: {
...current.gitStatusByWorktree,
[worktree.id]: []
},
remoteStatusesByWorktree: {
...current.remoteStatusesByWorktree,
[worktree.id]: {
hasUpstream: true,
upstreamName: `origin/${branch}`,
ahead: 0,
behind: 0
}
},
getHostedReviewCreationEligibility: async () => eligibility,
fetchHostedReviewForBranch: async () => null,
setUpstreamStatus: () => undefined,
fetchUpstreamStatus: async () => null,
fetchPRForBranch: async (repoPath: string, targetBranch: string) => {
store.setState((next) => ({
prCache: {
...next.prCache,
[`${repo.id}::${targetBranch}`]: {
data: pr,
fetchedAt: Date.now()
},
[`${repoPath}::${targetBranch}`]: {
data: pr,
fetchedAt: Date.now()
}
}
}))
return pr
},
fetchPRChecks: async () => [],
fetchPRComments: async () => [],
createHostedReview: async (repoPath, input) => {
;(window as unknown as { __createPRPayloads: CreatePRPayload[] }).__createPRPayloads.push({
repoPath,
input
})
if (createResult) {
return createResult
}
return {
ok: true as const,
number: 73,
url: 'https://github.com/acme/orca/pull/73'
}
}
}))
state.setRightSidebarOpen(true)
state.setRightSidebarTab('source-control')
return { branch, worktreeId: worktree.id }
}, options)
}
test.describe('Source Control create pull request', () => {
test.beforeEach(async ({ orcaPage }) => {
await waitForSessionReady(orcaPage)
await waitForActiveWorktree(orcaPage)
})
test('creates the pull request from the Source Control primary action', async ({ orcaPage }) => {
const { branch, worktreeId } = await seedCreatePREligibleBranch(orcaPage)
await openSourceControl(orcaPage, worktreeId)
await forceCreatePREligibleStatus(orcaPage, worktreeId, branch)
const titleInput = orcaPage.getByRole('textbox', { name: 'Pull request title' })
const descriptionInput = orcaPage.getByRole('textbox', {
name: 'Pull request description'
})
const createButton = getCreatePRComposerSubmitButton(orcaPage)
await expect(createButton).toBeVisible({ timeout: 10_000 })
await expect(createButton).toBeEnabled()
await expect(titleInput).toHaveValue('E2e secondary')
await expect(orcaPage.getByRole('combobox', { name: 'Pull request base branch' })).toHaveValue(
'main'
)
await expect(descriptionInput).toHaveValue('')
await descriptionInput.fill('- Initial commit for E2E')
await expect(createButton).toBeEnabled()
await createButton.click()
await expect
.poll(
() =>
orcaPage.evaluate(
() =>
(window as unknown as { __createPRPayloads: CreatePRPayload[] }).__createPRPayloads
.length
),
{ timeout: 10_000 }
)
.toBe(1)
const payloads = await orcaPage.evaluate(
() => (window as unknown as { __createPRPayloads: CreatePRPayload[] }).__createPRPayloads
)
expect(payloads).toHaveLength(1)
expect(payloads[0].input).toMatchObject({
provider: 'github',
base: 'main',
head: branch,
title: 'E2e secondary',
body: '- Initial commit for E2E',
draft: false
})
})
test('surfaces create failures without clearing the pull request composer', async ({
orcaPage
}) => {
const failureMessage = 'Create PR failed: GitHub API rate limit exceeded'
const { branch, worktreeId } = await seedCreatePREligibleBranch(orcaPage, {
createResult: {
ok: false,
code: 'unknown',
error: failureMessage
}
})
await openSourceControl(orcaPage, worktreeId)
await forceCreatePREligibleStatus(orcaPage, worktreeId, branch)
const titleInput = orcaPage.getByRole('textbox', { name: 'Pull request title' })
const descriptionInput = orcaPage.getByRole('textbox', {
name: 'Pull request description'
})
const createButton = getCreatePRComposerSubmitButton(orcaPage)
await expect(createButton).toBeVisible({ timeout: 10_000 })
await titleInput.fill('Failing PR from E2E')
await descriptionInput.fill('This draft should survive a failed create attempt.')
await expect(createButton).toBeEnabled()
await createButton.click()
await expect(orcaPage.getByText(failureMessage)).toBeVisible()
await expect(titleInput).toHaveValue('Failing PR from E2E')
await expect(descriptionInput).toHaveValue('This draft should survive a failed create attempt.')
await expect(orcaPage.getByRole('combobox', { name: 'Pull request base branch' })).toHaveValue(
'main'
)
await expect(createButton).toBeEnabled()
})
})