faulty 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 815cc1b7ac571e9dc69546efd1b3892795a5ef284cc43448b8a6c1feadcf49c3
-  data.tar.gz: 575c2e0e7abb413f8866a0e159129a6f1ecc76149e8d8cb97c65c7ffd9913ba9
+  metadata.gz: afcc83576fab771e2cbf2c195027ccbe2cf014d437b53355e20fcc411a578995
+  data.tar.gz: ccc1fc4bf2fa33599b0295bdd7f65db61cdf17f7a9971418753990f8cc04eea4
 SHA512:
-  metadata.gz: 6effebfa578717256dc4ef7ec1c59a5f694eff2c78b21edb1649375a3f7ab62bbad597e3e4a0dc63cd729b4e66b4079ea9cbfd72795a1bfd34a9fab489415847
-  data.tar.gz: 2ba730eaa396ce24cb9d4eaf3a35db84180eb5c8ba4e3f3bc803d389436870480bd542aa57c93089ef33b77afe3f9b0c8614f972d232b971d8310f2dd067eb39
+  metadata.gz: f9ee287057df37f330e05e09b90b68e69325cc934f074db5746851bb16eecf2624b3d2689520d052f1af6c73c6f1f08ef1c0ef61c31bd2cc0236647f400dba41
+  data.tar.gz: ae88dedd7eff9153e84a47434d19731d371aae19e036dc88fb338945cd26330c443002fa5b2141fddf4b8c35e4dc927d4f3d4e2d4749c1241a1c1deb6024bd9e

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Releae v0.8.1
+
+* Add cause message to CircuitTrippedError #40 justinhoward
+* Record failures for cache hits #41 justinhoward
+
+
 ## Release v0.8.0
 
 * Store circuit options in the backend when run #34 justinhoward

data/README.md

@@ -1288,11 +1288,12 @@ but there are and have been many other options:
 ### Currently Active
 
 - [semian](https://github.com/Shopify/semian): A resiliency toolkit that
-  includes circuit breakers. It uses adapters to auto-wire circuits, and it has
-  only in-memory storage by design.
-- [circuitbox](https://github.com/yammer/circuitbox): Similar in design to
-  Faulty, but with a different API. It uses Moneta to abstract circuit storage
-  to allow any key-value store.
+  includes circuit breakers. It auto-wires circuits for MySQL, Net::HTTP, and
+  Redis. It has only in-memory storage by design. Its core components are
+  written in C, which allows it to be faster than pure ruby.
+- [circuitbox](https://github.com/yammer/circuitbox): Also uses a block syntax
+  to manually define circuits. It uses Moneta to abstract circuit storage to
+  allow any key-value store.
 
 ### Previous Work
 
@@ -1309,6 +1310,7 @@ but there are and have been many other options:
 
 - Simple API but configurable for advanced users
 - Pluggable storage backends (circuitbox also has this)
+- Patches for common core dependencies (semian also has this)
 - Protected storage access with fallback to safe storage
 - Global, or object-oriented configuration with multiple instances
 - Integrated caching support tailored for fault-tolerance

data/bin/benchmark

@@ -4,12 +4,13 @@
 require 'bundler/setup'
 require 'benchmark'
 require 'faulty'
+require 'redis'
+require 'json'
 
 n = 100_000
-
-puts "Starting circuit benchmarks with #{n} iterations each\n\n"
-
-Benchmark.bm(25) do |b|
+width = 25
+puts "In memory circuits x#{n}"
+Benchmark.bm(width) do |b|
   in_memory = Faulty.new(listeners: [])
   b.report('memory storage') do
     n.times { in_memory.circuit(:memory).run { true } }
@@ -31,11 +32,33 @@ Benchmark.bm(25) do |b|
   end
 end
 
-n = 1_000_000
+n = 1000
+puts "\n\Redis circuits x#{n}"
+Benchmark.bm(width) do |b|
+  redis = Faulty.new(listeners: [], storage: Faulty::Storage::Redis.new)
+  b.report('redis storage') do
+    n.times { redis.circuit(:memory).run { true } }
+  end
 
-puts "\n\nStarting extra benchmarks with #{n} iterations each\n\n"
+  b.report('redis storage failures') do
+    n.times do
+      begin
+        redis.circuit(:memory_fail, sample_threshold: n + 1).run { raise 'fail' }
+      rescue StandardError
+        # Expected to raise here
+      end
+    end
+  end
 
-Benchmark.bm(25) do |b|
+  redis_large = Faulty.new(listeners: [], storage: Faulty::Storage::Redis.new(max_sample_size: 1000))
+  b.report('large redis storage') do
+    n.times { redis_large.circuit(:memory).run { true } }
+  end
+end
+
+n = 1_000_000
+puts "\n\nExtra x#{n}"
+Benchmark.bm(width) do |b|
   in_memory = Faulty.new(listeners: [])
 
   log_listener = Faulty::Events::LogListener.new(Logger.new(File::NULL))

data/lib/faulty/circuit.rb

@@ -397,10 +397,13 @@ class Faulty
     rescue *options.errors => e
       raise if options.exclude.any? { |ex| e.is_a?(ex) }
 
+      opened = failure!(status, e)
       if cached_value.nil?
-        raise options.error_module::CircuitTrippedError.new(nil, self) if failure!(status, e)
-
-        raise options.error_module::CircuitFailureError.new(nil, self)
+        if opened
+          raise options.error_module::CircuitTrippedError.new(e.message, self)
+        else
+          raise options.error_module::CircuitFailureError.new(e.message, self)
+        end
       else
         cached_value
       end

data/lib/faulty/error.rb

@@ -36,10 +36,11 @@ class Faulty
     # @param message [String]
     # @param circuit [Circuit] The circuit that raised the error
     def initialize(message, circuit)
-      message ||= %(circuit error for "#{circuit.name}")
-      @circuit = circuit
+      full_message = %(circuit error for "#{circuit.name}")
+      full_message = %(#{full_message}: #{message}) if message
 
-      super(message)
+      @circuit = circuit
+      super(full_message)
     end
   end
 

data/lib/faulty/version.rb

@@ -3,6 +3,6 @@
 class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.8.0')
+    Gem::Version.new('0.8.1')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby