nil-client 0.5.2

Multiplayer strategy game
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

// Copyright (C) Call of Nil contributors
// SPDX-License-Identifier: AGPL-3.0-only

use bon::Builder;
use jiff::{SignedDuration, Timestamp};
use std::num::NonZeroU32;
use tap::{Conv, Pipe};

/// See: <https://learn.microsoft.com/en-us/azure/architecture/patterns/circuit-breaker>
#[derive(Builder)]
pub struct CircuitBreaker {
  #[builder(skip)]
  state: CircuitState,

  #[builder(skip)]
  failure_count: u32,

  #[builder(default = unsafe { NonZeroU32::new_unchecked(25)})]
  failure_threshold: NonZeroU32,

  #[builder(skip = Timestamp::UNIX_EPOCH)]
  last_failure: Timestamp,

  #[builder(default = unsafe { NonZeroU32::new_unchecked(15_000)})]
  failure_timeout_ms: NonZeroU32,

  #[builder(skip)]
  success_count: u32,

  #[builder(default = unsafe { NonZeroU32::new_unchecked(3)})]
  success_threshold: NonZeroU32,
}

impl CircuitBreaker {
  pub fn new() -> Self {
    Self::default()
  }

  pub(crate) fn update(&mut self) -> CircuitState {
    match self.state {
      CircuitState::Closed => {
        if self.failure_count >= self.failure_threshold.get() {
          self.enter(CircuitState::Open);
        }
      }
      CircuitState::Open => {
        if !self.has_recent_failure() {
          self.enter(CircuitState::HalfOpen);
        }
      }
      CircuitState::HalfOpen => {
        if self.has_recent_failure() {
          self.enter(CircuitState::Open);
        } else if self.success_count >= self.success_threshold.get() {
          self.enter(CircuitState::Closed);
        }
      }
    }

    self.state
  }

  fn enter(&mut self, state: CircuitState) {
    debug_assert_ne!(self.state, state);

    match state {
      CircuitState::Closed => {
        self.failure_count = 0;
      }
      CircuitState::Open | CircuitState::HalfOpen => {
        self.success_count = 0;
      }
    }

    self.state = state;
  }

  pub fn has_recent_failure(&self) -> bool {
    let timeout = self
      .failure_timeout_ms
      .get()
      .conv::<i64>()
      .pipe(SignedDuration::from_millis);

    Timestamp::now()
      .duration_since(self.last_failure)
      .le(&timeout)
  }

  pub(crate) fn record_failure(&mut self) {
    self.last_failure = Timestamp::now();
    if self.state == CircuitState::HalfOpen {
      self.enter(CircuitState::Open);
    } else {
      self.failure_count += 1;
    }
  }

  pub(crate) fn record_success(&mut self) {
    if let CircuitState::HalfOpen = self.state {
      self.success_count += 1;
    }
  }
}

impl Default for CircuitBreaker {
  fn default() -> Self {
    Self::builder().build()
  }
}

#[derive(Copy, Debug)]
#[derive_const(Clone, Default, PartialEq, Eq)]
pub enum CircuitState {
  #[default]
  Closed,
  Open,
  HalfOpen,
}