pushwire-server 0.1.1

Generic multiplexed push server with WebSocket and SSE transports
Documentation
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
use std::time::{Duration, Instant};

use dashmap::DashMap;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use thiserror::Error;
use uuid::Uuid;

/// Active transport path for a peer.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TransportMode {
    /// All traffic flows through the server-managed RPS socket.
    Direct,
    /// Peer-to-peer data channel is available.
    P2p,
    /// RPS relay is used as fallback for peer traffic.
    Relay,
}

/// Why a mode change was initiated.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ModeSwitchReason {
    Requested,
    PathDegraded,
    PathRecovered,
    OperatorOverride,
}

#[derive(Debug, Clone)]
struct ModeState {
    mode: TransportMode,
    generation: u64,
    updated_at: Instant,
    last_failure: Option<Instant>,
    health: PathHealth,
    last_cursors: HashMap<String, u64>,
}

#[derive(Debug, Clone)]
struct PathHealth {
    consecutive_failures: u32,
    backoff_until: Option<Instant>,
}

impl PathHealth {
    fn new() -> Self {
        Self {
            consecutive_failures: 0,
            backoff_until: None,
        }
    }
}

/// Thresholds for failover and retry behavior.
#[derive(Debug, Clone, Copy)]
pub struct FailoverPolicy {
    /// Number of consecutive P2P failures before switching to relay.
    pub failure_threshold: u32,
    /// How long to wait before attempting to recover back to P2P.
    pub retry_backoff: Duration,
}

impl Default for FailoverPolicy {
    fn default() -> Self {
        Self {
            failure_threshold: 3,
            retry_backoff: Duration::from_secs(10),
        }
    }
}

/// Signal emitted to clients when transport mode changes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ModeSwitchSignal {
    pub peer_id: Uuid,
    pub mode: TransportMode,
    pub previous_mode: TransportMode,
    pub reason: ModeSwitchReason,
    pub generation: u64,
}

/// Packet that needs to be routed to a peer.
#[derive(Debug, Clone)]
pub struct TransportPacket {
    pub channel: String,
    pub cursor: Option<u64>,
    pub payload: serde_json::Value,
}

impl TransportPacket {
    pub fn new(channel: impl Into<String>, payload: serde_json::Value) -> Self {
        Self {
            channel: channel.into(),
            cursor: None,
            payload,
        }
    }

    pub fn with_cursor(mut self, cursor: u64) -> Self {
        self.cursor = Some(cursor);
        self
    }
}

/// How the packet was ultimately routed.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TransportRoute {
    Direct,
    P2p,
    Relay,
}

/// Result of a single routing operation.
#[derive(Debug, Clone)]
pub struct RouteOutcome {
    pub route: TransportRoute,
    pub active_mode: TransportMode,
    pub switch: Option<ModeSwitchSignal>,
    pub delivered: bool,
}

/// Errors that can occur while routing.
#[derive(Debug, Error, PartialEq, Eq)]
pub enum TransportError {
    #[error("path unavailable: {0}")]
    PathUnavailable(&'static str),
    #[error("dispatch failed: {0}")]
    DispatchFailed(&'static str),
    #[error("rate limited: {0}")]
    RateLimited(&'static str),
}

/// Trait that abstracts the actual transport sinks.
pub trait TransportDispatcher: Send + Sync {
    fn send_direct(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError>;
    fn send_p2p(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError>;
    fn send_relay(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError>;
}

/// Keeps track of transport mode per peer and routes packets across the best available path.
pub struct TransportManager {
    modes: DashMap<Uuid, ModeState>,
    policy: FailoverPolicy,
}

impl Default for TransportManager {
    fn default() -> Self {
        Self::new()
    }
}

impl TransportManager {
    pub fn new() -> Self {
        Self {
            modes: DashMap::new(),
            policy: FailoverPolicy::default(),
        }
    }

    pub fn with_policy(policy: FailoverPolicy) -> Self {
        Self {
            modes: DashMap::new(),
            policy,
        }
    }

    /// Returns the active mode for the peer (defaults to Direct).
    pub fn mode_for(&self, peer: Uuid) -> TransportMode {
        self.modes
            .get(&peer)
            .map(|s| s.mode)
            .unwrap_or(TransportMode::Direct)
    }

    /// Forces a mode change and returns a signal to broadcast, if the mode actually changed.
    pub fn switch_mode(
        &self,
        peer: Uuid,
        new_mode: TransportMode,
        reason: ModeSwitchReason,
    ) -> Option<ModeSwitchSignal> {
        let mut state = self.ensure_state(peer);
        if state.mode == new_mode {
            return None;
        }

        let previous_mode = state.mode;
        state.mode = new_mode;
        state.generation += 1;
        state.updated_at = Instant::now();

        Some(ModeSwitchSignal {
            peer_id: peer,
            mode: new_mode,
            previous_mode,
            reason,
            generation: state.generation,
        })
    }

    /// Route a packet according to the current transport mode. If P2P is unavailable,
    /// the packet is transparently retried via relay and a mode switch signal is returned.
    pub fn route<D: TransportDispatcher>(
        &self,
        peer: Uuid,
        packet: TransportPacket,
        dispatcher: &D,
    ) -> Result<RouteOutcome, TransportError> {
        if self.is_duplicate(peer, &packet) {
            let mode = self.mode_for(peer);
            return Ok(RouteOutcome {
                route: match mode {
                    TransportMode::Direct => TransportRoute::Direct,
                    TransportMode::P2p => TransportRoute::P2p,
                    TransportMode::Relay => TransportRoute::Relay,
                },
                active_mode: mode,
                switch: None,
                delivered: false,
            });
        }

        let mode = self.mode_for(peer);
        match mode {
            TransportMode::Direct => {
                let record = packet.clone();
                dispatcher.send_direct(peer, packet)?;
                self.record_cursor(peer, &record);
                Ok(RouteOutcome {
                    route: TransportRoute::Direct,
                    active_mode: TransportMode::Direct,
                    switch: None,
                    delivered: true,
                })
            }
            TransportMode::Relay => {
                let record = packet.clone();
                dispatcher.send_relay(peer, packet)?;
                self.record_cursor(peer, &record);
                Ok(RouteOutcome {
                    route: TransportRoute::Relay,
                    active_mode: TransportMode::Relay,
                    switch: None,
                    delivered: true,
                })
            }
            TransportMode::P2p => match dispatcher.send_p2p(peer, packet.clone()) {
                Ok(_) => {
                    self.reset_failures(peer);
                    self.record_cursor(peer, &packet);
                    Ok(RouteOutcome {
                        route: TransportRoute::P2p,
                        active_mode: TransportMode::P2p,
                        switch: None,
                        delivered: true,
                    })
                }
                Err(TransportError::PathUnavailable(_)) => {
                    let switch = self.mark_failure_and_maybe_downgrade(peer);
                    let record = packet.clone();
                    dispatcher.send_relay(peer, packet)?;
                    self.record_cursor(peer, &record);
                    Ok(RouteOutcome {
                        route: TransportRoute::Relay,
                        active_mode: TransportMode::Relay,
                        switch,
                        delivered: true,
                    })
                }
                Err(err) => Err(err),
            },
        }
    }

    /// Attempt a background recovery back to P2P when backoff has elapsed.
    pub fn maybe_retry_p2p(&self, peer: Uuid) -> Option<ModeSwitchSignal> {
        let mut state = self.ensure_state(peer);
        if state.mode != TransportMode::Relay {
            return None;
        }

        let now = Instant::now();
        let ready = state
            .health
            .backoff_until
            .map(|until| now >= until)
            .unwrap_or(false);

        if !ready {
            return None;
        }

        state.health.backoff_until = None;
        state.health.consecutive_failures = 0;

        let previous_mode = state.mode;
        state.mode = TransportMode::P2p;
        state.generation += 1;
        state.updated_at = now;

        Some(ModeSwitchSignal {
            peer_id: peer,
            mode: TransportMode::P2p,
            previous_mode,
            reason: ModeSwitchReason::PathRecovered,
            generation: state.generation,
        })
    }

    fn ensure_state(&self, peer: Uuid) -> dashmap::mapref::one::RefMut<'_, Uuid, ModeState> {
        self.modes.entry(peer).or_insert_with(|| ModeState {
            mode: TransportMode::Direct,
            generation: 0,
            updated_at: Instant::now(),
            last_failure: None,
            health: PathHealth::new(),
            last_cursors: HashMap::new(),
        })
    }

    fn mark_failure_and_maybe_downgrade(&self, peer: Uuid) -> Option<ModeSwitchSignal> {
        let mut state = self.ensure_state(peer);
        let now = Instant::now();
        state.last_failure = Some(now);
        state.health.consecutive_failures = state.health.consecutive_failures.saturating_add(1);

        if state.health.consecutive_failures < self.policy.failure_threshold {
            return None;
        }

        state.health.backoff_until = Some(now + self.policy.retry_backoff);
        Some(ModeSwitchSignal {
            peer_id: peer,
            mode: TransportMode::Relay,
            previous_mode: state.mode,
            reason: ModeSwitchReason::PathDegraded,
            generation: {
                state.mode = TransportMode::Relay;
                state.generation += 1;
                state.generation
            },
        })
    }

    fn reset_failures(&self, peer: Uuid) {
        if let Some(mut state) = self.modes.get_mut(&peer) {
            state.health.consecutive_failures = 0;
            state.health.backoff_until = None;
        }
    }

    fn is_duplicate(&self, peer: Uuid, packet: &TransportPacket) -> bool {
        let Some(cursor) = packet.cursor else {
            return false;
        };
        let state = self.ensure_state(peer);
        if let Some(last) = state.last_cursors.get(&packet.channel) {
            return cursor <= *last;
        }
        false
    }

    fn record_cursor(&self, peer: Uuid, packet: &TransportPacket) {
        let Some(cursor) = packet.cursor else {
            return;
        };
        if let Some(mut state) = self.modes.get_mut(&peer) {
            state.last_cursors.insert(packet.channel.clone(), cursor);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;
    use std::sync::Mutex;

    #[derive(Default)]
    struct MockDispatcher {
        fail_p2p: Mutex<bool>,
        calls: Mutex<Vec<(TransportRoute, Uuid, TransportPacket)>>,
    }

    impl MockDispatcher {
        fn with_p2p_failure() -> Self {
            Self {
                fail_p2p: Mutex::new(true),
                calls: Mutex::new(Vec::new()),
            }
        }

        fn allow_p2p(&self) {
            *self.fail_p2p.lock().unwrap() = false;
        }

        fn calls(&self) -> Vec<(TransportRoute, Uuid, TransportPacket)> {
            self.calls.lock().unwrap().clone()
        }
    }

    impl TransportDispatcher for MockDispatcher {
        fn send_direct(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError> {
            self.calls
                .lock()
                .unwrap()
                .push((TransportRoute::Direct, peer, packet));
            Ok(())
        }

        fn send_p2p(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError> {
            if *self.fail_p2p.lock().unwrap() {
                return Err(TransportError::PathUnavailable("p2p unavailable"));
            }

            self.calls
                .lock()
                .unwrap()
                .push((TransportRoute::P2p, peer, packet));
            Ok(())
        }

        fn send_relay(&self, peer: Uuid, packet: TransportPacket) -> Result<(), TransportError> {
            self.calls
                .lock()
                .unwrap()
                .push((TransportRoute::Relay, peer, packet));
            Ok(())
        }
    }

    #[test]
    fn tracks_modes_and_generations() {
        let manager = TransportManager::new();
        let peer = Uuid::new_v4();

        assert_eq!(manager.mode_for(peer), TransportMode::Direct);

        let switch = manager
            .switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested)
            .unwrap();
        assert_eq!(switch.previous_mode, TransportMode::Direct);
        assert_eq!(switch.mode, TransportMode::P2p);
        assert_eq!(switch.generation, 1);

        assert!(
            manager
                .switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested)
                .is_none()
        );

        let switch = manager
            .switch_mode(peer, TransportMode::Relay, ModeSwitchReason::PathDegraded)
            .unwrap();
        assert_eq!(switch.generation, 2);
        assert_eq!(manager.mode_for(peer), TransportMode::Relay);
    }

    #[test]
    fn routes_using_current_mode() {
        let manager = TransportManager::new();
        let dispatcher = MockDispatcher::default();
        dispatcher.allow_p2p();

        let peer = Uuid::new_v4();
        let _ = manager.switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested);
        let packet = TransportPacket::new("presence", json!({ "message": "hi" }));

        let outcome = manager.route(peer, packet, &dispatcher).unwrap();
        assert_eq!(outcome.route, TransportRoute::P2p);
        assert_eq!(outcome.active_mode, TransportMode::P2p);
        assert!(outcome.delivered);
        assert!(outcome.switch.is_none());

        let calls = dispatcher.calls();
        assert_eq!(calls.len(), 1);
        assert_eq!(calls[0].0, TransportRoute::P2p);
        assert_eq!(calls[0].2.channel, "presence");
    }

    #[test]
    fn falls_back_to_relay_on_p2p_failure() {
        let manager = TransportManager::with_policy(FailoverPolicy {
            failure_threshold: 1,
            retry_backoff: Duration::from_secs(1),
        });
        let dispatcher = MockDispatcher::with_p2p_failure();
        let peer = Uuid::new_v4();
        let _ = manager.switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested);

        let packet = TransportPacket::new("data", json!({ "seq": 1 })).with_cursor(42);
        let outcome = manager.route(peer, packet, &dispatcher).unwrap();

        assert_eq!(outcome.route, TransportRoute::Relay);
        assert_eq!(outcome.active_mode, TransportMode::Relay);
        assert!(outcome.delivered);
        assert_eq!(
            manager.mode_for(peer),
            TransportMode::Relay,
            "mode should be downgraded after failure"
        );

        let switch = outcome.switch.expect("switch signal missing");
        assert_eq!(switch.reason, ModeSwitchReason::PathDegraded);
        assert_eq!(switch.previous_mode, TransportMode::P2p);
        assert_eq!(switch.mode, TransportMode::Relay);

        let calls = dispatcher.calls();
        assert_eq!(calls.len(), 1, "relay should get the retried packet");
        assert_eq!(calls[0].0, TransportRoute::Relay);
        assert_eq!(calls[0].2.cursor, Some(42));
        assert_eq!(calls[0].2.channel, "data");
    }

    #[test]
    fn respects_failure_threshold_and_backoff() {
        let manager = TransportManager::with_policy(FailoverPolicy {
            failure_threshold: 3,
            retry_backoff: Duration::from_secs(5),
        });
        let dispatcher = MockDispatcher::with_p2p_failure();
        let peer = Uuid::new_v4();
        let _ = manager.switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested);

        for _ in 0..(manager.policy.failure_threshold - 1) {
            let packet = TransportPacket::new("data", json!({ "seq": 1 }));
            let outcome = manager.route(peer, packet, &dispatcher).unwrap();
            assert!(outcome.switch.is_none(), "should not downgrade yet");
        }

        let packet = TransportPacket::new("data", json!({ "seq": 2 }));
        let outcome = manager.route(peer, packet, &dispatcher).unwrap();
        assert_eq!(outcome.active_mode, TransportMode::Relay);
        assert!(outcome.delivered);
        assert!(manager.mode_for(peer) == TransportMode::Relay);

        // Backoff not elapsed -> no retry.
        assert!(manager.maybe_retry_p2p(peer).is_none());
    }

    #[test]
    fn retries_after_backoff() {
        let manager = TransportManager::with_policy(FailoverPolicy {
            failure_threshold: 1,
            retry_backoff: Duration::from_millis(0),
        });
        let dispatcher = MockDispatcher::with_p2p_failure();
        let peer = Uuid::new_v4();
        let _ = manager.switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested);

        // Force downgrade.
        for _ in 0..manager.policy.failure_threshold {
            let packet = TransportPacket::new("data", json!({ "seq": 1 }));
            let _ = manager.route(peer, packet.clone(), &dispatcher).unwrap();
        }

        // Manually expire backoff.
        if let Some(mut state) = manager.modes.get_mut(&peer) {
            state.health.backoff_until = Some(Instant::now());
        }

        let switch = manager.maybe_retry_p2p(peer).expect("should retry");
        assert_eq!(switch.mode, TransportMode::P2p);
        assert_eq!(manager.mode_for(peer), TransportMode::P2p);
    }

    #[test]
    fn drops_duplicates_and_preserves_ordering() {
        let manager = TransportManager::with_policy(FailoverPolicy {
            failure_threshold: 1,
            retry_backoff: Duration::from_secs(1),
        });
        let dispatcher = MockDispatcher::default();
        dispatcher.allow_p2p();

        let peer = Uuid::new_v4();
        let _ = manager.switch_mode(peer, TransportMode::P2p, ModeSwitchReason::Requested);

        let packet1 = TransportPacket::new("data", json!({ "seq": 1 })).with_cursor(10);
        let outcome1 = manager.route(peer, packet1.clone(), &dispatcher).unwrap();
        assert!(outcome1.delivered);

        // Duplicate cursor should be dropped (no additional dispatch).
        let outcome_dup = manager.route(peer, packet1, &dispatcher).unwrap();
        assert!(!outcome_dup.delivered);

        let packet2 = TransportPacket::new("data", json!({ "seq": 2 })).with_cursor(11);
        let outcome2 = manager.route(peer, packet2, &dispatcher).unwrap();
        assert!(outcome2.delivered);

        let calls = dispatcher.calls();
        // Only two actual dispatches (cursor 10 and 11).
        assert_eq!(calls.len(), 2);
        assert_eq!(calls[0].2.cursor, Some(10));
        assert_eq!(calls[1].2.cursor, Some(11));
    }
}