|
| 1 | +//! Parallel peer-cache warm-up. |
| 2 | +//! |
| 3 | +//! Dials every node in the live topology except `self_id`, |
| 4 | +//! caps each dial at half the total deadline, and aggregates |
| 5 | +//! the outcome into a [`PeerWarmReport`]. Failures are |
| 6 | +//! non-fatal — operators see the per-peer failure in the |
| 7 | +//! returned report and the startup phase advances regardless. |
| 8 | +
|
| 9 | +use std::collections::HashSet; |
| 10 | +use std::time::{Duration, Instant}; |
| 11 | + |
| 12 | +use futures::future::join_all; |
| 13 | +use nodedb_cluster::{ClusterTopology, NexarTransport}; |
| 14 | + |
| 15 | +use super::report::PeerWarmReport; |
| 16 | + |
| 17 | +/// Pre-warm every peer in `topology` except `self_id`. |
| 18 | +/// |
| 19 | +/// `total_deadline` bounds the entire operation. Each |
| 20 | +/// individual peer dial is capped at `total_deadline / 2` |
| 21 | +/// so a single slow peer cannot eat the whole budget. All |
| 22 | +/// dials run in parallel, so the total wall-clock is |
| 23 | +/// roughly `max(per-peer-latency, total_deadline)`. |
| 24 | +/// |
| 25 | +/// Empty topology → returns [`PeerWarmReport::empty`]. |
| 26 | +/// Caller logs the returned report once; this function |
| 27 | +/// only logs per-peer failures if verbose tracing is |
| 28 | +/// enabled on the transport layer. |
| 29 | +pub async fn warm_known_peers( |
| 30 | + transport: &NexarTransport, |
| 31 | + topology: &ClusterTopology, |
| 32 | + self_id: u64, |
| 33 | + total_deadline: Duration, |
| 34 | +) -> PeerWarmReport { |
| 35 | + let start = Instant::now(); |
| 36 | + let per_peer_deadline = total_deadline.checked_div(2).unwrap_or(total_deadline); |
| 37 | + |
| 38 | + let peers: Vec<(u64, std::net::SocketAddr)> = topology |
| 39 | + .all_nodes() |
| 40 | + .filter(|n| n.node_id != self_id) |
| 41 | + .filter_map(|n| n.socket_addr().map(|a| (n.node_id, a))) |
| 42 | + .collect(); |
| 43 | + |
| 44 | + if peers.is_empty() { |
| 45 | + return PeerWarmReport::empty(); |
| 46 | + } |
| 47 | + |
| 48 | + let attempted = peers.len(); |
| 49 | + |
| 50 | + // Ensure the transport's address map has every peer. |
| 51 | + // `register_peer` is idempotent — safe to call again. |
| 52 | + for (id, addr) in &peers { |
| 53 | + transport.register_peer(*id, *addr); |
| 54 | + } |
| 55 | + |
| 56 | + let futs = peers.iter().map(|(id, _addr)| { |
| 57 | + let id = *id; |
| 58 | + async move { |
| 59 | + match tokio::time::timeout(per_peer_deadline, transport.warm_peer(id)).await { |
| 60 | + Ok(Ok(())) => (id, Ok(())), |
| 61 | + Ok(Err(e)) => (id, Err(format!("{e}"))), |
| 62 | + Err(_) => (id, Err(format!("dial timeout after {per_peer_deadline:?}"))), |
| 63 | + } |
| 64 | + } |
| 65 | + }); |
| 66 | + |
| 67 | + // Outer deadline bounds the entire parallel batch. On |
| 68 | + // outer timeout, every still-pending future is dropped |
| 69 | + // (cancelling the in-flight dials) and the missing peers |
| 70 | + // are reported as deadline exceedances. |
| 71 | + let outcome = tokio::time::timeout(total_deadline, join_all(futs)).await; |
| 72 | + |
| 73 | + let mut succeeded: Vec<u64> = Vec::with_capacity(attempted); |
| 74 | + let mut failed: Vec<(u64, String)> = Vec::new(); |
| 75 | + |
| 76 | + match outcome { |
| 77 | + Ok(results) => { |
| 78 | + for (id, outcome) in results { |
| 79 | + match outcome { |
| 80 | + Ok(()) => succeeded.push(id), |
| 81 | + Err(msg) => failed.push((id, msg)), |
| 82 | + } |
| 83 | + } |
| 84 | + } |
| 85 | + Err(_) => { |
| 86 | + // Outer deadline expired — we don't know which |
| 87 | + // futures completed vs which were in flight, so |
| 88 | + // mark every peer as a deadline exceedance. The |
| 89 | + // report is accurate about the worst case. |
| 90 | + for (id, _) in &peers { |
| 91 | + failed.push(( |
| 92 | + *id, |
| 93 | + format!("outer warm deadline exceeded after {total_deadline:?}"), |
| 94 | + )); |
| 95 | + } |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + // Sanity: account every attempted peer. If a future was |
| 100 | + // dropped between matching on the outer result and |
| 101 | + // collecting (shouldn't happen with join_all but cheap |
| 102 | + // to double-check), any missing ids become failures. |
| 103 | + let reported: HashSet<u64> = succeeded |
| 104 | + .iter() |
| 105 | + .copied() |
| 106 | + .chain(failed.iter().map(|(id, _)| *id)) |
| 107 | + .collect(); |
| 108 | + for (id, _) in &peers { |
| 109 | + if !reported.contains(id) { |
| 110 | + failed.push((*id, "unaccounted peer — internal bookkeeping bug".into())); |
| 111 | + } |
| 112 | + } |
| 113 | + |
| 114 | + PeerWarmReport { |
| 115 | + attempted, |
| 116 | + succeeded, |
| 117 | + failed, |
| 118 | + elapsed: start.elapsed(), |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +#[cfg(test)] |
| 123 | +mod tests { |
| 124 | + use super::*; |
| 125 | + use nodedb_cluster::ClusterTopology; |
| 126 | + |
| 127 | + #[tokio::test] |
| 128 | + async fn empty_topology_returns_empty_report() { |
| 129 | + let transport = test_transport(); |
| 130 | + let topo = ClusterTopology::new(); |
| 131 | + let report = warm_known_peers(&transport, &topo, 1, Duration::from_secs(1)).await; |
| 132 | + assert_eq!(report.attempted, 0); |
| 133 | + assert!(report.is_complete()); |
| 134 | + assert_eq!(report.elapsed, Duration::ZERO); |
| 135 | + } |
| 136 | + |
| 137 | + #[tokio::test] |
| 138 | + async fn self_only_topology_skips_self() { |
| 139 | + let transport = test_transport(); |
| 140 | + let mut topo = ClusterTopology::new(); |
| 141 | + topo.add_node(nodedb_cluster::NodeInfo::new( |
| 142 | + 1, |
| 143 | + "127.0.0.1:65530".parse().unwrap(), |
| 144 | + nodedb_cluster::NodeState::Active, |
| 145 | + )); |
| 146 | + let report = warm_known_peers(&transport, &topo, 1, Duration::from_secs(1)).await; |
| 147 | + assert_eq!(report.attempted, 0); |
| 148 | + } |
| 149 | + |
| 150 | + #[tokio::test] |
| 151 | + async fn dead_peer_is_reported_as_failure() { |
| 152 | + let transport = test_transport(); |
| 153 | + let mut topo = ClusterTopology::new(); |
| 154 | + topo.add_node(nodedb_cluster::NodeInfo::new( |
| 155 | + 1, |
| 156 | + "127.0.0.1:65530".parse().unwrap(), |
| 157 | + nodedb_cluster::NodeState::Active, |
| 158 | + )); |
| 159 | + // 127.0.0.1:1 — reserved port, guaranteed to fail. |
| 160 | + topo.add_node(nodedb_cluster::NodeInfo::new( |
| 161 | + 2, |
| 162 | + "127.0.0.1:1".parse().unwrap(), |
| 163 | + nodedb_cluster::NodeState::Active, |
| 164 | + )); |
| 165 | + let report = warm_known_peers(&transport, &topo, 1, Duration::from_millis(500)).await; |
| 166 | + assert_eq!(report.attempted, 1); |
| 167 | + assert_eq!(report.succeeded.len(), 0); |
| 168 | + assert_eq!(report.failed.len(), 1); |
| 169 | + assert_eq!(report.failed[0].0, 2); |
| 170 | + assert!(report.elapsed <= Duration::from_millis(700)); |
| 171 | + } |
| 172 | + |
| 173 | + fn test_transport() -> NexarTransport { |
| 174 | + NexarTransport::new(999, "127.0.0.1:0".parse().unwrap()).expect("test transport bind") |
| 175 | + } |
| 176 | +} |
0 commit comments