From 3ea0d502b38b6b8c7dafa894bd6a1eee5c1bf66e Mon Sep 17 00:00:00 2001
From: wangchongfei <wangchongfei@corp.netease.com>
Date: Thu, 12 Oct 2023 19:54:26 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=F0=9F=8E=89=20add=20on=5Fcircuit=5Fbre?=
 =?UTF-8?q?aker=5Fdrop=20method=20for=20circuit=20breaker=20state=20change?=
 =?UTF-8?q?=20listener?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../src/core/circuitbreaker/breaker/mod.rs    | 48 +++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/sentinel-core/src/core/circuitbreaker/breaker/mod.rs b/sentinel-core/src/core/circuitbreaker/breaker/mod.rs
index e2b4365..a874c54 100644
--- a/sentinel-core/src/core/circuitbreaker/breaker/mod.rs
+++ b/sentinel-core/src/core/circuitbreaker/breaker/mod.rs
@@ -101,6 +101,11 @@ pub trait StateChangeListener: Sync + Send {
     /// Argument rule is copy from circuit breaker's rule, any changes of rule don't take effect for circuit breaker
     /// Copying rule has a performance penalty and avoids invalid listeners as much as possible
     fn on_transform_to_half_open(&self, prev: State, rule: Arc<Rule>);
+
+    /// `on_circuit_breaker_drop` is triggered when circuit breaker is drop.
+    /// Argument rule is copy from circuit breaker's rule, any changes of rule don't take effect for circuit breaker
+    /// Copying rule has a performance penalty and avoids invalid listeners as much as possible
+    fn on_circuit_breaker_drop(&self, prev: State, rule: Arc<Rule>);
 }
 
 /// `CircuitBreakerTrait` is the basic trait of circuit breaker
@@ -343,6 +348,15 @@ impl BreakerBase {
     }
 }
 
+impl Drop for BreakerBase {
+    fn drop(&mut self) {
+        let listeners = state_change_listeners().lock().unwrap();
+        for listener in &*listeners {
+            listener.on_circuit_breaker_drop(self.current_state(), Arc::clone(&self.rule));
+        }
+    }
+}
+
 #[cfg(test)]
 pub(crate) use test::MockCircuitBreaker;
 
@@ -379,6 +393,7 @@ pub(crate) mod test {
             fn on_transform_to_closed(&self, prev: State, rule: Arc<Rule>);
             fn on_transform_to_open(&self, prev: State, rule: Arc<Rule>, snapshot: Option<Arc<Snapshot>>);
             fn on_transform_to_half_open(&self, prev: State, rule: Arc<Rule>);
+            fn on_circuit_breaker_drop(&self, prev: State, rule: Arc<Rule>);
         }
     }
 
@@ -751,4 +766,37 @@ pub(crate) mod test {
         assert!(changed);
         assert!(breaker.next_retry_timestamp_ms() > 0);
     }
+
+    #[test]
+    #[ignore]
+    fn on_circuit_breaker_drop() {
+        // by default, the state of `breaker` is `State::Closed` (see the impl of `Default` trait on `State`)
+        clear_state_change_listeners();
+        let mut listener = MockStateListener::new();
+        listener
+            .expect_on_circuit_breaker_drop()
+            .returning(|prev: State, rule: Arc<Rule>| {
+                logging::debug!(
+                    "circuit breaker drop, strategy: {:?}, previous state: {:?}",
+                    rule.strategy,
+                    prev
+                );
+                assert_eq!(prev, State::Closed);
+            });
+        register_state_change_listeners(vec![Arc::new(listener)]);
+        let rule = Arc::new(Rule {
+            resource: "abc".into(),
+            strategy: BreakerStrategy::Custom(101),
+            retry_timeout_ms: 3000,
+            min_request_amount: 10,
+            stat_interval_ms: 10000,
+            max_allowed_rt_ms: 50,
+            threshold: 0.5,
+            ..Default::default()
+        });
+        {
+            let _breaker = SlowRtBreaker::new(Arc::clone(&rule));
+        }
+        clear_state_change_listeners();
+    }
 }