1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
//! Gossip runtime orchestration.
use super::config::GossipConfig;
use super::pubsub::{PubSubManager, SigningContext};
use crate::error::NetworkResult;
use crate::network::NetworkNode;
use crate::presence::PresenceWrapper;
use saorsa_gossip_membership::{HyParViewMembership, MembershipConfig};
use saorsa_gossip_transport::GossipStreamType;
use saorsa_gossip_types::PeerId;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use std::time::{Duration, Instant};
/// Maximum time to spend handling one inbound presence Bulk message.
///
/// The runtime dispatcher is the single consumer of the network receive queue.
/// A wedged presence handler must not stop all future Bulk presence beacons from
/// being processed while the lower network receiver keeps enqueueing packets.
const PRESENCE_MESSAGE_HANDLE_TIMEOUT: Duration = Duration::from_secs(5);
/// Maximum time to spend handling one inbound PubSub message.
const PUBSUB_MESSAGE_HANDLE_TIMEOUT: Duration = Duration::from_secs(10);
/// Maximum time to spend handling one inbound membership message.
const MEMBERSHIP_MESSAGE_HANDLE_TIMEOUT: Duration = Duration::from_secs(5);
/// Per-stream dispatcher counters.
#[derive(Debug, Default)]
pub struct DispatchStreamStats {
received: AtomicU64,
completed: AtomicU64,
timed_out: AtomicU64,
max_elapsed_ms: AtomicU64,
}
/// JSON-friendly snapshot of per-stream dispatcher counters.
#[derive(Debug, Clone, serde::Serialize)]
pub struct DispatchStreamStatsSnapshot {
pub received: u64,
pub completed: u64,
pub timed_out: u64,
pub max_elapsed_ms: u64,
}
impl DispatchStreamStats {
fn record_received(&self) {
self.received.fetch_add(1, Ordering::Relaxed);
}
fn record_completed(&self, elapsed: Duration) {
self.completed.fetch_add(1, Ordering::Relaxed);
self.max_elapsed_ms
.fetch_max(duration_ms(elapsed), Ordering::Relaxed);
}
fn record_timed_out(&self, elapsed: Duration) {
self.timed_out.fetch_add(1, Ordering::Relaxed);
self.max_elapsed_ms
.fetch_max(duration_ms(elapsed), Ordering::Relaxed);
}
fn snapshot(&self) -> DispatchStreamStatsSnapshot {
DispatchStreamStatsSnapshot {
received: self.received.load(Ordering::Relaxed),
completed: self.completed.load(Ordering::Relaxed),
timed_out: self.timed_out.load(Ordering::Relaxed),
max_elapsed_ms: self.max_elapsed_ms.load(Ordering::Relaxed),
}
}
}
/// Dispatcher counters for the inbound gossip receive pipeline.
#[derive(Debug, Default)]
pub struct GossipDispatchStats {
pubsub: DispatchStreamStats,
membership: DispatchStreamStats,
bulk: DispatchStreamStats,
recv_depth_latest: AtomicU64,
recv_depth_max: AtomicU64,
recv_capacity_latest: AtomicU64,
}
/// JSON-friendly snapshot of [`GossipDispatchStats`].
#[derive(Debug, Clone, serde::Serialize)]
pub struct GossipDispatchStatsSnapshot {
pub pubsub: DispatchStreamStatsSnapshot,
pub membership: DispatchStreamStatsSnapshot,
pub bulk: DispatchStreamStatsSnapshot,
pub recv_depth_latest: u64,
pub recv_depth_max: u64,
pub recv_capacity_latest: u64,
}
impl GossipDispatchStats {
fn record_dequeue(&self, depth: usize, capacity: usize) {
let depth = usize_to_u64(depth);
let capacity = usize_to_u64(capacity);
self.recv_depth_latest.store(depth, Ordering::Relaxed);
self.recv_depth_max.fetch_max(depth, Ordering::Relaxed);
self.recv_capacity_latest.store(capacity, Ordering::Relaxed);
}
/// Snapshot dispatcher counters.
#[must_use]
pub fn snapshot(&self) -> GossipDispatchStatsSnapshot {
GossipDispatchStatsSnapshot {
pubsub: self.pubsub.snapshot(),
membership: self.membership.snapshot(),
bulk: self.bulk.snapshot(),
recv_depth_latest: self.recv_depth_latest.load(Ordering::Relaxed),
recv_depth_max: self.recv_depth_max.load(Ordering::Relaxed),
recv_capacity_latest: self.recv_capacity_latest.load(Ordering::Relaxed),
}
}
}
fn duration_ms(duration: Duration) -> u64 {
u64::try_from(duration.as_millis())
.ok()
.map_or(u64::MAX, |ms| ms)
}
fn usize_to_u64(value: usize) -> u64 {
u64::try_from(value).ok().map_or(u64::MAX, |v| v)
}
/// The gossip runtime that manages all gossip components.
///
/// This orchestrates HyParView membership, SWIM failure detection,
/// and pub/sub messaging via the saorsa-gossip stack.
pub struct GossipRuntime {
config: GossipConfig,
network: Arc<NetworkNode>,
membership: Arc<HyParViewMembership<NetworkNode>>,
pubsub: Arc<PubSubManager>,
peer_id: PeerId,
presence: std::sync::Mutex<Option<Arc<PresenceWrapper>>>,
dispatcher_handle: std::sync::Mutex<Option<tokio::task::JoinHandle<()>>>,
peer_sync_handle: std::sync::Mutex<Option<tokio::task::JoinHandle<()>>>,
keepalive_handle: std::sync::Mutex<Option<tokio::task::JoinHandle<()>>>,
dispatch_stats: Arc<GossipDispatchStats>,
}
impl std::fmt::Debug for GossipRuntime {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("GossipRuntime")
.field("config", &self.config)
.field("peer_id", &self.peer_id)
.finish_non_exhaustive()
}
}
impl GossipRuntime {
/// Create a new gossip runtime with the given configuration and network node.
///
/// This initializes HyParView membership, SWIM failure detection, and
/// pub/sub messaging. Call `start()` to begin gossip protocol operations.
///
/// # Arguments
///
/// * `config` - The gossip configuration
/// * `network` - The network node (implements GossipTransport)
///
/// # Returns
///
/// A new `GossipRuntime` instance
///
/// # Errors
///
/// Returns an error if configuration validation fails.
pub async fn new(
config: GossipConfig,
network: Arc<NetworkNode>,
signing: Option<Arc<SigningContext>>,
) -> NetworkResult<Self> {
config.validate().map_err(|e| {
crate::error::NetworkError::NodeCreation(format!("invalid gossip config: {e}"))
})?;
let peer_id = saorsa_gossip_transport::GossipTransport::local_peer_id(network.as_ref());
let membership_config = MembershipConfig::default();
let membership = Arc::new(HyParViewMembership::new(
peer_id,
membership_config,
Arc::clone(&network),
));
let pubsub = Arc::new(PubSubManager::new(Arc::clone(&network), signing)?);
Ok(Self {
config,
network,
membership,
pubsub,
peer_id,
presence: std::sync::Mutex::new(None),
dispatcher_handle: std::sync::Mutex::new(None),
peer_sync_handle: std::sync::Mutex::new(None),
keepalive_handle: std::sync::Mutex::new(None),
dispatch_stats: Arc::new(GossipDispatchStats::default()),
})
}
/// Get the PubSubManager for this runtime.
///
/// # Returns
///
/// A reference to the `PubSubManager`.
#[must_use]
pub fn pubsub(&self) -> &Arc<PubSubManager> {
&self.pubsub
}
/// Get the HyParView membership manager.
///
/// # Returns
///
/// A reference to the `HyParViewMembership`.
#[must_use]
pub fn membership(&self) -> &Arc<HyParViewMembership<NetworkNode>> {
&self.membership
}
/// Get the local peer ID.
///
/// # Returns
///
/// The `PeerId` for this node.
#[must_use]
pub fn peer_id(&self) -> PeerId {
self.peer_id
}
/// Set the presence wrapper for Bulk stream dispatch.
///
/// Must be called before `start()` so that the dispatcher loop can
/// route `GossipStreamType::Bulk` messages to the presence manager.
pub fn set_presence(&self, presence: Arc<PresenceWrapper>) {
if let Ok(mut guard) = self.presence.lock() {
*guard = Some(presence);
}
}
/// Get the presence wrapper, if configured.
#[must_use]
pub fn presence(&self) -> Option<Arc<PresenceWrapper>> {
self.presence.lock().ok().and_then(|guard| guard.clone())
}
/// Snapshot inbound dispatcher counters.
#[must_use]
pub fn dispatch_stats(&self) -> GossipDispatchStatsSnapshot {
self.dispatch_stats.snapshot()
}
/// Start the gossip runtime.
///
/// This initializes all gossip components and begins protocol operations.
///
/// # Errors
///
/// Returns an error if initialization fails.
pub async fn start(&self) -> NetworkResult<()> {
let network = Arc::clone(&self.network);
let membership = Arc::clone(&self.membership);
let pubsub = Arc::clone(&self.pubsub);
let presence = self.presence();
let dispatch_stats = Arc::clone(&self.dispatch_stats);
let handle = tokio::spawn(async move {
loop {
match saorsa_gossip_transport::GossipTransport::receive_message(network.as_ref())
.await
{
Ok((peer, stream_type, data)) => {
let (recv_depth, recv_capacity) = network.gossip_recv_queue_depth();
dispatch_stats.record_dequeue(recv_depth, recv_capacity);
match stream_type {
GossipStreamType::PubSub => {
dispatch_stats.pubsub.record_received();
let bytes = data.len();
let started = Instant::now();
tracing::debug!(
from = %peer,
bytes,
recv_depth,
recv_capacity,
stream_type = "PubSub",
"[2/6 runtime] dispatching gossip message"
);
match tokio::time::timeout(
PUBSUB_MESSAGE_HANDLE_TIMEOUT,
pubsub.handle_incoming(peer, data),
)
.await
{
Ok(()) => {
let elapsed = started.elapsed();
dispatch_stats.pubsub.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "PubSub",
"[2/6 runtime] completed gossip message dispatch"
);
}
Err(_) => {
let elapsed = started.elapsed();
dispatch_stats.pubsub.record_timed_out(elapsed);
tracing::warn!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
timeout_secs = PUBSUB_MESSAGE_HANDLE_TIMEOUT.as_secs(),
stream_type = "PubSub",
"Timed out handling gossip message"
);
}
}
}
GossipStreamType::Membership => {
dispatch_stats.membership.record_received();
let bytes = data.len();
let started = Instant::now();
tracing::debug!(
from = %peer,
bytes,
recv_depth,
recv_capacity,
stream_type = "Membership",
"[2/6 runtime] dispatching gossip message"
);
match tokio::time::timeout(
MEMBERSHIP_MESSAGE_HANDLE_TIMEOUT,
membership.dispatch_message(peer, &data),
)
.await
{
Ok(Ok(())) => {
let elapsed = started.elapsed();
dispatch_stats.membership.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Membership",
"[2/6 runtime] completed gossip message dispatch"
);
}
Ok(Err(e)) => {
let elapsed = started.elapsed();
dispatch_stats.membership.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Membership",
"Failed to handle membership message: {e}"
);
}
Err(_) => {
let elapsed = started.elapsed();
dispatch_stats.membership.record_timed_out(elapsed);
tracing::warn!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
timeout_secs = MEMBERSHIP_MESSAGE_HANDLE_TIMEOUT.as_secs(),
stream_type = "Membership",
"Timed out handling gossip message"
);
}
}
}
GossipStreamType::Bulk => {
dispatch_stats.bulk.record_received();
let bytes = data.len();
let started = Instant::now();
tracing::debug!(
from = %peer,
bytes,
recv_depth,
recv_capacity,
stream_type = "Bulk",
"[2/6 runtime] dispatching gossip message"
);
if let Some(ref pm) = presence {
match tokio::time::timeout(
PRESENCE_MESSAGE_HANDLE_TIMEOUT,
pm.manager().handle_presence_message(&data),
)
.await
{
Ok(Ok(Some(source))) => {
let elapsed = started.elapsed();
dispatch_stats.bulk.record_completed(elapsed);
tracing::debug!(
from = %source,
peer = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Bulk",
"Handled presence beacon"
);
}
Ok(Ok(None)) => {
let elapsed = started.elapsed();
dispatch_stats.bulk.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Bulk",
"Presence message processed (no source)"
);
}
Ok(Err(e)) => {
let elapsed = started.elapsed();
dispatch_stats.bulk.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Bulk",
"Failed to handle presence message: {e}"
);
}
Err(_) => {
let elapsed = started.elapsed();
dispatch_stats.bulk.record_timed_out(elapsed);
tracing::warn!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
timeout_secs = PRESENCE_MESSAGE_HANDLE_TIMEOUT.as_secs(),
stream_type = "Bulk",
"Timed out handling gossip message"
);
}
}
} else {
let elapsed = started.elapsed();
dispatch_stats.bulk.record_completed(elapsed);
tracing::debug!(
from = %peer,
bytes,
elapsed_ms = duration_ms(elapsed),
stream_type = "Bulk",
"Ignoring Bulk stream (presence not configured)"
);
}
}
}
}
Err(e) => {
tracing::error!("Message receive failed: {}", e);
break;
}
}
}
tracing::info!("Gossip message dispatcher shut down");
});
// Periodically refresh PlumTree topic peers with current connections.
// This ensures newly connected peers (discovered via HyParView or
// direct connection) are added to the eager set for existing topics.
// Using 1-second interval to minimize the window where a newly-connected
// peer could miss a published message (e.g. release manifest broadcast).
let pubsub_refresh = Arc::clone(&self.pubsub);
let peer_sync_handle = tokio::spawn(async move {
loop {
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
pubsub_refresh.refresh_topic_peers().await;
}
});
if let Ok(mut guard) = self.peer_sync_handle.lock() {
*guard = Some(peer_sync_handle);
}
// Keepalive: send a SWIM Ping to every connected peer every 15 seconds.
// This prevents QUIC idle timeout (30s) from dropping direct connections
// that were established via auto-connect. Without this, connections with
// no application traffic are closed by QUIC after 30s of inactivity.
// See ADR-0002 for rationale.
let keepalive_membership = Arc::clone(&self.membership);
let keepalive_network = Arc::clone(&self.network);
let keepalive_handle = tokio::spawn(async move {
loop {
tokio::time::sleep(std::time::Duration::from_secs(15)).await;
let peers = keepalive_network.connected_peers().await;
for peer in peers {
let gossip_peer = PeerId::new(peer.0);
if let Err(e) = keepalive_membership.send_ping(gossip_peer).await {
tracing::debug!(
peer = %gossip_peer,
"Keepalive ping failed: {e}"
);
}
}
}
});
if let Ok(mut guard) = self.keepalive_handle.lock() {
*guard = Some(keepalive_handle);
}
match self.dispatcher_handle.lock() {
Ok(mut guard) => *guard = Some(handle),
Err(_) => {
return Err(crate::error::NetworkError::NodeCreation(
"dispatcher handle lock poisoned".into(),
));
}
}
Ok(())
}
/// Shutdown the gossip runtime.
///
/// This gracefully stops all gossip components and cleans up resources.
///
/// # Errors
///
/// Returns an error if shutdown fails.
pub async fn shutdown(&self) -> NetworkResult<()> {
if let Ok(mut guard) = self.keepalive_handle.lock() {
if let Some(handle) = guard.take() {
handle.abort();
}
}
if let Ok(mut guard) = self.peer_sync_handle.lock() {
if let Some(handle) = guard.take() {
handle.abort();
}
}
if let Ok(mut guard) = self.dispatcher_handle.lock() {
if let Some(handle) = guard.take() {
handle.abort();
}
}
Ok(())
}
/// Get the runtime configuration.
#[must_use]
pub fn config(&self) -> &GossipConfig {
&self.config
}
/// Get the network node.
#[must_use]
pub fn network(&self) -> &Arc<NetworkNode> {
&self.network
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::network::NetworkConfig;
#[tokio::test]
async fn test_runtime_creation() {
let config = GossipConfig::default();
let network = NetworkNode::new(NetworkConfig::default(), None, None)
.await
.expect("Failed to create network");
let runtime = GossipRuntime::new(config, Arc::new(network), None)
.await
.expect("Failed to create runtime");
assert_eq!(
runtime.config().active_view_size,
GossipConfig::default().active_view_size
);
}
#[tokio::test]
async fn test_runtime_start_stop() {
let config = GossipConfig::default();
let network = NetworkNode::new(NetworkConfig::default(), None, None)
.await
.expect("Failed to create network");
let runtime = GossipRuntime::new(config, Arc::new(network), None)
.await
.expect("Failed to create runtime");
assert!(runtime.start().await.is_ok());
assert!(runtime.shutdown().await.is_ok());
}
#[tokio::test]
async fn test_runtime_accessors() {
let config = GossipConfig::default();
let network = NetworkNode::new(NetworkConfig::default(), None, None)
.await
.expect("Failed to create network");
let network_arc = Arc::new(network);
let runtime = GossipRuntime::new(config.clone(), network_arc.clone(), None)
.await
.expect("Failed to create runtime");
assert_eq!(runtime.config().active_view_size, config.active_view_size);
assert!(Arc::ptr_eq(runtime.network(), &network_arc));
}
#[tokio::test]
async fn test_runtime_peer_id() {
let config = GossipConfig::default();
let network = NetworkNode::new(NetworkConfig::default(), None, None)
.await
.expect("Failed to create network");
let network_arc = Arc::new(network);
let expected_peer_id =
saorsa_gossip_transport::GossipTransport::local_peer_id(network_arc.as_ref());
let runtime = GossipRuntime::new(config, network_arc, None)
.await
.expect("Failed to create runtime");
assert_eq!(runtime.peer_id(), expected_peer_id);
}
#[tokio::test]
async fn test_runtime_invalid_config() {
let config = GossipConfig {
active_view_size: 0,
..Default::default()
};
let network = NetworkNode::new(NetworkConfig::default(), None, None)
.await
.expect("Failed to create network");
let result = GossipRuntime::new(config, Arc::new(network), None).await;
assert!(result.is_err());
}
}