retries input retries the codes in retry-exempt-status-codes (403/404/422 are sent retries+1 times)
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 78/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- github, javascript, node.js, typescript
Direção de pesquisa
Comece por getRetryOptions em src/retry-options.ts e acompanhe como a função passa a contagem de tentativas para o plugin de retry do Octokit. Reproduza o caso com o fetch simulado e os formatos das opções descritos na issue. Verifique se os status isentos resultam em uma chamada, enquanto um 502 continua seguindo o backoff configurado. O trabalho estará concluído quando os códigos de status isentos forem enviados uma vez com as tentativas habilitadas.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- TypeScript
- Estrelas
- 5.1k
- Forks
- 583
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de actions/github-script
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
actions/github-script#731 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 48/100
actions/github-script#728 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 52/100
actions/github-script#727 · 2 reações ·
-
{Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 10/100
actions/github-script#724 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
actions/github-script#723 · 1 comentário ·
Todas as issues de actions/github-script
Issues semelhantes
-
db-d1-sqlite: upsert is aliased to updateOne, so payload.kv.set never inserts new keysTalvez já em andamento @pcbeingused333 assumiu hoje. AbertaBug db: d1-sqlite Payload OSS
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
payloadcms/payload#19766 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
device-management-toolkit/sample-web-ui#3711 ·
Mantenedores costumam responder em até 1 dia
-
bug impact:low Team: SecuritySolution Team:Defend Workflows v9.6.0
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
elastic/kibana#306401 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
agentes-chat/agentes-chat#927 ·
Mantenedores costumam responder em até 1 dia
-
Closing a pinned tab jumps to the Tabs section instead of the next open pinned tabTalvez já em andamento @seenimohamed assumiu hoje. Abertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
ardia-browser/ardia#2769 ·
Mantenedores costumam responder em até 1 dia