|
| 1 | +//! Startup probe of every configured foreign-chain RPC provider, via |
| 2 | +//! [`foreign_chain_health_check::probe`]. |
| 3 | +
|
| 4 | +use std::panic::AssertUnwindSafe; |
| 5 | + |
| 6 | +use foreign_chain_health_check::probe::{ProbeReport, ProviderStatus, probe_all_providers}; |
| 7 | +use futures::FutureExt as _; |
| 8 | +use mpc_node_config::ForeignChainsConfig; |
| 9 | +use tracing::{debug, error, info, warn}; |
| 10 | + |
| 11 | +/// Asks every configured provider which network it serves and logs a line per provider plus an |
| 12 | +/// `x/y providers healthy` summary. Diagnostic only: a provider on the wrong network keeps |
| 13 | +/// serving, because a boot time blip should not take a chain out of signing. |
| 14 | +/// |
| 15 | +/// A panic is caught and logged rather than vanishing with the spawned task's dropped handle. |
| 16 | +pub async fn run_startup_probe(foreign_chains: ForeignChainsConfig) { |
| 17 | + let probe = async move { |
| 18 | + info!("probing foreign-chain RPC providers"); |
| 19 | + log_report(&probe_all_providers(&foreign_chains).await); |
| 20 | + }; |
| 21 | + |
| 22 | + if AssertUnwindSafe(probe).catch_unwind().await.is_err() { |
| 23 | + error!("foreign-chain RPC provider probe panicked (diagnostic only; node unaffected)"); |
| 24 | + } |
| 25 | +} |
| 26 | + |
| 27 | +/// A [`ProviderStatus`] carries no provider text and no auth material, so it is logged whole. |
| 28 | +fn log_report(report: &ProbeReport) { |
| 29 | + for row in report.rows() { |
| 30 | + match &row.status { |
| 31 | + ProviderStatus::Healthy => debug!( |
| 32 | + chain = ?row.chain, |
| 33 | + provider = %row.provider, |
| 34 | + "foreign-chain RPC provider serves the expected network", |
| 35 | + ), |
| 36 | + ProviderStatus::ProbeNotImplemented => debug!( |
| 37 | + chain = ?row.chain, |
| 38 | + provider = %row.provider, |
| 39 | + "foreign-chain RPC provider cannot be probed", |
| 40 | + ), |
| 41 | + unhealthy => warn!( |
| 42 | + chain = ?row.chain, |
| 43 | + provider = %row.provider, |
| 44 | + status = ?unhealthy, |
| 45 | + "foreign-chain RPC provider is unhealthy", |
| 46 | + ), |
| 47 | + } |
| 48 | + } |
| 49 | + |
| 50 | + let counts = report.counts_per_chain(); |
| 51 | + let configured: usize = counts.values().map(|count| count.configured).sum(); |
| 52 | + if configured == 0 { |
| 53 | + warn!("foreign-chain RPC provider probe found nothing to probe: no chain is configured"); |
| 54 | + return; |
| 55 | + } |
| 56 | + let healthy: usize = counts.values().map(|count| count.healthy).sum(); |
| 57 | + info!("foreign-chain RPC provider probe complete: {healthy}/{configured} providers healthy"); |
| 58 | +} |
| 59 | + |
| 60 | +#[cfg(test)] |
| 61 | +#[expect(non_snake_case)] |
| 62 | +mod tests { |
| 63 | + use super::*; |
| 64 | + use mpc_node_config::{AuthConfig, ForeignChainConfig, ForeignChainProviderConfig}; |
| 65 | + use near_mpc_bounded_collections::NonEmptyBTreeMap; |
| 66 | + use std::num::NonZeroU64; |
| 67 | + use tracing_test::traced_test; |
| 68 | + |
| 69 | + /// Reserved as "discard", so nothing listens there. |
| 70 | + const CLOSED_PORT_URL: &str = "http://127.0.0.1:9"; |
| 71 | + |
| 72 | + fn chain_config(expected: &str, rpc_url: &str) -> ForeignChainConfig { |
| 73 | + ForeignChainConfig { |
| 74 | + timeout_sec: NonZeroU64::new(1).unwrap(), |
| 75 | + max_retries: NonZeroU64::new(1).unwrap(), |
| 76 | + expected_network_fingerprint: Some(expected.to_string()), |
| 77 | + providers: NonEmptyBTreeMap::new( |
| 78 | + "only".to_string().into(), |
| 79 | + ForeignChainProviderConfig { |
| 80 | + rpc_url: rpc_url.to_string(), |
| 81 | + auth: AuthConfig::None, |
| 82 | + }, |
| 83 | + ), |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + #[tokio::test] |
| 88 | + #[traced_test] |
| 89 | + async fn run_startup_probe__should_probe_every_configured_provider() { |
| 90 | + // Given |
| 91 | + let foreign_chains = ForeignChainsConfig { |
| 92 | + base: Some(chain_config("8453", CLOSED_PORT_URL)), |
| 93 | + ..Default::default() |
| 94 | + }; |
| 95 | + |
| 96 | + // When |
| 97 | + run_startup_probe(foreign_chains).await; |
| 98 | + |
| 99 | + // Then |
| 100 | + assert!(logs_contain("probing foreign-chain RPC providers")); |
| 101 | + assert!(logs_contain( |
| 102 | + "foreign-chain RPC provider probe complete: 0/1 providers healthy" |
| 103 | + )); |
| 104 | + } |
| 105 | + |
| 106 | + #[tokio::test] |
| 107 | + #[traced_test] |
| 108 | + async fn run_startup_probe__should_warn_when_no_chain_is_configured() { |
| 109 | + // Given |
| 110 | + let foreign_chains = ForeignChainsConfig::default(); |
| 111 | + |
| 112 | + // When |
| 113 | + run_startup_probe(foreign_chains).await; |
| 114 | + |
| 115 | + // Then |
| 116 | + assert!(logs_contain("no chain is configured")); |
| 117 | + } |
| 118 | + |
| 119 | + #[tokio::test] |
| 120 | + #[traced_test] |
| 121 | + async fn run_startup_probe__should_name_the_unhealthy_provider_and_its_status() { |
| 122 | + // Given |
| 123 | + let foreign_chains = ForeignChainsConfig { |
| 124 | + base: Some(chain_config("8453", CLOSED_PORT_URL)), |
| 125 | + ..Default::default() |
| 126 | + }; |
| 127 | + |
| 128 | + // When |
| 129 | + run_startup_probe(foreign_chains).await; |
| 130 | + |
| 131 | + // Then |
| 132 | + assert!(logs_contain("foreign-chain RPC provider is unhealthy")); |
| 133 | + assert!(logs_contain("Unreachable")); |
| 134 | + } |
| 135 | +} |
0 commit comments