Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions src/main/github/client-merge-queue-auto-merge.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,53 @@ describe('GitHub GraphQL rate-limit guard', () => {
).toBe(false)
})

it('enqueues when a required merge queue disallows auto-merge', async () => {
ghExecFileAsyncMock
.mockResolvedValueOnce({ stdout: JSON.stringify({ stack: null }) })
.mockResolvedValueOnce({
stdout: JSON.stringify({ id: 'PR_kwDO123', headRefOid: 'head-oid', baseRefName: 'main' })
})
.mockResolvedValueOnce({
stdout: JSON.stringify({
data: { repository: { mergeQueue: { id: 'MQ_kw' }, autoMergeAllowed: false } }
})
})
.mockResolvedValue({ stdout: '', stderr: '' })

await expect(
setPRAutoMerge('/repo-root', 7, true, 'squash', undefined, {
owner: 'stablyai',
repo: 'orca',
host: 'github.com'
})
).resolves.toEqual({ ok: true, enqueued: true })

expect(ghExecFileAsyncMock).toHaveBeenNthCalledWith(
4,
expect.arrayContaining([
'api',
'graphql',
'-f',
'pullRequestId=PR_kwDO123',
'-f',
'expectedHeadOid=head-oid'
]),
expect.objectContaining({
cwd: '/repo-root',
env: expect.objectContaining({ GH_PROMPT_DISABLED: '1' }),
host: 'github.com'
})
)
const enqueueCall = ghExecFileAsyncMock.mock.calls[3]?.[0] as string[]
expect(enqueueCall.some((arg) => arg.includes('enqueuePullRequest'))).toBe(true)
expect(
ghExecFileAsyncMock.mock.calls.some(
(call) =>
call[0][0] === 'pr' && call[0][1] === 'merge' && (call[0] as string[]).includes('--auto')
)
).toBe(false)
})

it('blocks direct merge when GitHub reports required approval', async () => {
ghExecFileAsyncMock
.mockResolvedValueOnce({ stdout: JSON.stringify({ stack: null }) })
Expand Down
6 changes: 6 additions & 0 deletions src/main/github/client/fetch/work-item-fetch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { githubHostExecOptions, type GitHubApiRepository } from '../../github-ap
import type { GhExecOptions } from './../github-exec-scope'
import { resolvePullRequestLookupCandidates } from './../pull-request-lookup-candidates'
import { detectRepositoryMergeMetadata } from './../detect/repository-merge-metadata'
import { readPullRequestInMergeQueue } from './../lookup/pull-request-merge-queue-membership'
import {
WORK_ITEM_PR_DETAIL_JSON_FIELDS,
usersFromUnknown,
Expand Down Expand Up @@ -121,9 +122,14 @@ export async function fetchPullRequestWorkItem(
const baseRefName = typeof item.baseRefName === 'string' ? item.baseRefName : undefined
try {
const mergeMetadata = await detectRepositoryMergeMetadata(ownerRepo, baseRefName, ghOptions)
const inMergeQueue =
mergeMetadata.mergeQueueRequired === true
? await readPullRequestInMergeQueue(ownerRepo, number, ghOptions)
: undefined
return {
...mapped,
mergeQueueRequired: mergeMetadata.mergeQueueRequired,
...(inMergeQueue !== undefined ? { inMergeQueue } : {}),
...(mergeMetadata.autoMergeAllowed !== null
? { autoMergeAllowed: mergeMetadata.autoMergeAllowed }
: {}),
Expand Down
5 changes: 3 additions & 2 deletions src/main/github/client/lookup/pr-branch-lookup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ export async function hydrateBranchLookupWithExactPR(
}
try {
return (
(await getPRByNumber(ownerRepo, branchData.number, ghOptions, executionScope, branchData)) ??
branchData
(await getPRByNumber(ownerRepo, branchData.number, ghOptions, executionScope, branchData, {
readQueueMembership: true
})) ?? branchData
)
} catch {
return branchData
Expand Down
12 changes: 8 additions & 4 deletions src/main/github/client/lookup/pr-number-lookup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ export async function getPRByNumber(
number: number,
ghOptions: ReturnType<typeof ghRepoExecOptions>,
executionScope: string,
knownPullRequestData?: PullRequestLookupData | null
knownPullRequestData?: PullRequestLookupData | null,
options?: { readQueueMembership?: boolean }
): Promise<PullRequestLookupData | null> {
try {
const { stdout } = await ghExecFileAsync(
Expand All @@ -76,7 +77,8 @@ export async function getPRByNumber(
...(knownPullRequestData?.stack ? { stack: knownPullRequestData.stack } : {})
},
ghOptions,
executionScope
executionScope,
options
)
} catch (err) {
// Why: deleted/edited linked PR metadata falls back to branch discovery; quota/auth/network failures get one cheaper REST exact lookup.
Expand All @@ -89,7 +91,7 @@ export async function getPRByNumber(
? await getRestPRByNumber(ownerRepo, number, ghOptions)
: knownPullRequestData
return restData
? hydratePullRequestLookupData(ownerRepo, restData, ghOptions, executionScope)
? hydratePullRequestLookupData(ownerRepo, restData, ghOptions, executionScope, options)
: null
} catch (restErr) {
if (isNotFoundGhError(restErr)) {
Expand All @@ -115,7 +117,9 @@ export async function lookupPRByNumber(args: {
candidate,
args.number,
args.ghOptions,
args.executionScope
args.executionScope,
undefined,
{ readQueueMembership: true }
)
if (!linkedData) {
continue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export function assemblePRRefreshFoundOutcome(args: {
: data.mergeQueueRequired
}
: {}),
...(data.inMergeQueue !== undefined ? { inMergeQueue: data.inMergeQueue } : {}),
...(data.mergeMethodSettings !== undefined
? { mergeMethodSettings: data.mergeMethodSettings }
: {}),
Expand Down
1 change: 1 addition & 0 deletions src/main/github/client/lookup/pull-request-lookup-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export type PullRequestLookupData = {
autoMergeEnabled?: boolean
autoMergeAllowed?: boolean | null
mergeQueueRequired?: boolean | null
inMergeQueue?: boolean
mergeMethodSettings?: GitHubPRMergeMethodSettings
mergeStateStatus?: string | null
baseRefName?: string
Expand Down
11 changes: 9 additions & 2 deletions src/main/github/client/lookup/pull-request-lookup-hydration.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { OwnerRepo } from '../../gh-utils'
import type { GhExecOptions } from './../github-exec-scope'
import { detectRepositoryMergeMetadata } from './../detect/repository-merge-metadata'
import { readPullRequestInMergeQueue } from './pull-request-merge-queue-membership'
import {
normalizePullRequestLookupData,
type PullRequestLookupData
Expand All @@ -9,7 +10,8 @@ export async function hydratePullRequestLookupData(
ownerRepo: OwnerRepo,
data: PullRequestLookupData,
ghOptions: GhExecOptions,
executionScope: string
executionScope: string,
options?: { readQueueMembership?: boolean }
): Promise<PullRequestLookupData> {
const normalized = normalizePullRequestLookupData(data)
const hasRichMergeFields =
Expand All @@ -22,12 +24,17 @@ export async function hydratePullRequestLookupData(
executionScope
)
: undefined
const inMergeQueue =
options?.readQueueMembership === true && mergeMetadata?.mergeQueueRequired === true
? await readPullRequestInMergeQueue(ownerRepo, normalized.number, ghOptions)
: undefined
return {
...normalized,
...(mergeMetadata ? { mergeQueueRequired: mergeMetadata.mergeQueueRequired } : {}),
...(mergeMetadata ? { autoMergeAllowed: mergeMetadata.autoMergeAllowed } : {}),
...(mergeMetadata?.mergeMethodSettings
? { mergeMethodSettings: mergeMetadata.mergeMethodSettings }
: {})
: {}),
...(inMergeQueue !== undefined ? { inMergeQueue } : {})
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { ghExecFileAsync } from '../../gh-utils'
import { githubHostExecOptions, type GitHubApiRepository } from '../../github-api-repository'
import { noteRepositoryRateLimitSpend, repositoryRateLimitGuard } from '../../rate-limit'
import type { GhExecOptions } from '../github-exec-scope'

/** True when this pull request already has a merge-queue entry.
* `gh pr view` has no field for that, and enqueue does not set autoMergeRequest. */
export async function readPullRequestInMergeQueue(
ownerRepo: GitHubApiRepository,
prNumber: number,
ghOptions: GhExecOptions
): Promise<boolean | undefined> {
const guard = repositoryRateLimitGuard(ownerRepo, 'graphql', ghOptions)
if (guard.blocked) {
return undefined
}
const query = `query($owner: String!, $repo: String!, $number: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $number) { isInMergeQueue }
}
}`
try {
noteRepositoryRateLimitSpend(ownerRepo, 'graphql', 1, ghOptions)
const { stdout } = await ghExecFileAsync(
[
'api',
'graphql',
'-f',
`query=${query}`,
'-f',
`owner=${ownerRepo.owner}`,
'-f',
`repo=${ownerRepo.repo}`,
'-F',
`number=${prNumber}`
],
{ ...ghOptions, ...githubHostExecOptions(ownerRepo) }
)
const parsed = JSON.parse(stdout) as {
data?: { repository?: { pullRequest?: { isInMergeQueue?: unknown } | null } | null }
}
const value = parsed.data?.repository?.pullRequest?.isInMergeQueue
return typeof value === 'boolean' ? value : undefined
} catch {
return undefined
}
}
53 changes: 45 additions & 8 deletions src/main/github/client/merge/pr-auto-merge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,22 +67,50 @@ export async function runPRAutoMergeCommand(
})
}

export async function shouldUseMergeQueueAutoMerge(
async function mergeQueueEnqueueDecision(
pr: PRAutoMergeIdentity,
ownerRepo: GitHubApiRepository | null,
ghOptions: GhExecOptions,
executionScope?: string
): Promise<boolean> {
): Promise<'enqueue' | 'auto' | 'skip'> {
if (!ownerRepo || !pr.baseRefName) {
return false
return 'skip'
}
const mergeMetadata = await detectRepositoryMergeMetadata(
ownerRepo,
pr.baseRefName,
ghOptions,
executionScope
)
return mergeMetadata.mergeQueueRequired === true
if (mergeMetadata.mergeQueueRequired !== true) {
return 'skip'
}
// A required queue that disallows auto-merge must be enqueued. The mutation
// does not set autoMergeRequest, so callers have to say it was queued.
return mergeMetadata.autoMergeAllowed === false ? 'enqueue' : 'auto'
}

async function enqueuePullRequest(
pr: PRAutoMergeIdentity,
ghOptions: GhExecOptions
): Promise<void> {
const query = `mutation($pullRequestId: ID!, $expectedHeadOid: GitObjectID) {
enqueuePullRequest(input: {
pullRequestId: $pullRequestId,
expectedHeadOid: $expectedHeadOid
}) {
mergeQueueEntry { id }
}
}`
const args = ['api', 'graphql', '-f', `query=${query}`, '-f', `pullRequestId=${pr.id}`]
if (pr.headRefOid) {
args.push('-f', `expectedHeadOid=${pr.headRefOid}`)
}
// Why: `gh pr merge --auto` calls enablePullRequestAutoMerge, which GitHub rejects when the repository disables auto-merge.
await ghExecFileAsync(args, {
...ghOptions,
env: { ...process.env, GH_PROMPT_DISABLED: '1' }
})
}

export async function enablePRAutoMerge(
Expand All @@ -91,7 +119,7 @@ export async function enablePRAutoMerge(
ownerRepo: GitHubApiRepository | null,
ghOptions: GhExecOptions,
executionScope?: string
): Promise<{ ok: true } | { ok: false; error: string }> {
): Promise<{ ok: true; enqueued?: true } | { ok: false; error: string }> {
if (ownerRepo) {
try {
const restData = await getRestPRByNumber(ownerRepo, prNumber, ghOptions)
Expand All @@ -109,8 +137,17 @@ export async function enablePRAutoMerge(
if (!pr?.id) {
return { ok: false, error: 'Could not resolve GitHub pull request ID' }
}
const useMergeQueue = await shouldUseMergeQueueAutoMerge(pr, ownerRepo, ghOptions, executionScope)
if (useMergeQueue) {
const mergeQueueDecision = await mergeQueueEnqueueDecision(
pr,
ownerRepo,
ghOptions,
executionScope
)
if (mergeQueueDecision === 'enqueue') {
await enqueuePullRequest(pr, ghOptions)
return { ok: true, enqueued: true }
}
if (mergeQueueDecision === 'auto') {
await runPRAutoMergeCommand(prNumber, method, ownerRepo, ghOptions)
return { ok: true }
}
Expand Down Expand Up @@ -152,7 +189,7 @@ export async function setPRAutoMerge(
connectionId?: string | null,
prRepo?: GitHubApiRepository | null,
localGitOptions: LocalGitExecOptions = {}
): Promise<{ ok: true } | { ok: false; error: string }> {
): Promise<{ ok: true; enqueued?: true } | { ok: false; error: string }> {
const { ownerRepo, ghOptions } = await resolveGitHubRepoExecution(
repoPath,
prRepo,
Expand Down
2 changes: 1 addition & 1 deletion src/preload/api/gh-bridge-mutations-and-projects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const ghMutationsAndProjectsApi = {
enabled: boolean
method?: 'merge' | 'squash' | 'rebase'
prRepo?: GitHubOwnerRepo | null
}): Promise<{ ok: true } | { ok: false; error: string }> =>
}): Promise<{ ok: true; enqueued?: true } | { ok: false; error: string }> =>
ipcRenderer.invoke('gh:setPRAutoMerge', args),
updatePRState: (args: {
repoPath: string
Expand Down
2 changes: 1 addition & 1 deletion src/preload/api/github-pull-request-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export type GithubPullRequestApi = {
method?: 'merge' | 'squash' | 'rebase'
prRepo?: GitHubOwnerRepo | null
}
) => Promise<{ ok: true } | { ok: false; error: string }>
) => Promise<{ ok: true; enqueued?: true } | { ok: false; error: string }>
updatePRState: (
args: GitHubRepoSelectorArgs & {
prNumber: number
Expand Down
31 changes: 31 additions & 0 deletions src/renderer/src/components/github-auto-merge-success-toast.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { translate } from '@/i18n/i18n'
import type { GitHubPRMergeStatePresentation } from './github-pr-merge-state'

export function githubAutoMergeSuccessToast(
enabled: boolean,
result: { enqueued?: boolean } | void | null
Comment thread
coderabbitai[bot] marked this conversation as resolved.
): string {
if (!enabled) {
return translate('auto.components.PullRequestPage.0f5821b035', 'Auto-merge disabled')
}
if (result && result.enqueued === true) {
return translate(
'auto.components.PullRequestPage.mergeQueueEnqueued',
'Added to the merge queue'
)
}
return translate('auto.components.PullRequestPage.5edbe7eefa', 'Auto-merge enabled')
}

export function presentPullRequestInMergeQueue(tone: string): GitHubPRMergeStatePresentation {
return {
label: translate('auto.components.github.pr.merge.state.inMergeQueue', 'In merge queue'),
tone,
tooltip: translate(
'auto.components.github.pr.merge.state.inMergeQueueTooltip',
'This pull request is already in the GitHub merge queue'
),
directMergeAvailable: false,
autoMergeAction: null
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
getGitHubMutationRoutingSettings,
getGitHubRuntimeRepoId
} from '@/lib/github-source-runtime-context'
import { githubAutoMergeSuccessToast } from '@/components/github-auto-merge-success-toast'
import { presentGitHubPRMergeState } from '@/components/github-pr-merge-state'
import {
GITHUB_PR_MERGE_METHOD_LABELS,
Expand Down Expand Up @@ -310,11 +311,7 @@ export function PRActionsPanel({
)
}
useAppStore.getState().recordFeatureInteraction('github-tasks')
toast.success(
enabled
? translate('auto.components.GitHubItemDialog.a35ea5a0f6', 'Auto-merge enabled')
: translate('auto.components.GitHubItemDialog.4b390bd50d', 'Auto-merge disabled')
)
toast.success(githubAutoMergeSuccessToast(enabled, result))
onMutated()
} catch {
toast.error(
Expand Down
Loading