Fix GitHub Primary Rate Limit Errors Not Retried

Aberta
#175 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
72/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
github, typescript

Direção de pesquisa

Start in packages/provider-github/src/http.ts, especially withRetry and assertResponseOk, then read the GitHubError definition and nearby tests. Add coverage for primary rate limit 403 responses, reset-header backoff, and Retry-After handling. Done means these errors retry using the provided timing headers where present, and the issue’s listed typecheck, test, and lint commands pass.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

bug good first issue

Summary

Codra's GitHub API client retries secondary rate limit errors (HTTP 403 with body "secondary rate limit") and HTTP 429/5xx errors, but does not retry primary rate limit errors. GitHub returns HTTP 403 (not 429) for primary rate limits, so these requests fail immediately and permanently, aborting in-progress reviews.

Affected File

packages/provider-github/src/http.ts - withRetry (lines 45-85):

const isSecondaryRateLimit =
  error instanceof GitHubError &&
  error.status === 403 &&
  error.body?.toLowerCase().includes("secondary rate limit");

const isRetryable =
  isSecondaryRateLimit ||
  (error instanceof GitHubError && (error.status === 429 || error.status >= 500)) ||
  error.name === "TimeoutError" ||
  error.message.includes("timeout");

Why GitHub Uses 403 for Primary Rate Limits

GitHub's REST API returns HTTP 403 Forbidden with the error body "API rate limit exceeded for installation ID ..." and includes these response headers:

  • x-ratelimit-remaining: 0 - confirms the quota is exhausted
  • x-ratelimit-reset: <epoch> - UTC epoch second when the quota resets

Since the check only recognizes "secondary rate limit" text, primary rate limit 403s fall through to the non-retryable path and immediately throw, causing the review to fail.

Proposed Fix

  1. Detect primary rate limit 403s:
const isPrimaryRateLimit =
  error instanceof GitHubError &&
  error.status === 403 &&
  (error.body?.toLowerCase().includes("rate limit exceeded") ||
   error.body?.toLowerCase().includes("api rate limit"));
  1. Capture x-ratelimit-reset from response headers and use it to calculate precise sleep duration:
// In assertResponseOk - capture headers
throw new GitHubError(response.status, errText, path, `...`, response.headers);
// In withRetry - respect x-ratelimit-reset
const rateLimitReset = error.headers?.get("x-ratelimit-reset");
const delay = rateLimitReset
  ? Math.max(0, parseInt(rateLimitReset, 10) * 1000 - Date.now()) + 1000
  : Math.pow(2, attempt) * 30000;

Done When

  • HTTP 403 responses with primary rate limit body text are retried with appropriate backoff
  • x-ratelimit-reset header is used to calculate wait time where present
  • Retry-After header on 429 responses is also respected
  • GitHubError carries response headers for use in retry logic
  • Tests cover primary rate limit 403 retry and x-ratelimit-reset backoff calculation
  • npm run typecheck, npm test, and npm run lint all pass
Linguagem predominante
TypeScript
Estrelas
125
Forks
23
Merge médio
2d 13h
PRs com merge (30d)
12

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de devarshishimpi/codra

Todas as issues de devarshishimpi/codra

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.