Tokio Async Code Review
Review Workflow
- Check Cargo.toml — Note tokio feature flags (
full,rt-multi-thread,macros,sync, etc.). Missing features cause confusing compile errors. - Check runtime setup — Is
#[tokio::main]or manual runtime construction used? Multi-thread vs current-thread? - Scan for blocking — Search for
std::fs,std::net,std::thread::sleep, CPU-heavy loops in async functions. - Check channel usage — Match channel type to communication pattern (mpsc, broadcast, oneshot, watch).
- Check sync primitives — Verify correct mutex type, proper guard lifetimes, no deadlock potential.
Gates (objective passes before conclusions)
Complete in order for the review scope. Do not assert Critical or Major until the relevant gate passes.
- Dependency surface — Read the crate (and workspace, if inherited)
Cargo.tomlthat suppliestokio. Pass: Written note oftokioversion and enabled features, or explicit statement that there is no directtokiodependency and where it comes from (workspace/path). - Runtime model — Locate runtime construction (
#[tokio::main],Runtime::builder, tests, or library with no owned runtime). Pass: One line naming flavor (multi_thread/current_thread/ tests-only / none) and where it is defined. - Blocking inventory — Search reviewed paths for blocking APIs (
std::fs::,std::net::without async wrappers,std::thread::sleep, heavy CPU loops inasync fn). Pass: Each hit listed aspath:line(or tool output excerpt), or explicit “no blocking patterns found in reviewed async code” after the search. - Protocol — Load
beagle-rust:review-verification-protocol. Pass: Its pass conditions met before any finding is reported (file:line evidence for asserted issues).
Output Format
Report findings as:
[FILE:LINE] ISSUE_TITLE
Severity: Critical | Major | Minor | Informational
Description of the issue and why it matters.
Quick Reference
| Issue Type | Reference |
|---|---|
| Task spawning, JoinHandle, structured concurrency | references/task-management.md |
| Mutex, RwLock, Semaphore, Notify, Barrier | references/sync-primitives.md |
| mpsc, broadcast, oneshot, watch channel patterns | references/channels.md |
| Pin, cancellation, Future internals, select!, blocking bridge | references/pinning-cancellation.md |
Review Checklist
Runtime Configuration
- Tokio features in Cargo.toml match actual usage
- Runtime flavor matches workload (
multi_threadfor I/O-bound,current_threadfor simpler cases) -
#[tokio::test]used for async tests (not manual runtime construction) - Worker thread count configured appropriately for production
Task Management
-
spawnreturn values (JoinHandle) are tracked, not silently dropped -
spawn_blockingused for CPU-heavy or synchronous I/O operations - Tasks respect cancellation (via
CancellationToken,select!, or shutdown channels) -
JoinError(task panic or cancellation) is handled, not just unwrapped -
tokio::select!branches are cancellation-safe - Native
async fnin traits used instead ofasync-traitcrate where possible (stable since Rust 1.75) - RPIT lifetime capture reviewed in async contexts —
-> impl Futurenow captures all in-scope lifetimes in edition 2024
Sync Primitives
-
tokio::sync::Mutexused when lock is held across.await;std::sync::Mutexfor short non-async sections - No mutex guard held across await points (deadlock risk)
-
Semaphoreused for limiting concurrent operations (not ad-hoc counters) -
RwLockused when read-heavy workload (many readers, infrequent writes) -
Notifyused for simple signaling (not channel overhead) -
std::sync::LazyLockused instead ofonce_cell::sync::Lazyorlazy_static!for runtime-initialized singletons (stable since Rust 1.80) -
if letlock guard patterns reviewed for edition 2024 temporary scoping — temporaries drop earlier, may change borrow validity
Channels
- Channel type matches pattern: mpsc for back-pressure, broadcast for fan-out, oneshot for request-response, watch for latest-value
- Bounded channels have appropriate capacity (not too small = deadlock, not too large = memory)
-
SendError/RecvErrorhandled (indicates other side dropped) - Broadcast
Laggederrors handled (receiver fell behind) - Channel senders dropped when done to signal completion to receivers
Timer and Sleep
-
tokio::time::sleepused instead ofstd::thread::sleep -
tokio::time::timeoutwraps operations that could hang -
tokio::time::intervalused correctly (.tick().awaitfor periodic work)
Severity Calibration
Critical
- Blocking I/O (
std::fs::read,std::net::TcpStream) in async context withoutspawn_blocking - Mutex guard held across
.awaitpoint (deadlock potential) std::thread::sleepin async function (blocks runtime thread)- Unbounded channel where back-pressure is needed (OOM risk)
Major
JoinHandlesilently dropped (lost errors, zombie tasks)- Missing
select!cancellation safety consideration - Wrong mutex type (std vs tokio) for the use case
- Missing timeout on network/external operations
Minor
tokio::spawnfor trivially small async blocks (overhead > benefit)- Overly large channel buffer without justification
- Manual runtime construction where
#[tokio::main]suffices std::sync::Mutexwhere contention is high enough to benefit from tokio's async mutex
Informational
- Suggestions to use
tokio-utilutilities (e.g.,CancellationToken) - Tower middleware patterns for service composition
- Structured concurrency with
JoinSet - Migration from
async-traitcrate to nativeasync fnin traits - Migration from
once_cell/lazy_statictostd::sync::LazyLock - Using
#[expect(lint)]instead of#[allow(lint)]for self-cleaning suppression
Valid Patterns (Do NOT Flag)
std::sync::Mutexfor short critical sections — tokio docs recommend this when no.awaitis inside the locktokio::spawnwithout explicit join — Valid for background tasks with proper shutdown signaling- Unbuffered channel capacity of 1 — Valid for synchronization barriers
#[tokio::main(flavor = "current_thread")]in simple binaries — Not every app needs multi-thread runtimeclone()onArc<T>beforespawn— Required for moving into tasks, not unnecessary cloning- Large broadcast channel capacity — Valid when lagged errors are expensive (event sourcing)
- Native
async fnin traits withoutasync-trait— Stable since 1.75; the crate is still valid fordyndispatch cases + use<'a>on-> impl Futurereturns — Correct edition 2024 precise capture syntax to limit lifetime capture#[expect(clippy::type_complexity)]on complex async types — Self-cleaning alternative to#[allow], warns when suppression is no longer needed
Before Submitting Findings
After Gates, apply beagle-rust:review-verification-protocol to every reported issue (evidence and dispositions per that skill).