commy 0.4.1

A hierarchical, multi-tenant shared memory coordination system for Windows enabling secure, efficient data sharing between multiple processes via WebSocket and direct memory-mapping
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
//! Client liveness detection system for COMMY
//!
//! Monitors client connections for:
//! - Connection drops (WSS disconnect)
//! - Queue stalls (outbound message queue not draining)
//! - Heartbeat timeouts

use crate::protocol::{ClientSession, ClientState, ClientSessionId};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::RwLock;
use thiserror::Error;
use chrono::{DateTime, Utc, Duration};

/// Errors that can occur in liveness detection
#[derive(Error, Debug)]
pub enum LivenessError {
    #[error("Client not found: {0}")]
    ClientNotFound(String),

    #[error("Client is dead: {0}")]
    ClientDead(String),

    #[error("Queue stalled for client: {0}")]
    QueueStalled(String),
}

pub type LivenessResult<T> = Result<T, LivenessError>;

/// Liveness detection configuration
#[derive(Clone, Debug)]
pub struct LivenessConfig {
    /// Heartbeat interval in seconds
    pub heartbeat_interval_secs: u64,
    /// Heartbeat timeout in seconds
    pub heartbeat_timeout_secs: u64,
    /// Queue stall threshold in seconds (30s recommended)
    pub queue_stall_threshold_secs: u64,
    /// Check interval in seconds (background task)
    pub check_interval_secs: u64,
}

impl Default for LivenessConfig {
    fn default() -> Self {
        Self {
            heartbeat_interval_secs: 30,
            heartbeat_timeout_secs: 60,
            queue_stall_threshold_secs: 30,
            check_interval_secs: 5,
        }
    }
}

/// Client liveness monitor
/// 
/// Tracks client connection health and detects:
/// 1. Connection drops (WSS disconnect)
/// 2. Queue stalls (outbound queue not draining)
/// 3. Heartbeat timeouts (no response in time)
pub struct LivenessMonitor {
    /// Active client sessions
    sessions: Arc<RwLock<HashMap<ClientSessionId, ClientSession>>>,
    /// Dead clients (for honeypot detection)
    dead_clients: Arc<RwLock<HashMap<ClientSessionId, DeadClientInfo>>>,
    /// Configuration
    config: LivenessConfig,
}

/// Information about a dead/revoked client
#[derive(Clone, Debug)]
pub struct DeadClientInfo {
    /// Session ID
    pub session_id: ClientSessionId,
    /// When the client was marked dead
    pub death_time: DateTime<Utc>,
    /// Reason for death
    pub reason: String,
}

impl LivenessMonitor {
    /// Create a new liveness monitor
    pub fn new(config: LivenessConfig) -> Self {
        Self {
            sessions: Arc::new(RwLock::new(HashMap::new())),
            dead_clients: Arc::new(RwLock::new(HashMap::new())),
            config,
        }
    }

    /// Register a new client session
    pub async fn register_client(&self, session: ClientSession) -> LivenessResult<String> {
        let session_id = session.session_id.clone();
        let mut sessions = self.sessions.write().await;
        sessions.insert(session_id.clone(), session);
        Ok(session_id)
    }

    /// Update client activity (heartbeat, message, etc.)
    pub async fn update_activity(&self, session_id: &str) -> LivenessResult<()> {
        let mut sessions = self.sessions.write().await;
        if let Some(session) = sessions.get_mut(session_id) {
            session.last_activity = Utc::now();
            Ok(())
        } else {
            Err(LivenessError::ClientNotFound(session_id.to_string()))
        }
    }

    /// Record heartbeat acknowledgment
    pub async fn record_heartbeat_ack(&self, session_id: &str) -> LivenessResult<()> {
        let mut sessions = self.sessions.write().await;
        if let Some(session) = sessions.get_mut(session_id) {
            session.last_heartbeat_ack = Some(Utc::now());
            session.outbound_queue_size = 0; // Queue drained
            Ok(())
        } else {
            Err(LivenessError::ClientNotFound(session_id.to_string()))
        }
    }

    /// Update outbound queue size for stall detection
    pub async fn update_queue_size(&self, session_id: &str, size: usize) -> LivenessResult<()> {
        let mut sessions = self.sessions.write().await;
        if let Some(session) = sessions.get_mut(session_id) {
            session.outbound_queue_size = size;
            Ok(())
        } else {
            Err(LivenessError::ClientNotFound(session_id.to_string()))
        }
    }

    /// Check if a client is alive
    pub async fn is_client_alive(&self, session_id: &str) -> LivenessResult<bool> {
        let sessions = self.sessions.read().await;
        if let Some(session) = sessions.get(session_id) {
            Ok(session.state != ClientState::Disconnected && 
               session.is_healthy(self.config.queue_stall_threshold_secs))
        } else {
            Err(LivenessError::ClientNotFound(session_id.to_string()))
        }
    }

