mirror of
https://github.com/stablyai/orca.git
synced 2026-11-19 04:23:57 +00:00
* fix(source-control): route GHES remotes to the GitHub provider for PR creation A GitHub Enterprise Server user could not submit a PR — Orca demanded ORCA_GITEA_TOKEN — while issue sync worked fine (#8312). Root cause: GitHub owner/repo resolution (parseGitHubOwnerRepo) hard-rejects any host that is not literally github.com. A GHES remote lives on a custom host, so GitHub's forge resolveRepository returned null and provider detection fell through the list to Gitea, whose KNOWN_NON_GITEA_HOSTS denylist cannot enumerate arbitrary GHES domains. Issue sync was unaffected because gh issue/pr list run with cwd=repoPath and let gh resolve the GHES host natively. Fix mirrors GitLab self-hosted detection (getGlabKnownHosts): a new getEnterpriseGitHubRepoSlug resolves a custom-host origin to owner/repo only when gh is authenticated to that host — gh only ever manages GitHub/GHES credentials, so a logged-in host is definitively GitHub. Wired into: - forge-provider GitHub resolveRepository (fallback after github.com miss), so detection claims GHES before Gitea is consulted; - createGitHubPullRequest owner/repo resolution; - isGitHubAuthenticated, which now probes the repo's real host instead of a hardcoded --hostname github.com. github.com repos keep the cached getRepoSlug fast path and never spawn the extra gh auth probe. * fix(github): host-qualify GHES gh commands and probe auth in the repo runtime Addresses two correctness issues found in review of the #8312 fix. 1. GHES host was discarded before `gh pr create`. `--repo owner/repo` shorthand resolves against gh's default host (usually github.com), so for a user authed to both github.com and GHES it could target a same-named github.com repo or fail — deterministic for SSH repos, which run gh with no cwd. Now `createGitHubPullRequest` and the `findOpenPRByHeadBase` fallback pass a host-qualified `HOST/owner/repo` for GHES (github.com keeps the shorthand). Also generalize `parseCreatePRPayload`'s URL regex off github.com so a GHES PR URL parses directly instead of limping through the list fallback. 2. GHES auth was probed on the wrong gh runtime. `getAuthenticatedGitHubHosts` ran a global `gh auth status` with no cwd/WSL/SSH context and cached every runtime under one "local" key, so a GHES login present only in the repo's WSL distro was missed and the repo fell back to Gitea. Replaced with `isGitHubHostAuthenticated`, which runs `gh auth status --hostname <host>` with the repository's execution options (cwd/WSL distro, or SSH-local like the create path) and caches per runtime+host — mirroring GitLab's isGlabConfiguredForRemoteHost. This also honors GH_ENTERPRISE_TOKEN inferred from repo context. Spawn failures stay indeterminate (uncached). Adds createGitHubPullRequest-level tests asserting the actual gh `--repo` arguments (create + fallback) and the WSL/SSH runtime of the auth probe. * perf(source-control): drop redundant GHES gh auth probe in eligibility Review follow-up. Detection only routes a GHES remote to the GitHub provider after getEnterpriseGitHubRepoSlug has confirmed gh is authenticated to its host, so isGitHubAuthenticated can trust a non-null slug as authenticated and skip a second, rate-limited `gh auth status` spawn per eligibility poll. Reaching the github.com probe now implies the remote is github.com. Tests assert the enterprise path fires no redundant gh probe.
182 lines
6.1 KiB
TypeScript
182 lines
6.1 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
const { ghExecFileAsyncMock, gitExecFileAsyncMock } = vi.hoisted(() => ({
|
|
ghExecFileAsyncMock: vi.fn(),
|
|
gitExecFileAsyncMock: vi.fn()
|
|
}))
|
|
|
|
// Mock only the exec boundary so the real remote-identity parsing, runtime
|
|
// option resolution, and `gh auth status` parsing run against controlled output.
|
|
vi.mock('../git/runner', () => ({
|
|
ghExecFileAsync: ghExecFileAsyncMock,
|
|
gitExecFileAsync: gitExecFileAsyncMock
|
|
}))
|
|
|
|
import {
|
|
_resetGitHubHostAuthCache,
|
|
getEnterpriseGitHubRepoSlug,
|
|
isGitHubHostAuthenticated
|
|
} from './github-enterprise-repository'
|
|
|
|
function mockOriginRemote(url: string): void {
|
|
gitExecFileAsyncMock.mockImplementation(async (args: string[]) => {
|
|
if (args[0] === 'remote' && args[1] === 'get-url') {
|
|
return { stdout: `${url}\n`, stderr: '' }
|
|
}
|
|
return { stdout: '', stderr: '' }
|
|
})
|
|
}
|
|
|
|
// gh exit 0 for `auth status --hostname <host>` means logged in to that host.
|
|
function mockHostAuthenticated(host = 'github.acme-corp.com'): void {
|
|
ghExecFileAsyncMock.mockResolvedValue({
|
|
stdout: `${host}\n ✓ Logged in to ${host} account kelora (keyring)`,
|
|
stderr: ''
|
|
})
|
|
}
|
|
|
|
// gh exits non-zero and reports no matching host when not logged in.
|
|
function mockHostNotAuthenticated(): void {
|
|
ghExecFileAsyncMock.mockRejectedValue(
|
|
Object.assign(new Error('exit 1'), {
|
|
stdout: '',
|
|
stderr: 'You are not logged into any GitHub hosts. To log in, run: gh auth login'
|
|
})
|
|
)
|
|
}
|
|
|
|
describe('getEnterpriseGitHubRepoSlug', () => {
|
|
beforeEach(() => {
|
|
ghExecFileAsyncMock.mockReset()
|
|
gitExecFileAsyncMock.mockReset()
|
|
_resetGitHubHostAuthCache()
|
|
})
|
|
|
|
it('resolves a GHES remote whose host the user is gh-authenticated to (#8312)', async () => {
|
|
mockOriginRemote('https://github.acme-corp.com/team/orca.git')
|
|
mockHostAuthenticated()
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toEqual({
|
|
owner: 'team',
|
|
repo: 'orca',
|
|
host: 'github.acme-corp.com'
|
|
})
|
|
// The auth probe targets the remote's host, not a hardcoded github.com.
|
|
expect(ghExecFileAsyncMock).toHaveBeenCalledWith(
|
|
['auth', 'status', '--hostname', 'github.acme-corp.com'],
|
|
{ cwd: '/repo' }
|
|
)
|
|
})
|
|
|
|
it('resolves a GHES SCP-style SSH remote', async () => {
|
|
mockOriginRemote('git@github.acme-corp.com:team/orca.git')
|
|
mockHostAuthenticated()
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toEqual({
|
|
owner: 'team',
|
|
repo: 'orca',
|
|
host: 'github.acme-corp.com'
|
|
})
|
|
})
|
|
|
|
it('probes gh in the repository WSL runtime, not the host/default distro', async () => {
|
|
mockOriginRemote('https://github.acme-corp.com/team/orca.git')
|
|
mockHostAuthenticated()
|
|
|
|
await getEnterpriseGitHubRepoSlug('/repo', null, {
|
|
localGitExecOptions: { wslDistro: 'Ubuntu' }
|
|
})
|
|
|
|
expect(ghExecFileAsyncMock).toHaveBeenCalledWith(
|
|
['auth', 'status', '--hostname', 'github.acme-corp.com'],
|
|
{ cwd: '/repo', wslDistro: 'Ubuntu' }
|
|
)
|
|
})
|
|
|
|
it('leaves github.com to getOwnerRepo without probing gh auth', async () => {
|
|
mockOriginRemote('https://github.com/team/orca.git')
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toBeNull()
|
|
expect(ghExecFileAsyncMock).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('declines a custom host the user is not gh-authenticated to (leaves it for Gitea)', async () => {
|
|
mockOriginRemote('https://gitea.example.com/team/orca.git')
|
|
mockHostNotAuthenticated()
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toBeNull()
|
|
})
|
|
|
|
it('returns null for an unparseable remote', async () => {
|
|
mockOriginRemote('not-a-remote-url')
|
|
mockHostAuthenticated()
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toBeNull()
|
|
expect(ghExecFileAsyncMock).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('returns null when the origin remote lookup fails', async () => {
|
|
gitExecFileAsyncMock.mockRejectedValue(new Error('no such remote'))
|
|
|
|
await expect(getEnterpriseGitHubRepoSlug('/repo')).resolves.toBeNull()
|
|
})
|
|
})
|
|
|
|
describe('isGitHubHostAuthenticated', () => {
|
|
beforeEach(() => {
|
|
ghExecFileAsyncMock.mockReset()
|
|
gitExecFileAsyncMock.mockReset()
|
|
_resetGitHubHostAuthCache()
|
|
})
|
|
|
|
it('runs gh in the SSH-local runtime (no cwd) for connection-backed repos', async () => {
|
|
mockHostAuthenticated()
|
|
|
|
await expect(
|
|
isGitHubHostAuthenticated('github.acme-corp.com', '/remote/repo', 'ssh-1')
|
|
).resolves.toBe(true)
|
|
expect(ghExecFileAsyncMock).toHaveBeenCalledWith(
|
|
['auth', 'status', '--hostname', 'github.acme-corp.com'],
|
|
{}
|
|
)
|
|
})
|
|
|
|
it('caches per runtime+host so detection polling does not re-spawn gh', async () => {
|
|
mockHostAuthenticated()
|
|
|
|
await isGitHubHostAuthenticated('github.acme-corp.com', '/repo')
|
|
await isGitHubHostAuthenticated('github.acme-corp.com', '/repo')
|
|
expect(ghExecFileAsyncMock).toHaveBeenCalledTimes(1)
|
|
})
|
|
|
|
it('does not share cache state across WSL distros', async () => {
|
|
mockHostAuthenticated()
|
|
|
|
await isGitHubHostAuthenticated('github.acme-corp.com', '/repo', null, { wslDistro: 'Ubuntu' })
|
|
await isGitHubHostAuthenticated('github.acme-corp.com', '/repo', null, { wslDistro: 'Debian' })
|
|
expect(ghExecFileAsyncMock).toHaveBeenCalledTimes(2)
|
|
})
|
|
|
|
it('treats a listed host as authenticated even when gh exits non-zero', async () => {
|
|
ghExecFileAsyncMock.mockRejectedValue(
|
|
Object.assign(new Error('exit 1'), {
|
|
stdout: '',
|
|
stderr:
|
|
'github.acme-corp.com\n ✓ Logged in to github.acme-corp.com account kelora (keyring)\n X github.com: token expired'
|
|
})
|
|
)
|
|
|
|
await expect(isGitHubHostAuthenticated('github.acme-corp.com', '/repo')).resolves.toBe(true)
|
|
})
|
|
|
|
it('does not cache a hard gh failure so a later probe can recover', async () => {
|
|
ghExecFileAsyncMock.mockRejectedValueOnce(
|
|
Object.assign(new Error('not installed'), { stdout: '', stderr: '' })
|
|
)
|
|
expect(await isGitHubHostAuthenticated('github.acme-corp.com', '/repo')).toBe(false)
|
|
|
|
mockHostAuthenticated()
|
|
expect(await isGitHubHostAuthenticated('github.acme-corp.com', '/repo')).toBe(true)
|
|
})
|
|
})
|