Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Unify time mocking strategy across the codebase

Aperta
  • Qualcosa non va?
#306 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
rust
Ambito
distributed-systems, testing

Direzione di ricerca

Inizia leggendo crates/core/src/deadline.rs, crates/app/src/retry.rs, crates/core/src/qbft/fake_clock.rs e gli altri file interessati elencati nell'issue, quindi esamina le PR #18 e #276. Mappa i pattern esistenti di clock e injection, valuta le alternative proposte e definisci il completamento come una strategia temporale coerente e verificabile tra i moduli interessati, senza l'attuale flakiness temporale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

testing

Context

Time mocking has been flagged as a recurring pain point across multiple PRs:

  • PR #18 (QBFT): Tests were flaky due to reliance on real wall-clock time. cargo nextest was introduced specifically for timeout/retry control. A custom FakeClock was built for QBFT to work around the problem. Several tests remain #[ignore]d with timing-related failures ("wrong decide round", "wrong prepared value").
  • PR #276 (Deadliner): Utc::now() is called directly throughout deadline.rs, making the module untestable with tokio::time::pause()/advance(). Tests rely on real wall-clock time with short millisecond sleeps — fragile under CI load. The PR was merged with the agreement to revisit this as a separate issue.

Current state

The codebase has three unrelated time approaches coexisting:

Approach Where Mockable?
chrono::Utc::now() / chrono::Local::now() deadline.rs, retry.rs, peerinfo, cluster/definition.rs, p2p/k1.rs No (not controlled by tokio test-util)
std::time::Instant / tokio::time::Instant peerinfo/protocol.rs, p2p/relay.rs, QBFT tests Partially (tokio variant responds to pause()/advance())
FakeClock (custom, crossbeam-based) core/qbft/fake_clock.rs Yes, but ad-hoc and only for QBFT

Additionally, some modules use injectable time functions as a workaround:

  • retry.rs has with_time() accepting a Fn() -> DateTime<Utc> provider
  • deadline.rs has DeadlineFunc for injectable deadline calculation

These are local solutions — there is no unified abstraction.

Problem

  1. chrono::Utc::now() is invisible to tokio's test-util. tokio::time::pause() only controls tokio::time::Instant and tokio::time::sleep(). Any code using chrono::Utc::now() will see real wall-clock time in tests, leading to flaky or non-deterministic behavior.
  2. FakeClock is QBFT-specific. It uses crossbeam::channel and std::time::Instant — a completely different mechanism from tokio's async timers. It can't be reused for async code that uses tokio::select!.
  3. No consistent pattern for new code to follow. Each module has invented its own approach.

Proposed direction

Explore a unified time abstraction, potentially:

  • Option A: Lean into tokio::time throughout. Replace chrono::Utc::now() with tokio::time::Instant-based calculations where possible. Use tokio::time::pause()/advance() in tests. Keep chrono only for formatting/parsing, not as a clock source.
  • Option B: Create a small Clock trait (or crate-level abstraction as suggested in #276) that wraps the time source. Production uses real time; tests inject a controllable clock. This is more flexible but adds a layer of indirection.
  • Option C: Hybrid — use tokio's built-in mocking for async timer code, and a simple injectable Fn() -> DateTime<Utc> for code that needs wall-clock timestamps.

Affected areas

Key files using chrono::Utc::now() or direct time that would benefit from unification:

  • crates/core/src/deadline.rs
  • crates/app/src/retry.rs
  • crates/peerinfo/src/protocol.rs, config.rs, behaviour.rs
  • crates/cluster/src/definition.rs
  • crates/p2p/src/k1.rs
  • crates/core/src/qbft/fake_clock.rs (custom mock)
  • crates/app/src/privkeylock.rs

References

  • #18 — QBFT implementation (flaky tests, FakeClock introduction)
  • #276 — Deadliner (time mocking discussion)
  • tokio test-util docs
Lingua principale
Rust
Stelle
8
Fork
6
Merge medio
4g 3h
PR unite (30g)
18

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NethermindEth/pluto

Tutte le issue di NethermindEth/pluto

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.