heliosdb-proxy 0.4.1

HeliosProxy - Intelligent connection router and failover manager for HeliosDB and PostgreSQL
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
//! Circuit Breaker Manager
//!
//! Manages circuit breakers for multiple nodes with centralized configuration
//! and monitoring.

use std::sync::Arc;
use std::time::Duration;

use dashmap::DashMap;

use super::breaker::{CircuitBreaker, CircuitOpen, RequestGuard};
use super::config::{CircuitBreakerConfig, NodeOverride};
use super::metrics::{CircuitMetrics, CircuitStats};
use super::state::{CircuitBreakerListener, CircuitState};

/// Configuration for the circuit breaker manager
#[derive(Debug, Clone)]
pub struct ManagerConfig {
    /// Global default configuration
    pub default_config: CircuitBreakerConfig,

    /// Per-node configuration overrides
    pub node_overrides: Vec<NodeOverride>,

    /// Enable manager-level metrics collection
    pub metrics_enabled: bool,

    /// Auto-create breakers for unknown nodes
    pub auto_create: bool,
}

impl Default for ManagerConfig {
    fn default() -> Self {
        Self {
            default_config: CircuitBreakerConfig::default(),
            node_overrides: Vec::new(),
            metrics_enabled: true,
            auto_create: true,
        }
    }
}

impl ManagerConfig {
    /// Create a new manager config
    pub fn new(default_config: CircuitBreakerConfig) -> Self {
        Self {
            default_config,
            ..Default::default()
        }
    }

    /// Add a node override
    pub fn with_node_override(mut self, override_: NodeOverride) -> Self {
        self.node_overrides.push(override_);
        self
    }

    /// Enable or disable metrics
    pub fn with_metrics(mut self, enabled: bool) -> Self {
        self.metrics_enabled = enabled;
        self
    }

    /// Get effective config for a node
    pub fn get_node_config(&self, node_id: &str) -> CircuitBreakerConfig {
        for override_ in &self.node_overrides {
            if override_.node_id == node_id {
                return override_.apply_to(&self.default_config);
            }
        }
        self.default_config.clone()
    }
}

/// Circuit Breaker Manager
///
/// Manages multiple circuit breakers for different nodes, providing centralized
/// configuration, monitoring, and node health filtering.
pub struct CircuitBreakerManager {
    /// Circuit breakers per node
    breakers: DashMap<String, CircuitBreaker>,

    /// Configuration
    config: parking_lot::RwLock<ManagerConfig>,

    /// Shared listeners for all breakers
    shared_listeners: parking_lot::RwLock<Vec<Arc<dyn CircuitBreakerListener>>>,

    /// Metrics collector
    metrics: CircuitMetrics,
}

impl CircuitBreakerManager {
    /// Create a new circuit breaker manager
    pub fn new(config: ManagerConfig) -> Self {
        Self {
            breakers: DashMap::new(),
            config: parking_lot::RwLock::new(config),
            shared_listeners: parking_lot::RwLock::new(Vec::new()),
            metrics: CircuitMetrics::new(),
        }
    }

    /// Create with default configuration
    pub fn with_defaults() -> Self {
        Self::new(ManagerConfig::default())
    }

    /// Get or create a circuit breaker for a node
    pub fn get_breaker(&self, node_id: &str) -> CircuitBreaker {
        if let Some(breaker) = self.breakers.get(node_id) {
            return breaker.clone();
        }

        let config = self.config.read();
        if !config.auto_create {
            // Return a permissive breaker if auto-create disabled
            return CircuitBreaker::new(node_id, CircuitBreakerConfig::default());
        }

        let node_config = config.get_node_config(node_id);
        drop(config);

        let breaker = CircuitBreaker::new(node_id, node_config);

        // Add shared listeners
        let listeners = self.shared_listeners.read();
        for listener in listeners.iter() {
            breaker.add_listener(Arc::clone(listener));
        }

        self.breakers.insert(node_id.to_string(), breaker.clone());
        breaker
    }

    /// Try to allow a request to a specific node
    pub fn allow_request(&self, node_id: &str) -> Result<RequestGuard, CircuitOpen> {
        let breaker = self.get_breaker(node_id);
        let result = breaker.allow_request();

        // Record metrics
        let config = self.config.read();
        if config.metrics_enabled {
            drop(config);
            match &result {
                Ok(_) => self.metrics.record_allowed(node_id),
                Err(_) => self.metrics.record_rejected(node_id),
            }
        }

        result
    }

    /// Wrap a function with circuit breaker protection
    pub fn wrap_request<F, T, E>(&self, node_id: &str, f: F) -> Result<T, WrapError<E>>
    where
        F: FnOnce() -> Result<T, E>,
        E: std::fmt::Display,
    {
        let guard = self.allow_request(node_id).map_err(WrapError::CircuitOpen)?;

        match f() {
            Ok(result) => {
                guard.success();
                Ok(result)
            }
            Err(e) => {
                guard.failure(&e.to_string());
                Err(WrapError::Inner(e))
            }
        }
    }

