module Ecluse.Core.Breaker (
Breaker,
BreakerPhase (..),
initialBreaker,
breakerPhase,
Attempt,
admit,
recordSuccess,
recordFailure,
release,
BreakerReporter (..),
noBreakerReporter,
reportBreakerChange,
breakerState,
) where
import Data.Time (NominalDiffTime, UTCTime, addUTCTime)
import Ecluse.Core.Telemetry.Metrics qualified as Metric
data Breaker = Breaker Integer BreakerPhase
deriving stock (Breaker -> Breaker -> Bool
(Breaker -> Breaker -> Bool)
-> (Breaker -> Breaker -> Bool) -> Eq Breaker
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Breaker -> Breaker -> Bool
== :: Breaker -> Breaker -> Bool
$c/= :: Breaker -> Breaker -> Bool
/= :: Breaker -> Breaker -> Bool
Eq, Int -> Breaker -> ShowS
[Breaker] -> ShowS
Breaker -> String
(Int -> Breaker -> ShowS)
-> (Breaker -> String) -> ([Breaker] -> ShowS) -> Show Breaker
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Breaker -> ShowS
showsPrec :: Int -> Breaker -> ShowS
$cshow :: Breaker -> String
show :: Breaker -> String
$cshowList :: [Breaker] -> ShowS
showList :: [Breaker] -> ShowS
Show)
data Attempt = Ordinary Integer | Recovery Integer
deriving stock (Attempt -> Attempt -> Bool
(Attempt -> Attempt -> Bool)
-> (Attempt -> Attempt -> Bool) -> Eq Attempt
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Attempt -> Attempt -> Bool
== :: Attempt -> Attempt -> Bool
$c/= :: Attempt -> Attempt -> Bool
/= :: Attempt -> Attempt -> Bool
Eq, Int -> Attempt -> ShowS
[Attempt] -> ShowS
Attempt -> String
(Int -> Attempt -> ShowS)
-> (Attempt -> String) -> ([Attempt] -> ShowS) -> Show Attempt
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Attempt -> ShowS
showsPrec :: Int -> Attempt -> ShowS
$cshow :: Attempt -> String
show :: Attempt -> String
$cshowList :: [Attempt] -> ShowS
showList :: [Attempt] -> ShowS
Show)
data BreakerPhase
=
Closed Int
|
Open UTCTime
|
HalfOpen
|
RecoveryReady
deriving stock (BreakerPhase -> BreakerPhase -> Bool
(BreakerPhase -> BreakerPhase -> Bool)
-> (BreakerPhase -> BreakerPhase -> Bool) -> Eq BreakerPhase
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: BreakerPhase -> BreakerPhase -> Bool
== :: BreakerPhase -> BreakerPhase -> Bool
$c/= :: BreakerPhase -> BreakerPhase -> Bool
/= :: BreakerPhase -> BreakerPhase -> Bool
Eq, Int -> BreakerPhase -> ShowS
[BreakerPhase] -> ShowS
BreakerPhase -> String
(Int -> BreakerPhase -> ShowS)
-> (BreakerPhase -> String)
-> ([BreakerPhase] -> ShowS)
-> Show BreakerPhase
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> BreakerPhase -> ShowS
showsPrec :: Int -> BreakerPhase -> ShowS
$cshow :: BreakerPhase -> String
show :: BreakerPhase -> String
$cshowList :: [BreakerPhase] -> ShowS
showList :: [BreakerPhase] -> ShowS
Show)
initialBreaker :: Breaker
initialBreaker :: Breaker
initialBreaker = Integer -> BreakerPhase -> Breaker
Breaker Integer
0 (Int -> BreakerPhase
Closed Int
0)
breakerPhase :: Breaker -> BreakerPhase
breakerPhase :: Breaker -> BreakerPhase
breakerPhase (Breaker Integer
_ BreakerPhase
phase) = BreakerPhase
phase
admit :: UTCTime -> Breaker -> (Maybe Attempt, Breaker)
admit :: UTCTime -> Breaker -> (Maybe Attempt, Breaker)
admit UTCTime
now br :: Breaker
br@(Breaker Integer
generation BreakerPhase
phase) = case BreakerPhase
phase of
Open UTCTime
until' | UTCTime
now UTCTime -> UTCTime -> Bool
forall a. Ord a => a -> a -> Bool
< UTCTime
until' -> (Maybe Attempt
forall a. Maybe a
Nothing, Breaker
br)
BreakerPhase
HalfOpen -> (Maybe Attempt
forall a. Maybe a
Nothing, Breaker
br)
Closed{} -> (Attempt -> Maybe Attempt
forall a. a -> Maybe a
Just (Integer -> Attempt
Ordinary Integer
generation), Breaker
br)
BreakerPhase
_ -> (Attempt -> Maybe Attempt
forall a. a -> Maybe a
Just (Integer -> Attempt
Recovery Integer
next), Integer -> BreakerPhase -> Breaker
Breaker Integer
next BreakerPhase
HalfOpen)
where
next :: Integer
next = Integer
generation Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
+ Integer
1
recordSuccess :: Attempt -> Breaker -> Breaker
recordSuccess :: Attempt -> Breaker -> Breaker
recordSuccess Attempt
ticket br :: Breaker
br@(Breaker Integer
generation BreakerPhase
_)
| Attempt -> Breaker -> Bool
owns Attempt
ticket Breaker
br = Integer -> BreakerPhase -> Breaker
Breaker Integer
generation (Int -> BreakerPhase
Closed Int
0)
| Bool
otherwise = Breaker
br
recordFailure :: Int -> NominalDiffTime -> UTCTime -> Attempt -> Breaker -> Breaker
recordFailure :: Int -> NominalDiffTime -> UTCTime -> Attempt -> Breaker -> Breaker
recordFailure Int
threshold NominalDiffTime
cooldown UTCTime
now Attempt
ticket br :: Breaker
br@(Breaker Integer
generation BreakerPhase
phase)
| Bool -> Bool
not (Attempt -> Breaker -> Bool
owns Attempt
ticket Breaker
br) = Breaker
br
| Closed Int
n <- BreakerPhase
phase, Int
n Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Int
1 Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
threshold = Integer -> BreakerPhase -> Breaker
Breaker Integer
generation (Int -> BreakerPhase
Closed (Int
n Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Int
1))
| Bool
otherwise = Integer -> BreakerPhase -> Breaker
Breaker Integer
generation (UTCTime -> BreakerPhase
Open (NominalDiffTime -> UTCTime -> UTCTime
addUTCTime NominalDiffTime
cooldown UTCTime
now))
release :: Attempt -> Breaker -> Breaker
release :: Attempt -> Breaker -> Breaker
release (Recovery Integer
ticket) (Breaker Integer
generation BreakerPhase
HalfOpen)
| Integer
ticket Integer -> Integer -> Bool
forall a. Eq a => a -> a -> Bool
== Integer
generation = Integer -> BreakerPhase -> Breaker
Breaker Integer
generation BreakerPhase
RecoveryReady
release Attempt
_ Breaker
br = Breaker
br
owns :: Attempt -> Breaker -> Bool
owns :: Attempt -> Breaker -> Bool
owns (Ordinary Integer
ticket) (Breaker Integer
generation BreakerPhase
phase) =
Integer
ticket Integer -> Integer -> Bool
forall a. Eq a => a -> a -> Bool
== Integer
generation Bool -> Bool -> Bool
&& case BreakerPhase
phase of
Closed{} -> Bool
True
Open{} -> Bool
True
BreakerPhase
_ -> Bool
False
owns (Recovery Integer
ticket) (Breaker Integer
generation BreakerPhase
phase) = Integer
ticket Integer -> Integer -> Bool
forall a. Eq a => a -> a -> Bool
== Integer
generation Bool -> Bool -> Bool
&& BreakerPhase
phase BreakerPhase -> BreakerPhase -> Bool
forall a. Eq a => a -> a -> Bool
== BreakerPhase
HalfOpen
newtype BreakerReporter = BreakerReporter (Breaker -> IO ())
noBreakerReporter :: BreakerReporter
noBreakerReporter :: BreakerReporter
noBreakerReporter = (Breaker -> IO ()) -> BreakerReporter
BreakerReporter (IO () -> Breaker -> IO ()
forall a b. a -> b -> a
const IO ()
forall (f :: * -> *). Applicative f => f ()
pass)
reportBreakerChange :: BreakerReporter -> Breaker -> Breaker -> IO ()
reportBreakerChange :: BreakerReporter -> Breaker -> Breaker -> IO ()
reportBreakerChange (BreakerReporter Breaker -> IO ()
report) Breaker
old Breaker
new
| Breaker -> BreakerState
breakerState Breaker
old BreakerState -> BreakerState -> Bool
forall a. Eq a => a -> a -> Bool
== Breaker -> BreakerState
breakerState Breaker
new = IO ()
forall (f :: * -> *). Applicative f => f ()
pass
| Bool
otherwise = Breaker -> IO ()
report Breaker
new
breakerState :: Breaker -> Metric.BreakerState
breakerState :: Breaker -> BreakerState
breakerState Breaker
br = case Breaker -> BreakerPhase
breakerPhase Breaker
br of
Closed{} -> BreakerState
Metric.Closed
Open{} -> BreakerState
Metric.Open
BreakerPhase
HalfOpen -> BreakerState
Metric.HalfOpen
BreakerPhase
RecoveryReady -> BreakerState
Metric.HalfOpen