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

未关闭 适合新手
#732 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
github, javascript, node.js, typescript
领域
api, backend

调研方向

从 getRetryOptions 和 src/retry-options.ts 开始,追踪它如何将重试次数传递给 Octokit 重试插件。使用 issue 中的 stub fetch 和选项形式复现问题,检查豁免状态是否只触发一次调用,同时 502 仍遵循已配置的退避策略。启用重试时,豁免状态码只发送一次,即为完成。

由索引模型根据 Issue 内容生成。

描述

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
主要语言
TypeScript
星标
5.1k
派生
583
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

actions/github-script 的其他 Issue

查看 actions/github-script 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。