Enforce the API readiness timeout across RPC calls and retry delays
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- backend-api-design, cli
Research direction
Start with src/cli/subcommands/wait_api_cmd.rs, where the readiness polling loop, Version RPC, and retry delay are identified. Trace how the loop applies --timeout and preserves the one-second request limit, then add coverage for late success, a failed poll near the deadline, and polling without an overall timeout. Done means each acceptance criterion passes.
Written by the indexing model from the issue text.
Description
Summary
The CLI API readiness command checks --timeout only before each poll in src/cli/subcommands/wait_api_cmd.rs. A Version RPC can return successfully after the timeout expires, and a failed poll can be followed by a retry sleep that extends beyond the timeout.
Required changes
Apply one overall deadline to the polling loop, including each RPC and retry delay. Retain the one-second per-request limit. When --timeout is omitted, continue polling until the API is available.
Acceptance criteria
- A response received after the overall timeout is not reported as success.
- A failed RPC and retry delay do not extend the command beyond the overall timeout.
- Each RPC retains its one-second limit.
- With no overall timeout, polling continues until success.
- Tests cover a late successful response, a failed poll and retry delay near the deadline, and the no-timeout behavior.
This behavior predates the duration parser change in the linked pull request.
Requested by @LesnyRumcajs.
Pull request: https://github.com/ChainSafe/forest/pull/7890
Review comment: https://github.com/ChainSafe/forest/pull/7890#discussion_r4614361143
- Dominant language
- Rust
- Stars
- 700
- Forks
- 201
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 65
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ChainSafe/forest
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Bug
Difficulty 3/5 1-2 days Newbie friendliness 20/100
Maintainers usually reply within 1 day
-
[automated] `cargo deny check advisories` failure @ 20/11/26 00:01Possibly taken @akaladarshi claimed this today. OpenBug
Difficulty 1/5 Under an hour Newbie friendliness 15/100
Maintainers usually reply within 1 day
-
FIP-0119 implementation in `builtin-actors`Possibly taken @LesnyRumcajs claimed this 2 days ago. OpenType: Task
ChainSafe/forest#7886 · 1 assignee ·
Maintainers usually reply within 1 day
-
allow to skip downloading enriched snapshotsPossibly taken @EclesioMeloJunior claimed this 2 days ago. OpenType: Task
ChainSafe/forest#7885 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in ChainSafe/forest
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
benchmark-review
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
app-request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
flatpark/flatpark#1423 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
area:image documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day