ya_circuit_breaker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73c83613b11f39499746959dafbe0d55d2f2e309
-  data.tar.gz: b7bbe8cfd8fd6232a4bafd7f3b49d64194151969
+  metadata.gz: 9ffa87cc6c8a50ade120114ace1c9d8e98e7ba4a
+  data.tar.gz: d119cd8c1448de2b4225114a9dc938e453b8c0a9
 SHA512:
-  metadata.gz: d4b170420e181aa1173ae9e6541bd8eddab1a8ef5d0c9c0610e78bfd4fb8b1b4722339a25f815bc5f5a4fd3ad0adc0105cbf17d911f8f93aa4abf00bf01290f0
-  data.tar.gz: b8f01d55e62c0f02c385fe6dc3a78160a65d2616858878e24760e0295a97ab6c7be382fe86bb3ecb389c0833c9882d2e1ddeacd3fecc742d56e46ba9224bab25
+  metadata.gz: 9f64c4eaceb986bc3a70e3a5e60a284eb6fa6d74ba421318ddd49ae99e921445f9a94ffc0a35c3d58d722841cfbfea1842e7967d81a3577a29c7c42b8539b3e5
+  data.tar.gz: e5df6e2f23df1d8a69ebb09d194ecc698eeda630f93506bd64e9ed696519b4256d40bdfea129429dde6ecc1e77cd59723ac068d198c2e0e9242d1930355e9703

data/ChangeLog

@@ -0,0 +1,3 @@
+2014-04-28  Multiple exceptions handling and Proc support in addition to truncated exponential reset timeouts logic
+
+2014-04-24  Initial version

data/README.md

@@ -31,7 +31,10 @@ options = {
   # invocation timeout in seconds
   invocation_timeout: 0.5,
   # a list of timeouts for consecutive failures in seconds. can be used for exponential backoff
-  reset_timeouts: [2, 4, 8, 16, 32, 64, 128]
+  # a Proc can be also passed instead, that can operate on a number of retries after circuit breaker trips
+  reset_timeouts: [2, 4, 8, 16, 32, 64, 128],  # or Proc.new {|retry| retry * 10}
+  # a list of errors or exceptions that indicates outtage of service
+  errors_handled: [Redis::CommandError]
 }
 
 circuit_breaker = CircuitBreaker::Basic.new(options)
@@ -44,6 +47,8 @@ rescue CircuitBreaker::CircuitBrokenError
   $stderr.puts "Circuit tripped"
 rescue Timeout::Error
   $stderr.puts "Call took too long"
+resque Redis::CommandError  # from errors_handled
+  $stderr.puts "One of the errors indicating outtage of the service"
 rescue Error
   $stderr.puts "Error thrown by 'http_api_call'"
 end

data/lib/circuit_breaker.rb

@@ -9,7 +9,8 @@ module CircuitBreaker
     DEFAULTS = {
       failure_threshold:    5,
       invocation_timeout:   2,
-      reset_timeouts:      10
+      reset_timeouts:      10,
+      errors_handled:     [],
     }
 
     attr_reader :failure_count, :last_failure_time, :failure_threshold
@@ -18,7 +19,8 @@ module CircuitBreaker
       options             = DEFAULTS.merge(options)
       @failure_threshold  = options[:failure_threshold]
       @invocation_timeout = options[:invocation_timeout]
-      @reset_timeouts     = Array(options[:reset_timeouts])
+      @reset_timeouts     = options[:reset_timeouts].is_a?(Proc) ? options[:reset_timeouts] : Array(options[:reset_timeouts])
+      @errors_handled     = Array(options[:errors_handled])
       @last_failure_time  = nil
       @failure_count      = 0
     end
@@ -50,7 +52,13 @@ module CircuitBreaker
     end
 
     def reset_timeout
-      @reset_timeouts[[@reset_timeouts.size - 1, retry_counter].min]
+      if @reset_timeouts.is_a? Proc
+        return @reset_timeouts.call retry_counter
+      else
+        index = [@reset_timeouts.size - 1, retry_counter].min
+        @reset_timeouts[index]
+      end
+
     end
 
 
@@ -73,8 +81,8 @@ module CircuitBreaker
             block.call if block_given?
           end
           reset!
-        rescue Timeout::Error
-          record_failure
+        rescue Exception => e
+          record_failure if e.class == Timeout::Error || @errors_handled.include?(e.class)
           raise
         end
       else

data/lib/circuit_breaker/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreaker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/circuit_breaker_test.rb

@@ -63,6 +63,17 @@ describe CircuitBreaker::Basic do
     end
   end
 
+  it "should trip after the failure threshold has been exceeded" do
+    circuit_breaker    = CircuitBreaker::Basic.new(failure_threshold: 1, invocation_timeout: 0.1, errors_handled: ArgumentError)
+
+    assert_raises ArgumentError do
+      circuit_breaker.execute do
+        raise ArgumentError
+      end
+    end
+    assert circuit_breaker.open?, "Circuit should be open"
+  end
+
   it "should reset after reset timeout" do
     reset_timeouts  = 0.1
     circuit_breaker = CircuitBreaker::Basic.new(reset_timeouts: reset_timeouts)
@@ -77,6 +88,23 @@ describe CircuitBreaker::Basic do
     assert circuit_breaker.half_open?
   end
 
+  it "should handle proc as reset timeout" do
+    reset_timeouts  = Proc.new {|retry_counter| retry_counter + 1}
+    circuit_breaker = CircuitBreaker::Basic.new(failure_threshold: 1, reset_timeouts: reset_timeouts, errors_handled: ArgumentError)
+
+    assert_raises ArgumentError do
+      circuit_breaker.execute do
+        raise ArgumentError
+      end
+    end
+
+    assert circuit_breaker.open?, "Circuit should be open"
+
+    sleep(reset_timeouts.call 1)
+
+    assert circuit_breaker.half_open?
+  end
+
   it "should change from half open to closed on success" do
     reset_timeouts  = 0.1
     circuit_breaker = CircuitBreaker::Basic.new(reset_timeouts: reset_timeouts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ya_circuit_breaker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Patrick Huesler
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Prevent long running external calls from blocking an application
@@ -47,8 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
+- ChangeLog
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,17 +70,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Basic circuit breaker in Ruby