circuitbox 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0f2e7b33bd03af9f5b4aa606de11a0a1068b931
-  data.tar.gz: 922098a0bf91d9c782c3ac147e94af11f834cf94
+  metadata.gz: 7d3753a1304b550e062e4956cb9c4ddd366a1916
+  data.tar.gz: 837d1d4e71f5ddaa3b9434d6333d846043d73303
 SHA512:
-  metadata.gz: e1fefde3c0c5af41966ff72eee0c71d3c0e5478306b3f744b95eed5ea4e5daeb651ecaf0cf0f7a92eb354571b0af3628c48881e3b29b0f291b8c1a8f1da57adb
-  data.tar.gz: 34add156e9af7dd00a3a12be2c6dde1d05e7f8c5ab5bfcb7006022351ddcbccc57586b340bd6d4b8323bb71cfc02022a49e5fef0bf8afbc88df0288edd93822b
+  metadata.gz: e12e4b470624fc64ca42ada7b624c4233b0d8f80d6ac98d244833a0de261ef3d0e09b11205e6740a3a24514cccad03a959780dc9cae75f56a6ac83ee26435186
+  data.tar.gz: 5a81d87b4a22644b5ea2bacf5a3ee2193ddbd896b15991f41ca9a21ae446fc74a844938cc9b761e2afe38b273cea4be184b84e43d892761d5c6d185e34478f58

data/README.md

@@ -94,7 +94,7 @@ class CircuitOpenException    < StandardError ; end
 
 ActiveSupport::Notifications.subscribe('circuit_open') do |name, start, finish, id, payload|
   circuit_name = payload[:circuit]
-  Rails.logger.warning("Open circuit for: #{circuit_name}")
+  Rails.logger.warn("Open circuit for: #{circuit_name}")
 end
 ActiveSupport::Notifications.subscribe('circuit_close') do |name, start, finish, id, payload|
   circuit_name = payload[:circuit]
@@ -196,17 +196,21 @@ conn.get("/api", circuit_breaker_run_options: {})
 c.use Circuitbox::FaradayMiddleware, circuit_breaker_options: {}
 ```
 
-<<<<<<< HEAD
-* `open_circuit` lambda determining what response is considered a failure, 
+* `open_circuit` lambda determining what response is considered a failure,
   counting towards the opening of the circuit
 
 ```ruby
 c.use Circuitbox::FaradayMiddleware, open_circuit: lambda { |response| response.status >= 500 }
 ```
+
 ## CHANGELOG
-<<<<<<< HEAD
+
 ### version next
 
+### v0.10.1
+- [Documentation fix](https://github.com/yammer/circuitbox/pull/29) [chiefcll](https://github.com/chiefcll)
+- [Faraday middleware fix](https://github.com/yammer/circuitbox/pull/30) [chiefcll](https://github.com/chiefcll)
+
 ### v0.10
 - configuration option for faraday middleware for what should be considered to open the circuit [enrico-scalavio](https://github.com/enrico-scalavino)
 - fix for issue 16, support of in_parallel requests in faraday middlware which were opening the circuit.

data/lib/circuitbox/faraday_middleware.rb

@@ -29,7 +29,6 @@ class Circuitbox
 
     def call(request_env)
       service_response = nil
-      check_circuit_open!(request_env)
       circuit(request_env).run!(run_options(request_env)) do
         @app.call(request_env).on_complete do |env|
           service_response = Faraday::Response.new(env)
@@ -50,11 +49,6 @@ class Circuitbox
 
     private
 
-    def check_circuit_open!(env)
-      # raises if the circuit is open
-      circuit(env).run!(run_options(env)) { :noop }
-    end
-
     def run_options(env)
       env[:circuit_breaker_run_options] || {}
     end
@@ -64,8 +58,7 @@ class Circuitbox
 
       @circuit_breaker_options = opts.fetch(:circuit_breaker_options, {})
       @circuit_breaker_options.merge!(
-        exceptions: opts.fetch(:exceptions, DEFAULT_EXCEPTIONS),
-        volume_threshold: 10
+        exceptions: opts.fetch(:exceptions, DEFAULT_EXCEPTIONS)
       )
     end
 

data/lib/circuitbox/version.rb

@@ -1,3 +1,3 @@
 class Circuitbox
-VERSION='0.10.0'
+  VERSION='0.10.1'
 end

data/test/faraday_middleware_test.rb

@@ -7,7 +7,7 @@ class Circuitbox
   class FaradayMiddlewareTest < Minitest::Test
 
     attr_reader :app
-    
+
     def setup
       @app = gimme
     end
@@ -84,7 +84,7 @@ class Circuitbox
       env = { url: "url", circuit_breaker_run_options: :sential }
       middleware = FaradayMiddleware.new(app, circuitbox: circuitbox)
       middleware.call(env)
-      verify(circuit, 2.times).run!(:sential) # one to check open, one to execute command
+      verify(circuit, 1.times).run!(:sential)
     end
 
     def test_pass_circuit_breaker_options
@@ -92,15 +92,14 @@ class Circuitbox
       env = { url: "url" }
       expected_circuit_breaker_options = {
         sential: :sential,
-        exceptions: FaradayMiddleware::DEFAULT_EXCEPTIONS,
-        volume_threshold: 10
+        exceptions: FaradayMiddleware::DEFAULT_EXCEPTIONS
       }
       give(circuitbox).circuit("url", expected_circuit_breaker_options) { circuit }
       options = { circuitbox: circuitbox, circuit_breaker_options: { sential: :sential } }
       middleware = FaradayMiddleware.new(app, options)
       middleware.call(env)
 
-      verify(circuitbox, 2.times).circuit("url", expected_circuit_breaker_options)
+      verify(circuitbox, 1.times).circuit("url", expected_circuit_breaker_options)
     end
 
     def test_overwrite_circuitbreaker_default_value

data/test/integration/faraday_middleware_test.rb

@@ -2,7 +2,12 @@ require "integration_helper"
 require "typhoeus/adapters/faraday"
 
 class Circuitbox
+
   class FaradayMiddlewareTest < Minitest::Test
+    include IntegrationHelpers
+
+    attr_reader :connection, :success_url, :failure_url
+
     @@only_once = false
     def setup
       @connection = Faraday.new do |c|
@@ -22,30 +27,34 @@ class Circuitbox
       Circuitbox.reset
     end
 
+    def test_circuit_does_not_open_for_below_threshhold_failed_requests
+      5.times { connection.get(failure_url) }
+      assert_equal connection.get(success_url).status, 200
+    end
+
     def test_failure_circuit_response
-      failure_response = @connection.get(@failure_url)
+      failure_response = connection.get(failure_url)
       assert_equal failure_response.status, 503
       assert_match failure_response.original_response.body, "Failure!"
     end
 
     def test_open_circuit_response
-      10.times { @connection.get(@failure_url) } # make the CircuitBreaker open
-
-      open_circuit_response = @connection.get(@failure_url)
+      open_circuit
+      open_circuit_response = connection.get(failure_url)
       assert_equal open_circuit_response.status, 503
       assert open_circuit_response.original_response.nil?
     end
 
     def test_closed_circuit_response
-      result = @connection.get(@success_url)
+      result = connection.get(success_url)
       assert result.success?
     end
 
     def test_parallel_requests_closed_circuit_response
       response_1, response_2 = nil
-      @connection.in_parallel do
-        response_1 = @connection.get(@success_url)
-        response_2 = @connection.get(@success_url)
+      connection.in_parallel do
+        response_1 = connection.get(success_url)
+        response_2 = connection.get(success_url)
       end
 
       assert response_1.success?
@@ -53,11 +62,11 @@ class Circuitbox
     end
 
     def test_parallel_requests_open_circuit_response
-      10.times { @connection.get(@failure_url) } # make the CircuitBreaker open
+      open_circuit
       response_1, response_2 = nil
-      @connection.in_parallel do
-        response_1 = @connection.get(@failure_url)
-        response_2 = @connection.get(@failure_url)
+      connection.in_parallel do
+        response_1 = connection.get(failure_url)
+        response_2 = connection.get(failure_url)
       end
 
       assert_equal response_1.status, 503

data/test/integration_helper.rb

@@ -38,3 +38,11 @@ class FakeServer
     sleep 0.5 # wait for the server to spin up
   end
 end
+
+module IntegrationHelpers
+  def open_circuit
+    volume_threshold = Circuitbox['test'].option_value(:volume_threshold)
+    (volume_threshold + 1).times { connection.get(failure_url) }
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuitbox
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Fahim Ferdous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler