rust-fsm - Finite state machines in rust; bendns fork to add types.


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

/// A dummy implementation of the Circuit Breaker pattern to demonstrate
/// capabilities of this library.
/// https://martinfowler.com/bliki/CircuitBreaker.html
use rust_fsm::*;
use std::sync::{Arc, Mutex};
use std::time::Duration;

#[derive(Debug)]
enum CircuitBreakerInput {
    Successful,
    Unsuccessful,
    TimerTriggered,
}

#[derive(Clone, Copy, Debug, PartialEq)]
enum CircuitBreakerState {
    Closed,
    Open,
    HalfOpen,
}

#[derive(Debug, PartialEq)]
struct CircuitBreakerOutputSetTimer;

#[derive(Debug)]
struct CircuitBreakerMachine;

impl StateMachineImpl for CircuitBreakerMachine {
    type Input = CircuitBreakerInput;
    type State = CircuitBreakerState;
    type Output = CircuitBreakerOutputSetTimer;
    const INITIAL_STATE: Self::State = CircuitBreakerState::Closed;

    fn transition(state: &Self::State, input: &Self::Input) -> Option<Self::State> {
        match (state, input) {
            (CircuitBreakerState::Closed, CircuitBreakerInput::Unsuccessful) => {
                Some(CircuitBreakerState::Open)
            }
            (CircuitBreakerState::Open, CircuitBreakerInput::TimerTriggered) => {
                Some(CircuitBreakerState::HalfOpen)
            }
            (CircuitBreakerState::HalfOpen, CircuitBreakerInput::Successful) => {
                Some(CircuitBreakerState::Closed)
            }
            (CircuitBreakerState::HalfOpen, CircuitBreakerInput::Unsuccessful) => {
                Some(CircuitBreakerState::Open)
            }
            _ => None,
        }
    }

    fn output(state: &Self::State, input: &Self::Input) -> Option<Self::Output> {
        match (state, input) {
            (CircuitBreakerState::Closed, CircuitBreakerInput::Unsuccessful) => {
                Some(CircuitBreakerOutputSetTimer)
            }
            (CircuitBreakerState::HalfOpen, CircuitBreakerInput::Unsuccessful) => {
                Some(CircuitBreakerOutputSetTimer)
            }
            _ => None,
        }
    }
}

#[test]
fn circuit_breaker() {
    let machine: StateMachine<CircuitBreakerMachine> = StateMachine::new();

    // Unsuccessful request
    let machine = Arc::new(Mutex::new(machine));
    {
        let mut lock = machine.lock().unwrap();
        let res = lock.consume(&CircuitBreakerInput::Unsuccessful).unwrap();
        assert_eq!(res, Some(CircuitBreakerOutputSetTimer));
        assert_eq!(lock.state(), &CircuitBreakerState::Open);
    }

    // Set up a timer
    let machine_wait = machine.clone();
    std::thread::spawn(move || {
        std::thread::sleep(Duration::new(5, 0));
        let mut lock = machine_wait.lock().unwrap();
        let res = lock.consume(&CircuitBreakerInput::TimerTriggered).unwrap();
        assert_eq!(res, None);
        assert_eq!(lock.state(), &CircuitBreakerState::HalfOpen);
    });

    // Try to pass a request when the circuit breaker is still open
    let machine_try = machine.clone();
    std::thread::spawn(move || {
        std::thread::sleep(Duration::new(1, 0));
        let mut lock = machine_try.lock().unwrap();
        let res = lock.consume(&CircuitBreakerInput::Successful);
        assert_eq!(res, Err(()));
        assert_eq!(lock.state(), &CircuitBreakerState::Open);
    });

    // Test if the circit breaker was actually closed
    std::thread::sleep(Duration::new(7, 0));
    {
        let mut lock = machine.lock().unwrap();
        let res = lock.consume(&CircuitBreakerInput::Successful).unwrap();
        assert_eq!(res, None);
        assert_eq!(lock.state(), &CircuitBreakerState::Closed);
    }
}