rs-zero 0.2.7

Rust-first microservice framework inspired by go-zero engineering practices
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

use std::{collections::HashMap, sync::Arc};

use tokio::sync::Mutex;

use crate::resil::{
    AdaptiveShedder, AdaptiveShedderConfig, BreakerConfig, BreakerPolicyConfig, BreakerSnapshot,
    SharedCircuitBreaker, ShedderSnapshot,
};

/// Registry that reuses circuit breakers by stable service or route key.
#[derive(Debug, Clone, Default)]
pub struct BreakerRegistry {
    breakers: Arc<Mutex<HashMap<String, SharedCircuitBreaker>>>,
}

impl BreakerRegistry {
    /// Creates an empty breaker registry.
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns an existing breaker or creates one with the provided config.
    pub async fn get_or_insert(
        &self,
        key: impl Into<String>,
        config: BreakerConfig,
    ) -> SharedCircuitBreaker {
        self.get_or_insert_with_policy(key, config, BreakerPolicyConfig::default())
            .await
    }

    /// Returns an existing breaker or creates one with the provided config and policy.
    pub async fn get_or_insert_with_policy(
        &self,
        key: impl Into<String>,
        config: BreakerConfig,
        policy: BreakerPolicyConfig,
    ) -> SharedCircuitBreaker {
        let key = key.into();
        let mut breakers = self.breakers.lock().await;
        breakers
            .entry(key)
            .or_insert_with(|| SharedCircuitBreaker::with_policy(config, policy))
            .clone()
    }

    /// Returns the number of registered breakers.
    pub async fn len(&self) -> usize {
        self.breakers.lock().await.len()
    }

    /// Returns whether the registry has no breakers.
    pub async fn is_empty(&self) -> bool {
        self.len().await == 0
    }

    /// Returns snapshots for all registered breakers.
    pub async fn snapshots(&self) -> Vec<(String, BreakerSnapshot)> {
        let breakers = self.breakers.lock().await;
        let items = breakers
            .iter()
            .map(|(key, breaker)| (key.clone(), breaker.clone()))
            .collect::<Vec<_>>();
        drop(breakers);

        let mut snapshots = Vec::with_capacity(items.len());
        for (key, breaker) in items {
            snapshots.push((key, breaker.snapshot().await));
        }
        snapshots
    }
}

/// Registry that reuses adaptive shedders by stable service or route key.
#[derive(Debug, Clone, Default)]
pub struct ShedderRegistry {
    shedders: Arc<Mutex<HashMap<String, AdaptiveShedder>>>,
}

impl ShedderRegistry {
    /// Creates an empty shedder registry.
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns an existing shedder or creates one with the provided config.
    pub async fn get_or_insert(
        &self,
        key: impl Into<String>,
        config: AdaptiveShedderConfig,
    ) -> AdaptiveShedder {
        let key = key.into();
        let mut shedders = self.shedders.lock().await;
        shedders
            .entry(key)
            .or_insert_with(|| AdaptiveShedder::new(config))
            .clone()
    }

    /// Returns the number of registered shedders.
    pub async fn len(&self) -> usize {
        self.shedders.lock().await.len()
    }

    /// Returns whether the registry has no shedders.
    pub async fn is_empty(&self) -> bool {
        self.len().await == 0
    }

    /// Returns snapshots for all registered shedders.
    pub async fn snapshots(&self) -> Vec<(String, ShedderSnapshot)> {
        let shedders = self.shedders.lock().await;
        let items = shedders
            .iter()
            .map(|(key, shedder)| (key.clone(), shedder.clone()))
            .collect::<Vec<_>>();
        drop(shedders);

        let mut snapshots = Vec::with_capacity(items.len());
        for (key, shedder) in items {
            snapshots.push((key, shedder.snapshot().await));
        }
        snapshots
    }
}

#[cfg(test)]
mod tests {
    use crate::resil::{AdaptiveShedderConfig, BreakerConfig, BreakerRegistry, ShedderRegistry};

    #[tokio::test]
    async fn registry_reuses_breakers_by_key() {
        let registry = BreakerRegistry::new();
        let first = registry
            .get_or_insert("GET /ready", BreakerConfig::default())
            .await;
        first.allow().await.expect("allow").record_failure().await;
        let second = registry
            .get_or_insert("GET /ready", BreakerConfig::default())
            .await;

        assert_eq!(registry.len().await, 1);
        assert_eq!(first.state().await, second.state().await);
        assert_eq!(registry.snapshots().await.len(), 1);
    }

    #[tokio::test]
    async fn shedder_registry_reuses_shedders_by_key() {
        let registry = ShedderRegistry::new();
        let first = registry
            .get_or_insert("GET /ready", AdaptiveShedderConfig::default())
            .await;
        let second = registry
            .get_or_insert("GET /ready", AdaptiveShedderConfig::default())
            .await;

        first.allow().await.expect("allow").record_success().await;
        assert_eq!(registry.len().await, 1);
        assert_eq!(
            second.snapshot().await.window.successes,
            first.snapshot().await.window.successes
        );
    }
}