fix: mark epoch-specific validators doctest as no_run#185
Open
r-near wants to merge 1 commit intonear:masterfrom
Open
fix: mark epoch-specific validators doctest as no_run#185r-near wants to merge 1 commit intonear:masterfrom
r-near wants to merge 1 commit intonear:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Marks a network-dependent doctest in the validators method docs as no_run so CI doesn’t flake when a hardcoded EpochId becomes unavailable on archival RPC nodes.
Changes:
- Updated the
EpochReference::EpochIddoctest fence insrc/methods/validators.rsto```no_runso it compiles but does not execute.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
EpochReference::EpochIddoctest insrc/methods/validators.rsasno_runto prevent flaky CI failuresProblem
The first doctest queries validators by a hardcoded epoch ID against a live RPC endpoint. NEAR nodes (including archival nodes) only retain ~3 epochs (~36 hours) of validator/epoch data in the EpochManager, so any hardcoded epoch ID inevitably goes stale, causing
cargo testto fail withUnknownEpoch.Fix
Changed the code fence from
```to```no_runso the example still compiles (ensuring correctness) but doesn't execute against a live endpoint during tests. This matches the established pattern used in other doctests throughout this repo (broadcast_tx_async.rs,broadcast_tx_commit.rs,tx.rs,send_tx.rs,experimental/protocol_config.rs).The second doctest (
EpochReference::Latest) remains runnable since it always queries the current epoch.