    /// Mark a client as dead and move to dead clients map
    pub async fn mark_client_dead(&self, session_id: &str, reason: String) -> LivenessResult<()> {
        let mut sessions = self.sessions.write().await;
        if let Some(mut session) = sessions.remove(session_id) {
            session.state = ClientState::Disconnected;

            let dead_info = DeadClientInfo {
                session_id: session_id.to_string(),
                death_time: Utc::now(),
                reason,
            };

            let mut dead = self.dead_clients.write().await;
            dead.insert(session_id.to_string(), dead_info);
            Ok(())
        } else {
            Err(LivenessError::ClientNotFound(session_id.to_string()))
        }
    }

    /// Detect dead clients (connection drop or queue stall)
    /// 
    /// Returns list of dead session IDs
    pub async fn detect_dead_clients(&self) -> Vec<(String, String)> {
        let mut dead_list = Vec::new();
        let mut sessions = self.sessions.write().await;

        let now = Utc::now();
        let heartbeat_timeout = Duration::seconds(self.config.heartbeat_timeout_secs as i64);

        // Check each client
        let dead_sessions: Vec<(String, String)> = sessions
            .iter()
            .filter_map(|(id, session)| {
                // Check 1: Queue stall - queue growing without heartbeat ack in threshold time
                if session.outbound_queue_size > 0 {
                    if let Some(last_ack) = session.last_heartbeat_ack {
                        let elapsed = now - last_ack;
                        if elapsed > Duration::seconds(self.config.queue_stall_threshold_secs as i64) {
                            return Some((
                                id.clone(),
                                format!("Queue stalled for {} seconds", elapsed.num_seconds()),
                            ));
                        }
                    }
                }

                // Check 2: Heartbeat timeout - no ack within timeout
                if session.state == ClientState::HeartbeatPending {
                    if let Some(last_ack) = session.last_heartbeat_ack {
                        if (now - last_ack) > heartbeat_timeout {
                            return Some((
                                id.clone(),
                                "Heartbeat timeout".to_string(),
                            ));
                        }
                    }
                }

                // Check 3: Inactivity timeout - no activity in 2x heartbeat interval
                let inactivity_timeout = Duration::seconds(
                    (self.config.heartbeat_interval_secs * 2) as i64
                );
                if (now - session.last_activity) > inactivity_timeout {
                    return Some((
                        id.clone(),
                        "Inactivity timeout".to_string(),
                    ));
                }

                None
            })
            .collect();

        // Remove dead clients
        for (session_id, reason) in dead_sessions {
            sessions.remove(&session_id);
            let dead_info = DeadClientInfo {
                session_id: session_id.clone(),
                death_time: Utc::now(),
                reason: reason.clone(),
            };
            dead_list.push((session_id, reason));

            let mut dead = self.dead_clients.write().await;
            dead.insert(dead_info.session_id.clone(), dead_info);
        }

        dead_list
    }

    /// Get all active client sessions
    pub async fn get_active_clients(&self) -> Vec<ClientSession> {
        let sessions = self.sessions.read().await;
        sessions.values().cloned().collect()
    }

    /// Get client session by ID
    pub async fn get_client(&self, session_id: &str) -> LivenessResult<ClientSession> {
        let sessions = self.sessions.read().await;
        sessions
            .get(session_id)
            .cloned()
            .ok_or_else(|| LivenessError::ClientNotFound(session_id.to_string()))
    }

    /// Remove a client (cleanup after revocation)
    pub async fn remove_client(&self, session_id: &str) -> LivenessResult<()> {
        let mut sessions = self.sessions.write().await;
        sessions.remove(session_id);
        Ok(())
    }

    /// Clean up honeypot dead clients older than threshold
    pub async fn cleanup_dead_clients(&self, max_age_secs: u64) {
        let mut dead = self.dead_clients.write().await;
        let now = Utc::now();
        let max_age = Duration::seconds(max_age_secs as i64);

        dead.retain(|_, info| (now - info.death_time) < max_age);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_register_and_get_client() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        let retrieved = monitor.get_client(&session_id).await.unwrap();

        assert_eq!(retrieved.session_id, session_id);
        assert_eq!(retrieved.state, ClientState::Unauthenticated);
    }

    #[tokio::test]
    async fn test_update_activity() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        let old_time = monitor.get_client(&session_id).await.unwrap().last_activity;

        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;
        monitor.update_activity(&session_id).await.unwrap();

