Files
orca/src/main/github/client-test-mocks.ts
T
Neil 9367169888 refactor(tests): split every oversized test file off the max-lines suppression list (#14728)
* refactor(tests): split oversized test files off the max-lines suppression list

Every `*.test.ts`/`*.spec.ts` that carried an `eslint/oxlint-disable max-lines`
directive is now split into focused, behavior-scoped suites that fit the 800-line
test budget, with shared setup extracted into co-located `*-test-harness.ts` /
`*-test-fixtures.ts` modules (300-line budget). 83 files became ~930; the largest
output is 797 effective lines. `orca-runtime.test.ts` is intentionally untouched.

Test bodies were moved by scripted line-range slicing rather than retyped, so
assertions are byte-identical. The only permitted body edits were mechanical
rebinding where a shared value moved into a harness (e.g. `tmpHome` ->
`homes.tmpHome`).

Registries that enumerate test files were updated in lockstep:
- config/max-lines-baseline.txt: pruned 341 -> 258 entries (all 83 removed).
- config/reliability-gates.jsonc: 33 gates repointed at the split files, with
  assertionRefs split per file where a gate's coverage now spans several.
- .github/workflows/pr.yml: the real-zsh lane now lists the 4 split files that
  actually exercise zsh, so they keep running in the dedicated shell lane.

Also renamed agent-hooks `server-test-fixtures.ts` to `server.test-fixtures.ts`
so the global-fetch call-site audit keeps skipping it, and added `.js` extensions
to the CLI suites' dynamic harness imports (node16 resolution) to unbreak
`build:cli`.

Verification: full suite 52,449 passing vs 52,448 at baseline with zero
assertions lost; `pnpm lint`, `pnpm typecheck`, and `pnpm build:cli` all exit 0;
the terminal-pane e2e spec runs 31/31 headless.

* refactor(tests): split hook-idle arbitration suite that oxfmt pushed over budget

The pre-commit oxfmt pass reflowed pty-connection-hook-idle-arbitration.test.ts
to 811 effective lines, 11 over the test budget. Split the hook-completion side
effect and replacement-agent veto cases into their own suite; both files now sit
well under the cap and the 15 tests are unchanged.

* test: port upstream test changes into the split files after rebase

Rebasing onto main surfaced 27 tests that main had added to files this branch
deleted, plus edits to tests that had already moved. Taking the deletion side of
those modify/delete conflicts would have dropped that coverage silently, so each
upstream change is ported into the split file that now owns the behavior — for
example main's six orchestration mailbox tests land across orchestration-runs,
-send, and -check.

Also repoints `orchestration.notification-mailbox-consistency`, a gate main added
after this branch's gate remap, at those same three split files, and re-prunes
the max-lines baseline against main's (257 entries).

Verified: all 27 upstream test titles present; full suite 52,761 passing with the
only diff vs baseline being 12 tests main itself removed and 3 that moved from
skipped to passing; lint and typecheck exit 0.

* fix(test): flush pending continuations before tearing down terminal test globals

CI shard 5/16 failed on both Node 24 and 26 with `ReferenceError: window is not
defined` from pty-connection.ts, surfacing through
pty-connection-daemon-snapshot-replay.test.ts.

The reattach/settle chains `await` a real promise and then touch `window.api`.
Under fake timers those continuations cannot run, so they only become schedulable
once restoreTerminalTestGlobals() switches back to real timers — which previously
happened immediately before `delete globalThis.window`, so a late continuation
threw and failed the whole file. Flush async ticks in that window instead.

This is latent in the source rather than new: the pre-split 25k-line file kept
running other tests after these, which gave the chains time to settle before
teardown. Splitting the file moved teardown directly behind them.

* fix(test): keep an inert window after terminal test teardown instead of deleting it

The async-tick flush was not enough: the reattach/settle chain can resolve after
teardown regardless of how long we drain, so CI shard 5/16 still failed with
`ReferenceError: window is not defined` from pty-connection.ts.

A real renderer never loses `window`, so deleting it was the artificial part.
Swap in an inert proxy whose properties resolve to callables and whose calls
resolve to undefined, making a late `window.api.pty.*` call a harmless no-op.
The next test replaces it wholesale via installTerminalTestGlobals(), and no test
asserts that `window` is absent.
2026-08-15 00:54:20 -07:00

234 lines
8.6 KiB
TypeScript

import { vi, type Mock } from 'vitest'
import type { ClassifiedError } from '../../shared/classified-error'
import type { GitHubOwnerRepo } from '../../shared/github/pull-request-types'
import type * as GithubApiRepositoryModule from './github-api-repository'
import type * as GitHubEnterpriseRepositoryModule from './github-enterprise-repository'
import type { ghRepoExecOptions, githubRepoContext } from './github-repository-identity'
export type RateLimitGuardResult =
| { blocked: false }
| { blocked: true; remaining: number; limit: number; resetAt: number }
export type GitHubClientMocks = {
execFileAsyncMock: Mock
ghExecFileAsyncMock: Mock
getOwnerRepoMock: Mock
getIssueOwnerRepoMock: Mock
getOwnerRepoForRemoteMock: Mock
resolvePRRepositoryCandidatesMock: Mock
getRemoteUrlForRepoMock: Mock
gitExecFileAsyncMock: Mock
getRateLimitMock: Mock
rateLimitGuardMock: Mock<(bucket?: string) => RateLimitGuardResult>
noteRateLimitSpendMock: Mock
ghRepoExecOptionsMock: Mock<typeof ghRepoExecOptions>
githubRepoContextMock: Mock<typeof githubRepoContext>
getSshGitProviderMock: Mock
readLocalGitConfigSignatureMock: Mock
acquireMock: Mock
releaseMock: Mock
}
// Why: every client suite registers its own `vi.mock` factories (hoisting is
// per-file), so the mock set and the factory bodies live here and the test file
// only wires them together.
export function createGitHubClientMocks(): GitHubClientMocks {
return {
execFileAsyncMock: vi.fn(),
ghExecFileAsyncMock: vi.fn(),
getOwnerRepoMock: vi.fn(),
getIssueOwnerRepoMock: vi.fn(),
getOwnerRepoForRemoteMock: vi.fn(),
resolvePRRepositoryCandidatesMock: vi.fn(),
getRemoteUrlForRepoMock: vi.fn(),
gitExecFileAsyncMock: vi.fn(),
getRateLimitMock: vi.fn(),
rateLimitGuardMock: vi.fn<(bucket?: string) => RateLimitGuardResult>(() => ({
blocked: false
})),
noteRateLimitSpendMock: vi.fn(),
ghRepoExecOptionsMock: vi.fn<typeof ghRepoExecOptions>((context) =>
context.connectionId
? {}
: {
cwd: context.repoPath,
...(context.wslDistro ? { wslDistro: context.wslDistro } : {})
}
),
githubRepoContextMock: vi.fn<typeof githubRepoContext>(
(repoPath, connectionId, localGitOptions) => ({
repoPath,
connectionId: connectionId ?? null,
...localGitOptions
})
),
getSshGitProviderMock: vi.fn(),
readLocalGitConfigSignatureMock: vi.fn(),
acquireMock: vi.fn(),
releaseMock: vi.fn()
}
}
export type GhUtilsModuleMock = {
execFileAsync: Mock
ghExecFileAsync: Mock
getOwnerRepo: Mock
getIssueOwnerRepo: Mock
getOwnerRepoForRemote: Mock
resolvePRRepositoryCandidates: Mock
getRemoteUrlForRepo: Mock
gitExecFileAsync: Mock
ghRepoExecOptions: Mock<typeof ghRepoExecOptions>
githubRepoContext: Mock<typeof githubRepoContext>
classifyGhError: (stderr: string) => ClassifiedError
parseGitHubOwnerRepo: (remoteUrl: string) => GitHubOwnerRepo | null
acquire: Mock
release: Mock
_resetOwnerRepoCache: Mock
}
export function ghUtilsModuleMock(mocks: GitHubClientMocks): GhUtilsModuleMock {
return {
execFileAsync: mocks.execFileAsyncMock,
ghExecFileAsync: mocks.ghExecFileAsyncMock,
getOwnerRepo: mocks.getOwnerRepoMock,
getIssueOwnerRepo: mocks.getIssueOwnerRepoMock,
getOwnerRepoForRemote: mocks.getOwnerRepoForRemoteMock,
resolvePRRepositoryCandidates: mocks.resolvePRRepositoryCandidatesMock,
getRemoteUrlForRepo: mocks.getRemoteUrlForRepoMock,
gitExecFileAsync: mocks.gitExecFileAsyncMock,
ghRepoExecOptions: mocks.ghRepoExecOptionsMock,
githubRepoContext: mocks.githubRepoContextMock,
classifyGhError: (stderr: string) => {
const lower = stderr.toLowerCase()
if (lower.includes('not found') || stderr.includes('HTTP 404')) {
return { type: 'not_found', message: stderr }
}
if (lower.includes('rate limit')) {
return { type: 'rate_limited', message: stderr }
}
if (lower.includes('resource not accessible')) {
return { type: 'permission_denied', message: stderr }
}
return { type: 'unknown', message: stderr }
},
parseGitHubOwnerRepo: (remoteUrl: string) => {
const match = remoteUrl.trim().match(/github\.com[:/]([^/]+)\/([^/]+?)(?:\.git)?$/)
return match ? { owner: match[1], repo: match[2] } : null
},
acquire: mocks.acquireMock,
release: mocks.releaseMock,
_resetOwnerRepoCache: vi.fn()
}
}
export type GitRunnerModuleMock = { gitExecFileAsync: Mock; ghExecFileAsync: Mock }
export function gitRunnerModuleMock(mocks: GitHubClientMocks): GitRunnerModuleMock {
return {
gitExecFileAsync: mocks.gitExecFileAsyncMock,
ghExecFileAsync: mocks.ghExecFileAsyncMock
}
}
export type SshGitDispatchModuleMock = { getSshGitProvider: Mock }
export function sshGitDispatchModuleMock(mocks: GitHubClientMocks): SshGitDispatchModuleMock {
return { getSshGitProvider: mocks.getSshGitProviderMock }
}
export type LocalGitConfigSignatureModuleMock = { readLocalGitConfigSignature: Mock }
export function localGitConfigSignatureModuleMock(
mocks: GitHubClientMocks
): LocalGitConfigSignatureModuleMock {
return { readLocalGitConfigSignature: mocks.readLocalGitConfigSignatureMock }
}
export function githubEnterpriseRepositoryModuleMock(
actual: typeof GitHubEnterpriseRepositoryModule
): typeof GitHubEnterpriseRepositoryModule {
return {
...actual,
isGitHubHostAuthenticated: vi.fn().mockResolvedValue(true)
}
}
export type RateLimitModuleMock = {
getRateLimit: Mock
rateLimitGuard: Mock<(bucket?: string) => RateLimitGuardResult>
noteRateLimitSpend: Mock
repositoryRateLimitGuard: (repository: unknown, bucket: string) => RateLimitGuardResult
noteRepositoryRateLimitSpend: (repository: unknown, bucket: string) => void
spendsSharedGitHubComQuota: () => boolean
}
export function rateLimitModuleMock(mocks: GitHubClientMocks): RateLimitModuleMock {
return {
getRateLimit: mocks.getRateLimitMock,
rateLimitGuard: mocks.rateLimitGuardMock,
noteRateLimitSpend: mocks.noteRateLimitSpendMock,
// Why: the repository-scoped guards share the same bucket-keyed budget as the
// legacy ones, so delegate to the existing mocks to keep per-bucket blocking
// and spend assertions working unchanged.
repositoryRateLimitGuard: (_repository: unknown, bucket: string) =>
mocks.rateLimitGuardMock(bucket),
noteRepositoryRateLimitSpend: (_repository: unknown, bucket: string) =>
mocks.noteRateLimitSpendMock(bucket),
spendsSharedGitHubComQuota: () => true
}
}
export function githubApiRepositoryModuleMock(
mocks: GitHubClientMocks,
actual: typeof GithubApiRepositoryModule
): typeof GithubApiRepositoryModule {
return {
...actual,
// Why: these suites inject repo identities through the legacy gh-utils
// mocks; bridge the hosted seams onto the same mocks so per-test setups
// keep driving resolution without real enterprise probes.
resolveGitHubApiRepositoryCandidates: (
repoPath: string,
connectionId?: string | null,
localGitOptions?: unknown
) => mocks.resolvePRRepositoryCandidatesMock(repoPath, connectionId, localGitOptions),
getGitHubApiRepositoryForRemote: (
repoPath: string,
remoteName: string,
connectionId?: string | null
) => mocks.getOwnerRepoForRemoteMock(repoPath, remoteName, connectionId),
getOriginGitHubApiRepository: async (
repoPath: string,
connectionId?: string | null,
localGitOptions?: unknown
) => {
// Prefer the remote-specific mock (production origin path); fall back for
// suites that only configure getOwnerRepo.
const fromRemote = await mocks.getOwnerRepoForRemoteMock(
repoPath,
'origin',
connectionId,
localGitOptions
)
const slug =
fromRemote ?? (await mocks.getOwnerRepoMock(repoPath, connectionId, localGitOptions))
// Mirror production: dotcom origin slugs come back pinned to github.com.
return slug ? { host: 'github.com', ...slug } : slug
},
getIssueGitHubApiRepository: async (repoPath: string, connectionId?: string | null) => {
const slug = await mocks.getIssueOwnerRepoMock(repoPath, connectionId)
// Mirror production: issue slugs come back host-qualified to github.com.
return slug ? { host: 'github.com', ...slug } : slug
},
resolveIssueGitHubApiRepositorySource: async (
repoPath: string,
_preference: unknown,
connectionId?: string | null
) => {
const slug = await mocks.getIssueOwnerRepoMock(repoPath, connectionId)
return { source: slug ? { host: 'github.com', ...slug } : slug, fellBack: false }
}
}
}