breaker_machines 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd34f2d2c0993335422fcb7c9a2495af660ec6c59dde5f57c7f9da0841cb51db
-  data.tar.gz: fc1ba508ecbaf43dbf451ef81bcacb9b586a0003ca5148d66d80f4d51a53f926
+  metadata.gz: 302ad7f4383ff797f0f9bf89c4da1252f27f33ebcfab3cc7c3c114ba32afe5e0
+  data.tar.gz: 6fc626f0001941fe023d02417c384673b4df74c3cbbb82c28c8a1e932992ba00
 SHA512:
-  metadata.gz: 49eac0d2918c9cee306309f785009fe53ffbd4d4a26641132f2dfe8a069e0cb200a47a3d97a8748ae1bf52d4604969127d3c549db2e31cf6e25d0b95ce9eb65c
-  data.tar.gz: a08fa2490b8b2a3b1ac6bc44853540763875ce39ce439c860b682256f01ccfbdf5e5e63176f917d9c109a3593b573a32588dddb336c34d0a1023c00bbe4c15c5
+  metadata.gz: b84a777ed7f9bb88bca15ec3935193123bcdf47e9642d2a4ffe4c8de35ea9dcd1d335717922739675f144915815e10e2adc638bb6bb747bc2f0ca35e7968211d
+  data.tar.gz: 91e832c67256d91f61692fe7f7ca7b006fef2752560b98a95f9ac3d0169a4af5f9fe4d1e8ebb8d794f6d9dbbe72a2f4e7e71b7b3b7d1d4b1c1de115d96d3707d

data/lib/breaker_machines/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BreakerMachines
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/sig/README.md

@@ -71,4 +71,4 @@ end
 The type signatures define several interfaces:
 - `_StorageBackend` - For custom storage implementations
 - `_MetricsRecorder` - For custom metrics recording
-- `_CircuitLike` - For circuit-compatible objects
+- `_CircuitLike` - For circuit-compatible objects

data/sig/all.rbs

@@ -22,4 +22,4 @@
 
 # Import all type definitions
 use BreakerMachines::*
-use BreakerMachines::Storage::*
+use BreakerMachines::Storage::*

data/sig/breaker_machines/circuit.rbs

@@ -151,4 +151,4 @@ module BreakerMachines
     def invoke_fallback: (StandardError error) -> untyped
     def invoke_single_fallback: (Proc | untyped fallback, StandardError error) -> untyped
   end
-end
+end

data/sig/breaker_machines/console.rbs

@@ -29,4 +29,4 @@ module BreakerMachines
     def colorize_state: (Symbol state) -> String
     def colorize_event_type: (Symbol type) -> String
   end
-end
+end

data/sig/breaker_machines/dsl.rbs

@@ -47,4 +47,4 @@ module BreakerMachines
       def parallel_calls: (Integer count, ?timeout: Integer?) -> void
     end
   end
-end
+end

data/sig/breaker_machines/errors.rbs

@@ -21,4 +21,4 @@ module BreakerMachines
 
   class StorageError < Error
   end
-end
+end

data/sig/breaker_machines/interfaces.rbs

@@ -43,4 +43,4 @@ module BreakerMachines
     def reset: () -> bool
     def stats: () -> Hash[Symbol, untyped]
   end
-end
+end

data/sig/breaker_machines/registry.rbs

@@ -27,4 +27,4 @@ module BreakerMachines
 
     def cleanup_dead_references_unsafe: () -> void
   end
-end
+end

data/sig/breaker_machines/storage.rbs

@@ -62,4 +62,4 @@ module BreakerMachines
       def event_log: (String circuit_name, ?Integer limit) -> Array[untyped]
     end
   end
-end
+end

data/sig/breaker_machines/types.rbs

@@ -94,4 +94,4 @@ module BreakerMachines
     status: circuit_state,
     opened_at: Float?
   }
-end
+end

data/sig/manifest.yaml

@@ -2,4 +2,4 @@ dependencies:
   - name: activesupport
   - name: concurrent-ruby
   - name: state_machines
