swactor/crates/distribution/src/iroh_driver.rs

1461 lines
60 KiB
Rust
Raw Normal View History

//! iroh-based P2P network driver for `DistributedNode`.
//!
//! Provides the same driver pattern as `NodeDriver`, but uses iroh's
//! QUIC-based peer-to-peer transport with built-in TLS, NAT hole-punching,
//! and relay server fallback.
//!
//! The driver owns a tokio runtime internally, exposing a synchronous API
//! (`tick()`, `recv()`, `join()`) to match the existing main loop pattern.
use std::collections::HashMap;
use std::net::{IpAddr, SocketAddr};
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};
use iroh::endpoint::Connection;
use iroh::{Endpoint, EndpointAddr, PublicKey, RelayMode, SecretKey};
use tokio::runtime::Runtime as TokioRuntime;
use crate::crypto::Keypair;
use crate::diagnostics::{
noop_emitter, Aggregator, ConnectionCacheTracker, DialOutcome as DiagDialOutcome, DynEmitter,
Event as DiagEvent, EventEmitter, IrohIntrospect, IrohIntrospector, Sink as DiagSink,
SwimIntrospector,
};
use crate::diagnostics::iroh_introspect::IntrospectConfig;
use crate::diagnostics::wall_ms_now;
use crate::messages::*;
use crate::node::{DistributedNode, DistributedNodeConfig};
use crate::peer_auth::PeerAllowList;
use crate::snapshot::DistributionNodeSnapshot;
use crate::swim::node::NodeAction;
use crate::types::NodeId;
/// ALPN protocol identifier for SWIM messages over iroh.
const ALPN: &[u8] = b"swactor/swim/1";
// ─── Config ─────────────────────────────────────────────────────────────────
/// Configuration for the iroh-based driver.
pub struct IrohDriverConfig {
/// Secret key for the iroh endpoint.
/// If `None`, a fresh key is generated (node gets a random identity).
pub secret_key: Option<SecretKey>,
/// Relay server configuration.
/// Defaults to `RelayMode::Default` (n0 production relays).
pub relay_mode: RelayMode,
/// Protocol-layer configuration.
pub node: DistributedNodeConfig,
/// Optional peer allow-list. If provided, only allowed peers can connect.
pub peer_auth: Option<Arc<Mutex<PeerAllowList>>>,
/// Additional ALPNs to register beyond SWIM. Opaque to the driver.
pub additional_alpns: Vec<Vec<u8>>,
/// If set, start an embedded relay server on this address.
/// Requires the `relay` feature. On success, the driver uses the embedded
/// relay for `RelayMode::Custom`; on failure, falls back to `relay_mode`.
#[cfg(feature = "relay")]
pub embedded_relay_bind: Option<std::net::SocketAddr>,
/// Public IP to advertise in the relay URL instead of the bind address.
/// When `Some`, the relay URL uses this IP; when `None`, falls back to the
/// bind address (which may be `0.0.0.0`).
#[cfg(feature = "relay")]
pub relay_public_ip: Option<std::net::IpAddr>,
}
// ─── Pending join result ────────────────────────────────────────────────────
/// Result of a background join attempt, collected during `recv()`.
struct JoinResult {
node_id: NodeId,
conn: Connection,
}
// ─── LAN IP Discovery ──────────────────────────────────────────────────────
/// Discover all non-loopback LAN IP addresses on this host.
///
/// Uses UDP socket tricks to multiple broadcast destinations to find
/// addresses across different subnets. Also parses `/proc/net/if_inet6`
/// for IPv6 addresses on Linux.
pub fn discover_lan_ips() -> Vec<IpAddr> {
let mut ips = Vec::new();
let mut seen = std::collections::HashSet::new();
// UDP socket trick: connect to a broadcast-ish address, read local_addr
let targets: &[&str] = &[
"10.255.255.255:1",
"192.168.255.255:1",
"172.31.255.255:1",
];
for target in targets {
if let Ok(sock) = std::net::UdpSocket::bind("0.0.0.0:0") {
if sock.connect(target).is_ok() {
if let Ok(local) = sock.local_addr() {
let ip = local.ip();
if !ip.is_loopback() && !ip.is_unspecified() && seen.insert(ip) {
ips.push(ip);
}
}
}
}
}
// Parse /proc/net/if_inet6 for IPv6 addresses (Linux only)
if let Ok(contents) = std::fs::read_to_string("/proc/net/if_inet6") {
for line in contents.lines() {
let parts: Vec<&str> = line.split_whitespace().collect();
if parts.len() >= 6 {
let hex = parts[0];
if hex.len() == 32 {
let mut bytes = [0u8; 16];
let mut valid = true;
for i in 0..16 {
match u8::from_str_radix(&hex[i * 2..i * 2 + 2], 16) {
Ok(b) => bytes[i] = b,
Err(_) => { valid = false; break; }
}
}
if valid {
let ip = IpAddr::V6(std::net::Ipv6Addr::from(bytes));
if !ip.is_loopback() && !ip.is_unspecified() {
// Skip link-local (fe80::)
if let IpAddr::V6(v6) = ip {
if (v6.segments()[0] & 0xffc0) == 0xfe80 {
continue;
}
}
if seen.insert(ip) {
ips.push(ip);
}
}
}
}
}
}
}
ips
}
// ─── Join Status ───────────────────────────────────────────────────────────
/// Phase of a join attempt.
#[derive(Debug, Clone)]
pub enum JoinPhase {
Connecting { attempt: u32, max_attempts: u32 },
Sending { attempt: u32, max_attempts: u32 },
Sent,
Failed { error: String },
}
/// Real-time status of a join attempt to a specific peer.
#[derive(Debug, Clone)]
pub struct JoinStatus {
pub phase: JoinPhase,
pub has_relay: bool,
pub has_direct: bool,
pub direct_addr_count: usize,
pub updated_at: Instant,
}
// ─── Driver ─────────────────────────────────────────────────────────────────
/// iroh P2P network driver.
///
/// Bridges the synchronous `DistributedNode` state machine with iroh's
/// async QUIC transport. Owns a tokio runtime internally.
pub struct IrohDriver {
node: DistributedNode,
endpoint: Endpoint,
rt: TokioRuntime,
connections: HashMap<NodeId, Connection>,
peer_auth: Option<Arc<Mutex<PeerAllowList>>>,
/// Collects connections from background join tasks.
pending_joins: Arc<Mutex<Vec<JoinResult>>>,
/// Connections accepted by the background accept loop (SWIM ALPN).
accepted_conns: Arc<Mutex<Vec<(NodeId, Connection)>>>,
/// Connections accepted on non-SWIM ALPNs (streams, etc.).
other_accepted_conns: Arc<Mutex<Vec<(NodeId, Connection)>>>,
/// Relay URLs learned from join seeds, used for reconnection.
peer_relay_urls: HashMap<NodeId, iroh::RelayUrl>,
/// Real-time join status for each peer being joined.
join_statuses: Arc<Mutex<HashMap<NodeId, JoinStatus>>>,
/// Embedded relay server (if started).
#[cfg(feature = "relay")]
relay_server: Option<iroh_relay::server::Server>,
/// URL of the embedded relay server (if started).
relay_url: Option<String>,
/// Diagnostics emitter. Defaults to no-op so callers that don't
/// opt in pay no overhead. Set via [`Self::set_diagnostics`].
diagnostics: DynEmitter,
/// Per-peer connection-cache lifecycle aggregate (T2.4). Owns
/// `generation`, `created_at_ms`, last successful send/failure
/// timestamps. Shared with the iroh introspector so its tier-2
/// snapshots include the same numbers the per-touch events
/// already carry. Always allocated; the cost is one
/// `Arc<Mutex<HashMap>>` per driver.
connection_cache_tracker: Arc<ConnectionCacheTracker>,
/// Tier-2 iroh introspector. Owns the polling task that scrapes
/// `RemoteInfo` and `iroh-metrics` into the snapshot body, plus
/// the home-relay watcher that emits `RelayChanged`. Installed
/// via [`Self::install_iroh_introspect`].
iroh_introspect: Option<Arc<IrohIntrospect>>,
}
impl IrohDriver {
/// Create a new iroh driver.
///
/// Builds a tokio runtime, creates an iroh `Endpoint`, and initializes
/// the protocol-layer `DistributedNode`.
///
/// If `embedded_relay_bind` is set (requires `relay` feature), the driver
/// starts an embedded relay server on the tokio runtime before creating
/// the endpoint. On success the endpoint uses the embedded relay; on
/// failure it falls back to `config.relay_mode`.
pub fn new(config: IrohDriverConfig) -> Result<Self, Box<dyn std::error::Error>> {
let rt = tokio::runtime::Builder::new_multi_thread()
.enable_all()
.build()?;
// Try to start embedded relay if configured
#[cfg(feature = "relay")]
let (relay_server, relay_url, effective_relay_mode) = match config.embedded_relay_bind {
Some(bind_addr) => {
match rt.block_on(start_embedded_relay(bind_addr, config.relay_public_ip)) {
Ok((server, url)) => {
let url_str = url.to_string();
eprintln!("Relay: embedded relay started at {url}");
(Some(server), Some(url_str), RelayMode::Custom(url.into()))
}
Err(e) => {
eprintln!("Relay: failed to start embedded relay: {e}, falling back");
(None, None, config.relay_mode)
}
}
}
None => (None, None, config.relay_mode),
};
#[cfg(not(feature = "relay"))]
let (relay_url, effective_relay_mode) = (None::<String>, config.relay_mode);
let endpoint = rt.block_on(async {
let mut alpns = vec![ALPN.to_vec()];
alpns.extend(config.additional_alpns.iter().cloned());
let mut builder = Endpoint::builder(iroh::endpoint::presets::Minimal)
.relay_mode(effective_relay_mode)
.alpns(alpns);
if let Some(key) = config.secret_key {
builder = builder.secret_key(key);
}
builder.bind().await
})?;
// Create a DistributedNode whose identity matches the iroh endpoint.
// Both use ed25519-dalek, so we can reconstruct our Keypair from iroh's secret key.
let iroh_secret = endpoint.secret_key().to_bytes();
let keypair = Keypair::from_bytes(&iroh_secret);
let node = DistributedNode::with_keypair(keypair, config.node);
// Spawn background accept loop so incoming connections are never missed
let accepted_conns: Arc<Mutex<Vec<(NodeId, Connection)>>> =
Arc::new(Mutex::new(Vec::new()));
let other_accepted_conns: Arc<Mutex<Vec<(NodeId, Connection)>>> =
Arc::new(Mutex::new(Vec::new()));
{
let ep = endpoint.clone();
let peer_auth = config.peer_auth.clone();
let swim_buf = Arc::clone(&accepted_conns);
let other_buf = Arc::clone(&other_accepted_conns);
rt.spawn(async move {
loop {
match ep.accept().await {
Some(incoming) => match incoming.await {
Ok(conn) => {
let remote_id = conn.remote_id();
let node_id = NodeId(*remote_id.as_bytes());
// Peer auth check
let allowed = match &peer_auth {
None => true,
Some(auth) => auth.lock().unwrap().is_allowed(&node_id),
};
if !allowed {
eprintln!(
"iroh driver: rejected connection from unauthorized peer {}",
swactor::transport::hex_encode(&node_id.0[..4])
);
conn.close(0u32.into(), b"unauthorized");
continue;
}
// Route by negotiated ALPN
let negotiated_alpn = conn.alpn();
if negotiated_alpn == ALPN {
eprintln!(
"iroh driver: accepted SWIM connection from {}",
swactor::transport::hex_encode(&node_id.0[..4])
);
swim_buf.lock().unwrap().push((node_id, conn));
} else {
eprintln!(
"iroh driver: accepted non-SWIM connection from {} (ALPN: {})",
swactor::transport::hex_encode(&node_id.0[..4]),
String::from_utf8_lossy(negotiated_alpn),
);
other_buf.lock().unwrap().push((node_id, conn));
}
}
Err(e) => {
eprintln!("iroh driver: incoming connection error: {e}");
}
},
None => break, // endpoint closed
}
}
});
}
Ok(Self {
node,
endpoint,
rt,
connections: HashMap::new(),
peer_auth: config.peer_auth,
pending_joins: Arc::new(Mutex::new(Vec::new())),
accepted_conns,
other_accepted_conns,
peer_relay_urls: HashMap::new(),
join_statuses: Arc::new(Mutex::new(HashMap::new())),
#[cfg(feature = "relay")]
relay_server,
relay_url,
diagnostics: noop_emitter(),
connection_cache_tracker: Arc::new(ConnectionCacheTracker::new()),
iroh_introspect: None,
})
}
/// Install a diagnostics emitter so dial attempts, message I/O, and
/// connection-cache lifecycle surface as structured events. Also
/// forwards to the inner [`DistributedNode`] so SWIM transitions
/// are captured under the same emitter.
pub fn set_diagnostics(&mut self, emitter: DynEmitter) {
self.node.set_diagnostics(emitter.clone());
self.diagnostics = emitter;
}
/// Borrow the installed diagnostics emitter. Returns the no-op
/// emitter (cheap clone) when diagnostics are not installed, so
/// callers can `.clone()` it unconditionally without branching.
pub fn diagnostics(&self) -> &DynEmitter {
&self.diagnostics
}
/// Forward an event into the installed diagnostics emitter. App
/// code that holds `&IrohDriver` can emit `Event::Custom` records
/// through this without acquiring the aggregator directly. No-op
/// when diagnostics are not installed.
pub fn emit(&self, event: DiagEvent) {
self.diagnostics.emit_event(event);
}
/// Install diagnostics with full tier-2 iroh introspection.
///
/// Equivalent to [`Self::set_diagnostics`] plus spinning up an
/// [`IrohIntrospect`] bound to this driver's endpoint, registering
/// it on the aggregator (so tier-2 fields land in every snapshot),
/// and spawning the home-relay watcher that emits `RelayChanged`.
///
/// Use this in production / e2e wiring. The plain
/// [`Self::set_diagnostics`] is enough for callers that only want
/// tier-1 event emission.
pub fn install_diagnostics<S>(&mut self, aggregator: Arc<Aggregator<S>>)
where
S: DiagSink + Send + Sync + 'static,
{
self.install_diagnostics_with_config(aggregator, IntrospectConfig::default());
}
/// Variant of [`Self::install_diagnostics`] taking an explicit
/// scrape-interval config. Useful in tests that want to dial down
/// the polling cadence without `sleep`-ing.
pub fn install_diagnostics_with_config<S>(
&mut self,
aggregator: Arc<Aggregator<S>>,
config: IntrospectConfig,
) where
S: DiagSink + Send + Sync + 'static,
{
self.set_diagnostics(aggregator.clone());
let intro = Arc::new(IrohIntrospect::start(
self.endpoint.clone(),
self.rt.handle().clone(),
self.diagnostics.clone(),
config,
Arc::clone(&self.connection_cache_tracker),
));
aggregator.set_iroh_introspector(intro.clone() as Arc<dyn IrohIntrospector>);
self.iroh_introspect = Some(intro);
// Tier-2 SWIM scrape: install the introspector on the SWIM
// node and register the same Arc with the aggregator so every
// snapshot also includes the SWIM block.
let swim_intro = self.node.install_swim_introspect();
aggregator.set_swim_introspector(swim_intro as Arc<dyn SwimIntrospector>);
// Same dance for the local name-registry view.
let registry_intro = self.node.install_registry_introspect();
aggregator.set_registry_introspector(
registry_intro as Arc<dyn crate::diagnostics::RegistryIntrospector>,
);
}
/// Register a peer with the iroh introspector (if installed) so
/// its tier-2 `RemoteInfo` is included in future snapshots. No-op
/// when no introspector is wired.
pub fn register_diagnostics_peer(&self, node_id: NodeId) {
if let Some(intro) = &self.iroh_introspect {
intro.register_peer(node_id);
}
}
/// Force the introspector to refresh its tier-2 cache right now.
/// Used by tests so an assertion against snapshot contents need
/// not wait for the next polling tick. No-op when no introspector
/// is wired.
pub fn force_iroh_introspect_refresh(&self) {
if let Some(intro) = &self.iroh_introspect {
intro.force_refresh_blocking(&self.endpoint, self.rt.handle());
}
}
/// Get a handle to the tokio runtime owned by this driver.
pub fn tokio_handle(&self) -> tokio::runtime::Handle {
self.rt.handle().clone()
}
/// Get a reference to the iroh endpoint (for creating outbound connections).
pub fn endpoint(&self) -> &Endpoint {
&self.endpoint
}
/// Drain connections accepted on non-SWIM ALPNs.
pub fn drain_other_connections(&self) -> Vec<(NodeId, Connection)> {
self.other_accepted_conns.lock().unwrap().drain(..).collect()
}
/// The node's identity.
pub fn node_id(&self) -> NodeId {
self.node.node_id()
}
/// The endpoint's full address (public key + direct socket addresses).
///
/// Constructs the address from the endpoint's public key and bound
/// sockets. For sockets bound to `0.0.0.0`, emits one address per
/// discovered LAN IP so that peers on the same network can connect
/// directly. IPv6 unspecified is mapped to localhost.
pub fn endpoint_addr(&self) -> EndpointAddr {
let key = PublicKey::from_bytes(&self.node.node_id().0)
.expect("node_id is a valid public key");
let mut addr = EndpointAddr::new(key);
for sa in self.direct_addresses() {
addr = addr.with_ip_addr(sa);
}
addr
}
/// Compute direct socket addresses from bound sockets + LAN discovery.
///
/// For sockets bound to `0.0.0.0`, emits one `SocketAddr` per discovered
/// LAN IP using the bound port. Specific-IP binds are kept as-is.
pub fn direct_addresses(&self) -> Vec<SocketAddr> {
let lan_ips = discover_lan_ips();
let mut addrs = Vec::new();
for sock in self.endpoint.bound_sockets() {
match sock.ip() {
IpAddr::V4(ip) if ip.is_unspecified() => {
// Emit one address per discovered LAN IP
for lip in &lan_ips {
if lip.is_ipv4() {
addrs.push(SocketAddr::new(*lip, sock.port()));
}
}
// Also include localhost for same-host connectivity
addrs.push(SocketAddr::new(
IpAddr::V4(std::net::Ipv4Addr::LOCALHOST),
sock.port(),
));
}
IpAddr::V6(ip) if ip.is_unspecified() => {
addrs.push(SocketAddr::new(
IpAddr::V6(std::net::Ipv6Addr::LOCALHOST),
sock.port(),
));
}
_ => {
addrs.push(sock);
}
}
}
addrs
}
/// Access the underlying node (read-only).
pub fn node(&self) -> &DistributedNode {
&self.node
}
/// Access the underlying node (mutable).
pub fn node_mut(&mut self) -> &mut DistributedNode {
&mut self.node
}
/// Capture a snapshot enriched with iroh endpoint info.
pub fn snapshot(&self) -> DistributionNodeSnapshot {
let mut snap = self.node.snapshot();
// Use iroh endpoint address as the "listen address"
let addr_info = self.rt.block_on(async {
format!("{}", self.endpoint.id())
});
snap.listen_addr = Some(addr_info);
snap
}
/// Get a snapshot of all join statuses.
pub fn join_statuses(&self) -> HashMap<NodeId, JoinStatus> {
self.join_statuses.lock().unwrap().clone()
}
/// Clear join statuses for the given node IDs (e.g. peers that are now alive).
pub fn clear_join_statuses(&self, node_ids: &[NodeId]) {
let mut map = self.join_statuses.lock().unwrap();
for id in node_ids {
map.remove(id);
}
}
/// Clear a single join status entry.
pub fn clear_join_status(&self, node_id: &NodeId) {
self.join_statuses.lock().unwrap().remove(node_id);
}
/// Join a cluster by connecting to seed nodes via iroh.
///
/// Each seed is identified by its `EndpointAddr` (public key + optional
/// direct addresses). Connect+send is spawned as a background task so
/// that the peer can accept the connection during its `recv()` cycle.
/// Results are collected in the next `recv()` call.
pub fn join(&mut self, seeds: &[EndpointAddr]) {
for seed_addr in seeds {
// Store relay URL for future reconnection
let seed_node_id = NodeId(*seed_addr.id.as_bytes());
if let Some(relay) = seed_addr.relay_urls().next() {
self.peer_relay_urls.insert(seed_node_id, relay.clone());
// We just learned a relay URL from a join seed. Iroh
// doesn't have a separate add_node_addr() in 0.96 —
// the equivalent is feeding the addr into endpoint
// .connect(), which spawn_join_request does below.
// Emit the NodeMapUpdate here so the bundle reader
// sees "learned from join seed" even if the connect
// itself never fires (e.g. shutdown beats it).
self.diagnostics.emit_event(DiagEvent::NodeMapUpdate {
peer: seed_node_id,
from_source: "join_seed".into(),
accepted: true,
});
} else if seed_addr.ip_addrs().next().is_some() {
self.diagnostics.emit_event(DiagEvent::NodeMapUpdate {
peer: seed_node_id,
from_source: "join_seed_direct".into(),
accepted: true,
});
}
// Clear any Dead entry so the JoinResponse can re-establish it.
// Without this, SWIM merge semantics reject Alive at the same
// incarnation when the local entry is Dead (Dead > Alive).
self.node.clear_dead_member(seed_node_id);
// Drop stale cached connection so iroh establishes a fresh one
self.connections.remove(&seed_node_id);
// Enrich the seed addr with a cached relay URL if it doesn't
// have one. The re-peer flow sends only a bare public key
// because metadata (including relay URL) is stripped when a
// node is declared dead. Without a relay URL iroh cannot
// reach the peer through NAT.
let enriched = if seed_addr.relay_urls().next().is_none() {
if let Some(relay) = self.peer_relay_urls.get(&seed_node_id).cloned()
.or_else(|| self.node.relay_url(&seed_node_id)
.and_then(|s| s.parse::<iroh::RelayUrl>().ok()))
.or_else(|| self.endpoint.addr().relay_urls().next().cloned())
{
seed_addr.clone().with_relay_url(relay)
} else {
seed_addr.clone()
}
} else {
seed_addr.clone()
};
self.spawn_join_request(enriched);
}
}
fn spawn_join_request(&self, seed_addr: EndpointAddr) {
let msg = JoinRequest {
from: self.node.node_id(),
};
let payload = serde_json::to_vec(&msg).expect("serialize JoinRequest");
let tag = <JoinRequest as swactor::transport::NetworkMessage>::type_tag();
let endpoint = self.endpoint.clone();
let seed_node_id = NodeId(*seed_addr.id.as_bytes());
let pending = Arc::clone(&self.pending_joins);
let statuses = Arc::clone(&self.join_statuses);
let diagnostics = self.diagnostics.clone();
self.register_diagnostics_peer(seed_node_id);
let has_relay = seed_addr.relay_urls().next().is_some();
let direct_addr_count = seed_addr.ip_addrs().count();
let has_direct = direct_addr_count > 0;
self.rt.spawn(async move {
let mut delay = Duration::from_secs(2);
let max_delay = Duration::from_secs(30);
let max_attempts: u32 = 5;
let per_attempt_timeout = Duration::from_secs(10);
for attempt in 1..=max_attempts {
if attempt > 1 {
tokio::time::sleep(delay).await;
delay = (delay * 2).min(max_delay);
}
// Update status: Connecting
{
let mut map = statuses.lock().unwrap();
map.insert(seed_node_id, JoinStatus {
phase: JoinPhase::Connecting { attempt, max_attempts },
has_relay,
has_direct,
direct_addr_count,
updated_at: Instant::now(),
});
}
eprintln!("iroh driver: join attempt {attempt}/{max_attempts} connecting to {}...", seed_addr.id);
diagnostics.emit_event(DiagEvent::DialStarted {
peer: seed_node_id,
attempt,
timeout_ms: per_attempt_timeout.as_millis() as u64,
});
// Bare-seed dial: iroh has only a public key (no relay
// and no direct addresses), so the connect call runs
// iroh's discovery layer. Wrap the call in a
// `discovery_resolve_*` event pair so the bundle
// reader can tell the discovery layer was even
// exercised (T2.7).
let runs_discovery = !has_relay && !has_direct;
let peer_hex = swactor::transport::hex_encode(&seed_node_id.0);
if runs_discovery {
diagnostics.emit_event(DiagEvent::Custom {
kind: "discovery_resolve_started".into(),
fields: serde_json::json!({
"peer_node_id_hex": peer_hex,
"attempt": attempt,
"site": "join",
}),
});
}
let attempt_start = Instant::now();
let connect_result = tokio::time::timeout(
per_attempt_timeout,
endpoint.connect(seed_addr.clone(), ALPN),
).await;
let duration_ms = attempt_start.elapsed().as_millis() as u64;
if runs_discovery {
let outcome_str = match &connect_result {
Ok(Ok(_)) => "resolved",
_ => "failed",
};
diagnostics.emit_event(DiagEvent::Custom {
kind: "discovery_resolve_completed".into(),
fields: serde_json::json!({
"peer_node_id_hex": peer_hex,
"attempt": attempt,
"duration_ms": duration_ms,
"outcome": outcome_str,
"site": "join",
}),
});
}
match connect_result {
Ok(Ok(conn)) => {
diagnostics.emit_event(DiagEvent::DialOutcome {
peer: seed_node_id,
attempt,
outcome: DiagDialOutcome::Success,
duration_ms,
});
// Update status: Sending
{
let mut map = statuses.lock().unwrap();
map.insert(seed_node_id, JoinStatus {
phase: JoinPhase::Sending { attempt, max_attempts },
has_relay,
has_direct,
direct_addr_count,
updated_at: Instant::now(),
});
}
eprintln!("iroh driver: join attempt {attempt}/{max_attempts} connected to {}, sending...", seed_addr.id);
let send_result: Result<(), String> = async {
let mut send = conn.open_uni().await.map_err(|e| e.to_string())?;
let tag_len = (tag.len() as u32).to_be_bytes();
send.write_all(&tag_len).await.map_err(|e| e.to_string())?;
send.write_all(tag.as_bytes()).await.map_err(|e| e.to_string())?;
send.write_all(&payload).await.map_err(|e| e.to_string())?;
send.finish().map_err(|e| e.to_string())?;
Ok(())
}
.await;
match send_result {
Ok(()) => {
eprintln!("iroh driver: join attempt {attempt}/{max_attempts} sent to {}", seed_addr.id);
diagnostics.emit_event(DiagEvent::MessageSent {
peer: seed_node_id,
kind: tag.to_string(),
size: payload.len() as u32,
});
// Update status: Sent
{
let mut map = statuses.lock().unwrap();
map.insert(seed_node_id, JoinStatus {
phase: JoinPhase::Sent,
has_relay,
has_direct,
direct_addr_count,
updated_at: Instant::now(),
});
}
pending.lock().unwrap().push(JoinResult {
node_id: seed_node_id,
conn,
});
return;
}
Err(e) => {
eprintln!(
"iroh driver: join attempt {attempt}/{max_attempts} send error to {}: {e}",
seed_addr.id
);
diagnostics.emit_event(DiagEvent::Error {
component: "iroh_driver".into(),
message: format!("join send error: {e}"),
peer: Some(seed_node_id),
});
continue;
}
}
}
Ok(Err(e)) => {
eprintln!(
"iroh driver: join attempt {attempt}/{max_attempts} connect error to {}: {e}",
seed_addr.id
);
let outcome = classify_dial_error_str(&e.to_string());
diagnostics.emit_event(DiagEvent::DialOutcome {
peer: seed_node_id,
attempt,
outcome,
duration_ms,
});
continue;
}
Err(_) => {
eprintln!(
"iroh driver: join attempt {attempt}/{max_attempts} connect timeout to {}",
seed_addr.id
);
diagnostics.emit_event(DiagEvent::DialOutcome {
peer: seed_node_id,
attempt,
outcome: DiagDialOutcome::Timeout,
duration_ms,
});
continue;
}
}
}
// Update status: Failed
{
let mut map = statuses.lock().unwrap();
map.insert(seed_node_id, JoinStatus {
phase: JoinPhase::Failed { error: "all attempts exhausted".into() },
has_relay,
has_direct,
direct_addr_count,
updated_at: Instant::now(),
});
}
eprintln!("iroh driver: join failed after {max_attempts} attempts to {}", seed_addr.id);
});
}
/// Advance the node by one tick.
pub fn tick(&mut self) {
let actions = self.node.tick();
self.send_actions(&actions);
}
/// Process incoming iroh connections and messages (non-blocking).
pub fn recv(&mut self) {
// Collect completed background join connections
{
let mut pending = self.pending_joins.lock().unwrap();
if !pending.is_empty() {
eprintln!("iroh driver: collecting {} pending join connection(s)", pending.len());
}
for result in pending.drain(..) {
self.connection_cache_tracker
.note_dial_success(result.node_id, wall_ms_now());
self.connections.insert(result.node_id, result.conn);
}
}
let (incoming, new_conns) = self.rt.block_on(async {
self.receive_pending().await
});
// Cache connections accepted from remote peers (replace stale ones)
for (node_id, conn) in new_conns {
self.connection_cache_tracker
.note_dial_success(node_id, wall_ms_now());
self.connections.insert(node_id, conn);
}
for (tag, payload, from_key) in incoming {
let from = NodeId(*from_key.as_bytes());
let response_actions = self.dispatch_incoming(&tag, &payload, from);
self.send_actions(&response_actions);
}
}
// ─── Outgoing: NodeAction → iroh ─────────────────────────────────
fn send_actions(&mut self, actions: &[NodeAction]) {
let mut failure_targets: Vec<NodeId> = Vec::new();
for action in actions {
if let Err(e) = self.send_action(action) {
eprintln!("iroh driver: send error: {e}");
let target = action_target(action);
self.diagnostics.emit_event(DiagEvent::Error {
component: "iroh_driver".into(),
message: format!("send error: {e}"),
peer: target,
});
if let Some(target) = target {
if !failure_targets.contains(&target) {
failure_targets.push(target);
}
}
}
}
for target in failure_targets {
let probe_actions = self.node.report_send_failure(target);
// Best-effort send of probe actions — no recursion on failure
for action in &probe_actions {
if let Err(e) = self.send_action(action) {
eprintln!("iroh driver: probe send error: {e}");
}
}
}
}
fn send_action(&mut self, action: &NodeAction) -> Result<(), Box<dyn std::error::Error>> {
match action {
NodeAction::SendPing {
to,
sequence,
piggyback,
} => {
let msg = Ping {
from: self.node.node_id(),
sequence: *sequence,
piggyback: piggyback.clone(),
};
self.send_message(to, &msg)
}
NodeAction::SendAck {
to,
sequence,
piggyback,
} => {
let msg = Ack {
from: self.node.node_id(),
sequence: *sequence,
piggyback: piggyback.clone(),
};
self.send_message(to, &msg)
}
NodeAction::SendPingReq {
relay,
target,
sequence,
piggyback,
} => {
let msg = PingReq {
from: self.node.node_id(),
target: *target,
sequence: *sequence,
piggyback: piggyback.clone(),
};
self.send_message(relay, &msg)
}
NodeAction::SendJoinResponse { to, members } => {
let msg = JoinResponse {
members: members.clone(),
};
self.send_message(to, &msg)
}
NodeAction::ForwardAck { to, target, sequence, piggyback } => {
let msg = IndirectAck { target: *target, sequence: *sequence, piggyback: piggyback.clone() };
self.send_message(to, &msg)
}
NodeAction::MembershipChanged { .. } => Ok(()),
}
}
fn send_message<M: swactor::transport::NetworkMessage + serde::Serialize>(
&mut self,
to: &NodeId,
msg: &M,
) -> Result<(), Box<dyn std::error::Error>> {
let tag = M::type_tag();
let payload = serde_json::to_vec(msg)?;
let target_key = PublicKey::from_bytes(&to.0)?;
let payload_size = payload.len() as u32;
let conn = self.get_or_connect(*to, target_key)?;
let result = self.rt.block_on(async {
let mut send = conn.open_uni().await?;
write_message(&mut send, tag.as_bytes(), &payload).await?;
send.finish()?;
Ok::<_, Box<dyn std::error::Error>>(())
});
if let Err(e) = result {
// Connection may be stale, remove and retry once
self.connections.remove(to);
let generation = self.connection_cache_tracker.generation_for(*to);
let reason = format!("send-failed: {e}");
self.connection_cache_tracker
.note_failure(*to, wall_ms_now(), &reason);
self.diagnostics
.emit_event(DiagEvent::ConnectionCacheInvalidated {
peer: *to,
generation,
reason: "send-failed".into(),
});
let conn = self.get_or_connect(*to, target_key)?;
self.rt.block_on(async {
let mut send = conn.open_uni().await?;
write_message(&mut send, tag.as_bytes(), &payload).await?;
send.finish()?;
Ok::<_, Box<dyn std::error::Error>>(())
})?;
}
self.connection_cache_tracker
.note_send_success(*to, wall_ms_now());
self.diagnostics.emit_event(DiagEvent::MessageSent {
peer: *to,
kind: tag.to_string(),
size: payload_size,
});
Ok(())
}
fn get_or_connect(
&mut self,
node_id: NodeId,
key: PublicKey,
) -> Result<Connection, Box<dyn std::error::Error>> {
self.register_diagnostics_peer(node_id);
// Defense in depth: check peer auth before connecting
if !self.is_peer_allowed(&node_id) {
self.diagnostics.emit_event(DiagEvent::Error {
component: "iroh_driver".into(),
message: "peer not in allow-list".into(),
peer: Some(node_id),
});
return Err(format!(
"peer {} not in allow-list",
swactor::transport::hex_encode(&node_id.0[..4])
)
.into());
}
// Check for cached connection that's still open
if let Some(conn) = self.connections.get(&node_id) {
if conn.close_reason().is_none() {
let generation = self.connection_cache_tracker.generation_for(node_id);
self.diagnostics.emit_event(DiagEvent::ConnectionCacheHit {
peer: node_id,
generation,
});
return Ok(conn.clone());
}
// Connection closed, remove it
self.connections.remove(&node_id);
let generation = self.connection_cache_tracker.generation_for(node_id);
self.connection_cache_tracker.note_failure(
node_id,
wall_ms_now(),
"connection-closed",
);
self.diagnostics
.emit_event(DiagEvent::ConnectionCacheInvalidated {
peer: node_id,
generation,
reason: "connection-closed".into(),
});
}
// We're about to dial. Whether we had a stale entry above or
// never had one, this is a miss from the lookup's perspective.
self.diagnostics
.emit_event(DiagEvent::ConnectionCacheMiss { peer: node_id });
// Resolve relay URL: explicit cache → SWIM metadata gossip → own home relay
let (relay, relay_source) = if let Some(r) = self.peer_relay_urls.get(&node_id).cloned() {
(Some(r), "explicit_relay_cache")
} else if let Some(r) = self
.node
.relay_url(&node_id)
.and_then(|s| s.parse::<iroh::RelayUrl>().ok())
{
(Some(r), "swim_metadata")
} else if let Some(r) = self.endpoint.addr().relay_urls().next().cloned() {
(Some(r), "home_relay_fallback")
} else {
(None, "none")
};
// Emit NodeMapUpdate whenever we are about to feed iroh a peer
// address (relay URL). The bare-public-key path below is *not*
// an addr-injection — it just asks iroh to look up the peer.
if relay.is_some() {
self.diagnostics.emit_event(DiagEvent::NodeMapUpdate {
peer: node_id,
from_source: relay_source.to_string(),
accepted: true,
});
}
let endpoint = self.endpoint.clone();
// SWIM probes used a 2s connect-timeout with no in-call retry. On a
// WAN mesh where the home-relay path adds 100-500 ms latency and
// packets are occasionally dropped, that was too tight: a single
// slow handshake marked the peer suspect, then dead. Bumping the
// per-attempt budget and retrying inside the dial keeps SWIM
// convergence stable across the canary-relay endpoints that
// iroh 0.96 routes to by default.
const ATTEMPTS: u32 = 3;
let per_attempt_timeout = Duration::from_secs(10);
let addr_for_dial = relay.as_ref().map(|r| {
EndpointAddr::new(key).with_relay_url(r.clone())
});
let mut last_err: Option<Box<dyn std::error::Error>> = None;
let mut conn_opt: Option<Connection> = None;
let timeout_ms = per_attempt_timeout.as_millis() as u64;
let peer_hex = swactor::transport::hex_encode(&node_id.0);
for attempt in 1..=ATTEMPTS {
self.diagnostics.emit_event(DiagEvent::DialStarted {
peer: node_id,
attempt,
timeout_ms,
});
// Bare-key dial: iroh has only the public key and must
// run its discovery layer to find an address. Emit a
// `discovery_resolve_*` pair around the call so the
// bundle reader can distinguish "discovery never started"
// from "discovery started but never resolved" (T2.7).
let bare_key_dial = addr_for_dial.is_none();
if bare_key_dial {
self.diagnostics.emit_event(DiagEvent::Custom {
kind: "discovery_resolve_started".into(),
fields: serde_json::json!({
"peer_node_id_hex": peer_hex,
"attempt": attempt,
}),
});
}
let attempt_start = Instant::now();
let addr_clone = addr_for_dial.clone();
let endpoint = endpoint.clone();
let dial: Result<Connection, Box<dyn std::error::Error>> =
self.rt.block_on(async move {
let result = match addr_clone {
Some(a) => {
tokio::time::timeout(
per_attempt_timeout,
endpoint.connect(a, ALPN),
)
.await
}
None => {
tokio::time::timeout(
per_attempt_timeout,
endpoint.connect(key, ALPN),
)
.await
}
};
match result {
Ok(r) => r.map_err(|e| -> Box<dyn std::error::Error> { Box::new(e) }),
Err(_) => Err("connect timeout".into()),
}
});
let duration_ms = attempt_start.elapsed().as_millis() as u64;
if bare_key_dial {
let outcome_str = match &dial {
Ok(_) => "resolved",
Err(_) => "failed",
};
self.diagnostics.emit_event(DiagEvent::Custom {
kind: "discovery_resolve_completed".into(),
fields: serde_json::json!({
"peer_node_id_hex": peer_hex,
"attempt": attempt,
"duration_ms": duration_ms,
"outcome": outcome_str,
}),
});
}
match dial {
Ok(c) => {
self.diagnostics.emit_event(DiagEvent::DialOutcome {
peer: node_id,
attempt,
outcome: DiagDialOutcome::Success,
duration_ms,
});
conn_opt = Some(c);
break;
}
Err(e) => {
let outcome = classify_dial_error(&e);
self.diagnostics.emit_event(DiagEvent::DialOutcome {
peer: node_id,
attempt,
outcome,
duration_ms,
});
if attempt < ATTEMPTS {
eprintln!(
"iroh driver: connect attempt {attempt}/{ATTEMPTS} to {} failed: {e}",
swactor::transport::hex_encode(&node_id.0[..4]),
);
}
last_err = Some(e);
// Short backoff so a transient relay-side hiccup has
// time to recover before the next attempt. Linear
// 0/200/600 ms across 3 attempts.
if attempt == 1 {
std::thread::sleep(Duration::from_millis(200));
} else if attempt == 2 {
std::thread::sleep(Duration::from_millis(600));
}
}
}
}
let conn = conn_opt.ok_or_else(|| {
last_err.unwrap_or_else(|| -> Box<dyn std::error::Error> {
"connect failed".into()
})
})?;
self.connections.insert(node_id, conn.clone());
self.connection_cache_tracker
.note_dial_success(node_id, wall_ms_now());
Ok(conn)
}
// ─── Incoming: iroh → handler ────────────────────────────────────
fn is_peer_allowed(&self, node_id: &NodeId) -> bool {
match &self.peer_auth {
None => true,
Some(auth) => auth.lock().unwrap().is_allowed(node_id),
}
}
async fn receive_pending(&self) -> (Vec<(String, Vec<u8>, PublicKey)>, Vec<(NodeId, Connection)>) {
let mut messages = Vec::new();
// Drain connections accepted by the background accept loop
let new_connections: Vec<(NodeId, Connection)> = {
let mut buf = self.accepted_conns.lock().unwrap();
buf.drain(..).collect()
};
// Read streams from newly accepted connections
for (node_id, conn) in &new_connections {
let remote_id = PublicKey::from_bytes(&node_id.0).unwrap();
self.read_streams(conn, remote_id, &mut messages).await;
}
// Also read from existing cached connections
let conn_snapshot: Vec<(NodeId, Connection)> = self
.connections
.iter()
.map(|(id, c)| (*id, c.clone()))
.collect();
for (node_id, conn) in conn_snapshot {
let remote_id = PublicKey::from_bytes(&node_id.0).unwrap();
self.read_streams(&conn, remote_id, &mut messages).await;
}
if !messages.is_empty() {
eprintln!("iroh driver: received {} message(s)", messages.len());
}
(messages, new_connections)
}
async fn read_streams(
&self,
conn: &Connection,
remote_id: PublicKey,
messages: &mut Vec<(String, Vec<u8>, PublicKey)>,
) {
loop {
match tokio::time::timeout(Duration::from_millis(1), conn.accept_uni()).await {
Ok(Ok(mut recv)) => {
match read_message(&mut recv).await {
Ok((tag, payload)) => {
messages.push((tag, payload, remote_id));
}
Err(e) => {
eprintln!("iroh driver: read error: {e}");
break;
}
}
}
_ => break,
}
}
}
fn dispatch_incoming(
&mut self,
tag: &str,
payload: &[u8],
from: NodeId,
) -> Vec<NodeAction> {
self.register_diagnostics_peer(from);
self.diagnostics.emit_event(DiagEvent::MessageReceived {
peer: from,
kind: tag.to_string(),
size: payload.len() as u32,
});
match tag {
"swactor_dist::Ping" => match serde_json::from_slice::<Ping>(payload) {
Ok(msg) => self.node.handle_ping(msg.from, msg.sequence, &msg.piggyback),
Err(e) => {
eprintln!("iroh driver: decode Ping: {e}");
Vec::new()
}
},
"swactor_dist::Ack" => match serde_json::from_slice::<Ack>(payload) {
Ok(msg) => self.node.handle_ack(msg.from, msg.sequence, &msg.piggyback),
Err(e) => {
eprintln!("iroh driver: decode Ack: {e}");
Vec::new()
}
},
"swactor_dist::PingReq" => match serde_json::from_slice::<PingReq>(payload) {
Ok(msg) => {
self.node
.handle_ping_req(msg.from, msg.target, msg.sequence, &msg.piggyback)
}
Err(e) => {
eprintln!("iroh driver: decode PingReq: {e}");
Vec::new()
}
},
"swactor_dist::JoinRequest" => {
match serde_json::from_slice::<JoinRequest>(payload) {
Ok(msg) => self.node.handle_join_request(msg.from),
Err(e) => {
eprintln!("iroh driver: decode JoinRequest: {e}");
Vec::new()
}
}
}
"swactor_dist::JoinResponse" => {
match serde_json::from_slice::<JoinResponse>(payload) {
Ok(msg) => self.node.handle_join_response(msg.members),
Err(e) => {
eprintln!("iroh driver: decode JoinResponse: {e}");
Vec::new()
}
}
}
"swactor_dist::IndirectAck" => match serde_json::from_slice::<IndirectAck>(payload) {
Ok(msg) => self.node.handle_indirect_ack(msg.target, msg.sequence, &msg.piggyback),
Err(e) => {
eprintln!("iroh driver: decode IndirectAck: {e}");
Vec::new()
}
},
other => {
eprintln!("iroh driver: unknown message type: {other}");
Vec::new()
}
}
}
/// URL of the embedded relay server, if one was started.
pub fn relay_url(&self) -> Option<&str> {
self.relay_url.as_deref()
}
/// The endpoint's home relay URL (from RelayMode::Custom), if connected.
pub fn home_relay_url(&self) -> Option<iroh::RelayUrl> {
self.endpoint.addr().relay_urls().next().cloned()
}
/// Shut down the driver: stop the embedded relay (if any), then close the
/// iroh endpoint.
pub fn shutdown(&mut self) {
// Shut down embedded relay first (must stop before endpoint closes)
#[cfg(feature = "relay")]
if let Some(server) = self.relay_server.take() {
self.rt.block_on(async {
let _ = server.shutdown().await;
});
}
self.rt.block_on(async {
self.endpoint.close().await;
});
}
}
// ─── Embedded Relay ─────────────────────────────────────────────────────────
#[cfg(feature = "relay")]
async fn start_embedded_relay(
bind_addr: std::net::SocketAddr,
public_ip: Option<std::net::IpAddr>,
) -> Result<(iroh_relay::server::Server, iroh::RelayUrl), Box<dyn std::error::Error>> {
let server = iroh_relay::server::Server::spawn(
iroh_relay::server::ServerConfig::<(), ()> {
relay: Some(iroh_relay::server::RelayConfig {
http_bind_addr: bind_addr,
tls: None,
limits: Default::default(),
key_cache_capacity: Some(256),
access: iroh_relay::server::AccessConfig::Everyone,
}),
quic: None,
metrics_addr: None,
},
)
.await?;
let url: iroh::RelayUrl = match server.http_addr() {
Some(addr) => {
let host = public_ip.unwrap_or_else(|| addr.ip());
format!("http://{}:{}/", host, addr.port()).parse()?
}
None => return Err("relay server has no HTTP address".into()),
};
Ok((server, url))
}
// ─── Helpers ─────────────────────────────────────────────────────────────────
/// Bucket a dial error into one of the diagnostic outcome categories.
/// Falls back to `Error(msg)` for anything we can't classify so the
/// post-processor still sees the original error text.
fn classify_dial_error(err: &Box<dyn std::error::Error>) -> DiagDialOutcome {
classify_dial_error_str(&err.to_string())
}
fn classify_dial_error_str(msg: &str) -> DiagDialOutcome {
let lower = msg.to_lowercase();
if lower.contains("timeout") || lower.contains("timed out") {
DiagDialOutcome::Timeout
} else if lower.contains("refused") {
DiagDialOutcome::Refused
} else if lower.contains("no route") || lower.contains("unreachable") {
DiagDialOutcome::NoRoute
} else {
DiagDialOutcome::Error(msg.to_string())
}
}
/// Extract the send target from a node action (if it has one).
fn action_target(action: &NodeAction) -> Option<NodeId> {
match action {
NodeAction::SendPing { to, .. } => Some(*to),
NodeAction::SendAck { to, .. } => Some(*to),
NodeAction::SendPingReq { relay, .. } => Some(*relay),
NodeAction::SendJoinResponse { to, .. } => Some(*to),
NodeAction::ForwardAck { to, .. } => Some(*to),
NodeAction::MembershipChanged { .. } => None,
}
}
// ─── Wire Framing Over QUIC Streams ─────────────────────────────────────────
/// Write a tagged message to a QUIC send stream.
///
/// Frame format: `[4B tag_len][tag_bytes][payload_bytes]`
async fn write_message(
send: &mut iroh::endpoint::SendStream,
tag: &[u8],
payload: &[u8],
) -> Result<(), Box<dyn std::error::Error>> {
let tag_len = (tag.len() as u32).to_be_bytes();
send.write_all(&tag_len).await?;
send.write_all(tag).await?;
send.write_all(payload).await?;
Ok(())
}
/// Read a tagged message from a QUIC recv stream.
///
/// Returns `(type_tag, payload)`.
async fn read_message(
recv: &mut iroh::endpoint::RecvStream,
) -> Result<(String, Vec<u8>), Box<dyn std::error::Error>> {
let mut tag_len_buf = [0u8; 4];
recv.read_exact(&mut tag_len_buf).await?;
let tag_len = u32::from_be_bytes(tag_len_buf) as usize;
if tag_len > 1024 {
return Err("tag too large".into());
}
let mut tag_buf = vec![0u8; tag_len];
recv.read_exact(&mut tag_buf).await?;
let tag = String::from_utf8(tag_buf)?;
let payload = recv.read_to_end(64 * 1024).await?;
Ok((tag, payload))
}