breaker_machines 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fae87263df3eaaba47c2a78df338740ae9ed8599e13a42867110270787f9dc8a
-  data.tar.gz: 03bb57d8e463c3bd92ed2d7938788563b3df6d94329f87cf176b6934c218a963
+  metadata.gz: 5137f3692641c76411b86e725df03e901220a09d18a9bc1ba64fc1834d93b811
+  data.tar.gz: f5f0c05289c82dfe6aa1fe23322a531fbfd9faa1b8e9f29575eb5c801aacf712
 SHA512:
-  metadata.gz: 67a9a1adad11d9d83fba339ccf3fe24317dde8e1da919b5fa7ffd2cf0509908daeb20a6efac0519e30604433617d493bdfa358e9b3de41140a0f440432c626df
-  data.tar.gz: 907986bddf430ea0daa163d2c8d51e7c77e3a61031927117529bcdc5586bec664f45c9b9c293cb614ca0c96ee2f539e810fdebef9ea55a04d2d3a6c163d54d25
+  metadata.gz: 1150d77d3823b038277fb4bd7ee2c28bb39ea0307fefe227f2346c220ceb961f89349bfadc0d8b7bbcea01d7c0bd319ad96177c2de0eb24b6df82f57ee8001f6
+  data.tar.gz: 3673de4be4d9784ea7135da34e0d02aae91c4b2f8a0c04bc3e058cb01e7f250feb9e6526c4f638d555cc7a3e35a4d3ffb75ffcd770db867442e234ecf43f58a7

data/ext/breaker_machines_native/extconf.rb

@@ -1,40 +1,3 @@
 # frozen_string_literal: true
 
-# Skip native extension compilation on JRuby
-if RUBY_ENGINE == 'jruby'
-  puts 'Skipping native extension compilation on JRuby'
-  puts 'BreakerMachines will use pure Ruby backend'
-  makefile_content = "all:\n\t@echo 'Skipping native extension on JRuby'\n" \
-                     "install:\n\t@echo 'Skipping native extension on JRuby'\n"
-  File.write('Makefile', makefile_content)
-  exit 0
-end
-
-# Check if Cargo is available
-def cargo_available?
-  system('cargo --version > /dev/null 2>&1')
-end
-
-unless cargo_available?
-  warn 'WARNING: Cargo (Rust toolchain) not found!'
-  warn 'BreakerMachines will fall back to pure Ruby backend.'
-  warn 'To enable native performance, install Rust from https://rustup.rs'
-
-  # Create a dummy Makefile that does nothing
-  makefile_content = "all:\n\t@echo 'Skipping native extension (Cargo not found)'\n" \
-                     "install:\n\t@echo 'Skipping native extension (Cargo not found)'\n"
-  File.write('Makefile', makefile_content)
-  exit 0
-end
-
-# Use rb_sys to compile the Rust extension
-require 'mkmf'
-require 'rb_sys/mkmf'
-
-create_rust_makefile('breaker_machines_native/breaker_machines_native') do |r|
-  # Set the path to the FFI crate (relative to current directory)
-  r.ext_dir = 'ffi'
-
-  # Profile configuration
-  r.profile = ENV.fetch('RB_SYS_CARGO_PROFILE', :release).to_sym
-end
+require_relative 'ffi/extconf'