-  - name: zeitwerk
+  - name: zeitwerk

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breaker_machines
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -51,20 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rb_sys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: state_machines
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -144,26 +144,11 @@ description: |
 email:
 - terminale@gmail.com
 executables: []
-extensions:
-- ext/breaker_machines_native/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- ext/breaker_machines_native/core/Cargo.toml
-- ext/breaker_machines_native/core/examples/basic.rs
-- ext/breaker_machines_native/core/src/builder.rs
-- ext/breaker_machines_native/core/src/bulkhead.rs
-- ext/breaker_machines_native/core/src/callbacks.rs
-- ext/breaker_machines_native/core/src/circuit.rs
-- ext/breaker_machines_native/core/src/classifier.rs
-- ext/breaker_machines_native/core/src/errors.rs
-- ext/breaker_machines_native/core/src/lib.rs
-- ext/breaker_machines_native/core/src/storage.rs
-- ext/breaker_machines_native/extconf.rb
-- ext/breaker_machines_native/ffi/Cargo.toml
-- ext/breaker_machines_native/ffi/extconf.rb
-- ext/breaker_machines_native/ffi/src/lib.rs
 - lib/breaker_machines.rb
 - lib/breaker_machines/async_circuit.rb
 - lib/breaker_machines/async_support.rb

data/ext/breaker_machines_native/core/Cargo.toml

@@ -1,21 +0,0 @@
-[package]
-name = "breaker-machines"
-version = "0.7.6"
-edition = "2024"
-authors = ["Abdelkader Boudih <oss@seuros.com>"]
-license = "MIT"
-description = "High-performance circuit breaker with fallback support and rate-based thresholds"
-repository = "https://github.com/seuros/breaker_machines"
-readme = "README.md"
-keywords = ["circuit-breaker", "reliability", "fault-tolerance", "state-machine"]
-categories = ["concurrency"]
-
-[lib]
-crate-type = ["lib"]
-
-[features]
-inspect = ["state-machines/inspect"]
-
-[dependencies]
-state-machines = { workspace = true }
-chrono-machines = { workspace = true }

data/ext/breaker_machines_native/core/examples/basic.rs

@@ -1,61 +0,0 @@
-//! Basic circuit breaker usage example
-
-use breaker_machines::CircuitBreaker;
-
-fn main() {
-    println!("=== Circuit Breaker Basic Example ===\n");
-
-    // Create a circuit with builder API
-    let mut circuit = CircuitBreaker::builder("payment_api")
-        .failure_threshold(3)
-        .failure_window_secs(10.0)
-        .half_open_timeout_secs(5.0)
-        .success_threshold(2)
-        .on_open(|name| println!("🔴 Circuit '{}' opened!", name))
-        .on_close(|name| println!("🟢 Circuit '{}' closed!", name))
-        .on_half_open(|name| println!("🟡 Circuit '{}' half-open, testing...", name))
-        .build();
-
-    println!("Initial state: {}\n", circuit.state_name());
-
-    // Simulate successful calls
-    println!("--- Successful calls ---");
-    for i in 1..=2 {
-        match circuit.call(move || Ok::<_, String>(format!("Payment {}", i))) {
-            Ok(result) => println!("✓ {}", result),
-            Err(e) => println!("✗ Error: {}", e),
-        }
-    }
-    println!("State: {}\n", circuit.state_name());
-
-    // Simulate failures
-    println!("--- Triggering failures ---");
-    for i in 1..=3 {
-        match circuit.call(move || Err::<String, _>(format!("Payment failed {}", i))) {
-            Ok(_) => println!("✓ Success"),
-            Err(e) => println!("✗ {}", e),
-        }
-    }
-    println!("State: {} (circuit opened)\n", circuit.state_name());
-
-    // Try calling while open
-    println!("--- Attempting call while open ---");
-    match circuit.call(|| Ok::<_, String>("Should be rejected")) {
-        Ok(_) => println!("✓ Success"),
-        Err(e) => println!("✗ {}", e),
-    }
-    println!();
-
-    // Reset and demonstrate recovery
-    println!("--- Resetting circuit ---");
-    circuit.reset();
-    println!("State after reset: {}\n", circuit.state_name());
-
-    // Successful calls after reset
-    println!("--- Calls after reset ---");
-    match circuit.call(|| Ok::<_, String>("Payment successful")) {
-        Ok(result) => println!("✓ {}", result),
-        Err(e) => println!("✗ {}", e),
-    }
-    println!("State: {}", circuit.state_name());
-}

