Files
orca/src/main/github/project-view.test.ts
T
971b167548 fix(github): load PR diffs for Enterprise remotes (#8932)
* fix(github): load PR diffs for Enterprise remotes

* fix(github): encode PR content paths by segment

* Fix PR review actions failing on GitHub Enterprise remotes

- Threads GitHub host identity (not just owner/repo) through the client,
  work-item-details, issues, and RPC layers so gh commands target the
  correct Enterprise server instead of silently falling back to github.com
- Adds a shared github-api-repository helper to resolve/host-qualify repo
  identity consistently across REST, GraphQL, and CLI shorthand calls
- Scopes the gh rate-limit breaker and singleton rate-limit snapshot by
  host/runtime so a github.com block or probe can't affect GHES or WSL
- Coalesces concurrent host-auth probes and paginates PR file fetching
  beyond 100 results
- Propagates `host` through renderer PR caches, checks-panel keys, and
  preload IPC types so Enterprise and github.com data never collide

* Route gh host qualification through runner options instead of argv sniff

Move GHES/GH_HOST resolution from parsing --hostname/--repo out of gh argv to an explicit options.host passed through ghExecFileAsync, since SSH-backed repos spawn gh with no cwd and argv sniffing couldn't reliably detect the target host. The runner now injects --hostname and qualifies --repo/-R at spawn time from options.host, and rate-limit scoping/guards use the same explicit host instead of inferring it. Also adds a shared githubRepoIdentityKey helper to keep cache/store keys consistent with the new host-aware repository identity.

* Fix gh CLI GHES host pinning and rate-limit scope leaks

- Pin `--host` on every gh call site so a process-level GH_HOST can't
  silently redirect requests, and qualify `-R`/`-R=` repo shorthand
  alongside the existing `--repo=` handling.
- Check the target scope for an active rate-limit block before each
  WSL/native or host fallback retry, not just on the initial attempt,
  so a blocked scope can't be hit again through a fallback path.
- Compute idempotency once per call instead of re-deriving it after
  fallback reassigns args.

* Fix GitHub Enterprise host identity loss across PR/work-item paths

- Thread `host` through mobile PR RPC params, IPC work-item lookups, and
  RPC schemas so GHES identity survives the renderer/mobile/main boundary
  instead of silently falling back to a same-named github.com repo.
- Qualify `--repo`/`-R` args for github.com too (not just GHES), since
  gh resolves bare shorthand against a process-level GH_HOST that can
  redirect pinned github.com commands.
- Cache `getOriginGitHubApiRepository` to avoid a per-call uncached
  `git remote get-url` round trip on connection-backed repos.
- Add a local-fork fallback in `getWorkItemDetails` so PRs living on a
  base repo (not visible via the origin slug) still resolve via cwd.
- Centralize the github.com-vs-GHES host predicate in
  `isDefaultGitHubHost` so cache keys, quota scoping, and identity
  checks can't drift out of sync.

* Make repository identity host-aware across all GitHub surfaces

Generalize the auth-gated enterprise resolver to any remote and build a
cached hosted-identity family (origin/issue/candidates/source) on top of
it, then migrate every github.com-only consumer: Tasks listing/counting,
branch-to-PR discovery, push targets, fork upstream, issue operations,
Projects, web links, avatars, and PR-link facts. Scope the rate-limit
breaker probe per runtime:host and classify WSL UNC cwds correctly.

Co-authored-by: Orca <help@stably.ai>

* Fix expected slug to include host field in GitHub PR link test

Updates the smart-source paste-intent test fixture to match the
repository slug shape that now carries a `host` field, keeping GHES
host identity intact through the paste-intent parsing path.

* Surface per-host gh auth state for GitHub Enterprise

diagnoseGhAuth accepts the host a surface needs credentials for, scopes
the account/scope diagnosis to that host, and reports whether gh has any
login there; GhAuthErrorHelp renders host-qualified login/refresh
commands so an unauthenticated GHES host stops masquerading as a
github.com scope problem. Also fixes the mobile paste-intent expectation
for host-carrying parsed links.

Co-authored-by: Orca <help@stably.ai>

* Bound GHES identity caches and preserve non-default ports in host identity

Cap the origin-repo and host-auth caches like ownerRepoCache; keep ports
from remote/link URLs so GHES on a non-default port is a distinct
identity; make positional github.com slugs explicit against GH_HOST;
compare work-item sources by host-aware identity key; bail cwd-less
branch lookups when no repository candidate resolved; thread host
through the renderer work-item slug lookup.

Co-authored-by: Orca <help@stably.ai>

* Thread GitHub host through issue detail requests

Incorporates ghes-issue-host-support (ed6bb96ef): one hosted issue
repository identity is resolved before the details fan-out so comments,
timeline, participants, and mention lookups cannot drift across hosts,
with SSH guards so unresolved issue/PR repositories never fall through
to gh's default host.

Co-authored-by: Orca <help@stably.ai>

* Scope remaining GitHub rate-limit accounting

* Resolve typed PR lookups across hosted repository candidates

getWorkItem's PR path probes upstream-then-origin hosted candidates
instead of origin alone, so fork checkouts resolve the base repo's PR
with the right host; issue detail resolution reuses the up-front hosted
identity and keeps the SSH unresolved-host guards.

Co-authored-by: Orca <help@stably.ai>

* Refactor GitHub repository execution setup

* Carry host on smart-submit link intents

Co-authored-by: Orca <help@stably.ai>

* Carry the project host on GitHub item dialog origins

Co-authored-by: Orca <help@stably.ai>

* Keep GHES web ports but drop SSH transport ports in host identity

Supersedes PR #9118 on this branch: http(s) remote ports identify the
Enterprise web/API endpoint and are preserved, while ssh/git transport
ports (including ssh.github.com:443) never leak into gh's host identity.
Replaces the ssh.github.com:443 special case with the structural
protocol split and ports the PR's parsing test suite.

Co-authored-by: Orca <help@stably.ai>

* Support GitHub Enterprise diffs and mutations with host-scoped caches

Parse GitHub host identity from work-item URLs and carry it through PR/issue mutations, labels, and assignments. Bound rate-limit and scope-probe caches (1024 and 512 entries) to prevent unbounded growth when interacting with multiple GHES instances. Normalize repository identity keys to include host so github.com and GHES slugs don't collide in cache and equality checks.

* Support GitHub Enterprise diffs and mutations with host-scoped caches

- Carry host identity through PR mutations and reads so fork PRs on
  different GHES instances don't collide in cache or state tracking.
- Validate host authentication before routing requests to unconfigured
  Enterprise servers; ambient credentials must never reach untrusted hosts.
- Scope rate-limit guards and spend tracking per host so GHES quota stays
  independent from github.com quota.
- Respect explicit --hostname arguments in gh CLI calls ahead of GH_HOST or
  ambient defaults, so breaker state follows the actual request target.
- Detect implicit WSL runtimes from UNC paths for consistent host auth and
  execution-options scoping across mobile and desktop clients.

* Support GitHub Enterprise work-item diffs with host-scoped execution

Enterprise PRs must use their selected host consistently across diff, comments,
and file-content loads. Validate repository slugs before authenticated execution
to prevent path-injection via renderer overrides. Scope project browsing cache
and rate-limit tracking by host to prevent cross-host pollution. Use parsed
URLs as authoritative over ambient hosts for project resolution.

* Support GitHub Enterprise work-item diffs with host-scoped execution

Preserve host identity on PR/issue work items throughout the mutation and diff
pipeline so Enterprise instances (including ported endpoints like
github.acme.test:8443) can execute mutations without ambiguity. Rate-limit gh
commands by the pre-qualified --repo host, cache auth state per ported host,
and surface Enterprise hosts in project metadata and error messages.

* fix(review): drop dead rateLimitGuard/noteRateLimitSpend re-export

Both callers (project-view.ts, mutations.ts) moved to the host-scoped
repositoryRateLimitGuard/noteRepositoryRateLimitSpend; the bucket-only
re-export in internals.ts had zero importers left.

Co-authored-by: Orca <help@stably.ai>

* fix(ci): split Enterprise host work-item tests under max-lines

Move GHES/SSH host-routing cases out of work-item-details.test.ts so
the suite stays within the 800-line test max-lines budget.

* test(github): align mocks with host-scoped repository resolution

- Route origin repository resolution through getOwnerRepoForRemote, not getOwnerRepo, to match production path
- Pin github.com host on origin results so host-less fixtures pass host gate in resolveGitHubApiRepository
- Add generation-based invalidation to prevent stale slug-cache writes from in-flight resolutions
- Fix ref-sync race in ProjectPicker: use useLayoutEffect so committed tree owns browse cache key
- Defer handledCrossRepoUrlRef assignment in SmartWorkspaceNameField until resolution succeeds
- Update Enterprise host routing: found work items must not silently fall back to default host when unresolved
- Normalize GHES avatar URLs: accept explicit port 443 as canonical form, not a fallback trigger

---------

Co-authored-by: Jinjing <6427696+AmethystLiang@users.noreply.github.com>
Co-authored-by: Orca <help@stably.ai>
2026-07-20 18:55:45 -07:00

287 lines
10 KiB
TypeScript

// Why: covers the recent fixes —
// (a) network errors must NOT be misclassified as not_found ("could not
// resolve host" partially overlaps "could not resolve to a"),
// (b) repo slug validation must accept names with leading underscore
// (GitHub allows them, e.g. `_internal`),
// (c) owner slug validation must reject `.`/`_` (GitHub disallows them in
// usernames/orgs),
// (d) parseProjectPaste shorthand owner-only alphabet matches the renderer,
// (e) project owner/capability caches stay bounded in long sessions.
import { beforeEach, describe, expect, it } from 'vitest'
import {
GITHUB_PROJECT_REF_INPUT_MAX_BYTES,
GITHUB_PROJECT_REF_INPUT_TOO_LARGE_ERROR
} from '../../shared/github-project-ref-input'
import {
PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES,
_getProjectViewCacheSizesForTests,
_getProjectViewOwnerTypeForTests,
_hasProjectViewParentFieldRetriedForTests,
_hasProjectViewParentFieldWarningLoggedForTests,
_markProjectViewParentFieldRetriedForTests,
_markProjectViewParentFieldWarningLoggedForTests,
_rememberProjectViewOwnerTypeForTests,
_resetProjectViewCachesForTests,
classifyProjectError,
isValidOwnerSlug,
isValidRepoSlug,
parseProjectPaste,
resolveProjectRef
} from './project-view'
describe('classifyProjectError', () => {
it('classifies HTTP 404 as not_found', () => {
expect(classifyProjectError('HTTP 404 Not Found', '').type).toBe('not_found')
})
it('classifies "Could not resolve to a User" as not_found', () => {
expect(classifyProjectError('Could not resolve to a User with the login of foo', '').type).toBe(
'not_found'
)
})
it('classifies "could not resolve host" as network_error, NOT not_found', () => {
// Why: this was the bug — substring "could not resolve" overlaps. The
// network branch must run before not_found, and the not_found check
// must require "to a " to disambiguate.
expect(classifyProjectError('could not resolve host: api.github.com', '').type).toBe(
'network_error'
)
})
it('classifies "dial tcp" timeouts as network_error', () => {
expect(classifyProjectError('dial tcp 140.82.112.3:443: i/o timeout', '').type).toBe(
'network_error'
)
})
it('classifies rate-limit text as rate_limited', () => {
expect(classifyProjectError('API rate limit exceeded for user', '').type).toBe('rate_limited')
})
it('classifies missing-scope as scope_missing', () => {
expect(
classifyProjectError('your token has not been granted the required scopes', '').type
).toBe('scope_missing')
})
it('classifies auth-required when gh is not signed in', () => {
expect(classifyProjectError('gh auth login required', '').type).toBe('auth_required')
})
it('pins Enterprise auth and scope remediation to the selected host', () => {
expect(
classifyProjectError('gh auth login required', '', 'github.acme.test').message
).toContain('gh auth login --hostname github.acme.test')
expect(
classifyProjectError(
'your token has not been granted the required scopes',
'',
'github.acme.test'
).message
).toContain('gh auth refresh --hostname github.acme.test')
})
})
describe('isValidOwnerSlug', () => {
it('accepts plain alphanumerics and hyphens', () => {
expect(isValidOwnerSlug('acme')).toBe(true)
expect(isValidOwnerSlug('acme-co')).toBe(true)
expect(isValidOwnerSlug('user1')).toBe(true)
})
it('rejects underscore (GitHub disallows it in usernames/orgs)', () => {
expect(isValidOwnerSlug('_acme')).toBe(false)
expect(isValidOwnerSlug('acme_co')).toBe(false)
})
it('rejects leading hyphen and dot', () => {
expect(isValidOwnerSlug('-acme')).toBe(false)
expect(isValidOwnerSlug('.acme')).toBe(false)
})
it('rejects empty and slash-containing values', () => {
expect(isValidOwnerSlug('')).toBe(false)
expect(isValidOwnerSlug('a/b')).toBe(false)
expect(isValidOwnerSlug(123)).toBe(false)
})
})
describe('isValidRepoSlug', () => {
it('accepts leading underscore (GitHub allows it for repo names)', () => {
expect(isValidRepoSlug('_internal')).toBe(true)
})
it('accepts leading dot', () => {
expect(isValidRepoSlug('.github')).toBe(true)
})
it('accepts dots, dashes, underscores anywhere', () => {
expect(isValidRepoSlug('repo-name')).toBe(true)
expect(isValidRepoSlug('repo.name')).toBe(true)
expect(isValidRepoSlug('repo_name')).toBe(true)
})
it('rejects reserved single/double dot', () => {
expect(isValidRepoSlug('.')).toBe(false)
expect(isValidRepoSlug('..')).toBe(false)
})
it('rejects path separators and empty', () => {
expect(isValidRepoSlug('a/b')).toBe(false)
expect(isValidRepoSlug('')).toBe(false)
})
})
describe('parseProjectPaste', () => {
it('parses owner/number shorthand', () => {
expect(parseProjectPaste('acme/42')).toEqual({ kind: 'bare', owner: 'acme', number: 42 })
})
it('rejects shorthand with underscore in owner (renderer parity)', () => {
// Why: the renderer's parser uses `[A-Za-z0-9][A-Za-z0-9-]*` for owner
// (matches OWNER_SLUG_RE). Both sides must reject the same inputs.
expect(parseProjectPaste('co_op/45')).toBeNull()
})
it('parses org URL with view number', () => {
expect(parseProjectPaste('https://github.com/orgs/acme/projects/42/views/3')).toEqual({
kind: 'org',
owner: 'acme',
number: 42,
host: 'github.com',
viewNumber: 3
})
})
it('parses user URL', () => {
expect(parseProjectPaste('https://github.com/users/octocat/projects/1')).toEqual({
kind: 'user',
owner: 'octocat',
number: 1,
host: 'github.com'
})
})
it('rejects URLs whose owner has invalid characters', () => {
expect(parseProjectPaste('https://github.com/orgs/co_op/projects/1')).toBeNull()
})
it('accepts enterprise-host URLs only when that host is provided (GHES)', () => {
const url = 'https://github.corp.example/orgs/acme/projects/7/views/2'
expect(parseProjectPaste(url, 'github.corp.example')).toEqual({
kind: 'org',
owner: 'acme',
number: 7,
host: 'github.corp.example',
viewNumber: 2
})
expect(parseProjectPaste(url)).toBeNull()
// github.com URLs still parse when a GHES host is supplied.
expect(
parseProjectPaste('https://github.com/orgs/acme/projects/7', 'github.corp.example')
).toEqual({ kind: 'org', owner: 'acme', number: 7, host: 'github.com' })
})
it('preserves a GHES custom port while parsing project URLs', () => {
expect(
parseProjectPaste(
'https://github.corp.example:8443/orgs/acme/projects/7',
'github.corp.example:8443'
)
).toEqual({
kind: 'org',
owner: 'acme',
number: 7,
host: 'github.corp.example:8443'
})
})
it('rejects credentials and paths that only begin like a Project URL', () => {
expect(parseProjectPaste('https://user:token@github.com/orgs/acme/projects/1')).toBeNull()
expect(parseProjectPaste('https://github.com/orgs/acme/projects/1evil')).toBeNull()
expect(parseProjectPaste('https://github.com/orgs/acme/projects/1/views/2evil')).toBeNull()
expect(parseProjectPaste('https://github.com/orgs/acme/projects/1/files')).toBeNull()
})
it('returns null for empty input', () => {
expect(parseProjectPaste('')).toBeNull()
expect(parseProjectPaste(' ')).toBeNull()
})
it('rejects oversized valid-looking URLs without parsing the secret-bearing tail', () => {
const secret = 'project-url-secret'
const input = [
'https://github.com/orgs/acme/projects/42?',
secret,
'x'.repeat(GITHUB_PROJECT_REF_INPUT_MAX_BYTES)
].join('')
expect(parseProjectPaste(input)).toBeNull()
})
})
describe('resolveProjectRef', () => {
it('rejects oversized project refs with a metadata-only validation error', async () => {
const secret = 'project-url-secret'
const input = [
'https://github.com/orgs/acme/projects/42?',
secret,
'x'.repeat(GITHUB_PROJECT_REF_INPUT_MAX_BYTES)
].join('')
await expect(resolveProjectRef({ input })).resolves.toEqual({
ok: false,
error: {
type: 'validation_error',
message: GITHUB_PROJECT_REF_INPUT_TOO_LARGE_ERROR
}
})
await expect(resolveProjectRef({ input })).resolves.not.toMatchObject({
error: { message: expect.stringContaining(secret) }
})
})
})
describe('project view owner caches', () => {
beforeEach(() => {
_resetProjectViewCachesForTests()
})
it('LRU-evicts old owner type probes', () => {
for (let i = 0; i <= PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES; i++) {
_rememberProjectViewOwnerTypeForTests(`owner-${i}`, i % 2 === 0 ? 'organization' : 'user')
}
expect(_getProjectViewCacheSizesForTests().ownerTypes).toBe(
PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES
)
expect(_getProjectViewOwnerTypeForTests('owner-0')).toBeUndefined()
expect(_getProjectViewOwnerTypeForTests('owner-1')).toBe('user')
})
it('shares owner type probes between implicit and explicit github.com hosts', () => {
_rememberProjectViewOwnerTypeForTests('acme', 'organization')
expect(_getProjectViewOwnerTypeForTests('acme', 'github.com')).toBe('organization')
expect(_getProjectViewCacheSizesForTests().ownerTypes).toBe(1)
})
it('LRU-evicts old parent-field retry and warning probes', () => {
for (let i = 0; i <= PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES; i++) {
const scopeKey = `owner-${i}\u0000organization`
_markProjectViewParentFieldRetriedForTests(scopeKey)
_markProjectViewParentFieldWarningLoggedForTests(scopeKey)
}
expect(_getProjectViewCacheSizesForTests()).toMatchObject({
parentFieldRetries: PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES,
parentFieldWarnings: PROJECT_VIEW_OWNER_CACHE_MAX_ENTRIES
})
expect(_hasProjectViewParentFieldRetriedForTests('owner-0\u0000organization')).toBe(false)
expect(_hasProjectViewParentFieldWarningLoggedForTests('owner-0\u0000organization')).toBe(false)
expect(_hasProjectViewParentFieldRetriedForTests('owner-1\u0000organization')).toBe(true)
expect(_hasProjectViewParentFieldWarningLoggedForTests('owner-1\u0000organization')).toBe(true)
})
})