seatbelt 0.4.2

Resilience and recovery mechanisms for fallible operations.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use std::time::Duration;

use crate::breaker::HalfOpenMode;
use crate::breaker::constants::{DEFAULT_BREAK_DURATION, DEFAULT_FAILURE_THRESHOLD, DEFAULT_MIN_THROUGHPUT, DEFAULT_SAMPLING_DURATION};

/// Configuration for the circuit breaker middleware.
///
/// This struct provides a serialization-friendly way to configure the circuit breaker middleware
/// from external sources such as configuration files. Use [`BreakerLayer::config`][crate::breaker::BreakerLayer::config] to apply
/// the configuration to a breaker layer.
///
/// # Defaults
///
/// The default values match the circuit breaker middleware defaults:
///
/// | Field | Default |
/// |-------|---------|
/// | `enabled` | `true` |
/// | `failure_threshold` | `0.1` (10%) |
/// | `min_throughput` | `100` |
/// | `sampling_duration` | 30 seconds |
/// | `break_duration` | 5 seconds |
/// | `half_open_mode` | `Progressive` (no custom stage duration) |
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(any(feature = "serde", test), derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct BreakerConfig {
    /// Whether the circuit breaker middleware is enabled. When `false`, the middleware
    /// is bypassed and requests pass through directly to the inner service.
    pub enabled: bool,

    /// The failure threshold (0.0 to 1.0) at which the circuit opens.
    pub failure_threshold: f32,

    /// The minimum number of executions in the sampling window before the circuit can open.
    pub min_throughput: u32,

    /// The time window for calculating failure rates.
    #[cfg_attr(
        any(feature = "serde", test),
        serde(with = "jiff::fmt::serde::unsigned_duration::friendly::compact::required")
    )]
    pub sampling_duration: Duration,

    /// The duration the circuit remains open before transitioning to half-open.
    #[cfg_attr(
        any(feature = "serde", test),
        serde(with = "jiff::fmt::serde::unsigned_duration::friendly::compact::required")
    )]
    pub break_duration: Duration,

    /// The behavior of the circuit breaker when transitioning from half-open to closed state.
    pub half_open_mode: HalfOpenMode,
}

impl Default for BreakerConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            failure_threshold: DEFAULT_FAILURE_THRESHOLD,
            min_throughput: DEFAULT_MIN_THROUGHPUT,
            sampling_duration: DEFAULT_SAMPLING_DURATION,
            break_duration: DEFAULT_BREAK_DURATION,
            half_open_mode: HalfOpenMode::progressive(None),
        }
    }
}

#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg(test)]
mod tests {
    use super::*;

    #[cfg_attr(miri, ignore)]
    #[test]
    fn default_snapshot() {
        let config = BreakerConfig::default();
        insta::assert_json_snapshot!(config);
    }

    #[cfg_attr(miri, ignore)]
    #[test]
    fn quick_half_open_mode_snapshot() {
        let config = BreakerConfig {
            half_open_mode: HalfOpenMode::quick(),
            ..BreakerConfig::default()
        };
        insta::assert_json_snapshot!(config);
    }

    #[cfg_attr(miri, ignore)]
    #[test]
    fn progressive_no_duration_half_open_mode_snapshot() {
        let config = BreakerConfig {
            half_open_mode: HalfOpenMode::progressive(None),
            ..BreakerConfig::default()
        };
        insta::assert_json_snapshot!(config);
    }

    #[cfg_attr(miri, ignore)]
    #[test]
    fn progressive_with_duration_half_open_mode_snapshot() {
        let config = BreakerConfig {
            half_open_mode: HalfOpenMode::progressive(Duration::from_secs(45)),
            ..BreakerConfig::default()
        };
        insta::assert_json_snapshot!(config);
    }
}