data/ext/breaker_machines_native/core/src/builder.rs

@@ -1,232 +0,0 @@
-//! Builder API for ergonomic circuit breaker configuration
-
-use crate::{
-    MemoryStorage, StorageBackend,
-    bulkhead::BulkheadSemaphore,
-    callbacks::Callbacks,
-    circuit::{CircuitBreaker, CircuitContext, Config},
-    classifier::FailureClassifier,
-};
-use std::sync::Arc;
-
-/// Builder for creating circuit breakers with fluent API
-pub struct CircuitBuilder {
-    name: String,
-    config: Config,
-    storage: Option<Arc<dyn StorageBackend>>,
-    failure_classifier: Option<Arc<dyn FailureClassifier>>,
-    bulkhead: Option<Arc<BulkheadSemaphore>>,
-    callbacks: Callbacks,
-}
-
-impl CircuitBuilder {
-    /// Create a new builder for a circuit with the given name
-    pub fn new(name: impl Into<String>) -> Self {
-        Self {
-            name: name.into(),
-            config: Config::default(),
-            storage: None,
-            failure_classifier: None,
-            bulkhead: None,
-            callbacks: Callbacks::new(),
-        }
-    }
-
-    /// Set the absolute failure threshold (number of failures to open circuit)
-    pub fn failure_threshold(mut self, threshold: usize) -> Self {
-        self.config.failure_threshold = Some(threshold);
-        self
-    }
-
-    /// Disable absolute failure threshold (use only rate-based)
-    pub fn disable_failure_threshold(mut self) -> Self {
-        self.config.failure_threshold = None;
-        self
-    }
-
-    /// Set the failure rate threshold (0.0-1.0)
-    /// Circuit opens when (failures / total_calls) >= this value
-    pub fn failure_rate(mut self, rate: f64) -> Self {
-        self.config.failure_rate_threshold = Some(rate.clamp(0.0, 1.0));
-        self
-    }
-
-    /// Set minimum number of calls before rate-based threshold is evaluated
-    pub fn minimum_calls(mut self, calls: usize) -> Self {
-        self.config.minimum_calls = calls;
-        self
-    }
-
-    /// Set the failure window in seconds
-    pub fn failure_window_secs(mut self, seconds: f64) -> Self {
-        self.config.failure_window_secs = seconds;
-        self
-    }
-
-    /// Set the half-open timeout in seconds
-    pub fn half_open_timeout_secs(mut self, seconds: f64) -> Self {
-        self.config.half_open_timeout_secs = seconds;
-        self
-    }
-
-    /// Set the success threshold (successes needed to close from half-open)
-    pub fn success_threshold(mut self, threshold: usize) -> Self {
-        self.config.success_threshold = threshold;
-        self
-    }
-
-    /// Set the jitter factor (0.0 = no jitter, 1.0 = full jitter)
-    /// Uses chrono-machines formula: timeout * (1 - jitter + rand * jitter)
-    pub fn jitter_factor(mut self, factor: f64) -> Self {
-        self.config.jitter_factor = factor;
-        self
-    }
-
-    /// Set custom storage backend
-    pub fn storage(mut self, storage: Arc<dyn StorageBackend>) -> Self {
-        self.storage = Some(storage);
-        self
-    }
-
-    /// Set a failure classifier to filter which errors should trip the circuit
-    ///
-    /// The classifier determines whether a given error should count toward
-    /// opening the circuit. Use this to ignore "expected" errors like validation
-    /// failures or client errors (4xx), while still tripping on server errors (5xx).
-    ///
-    /// # Examples
-    ///
-    /// ```rust
-    /// use breaker_machines::{CircuitBreaker, PredicateClassifier};
-    /// use std::sync::Arc;
-    ///
-    /// let circuit = CircuitBreaker::builder("api")
-    ///     .failure_classifier(Arc::new(PredicateClassifier::new(|ctx| {
-    ///         // Only trip on slow errors
-    ///         ctx.duration > 1.0
-    ///     })))
-    ///     .build();
-    /// ```
-    pub fn failure_classifier(mut self, classifier: Arc<dyn FailureClassifier>) -> Self {
-        self.failure_classifier = Some(classifier);
-        self
-    }
-
-    /// Set maximum concurrency limit (bulkheading)
-    ///
-    /// When set, the circuit breaker will reject calls with `BulkheadFull` error
-    /// if the number of concurrent calls exceeds this limit. This prevents
-    /// resource exhaustion by limiting how many operations can run simultaneously.
-    ///
-    /// # Panics
-    ///
-    /// Panics if `limit` is 0.
-    ///
-    /// # Examples
-    ///
-    /// ```rust
-    /// use breaker_machines::CircuitBreaker;
-    ///
-    /// let mut circuit = CircuitBreaker::builder("api")
-    ///     .max_concurrency(10) // Allow max 10 concurrent calls
-    ///     .build();
-    ///
-    /// // This will succeed until 10 calls are running concurrently
-    /// let result = circuit.call(|| Ok::<_, String>("success"));
-    /// ```
-    pub fn max_concurrency(mut self, limit: usize) -> Self {
-        self.bulkhead = Some(Arc::new(BulkheadSemaphore::new(limit)));
-        self
-    }
-
-    /// Set callback for when circuit opens
-    pub fn on_open<F>(mut self, f: F) -> Self
-    where
-        F: Fn(&str) + Send + Sync + 'static,
-    {
-        self.callbacks.on_open = Some(Arc::new(f));
-        self
-    }
-
-    /// Set callback for when circuit closes
-    pub fn on_close<F>(mut self, f: F) -> Self
-    where
-        F: Fn(&str) + Send + Sync + 'static,
-    {
-        self.callbacks.on_close = Some(Arc::new(f));
-        self
-    }
-
-    /// Set callback for when circuit enters half-open
-    pub fn on_half_open<F>(mut self, f: F) -> Self
-    where
-        F: Fn(&str) + Send + Sync + 'static,
-    {
-        self.callbacks.on_half_open = Some(Arc::new(f));
-        self
-    }
-
-    /// Build the circuit breaker
-    pub fn build(self) -> CircuitBreaker {
-        let storage = self
-            .storage
-            .unwrap_or_else(|| Arc::new(MemoryStorage::new()));
-
-        let context = CircuitContext {
-            name: self.name,
-            config: self.config,
-            storage,
-            failure_classifier: self.failure_classifier,
-            bulkhead: self.bulkhead,
-        };
-
-        CircuitBreaker::with_context_and_callbacks(context, self.callbacks)
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn test_builder_defaults() {
-        let circuit = CircuitBuilder::new("test").build();
-
-        assert_eq!(circuit.state_name(), "Closed");
-        assert!(circuit.is_closed());
-    }
-
-    #[test]
-    fn test_builder_custom_config() {
-        let circuit = CircuitBuilder::new("test")
-            .failure_threshold(10)
-            .failure_window_secs(120.0)
-            .half_open_timeout_secs(60.0)
-            .success_threshold(3)
-            .build();
-
-        assert!(circuit.is_closed());
-    }
-
-    #[test]
-    fn test_builder_with_callbacks() {
-        use std::sync::atomic::{AtomicBool, Ordering};
-
-        let opened = Arc::new(AtomicBool::new(false));
-        let opened_clone = opened.clone();
-
-        let mut circuit = CircuitBuilder::new("test")
-            .failure_threshold(2)
-            .on_open(move |_name| {
-                opened_clone.store(true, Ordering::SeqCst);
-            })
-            .build();
-
-        // Trigger failures to open circuit
-        let _ = circuit.call(|| Err::<(), _>("error 1"));
-        let _ = circuit.call(|| Err::<(), _>("error 2"));
-
-        // Callback should have been triggered
-        assert!(opened.load(Ordering::SeqCst));
-    }
-}