    /// Async version of wrap_request
    pub async fn wrap_request_async<F, Fut, T, E>(
        &self,
        node_id: &str,
        f: F,
    ) -> Result<T, WrapError<E>>
    where
        F: FnOnce() -> Fut,
        Fut: std::future::Future<Output = Result<T, E>>,
        E: std::fmt::Display,
    {
        let guard = self.allow_request(node_id).map_err(WrapError::CircuitOpen)?;

        match f().await {
            Ok(result) => {
                guard.success();
                Ok(result)
            }
            Err(e) => {
                guard.failure(&e.to_string());
                Err(WrapError::Inner(e))
            }
        }
    }

    /// Get healthy nodes from a list (filters out nodes with open circuits)
    pub fn get_healthy_nodes<T: HasNodeId + Clone>(&self, nodes: &[T]) -> Vec<T> {
        nodes
            .iter()
            .filter(|node| {
                self.breakers
                    .get(node.node_id())
                    .map(|b| b.get_state() != CircuitState::Open)
                    .unwrap_or(true) // Unknown nodes are considered healthy
            })
            .cloned()
            .collect()
    }

    /// Get all node IDs with open circuits
    pub fn get_open_circuits(&self) -> Vec<String> {
        self.breakers
            .iter()
            .filter(|entry| entry.value().get_state() == CircuitState::Open)
            .map(|entry| entry.key().clone())
            .collect()
    }

    /// Get all node IDs with unhealthy circuits (open or half-open)
    pub fn get_unhealthy_nodes(&self) -> Vec<String> {
        self.breakers
            .iter()
            .filter(|entry| entry.value().get_state().is_unhealthy())
            .map(|entry| entry.key().clone())
            .collect()
    }

    /// Get state for all managed nodes
    pub fn get_all_states(&self) -> Vec<(String, CircuitState)> {
        self.breakers
            .iter()
            .map(|entry| (entry.key().clone(), entry.value().get_state()))
            .collect()
    }

    /// Force open circuit for a node
    pub fn force_open(&self, node_id: &str, admin: Option<&str>) {
        let breaker = self.get_breaker(node_id);
        breaker.force_open(admin);
    }

    /// Force close circuit for a node
    pub fn force_close(&self, node_id: &str, admin: Option<&str>) {
        if let Some(breaker) = self.breakers.get(node_id) {
            breaker.force_close(admin);
        }
    }

    /// Reset circuit for a node
    pub fn reset(&self, node_id: &str) {
        if let Some(breaker) = self.breakers.get(node_id) {
            breaker.reset();
        }
    }

    /// Reset all circuits
    pub fn reset_all(&self) {
        for entry in self.breakers.iter() {
            entry.value().reset();
        }
    }

    /// Remove a circuit breaker
    pub fn remove(&self, node_id: &str) -> Option<CircuitBreaker> {
        self.breakers.remove(node_id).map(|(_, b)| b)
    }

    /// Add a shared listener for all circuit breakers
    pub fn add_listener(&self, listener: Arc<dyn CircuitBreakerListener>) {
        // Add to existing breakers
        for entry in self.breakers.iter() {
            entry.value().add_listener(Arc::clone(&listener));
        }

        // Store for future breakers
        self.shared_listeners.write().push(listener);
    }

    /// Update global configuration
    pub fn update_config(&self, config: ManagerConfig) {
        // Update existing breakers with new configs
        for entry in self.breakers.iter() {
            let node_config = config.get_node_config(entry.key());
            entry.value().update_config(node_config);
        }

        *self.config.write() = config;
    }

    /// Get current configuration
    pub fn config(&self) -> ManagerConfig {
        self.config.read().clone()
    }

    /// Get metrics
    pub fn metrics(&self) -> &CircuitMetrics {
        &self.metrics
    }

    /// Get statistics for all circuits
    pub fn get_stats(&self) -> CircuitStats {
        let mut stats = CircuitStats::default();

        for entry in self.breakers.iter() {
            let breaker = entry.value();
            stats.add_node_stats(
                entry.key(),
                breaker.get_state(),
                breaker.failure_count(),
                breaker.open_count(),
                breaker.total_failures(),
                breaker.total_successes(),
            );
        }

        stats
    }

    /// Get number of managed nodes
    pub fn node_count(&self) -> usize {
        self.breakers.len()
    }

    /// Check if a specific node exists
    pub fn has_node(&self, node_id: &str) -> bool {
        self.breakers.contains_key(node_id)
    }
}

/// Error type for wrapped requests
#[derive(Debug)]
pub enum WrapError<E> {
    /// Circuit is open
    CircuitOpen(CircuitOpen),
    /// Inner function error
    Inner(E),
}

impl<E: std::fmt::Display> std::fmt::Display for WrapError<E> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            WrapError::CircuitOpen(open) => write!(f, "{}", open),
            WrapError::Inner(e) => write!(f, "{}", e),
        }
    }
}

impl<E: std::error::Error + 'static> std::error::Error for WrapError<E> {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            WrapError::CircuitOpen(open) => Some(open),
            WrapError::Inner(e) => Some(e),
        }
    }
}

