retries input retries the codes in retry-exempt-status-codes (403/404/422 are sent retries+1 times)

Đang mở Phù hợp với người mới
#732 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/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, javascript, node.js, typescript
Lĩnh vực
api, backend

Hướng nghiên cứu

Bắt đầu với getRetryOptions trong src/retry-options.ts và theo dõi cách hàm truyền số lần thử lại cho plugin thử lại của Octokit. Tái hiện trường hợp bằng fetch giả lập và các dạng tùy chọn trong issue. Kiểm tra rằng các trạng thái được miễn chỉ tạo ra một lần gọi, còn 502 vẫn tuân theo thời gian chờ lùi đã cấu hình. Hoàn tất khi các mã trạng thái được miễn chỉ được gửi một lần trong lúc bật thử lại.

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

Mô tả

Describe the bug

When retries is set, a response with a status listed in retry-exempt-status-codes is still retried, immediately and up to retries times. With retries: 3, a 403, 404 or 422 is sent 4 times. The README and the input description say those codes are not retried.

The cause is how getRetryOptions (src/retry-options.ts) passes the count. It puts the count in request.retries and the exempt list in retry.doNotRetry. In @octokit/plugin-retry 8.1.0, errorRequest honours doNotRetry: for an exempt status it rethrows without scheduling a retry. But the failed handler in wrapRequest reads error.request.request.retries for every error. That is the request.retries value github-script set, so the limiter retries anyway. retryAfter is unset on that path, so the delay is 0.

If the count is passed as retry: { retries } instead, and request.retries is left unset, the exempt list is honoured.

The same root cause is reported upstream as octokit/plugin-retry.js#576 ("404 being retried", open since 2024-09; the reporter sets request: { retries: 9 }).

To Reproduce

This is the option shape github-script v9.0.0 builds for retries: 3 with the default exempt codes, run against @octokit/core 7 and @octokit/plugin-retry 8.1.0 (the versions in its lockfile). It uses a stub fetch:

import { Octokit } from '@octokit/core';
import { retry } from '@octokit/plugin-retry';

async function run(label, status, opts) {
  let calls = 0;
  const fetch = async () => {
    calls++;
    return new Response('{"message":"x"}', { status, headers: { 'content-type': 'application/json' } });
  };
  const O = Octokit.plugin(retry);
  const o = new O({ ...opts, request: { ...opts.request, fetch } });
  await o.request('GET /repos/a/b').catch(() => {});
  console.log(label, status, 'calls:', calls);
}

// What github-script builds for `retries: 3`
const githubScript = { retry: { enabled: true, doNotRetry: [400, 401, 403, 404, 422] }, request: { retries: 3 } };
// Count in the retry options instead
const retryOptions = { retry: { enabled: true, retries: 3, doNotRetry: [400, 401, 403, 404, 422] } };

await run('github-script shape', 403, githubScript);
await run('github-script shape', 404, githubScript);
await run('github-script shape', 422, githubScript);
await run('retry.retries shape', 403, retryOptions);

Output:

github-script shape 403 calls: 4
github-script shape 404 calls: 4
github-script shape 422 calls: 4
retry.retries shape 403 calls: 1

The retry.retries shape still retries a 502 with the 1 s / 4 s / 9 s backoff.

Expected behavior

A status in retry-exempt-status-codes is sent once. This matters most for 403. With retries set, a rate-limited or forbidden request is sent again at once, several times. It also delays every 404 a script expects and handles.

Possible fix

In getRetryOptions, put the count in the retry options (retryOptions.retries = retries) rather than in requestOptions.retries. The secondary clients from the injected getOctokit would inherit it through createConfiguredGetOctokit unchanged.

Workaround

Leave retries at 0 and build clients with the injected getOctokit(token, { retry: { enabled: true, retries: 3 } }). In v9 the plugin is always attached and the merged retry options enable it.

Versions

  • actions/github-script v9.0.0 (d746ffe35508b1917358783b479e04febd2b8f71)
  • @octokit/plugin-retry 8.1.0, @octokit/core 7.0.6, @octokit/request 10.0.8 (from the v9.0.0 package-lock.json)
  • Reproduced with Node 22
Ngôn ngữ chính
TypeScript
Star
5.1k
Fork
583
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 actions/github-script

Tất cả issue của actions/github-script

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.