rs-zero 0.2.6

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

use crate::{
    cache::{CacheError, CacheResult},
    cache_redis::{
        RedisCacheError, RedisCacheResult, RedisCacheStore, RedisDegradationEvent,
        RedisDegradedAction, RedisOperation, classify_redis_error, redis_breaker_rejection,
    },
    resil::{BreakerCallError, BreakerGuard},
};

pub(crate) fn is_breaker_acceptable_error(error: &RedisCacheError) -> bool {
    matches!(
        classify_redis_error(error),
        crate::cache_redis::RedisCommandOutcome::NoScript
            | crate::cache_redis::RedisCommandOutcome::Redirect(_)
    )
}

impl RedisCacheStore {
    pub(super) async fn protect_command<T, F>(
        &self,
        operation: &'static str,
        future: F,
    ) -> RedisCacheResult<T>
    where
        F: std::future::Future<Output = redis::RedisResult<T>>,
    {
        let Some(breaker) = &self.breaker else {
            return future.await.map_err(crate::cache_redis::redis_error);
        };

        match breaker
            .do_with_acceptable(
                || async { future.await.map_err(crate::cache_redis::redis_error) },
                is_breaker_acceptable_error,
            )
            .await
        {
            Ok(value) => {
                self.recorder
                    .record_breaker(crate::cache_redis::RedisCommandOutcome::Success);
                Ok(value)
            }
            Err(BreakerCallError::Rejected(error)) => {
                self.recorder
                    .record_breaker(crate::cache_redis::RedisCommandOutcome::BreakerRejected);
                Err(redis_breaker_rejection(operation, error))
            }
            Err(BreakerCallError::Inner(error)) => {
                self.recorder.record_breaker(classify_redis_error(&error));
                Err(error)
            }
        }
    }

    pub(super) async fn allow_breaker(
        &self,
        operation: &'static str,
    ) -> RedisCacheResult<Option<BreakerGuard>> {
        let Some(breaker) = &self.breaker else {
            return Ok(None);
        };

        match breaker.allow().await {
            Ok(guard) => Ok(Some(guard)),
            Err(error) => {
                self.recorder
                    .record_breaker(crate::cache_redis::RedisCommandOutcome::BreakerRejected);
                Err(redis_breaker_rejection(operation, error))
            }
        }
    }

    pub(super) async fn record_breaker_outcome<T>(
        &self,
        guard: Option<BreakerGuard>,
        result: &RedisCacheResult<T>,
    ) {
        let Some(guard) = guard else {
            return;
        };

        match result {
            Ok(_) => {
                guard.record_success().await;
                self.recorder
                    .record_breaker(crate::cache_redis::RedisCommandOutcome::Success);
            }
            Err(error) if is_breaker_acceptable_error(error) => {
                guard.record_success().await;
                self.recorder.record_breaker(classify_redis_error(error));
            }
            Err(error) => {
                guard.record_failure().await;
                self.recorder.record_breaker(classify_redis_error(error));
            }
        }
    }

    pub(super) async fn ensure_breaker_allows(
        &self,
        operation: RedisOperation,
    ) -> Result<(), CacheResult<()>> {
        let Some(breaker) = &self.breaker else {
            return Ok(());
        };

        match breaker.state().await {
            crate::resil::BreakerState::Open => {
                self.recorder
                    .record_breaker(crate::cache_redis::RedisCommandOutcome::BreakerRejected);
                let error = RedisCacheError::BreakerOpen(format!(
                    "{}: circuit breaker is open",
                    operation.as_str()
                ));
                Err(self.degrade_unit_error(operation, error))
            }
            crate::resil::BreakerState::Closed | crate::resil::BreakerState::HalfOpen => Ok(()),
        }
    }

    fn degrade_unit_error(
        &self,
        operation: RedisOperation,
        error: RedisCacheError,
    ) -> CacheResult<()> {
        let action = self.config.unavailable_policy.action_for(operation, &error);
        if action == RedisDegradedAction::ReturnError {
            return Err(CacheError::Backend(error.to_string()));
        }
        self.recorder
            .record_degradation(RedisDegradationEvent::new(operation, action));
        Ok(())
    }
}