impl<E> WrapError<E> {
    /// Check if this is a circuit open error
    pub fn is_circuit_open(&self) -> bool {
        matches!(self, WrapError::CircuitOpen(_))
    }

    /// Get retry-after duration if circuit is open
    pub fn retry_after(&self) -> Option<Duration> {
        match self {
            WrapError::CircuitOpen(open) => Some(open.retry_after),
            WrapError::Inner(_) => None,
        }
    }
}

/// Trait for types that have a node ID
pub trait HasNodeId {
    fn node_id(&self) -> &str;
}

impl HasNodeId for String {
    fn node_id(&self) -> &str {
        self
    }
}

impl HasNodeId for &str {
    fn node_id(&self) -> &str {
        self
    }
}

/// Simple node info for testing
#[derive(Debug, Clone)]
pub struct SimpleNode {
    pub id: String,
}

impl HasNodeId for SimpleNode {
    fn node_id(&self) -> &str {
        &self.id
    }
}

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

    #[test]
    fn test_manager_creation() {
        let manager = CircuitBreakerManager::with_defaults();
        assert_eq!(manager.node_count(), 0);
    }

    #[test]
    fn test_manager_get_breaker() {
        let manager = CircuitBreakerManager::with_defaults();

        let breaker = manager.get_breaker("node-1");
        assert_eq!(breaker.node_id(), "node-1");
        assert_eq!(breaker.get_state(), CircuitState::Closed);

        assert_eq!(manager.node_count(), 1);
        assert!(manager.has_node("node-1"));
    }

    #[test]
    fn test_manager_allow_request() {
        let manager = CircuitBreakerManager::with_defaults();

        let guard = manager.allow_request("node-1").expect("should allow");
        guard.success();

        let breaker = manager.get_breaker("node-1");
        assert_eq!(breaker.total_successes(), 1);
    }

    #[test]
    fn test_manager_healthy_nodes() {
        let config = ManagerConfig::new(
            CircuitBreakerConfig::builder()
                .failure_threshold(2)
                .build(),
        );
        let manager = CircuitBreakerManager::new(config);

        // Create some nodes
        let nodes = vec![
            SimpleNode {
                id: "node-1".to_string(),
            },
            SimpleNode {
                id: "node-2".to_string(),
            },
            SimpleNode {
                id: "node-3".to_string(),
            },
        ];

        // Initially all healthy
        let healthy = manager.get_healthy_nodes(&nodes);
        assert_eq!(healthy.len(), 3);

        // Open circuit for node-2
        manager.force_open("node-2", None);

        let healthy = manager.get_healthy_nodes(&nodes);
        assert_eq!(healthy.len(), 2);
        assert!(healthy.iter().all(|n| n.id != "node-2"));
    }

    #[test]
    fn test_manager_wrap_request() {
        let manager = CircuitBreakerManager::with_defaults();

        let result = manager.wrap_request("node-1", || Ok::<i32, &str>(42));
        assert_eq!(result.unwrap(), 42);

        let result = manager.wrap_request("node-1", || Err::<i32, &str>("error"));
        assert!(result.is_err());
    }

    #[test]
    fn test_manager_node_overrides() {
        let config = ManagerConfig::new(
            CircuitBreakerConfig::builder()
                .failure_threshold(5)
                .build(),
        )
        .with_node_override(
            NodeOverride::new("special-node").with_failure_threshold(10),
        );

        let manager = CircuitBreakerManager::new(config);

        let normal_breaker = manager.get_breaker("normal-node");
        assert_eq!(normal_breaker.config().failure_threshold, 5);

        let special_breaker = manager.get_breaker("special-node");
        assert_eq!(special_breaker.config().failure_threshold, 10);
    }

    #[test]
    fn test_manager_get_open_circuits() {
        let manager = CircuitBreakerManager::with_defaults();

        manager.force_open("node-1", None);
        manager.force_open("node-3", None);
        let _ = manager.get_breaker("node-2"); // Closed

        let open = manager.get_open_circuits();
        assert_eq!(open.len(), 2);
        assert!(open.contains(&"node-1".to_string()));
        assert!(open.contains(&"node-3".to_string()));
    }

    #[test]
    fn test_manager_reset_all() {
        let config = ManagerConfig::new(
            CircuitBreakerConfig::builder()
                .failure_threshold(1)
                .build(),
        );
        let manager = CircuitBreakerManager::new(config);

        // Open some circuits
        manager.force_open("node-1", None);
        manager.force_open("node-2", None);

        assert_eq!(manager.get_open_circuits().len(), 2);

        manager.reset_all();
        assert_eq!(manager.get_open_circuits().len(), 0);
    }

    #[tokio::test]
    async fn test_manager_wrap_async() {
        let manager = CircuitBreakerManager::with_defaults();

        let result = manager
            .wrap_request_async("node-1", || async { Ok::<i32, &str>(42) })
            .await;
        assert_eq!(result.unwrap(), 42);
    }
}