        let new_session = monitor.get_client(&session_id).await.unwrap();
        assert!(new_session.last_activity > old_time);
    }

    #[tokio::test]
    async fn test_detect_dead_clients() {
        let mut config = LivenessConfig::default();
        config.heartbeat_timeout_secs = 1;
        config.queue_stall_threshold_secs = 1;

        let monitor = LivenessMonitor::new(config);
        let mut session = ClientSession::new();
        let session_id = session.session_id.clone();

        // Simulate old last activity
        session.last_activity = Utc::now() - Duration::seconds(100);
        monitor.register_client(session).await.unwrap();

        let dead = monitor.detect_dead_clients().await;
        assert!(!dead.is_empty());
        assert_eq!(dead[0].0, session_id);
    }

    #[tokio::test]
    async fn test_heartbeat_ack() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor.record_heartbeat_ack(&session_id).await.unwrap();

        let updated = monitor.get_client(&session_id).await.unwrap();
        assert!(updated.last_heartbeat_ack.is_some());
        assert_eq!(updated.outbound_queue_size, 0);
    }

    #[tokio::test]
    async fn test_queue_stall_detection() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor.update_queue_size(&session_id, 10).await.unwrap();

        // Without heartbeat ack, should be considered unhealthy
        let client = monitor.get_client(&session_id).await.unwrap();
        assert!(!client.is_healthy(30));
    }

    #[tokio::test]
    async fn test_update_queue_size() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor.update_queue_size(&session_id, 42).await.unwrap();

        let client = monitor.get_client(&session_id).await.unwrap();
        assert_eq!(client.outbound_queue_size, 42);
    }

    #[tokio::test]
    async fn test_update_queue_size_unknown_client_returns_error() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let result = monitor.update_queue_size("ghost", 5).await;
        assert!(matches!(result, Err(LivenessError::ClientNotFound(_))));
    }

    #[tokio::test]
    async fn test_is_client_alive_returns_true_for_healthy_client() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        let alive = monitor.is_client_alive(&session_id).await.unwrap();
        assert!(alive);
    }

    #[tokio::test]
    async fn test_is_client_alive_unknown_client_returns_error() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let result = monitor.is_client_alive("ghost").await;
        assert!(matches!(result, Err(LivenessError::ClientNotFound(_))));
    }

    #[tokio::test]
    async fn test_mark_client_dead_removes_from_active() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor
            .mark_client_dead(&session_id, "test reason".to_string())
            .await
            .unwrap();

        // Should no longer be in active clients
        let result = monitor.get_client(&session_id).await;
        assert!(matches!(result, Err(LivenessError::ClientNotFound(_))));
    }

    #[tokio::test]
    async fn test_mark_client_dead_unknown_returns_error() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let result = monitor.mark_client_dead("ghost", "reason".to_string()).await;
        assert!(matches!(result, Err(LivenessError::ClientNotFound(_))));
    }

    #[tokio::test]
    async fn test_get_active_clients_returns_all() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let s1 = ClientSession::new();
        let s2 = ClientSession::new();

        monitor.register_client(s1).await.unwrap();
        monitor.register_client(s2).await.unwrap();

        let active = monitor.get_active_clients().await;
        assert_eq!(active.len(), 2);
    }

    #[tokio::test]
    async fn test_remove_client_cleans_up() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor.remove_client(&session_id).await.unwrap();

        let active = monitor.get_active_clients().await;
        assert!(active.is_empty());
    }

    #[tokio::test]
    async fn test_cleanup_dead_clients_removes_old_entries() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let session = ClientSession::new();
        let session_id = session.session_id.clone();

        monitor.register_client(session).await.unwrap();
        monitor
            .mark_client_dead(&session_id, "test".to_string())
            .await
            .unwrap();

        // max_age_secs = 0 should remove the entry immediately
        monitor.cleanup_dead_clients(0).await;
        // Verify no panic. Dead clients map is internal; just confirm method runs.
    }

    #[tokio::test]
    async fn test_update_activity_unknown_client_returns_error() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let result = monitor.update_activity("ghost").await;
        assert!(matches!(result, Err(LivenessError::ClientNotFound(_))));
    }

    #[tokio::test]
    async fn test_is_client_alive_disconnected_session_returns_false() {
        let monitor = LivenessMonitor::new(LivenessConfig::default());
        let mut session = ClientSession::new();
        let session_id = session.session_id.clone();
        // Explicitly set state to Disconnected before registering
        session.state = ClientState::Disconnected;
        monitor.register_client(session).await.unwrap();

        let result = monitor.is_client_alive(&session_id).await.unwrap();
        assert!(
            !result,
            "A session with state=Disconnected must be reported as not alive"
        );
    }
}