data/ext/breaker_machines_native/ffi/extconf.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Skip native extension compilation on JRuby
+if RUBY_ENGINE == 'jruby'
+  puts 'Skipping native extension compilation on JRuby'
+  puts 'BreakerMachines will use pure Ruby backend'
+  makefile_content = "all:\n\t@echo 'Skipping native extension on JRuby'\n" \
+                     "install:\n\t@echo 'Skipping native extension on JRuby'\n"
+  File.write('Makefile', makefile_content)
+  exit 0
+end
+
+# Check if Cargo is available
+def cargo_available?
+  system('cargo --version > /dev/null 2>&1')
+end
+
+def create_noop_makefile(message)
+  warn message
+  warn 'BreakerMachines will fall back to pure Ruby backend.'
+  File.write('Makefile', <<~MAKE)
+    all:
+    	@echo '#{message}'
+    install:
+    	@echo '#{message}'
+  MAKE
+  exit 0
+end
+
+unless cargo_available?
+  create_noop_makefile('Skipping native extension (Cargo not found)')
+end
+
+# Use rb_sys to compile the Rust extension
+require 'mkmf'
+
+# Wrap entire compilation process in error handling to ensure gem install never fails
+begin
+  require 'rb_sys/mkmf'
+
+  require 'pathname'
+
+  create_rust_makefile('breaker_machines_native/breaker_machines_native') do |r|
+    ffi_dir = Pathname(__dir__)
+    r.ext_dir = begin
+      ffi_dir.relative_path_from(Pathname(Dir.pwd)).to_s
+    rescue ArgumentError
+      ffi_dir.expand_path.to_s
+    end
+    # Profile configuration
+    r.profile = ENV.fetch('RB_SYS_CARGO_PROFILE', :release).to_sym
+  end
+
+  makefile_path = File.join(Dir.pwd, 'Makefile')
+  if File.exist?(makefile_path)
+    manifest_path = File.expand_path(__dir__)
+    contents = File.read(makefile_path)
+    contents.gsub!(%r{^RB_SYS_CARGO_MANIFEST_DIR \?=.*$}, "RB_SYS_CARGO_MANIFEST_DIR ?= #{manifest_path}")
+    File.write(makefile_path, contents)
+  end
+rescue LoadError => e
+  # rb_sys not available
+  create_noop_makefile("Skipping native extension (rb_sys gem not available: #{e.message})")
+rescue StandardError => e
+  # Any other compilation setup failure (Rust compilation errors, Makefile generation, etc.)
+  create_noop_makefile("Skipping native extension (compilation setup failed: #{e.message})")
+end

data/lib/breaker_machines/native_extension.rb

@@ -9,6 +9,14 @@ module BreakerMachines
       def load!
         return @loaded if defined?(@loaded)
 
+        # Respect explicit ENV flag to disable native (useful for testing)
+        if ENV['BREAKER_MACHINES_NATIVE'] == '0'
+          @loaded = false
+          BreakerMachines.instance_variable_set(:@native_available, false)
+          BreakerMachines.log(:info, 'Native extension disabled via ENV')
+          return false
+        end
+
         @loaded = true
         require 'breaker_machines_native/breaker_machines_native'
         BreakerMachines.instance_variable_set(:@native_available, true)

data/lib/breaker_machines/native_speedup.rb

@@ -3,4 +3,8 @@
 require_relative 'native_extension'
 
 # Load the native extension if available
-BreakerMachines::NativeExtension.load!
+if BreakerMachines::NativeExtension.load!
+  # Only load Storage::Native if native extension loaded successfully
+  # This prevents referencing BreakerMachinesNative::Storage when not available
+  require_relative 'storage/native'
+end

data/lib/breaker_machines/storage/native.rb

@@ -2,31 +2,34 @@
 
 module BreakerMachines
   module Storage
-    # Native extension storage backend for high-performance event tracking
+    # Native extension storage backend with graceful fallback to pure Ruby
     #
     # This backend provides identical functionality to Memory storage but with
-    # significantly better performance for sliding window calculations. It's
-    # particularly beneficial for high-throughput applications where circuit
-    # breaker state checks happen on every request.
+    # significantly better performance for sliding window calculations when the
+    # native extension is available. If the native extension isn't available
+    # (e.g., on JRuby or if Rust wasn't installed), it automatically falls back
+    # to the pure Ruby Memory storage backend.
     #
-    # Performance: ~63x faster than Memory storage for sliding window calculations
+    # Performance: ~63x faster than Memory storage when native extension is available
     #
     # Usage:
     #   BreakerMachines.configure do |config|
     #     config.default_storage = :native
     #   end
     #
-    # Fallback: If the native extension isn't available (e.g., on JRuby or if
-    # Rust wasn't installed during gem installation), this will raise LoadError.
-    # Use Storage::Memory as a fallback in such cases.
+    # FFI Hybrid Pattern: This class is only loaded when native extension is available
+    # Fallback happens at load time (native_speedup.rb), not at runtime
     class Native < Base
       def initialize(**options)
         super
-        unless defined?(BreakerMachinesNative::Storage)
-          raise LoadError, 'Native extension not available. Use Storage::Memory instead.'
-        end
+        # Native extension is guaranteed to be available when this class is loaded
+        @backend = BreakerMachinesNative::Storage.new
+      end
 
