Fix GitHub Primary Rate Limit Errors Not Retried

Đang mở
#175 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
72/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, typescript

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
125
Fork
23
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
12

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của devarshishimpi/codra

Tất cả issue của devarshishimpi/codra

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.