mirror of
https://github.com/peter-evans/create-pull-request.git
synced 2026-05-14 02:22:41 +00:00
fix: retry post-creation API calls on 422 eventual consistency errors (#4356)
Add retry logic to handle GitHub API eventual consistency errors that can occur after creating a new pull request. Follow-up API calls for milestones, labels, assignees, and reviewers may fail with a 422 "Could not resolve to a node" error before the PR is fully propagated. - Add generic `retryWithBackoff` helper in `src/utils.ts` with exponential backoff (default 2 retries, starting at 1s delay) - Wrap post-creation API calls in `src/github-helper.ts` with `withRetryForNewPr()`, which only retries for newly created PRs - Use `@octokit/request-error` `RequestError` type for precise error matching (status 422 + "Could not resolve to a node" message) - Add unit tests for `retryWithBackoff` covering success, retry, exhaustion, and non-retryable error scenarios - Update `dist/index.js` bundle and `package.json` dependencies
This commit is contained in:
@@ -118,3 +118,71 @@ describe('utils tests', () => {
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe('retryWithBackoff', () => {
|
||||
const makeConsistencyError = () => {
|
||||
const error = new Error(
|
||||
'Validation Failed: "Could not resolve to a node with the global id of \'PR_abc123\'."'
|
||||
)
|
||||
;(error as any).status = 422
|
||||
return error
|
||||
}
|
||||
|
||||
const shouldRetry = (e: unknown): boolean =>
|
||||
e instanceof Error &&
|
||||
(e as any).status === 422 &&
|
||||
e.message.includes('Could not resolve to a node')
|
||||
|
||||
test('succeeds on first attempt without retrying', async () => {
|
||||
const fn = jest.fn().mockResolvedValue('success')
|
||||
const result = await utils.retryWithBackoff(fn, shouldRetry, 2, 1)
|
||||
expect(result).toBe('success')
|
||||
expect(fn).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('retries on eventual consistency 422 and succeeds', async () => {
|
||||
const fn = jest
|
||||
.fn()
|
||||
.mockRejectedValueOnce(makeConsistencyError())
|
||||
.mockResolvedValue('success')
|
||||
const result = await utils.retryWithBackoff(fn, shouldRetry, 2, 1)
|
||||
expect(result).toBe('success')
|
||||
expect(fn).toHaveBeenCalledTimes(2)
|
||||
})
|
||||
|
||||
test('exhausts retries on persistent 422 and throws', async () => {
|
||||
const fn = jest.fn().mockRejectedValue(makeConsistencyError())
|
||||
await expect(utils.retryWithBackoff(fn, shouldRetry, 2, 1)).rejects.toThrow(
|
||||
'Could not resolve to a node'
|
||||
)
|
||||
expect(fn).toHaveBeenCalledTimes(3) // 1 initial + 2 retries
|
||||
})
|
||||
|
||||
test('does not retry on non-422 errors', async () => {
|
||||
const error = new Error('Forbidden')
|
||||
;(error as any).status = 403
|
||||
const fn = jest.fn().mockRejectedValue(error)
|
||||
await expect(utils.retryWithBackoff(fn, shouldRetry, 2, 1)).rejects.toThrow(
|
||||
'Forbidden'
|
||||
)
|
||||
expect(fn).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('does not retry on 422 without the consistency error message', async () => {
|
||||
const error = new Error('Validation Failed: invalid label')
|
||||
;(error as any).status = 422
|
||||
const fn = jest.fn().mockRejectedValue(error)
|
||||
await expect(utils.retryWithBackoff(fn, shouldRetry, 2, 1)).rejects.toThrow(
|
||||
'Validation Failed: invalid label'
|
||||
)
|
||||
expect(fn).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('does not retry on plain Error objects', async () => {
|
||||
const fn = jest.fn().mockRejectedValue(new Error('Something broke'))
|
||||
await expect(utils.retryWithBackoff(fn, shouldRetry, 2, 1)).rejects.toThrow(
|
||||
'Something broke'
|
||||
)
|
||||
expect(fn).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user