-        @native = BreakerMachinesNative::Storage.new
+      # Check if using native backend
+      # @return [Boolean] always true - this class only exists when native is available
+      def native?
+        true
       end
 
       def get_status(_circuit_name)
@@ -41,27 +44,27 @@ module BreakerMachines
       end
 
       def record_success(circuit_name, duration)
-        @native.record_success(circuit_name.to_s, duration.to_f)
+        @backend.record_success(circuit_name.to_s, duration)
       end
 
       def record_failure(circuit_name, duration)
-        @native.record_failure(circuit_name.to_s, duration.to_f)
+        @backend.record_failure(circuit_name.to_s, duration)
       end
 
       def success_count(circuit_name, window_seconds)
-        @native.success_count(circuit_name.to_s, window_seconds.to_f)
+        @backend.success_count(circuit_name.to_s, window_seconds)
       end
 
       def failure_count(circuit_name, window_seconds)
-        @native.failure_count(circuit_name.to_s, window_seconds.to_f)
+        @backend.failure_count(circuit_name.to_s, window_seconds)
       end
 
       def clear(circuit_name)
-        @native.clear(circuit_name.to_s)
+        @backend.clear(circuit_name.to_s)
       end
 
       def clear_all
-        @native.clear_all
+        @backend.clear_all
       end
 
       def record_event_with_details(circuit_name, type, duration, error: nil, new_state: nil)
@@ -78,7 +81,7 @@ module BreakerMachines
       end
 
       def event_log(circuit_name, limit)
-        @native.event_log(circuit_name.to_s, limit)
+        @backend.event_log(circuit_name.to_s, limit)
       end
 
       def with_timeout(_timeout_ms)

data/lib/breaker_machines/version.rb

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

data/lib/breaker_machines.rb

@@ -17,6 +17,7 @@ loader.ignore("#{__dir__}/breaker_machines/hedged_async_support.rb")
 loader.ignore("#{__dir__}/breaker_machines/circuit/async_state_management.rb")
 loader.ignore("#{__dir__}/breaker_machines/native_speedup.rb")
 loader.ignore("#{__dir__}/breaker_machines/native_extension.rb")
+loader.ignore("#{__dir__}/breaker_machines/storage/native.rb")
 loader.setup
 
 # BreakerMachines provides a thread-safe implementation of the Circuit Breaker pattern
@@ -190,11 +191,10 @@ module BreakerMachines
 end
 
 # Load optional native speedup after core is loaded
-# Opt-in with BREAKER_MACHINES_NATIVE=1 to enable native extensions
-if ENV['BREAKER_MACHINES_NATIVE'] == '1'
-  begin
-    require_relative 'breaker_machines/native_speedup'
-  rescue LoadError
-    # Native gem not available, skip native support
-  end
+# Automatically loads if available, gracefully falls back to pure Ruby if not
+begin
+  require_relative 'breaker_machines/native_speedup'
+rescue LoadError
+  # Native extension not available, using pure Ruby backend
+  # This is expected on JRuby or when Cargo is not available
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breaker_machines
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -79,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -108,19 +122,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rb_sys
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.3'
 description: |
   BreakerMachines is a production-ready circuit breaker implementation for Ruby that prevents
   cascade failures in distributed systems. Built on the battle-tested state_machines gem, it
@@ -149,6 +163,7 @@ files:
 - 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
 - ext/breaker_machines_native/target/debug/build/clang-sys-d961dfabd5f43fba/out/common.rs
 - ext/breaker_machines_native/target/debug/build/clang-sys-d961dfabd5f43fba/out/dynamic.rs
@@ -235,7 +250,6 @@ files:
 - lib/breaker_machines/storage/null.rb
 - lib/breaker_machines/types.rb
 - lib/breaker_machines/version.rb
-- lib/breaker_machines_native/breaker_machines_native.bundle
 - sig/README.md
 - sig/all.rbs
 - sig/breaker_machines.rbs
@@ -258,6 +272,8 @@ metadata:
   bug_tracker_uri: https://github.com/seuros/breaker_machines/issues
   documentation_uri: https://github.com/seuros/breaker_machines#readme
   rubygems_mfa_required: 'true'
+  cargo_crate_name: breaker_machines_native
+  cargo_manifest_path: ext/breaker_machines_native/ffi/Cargo.toml
 rdoc_options: []
 require_paths:
 - lib
@@ -265,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="