circuitbox 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d3753a1304b550e062e4956cb9c4ddd366a1916
-  data.tar.gz: 837d1d4e71f5ddaa3b9434d6333d846043d73303
+  metadata.gz: c55691f6ad22c899ad8425c2d412290ac47e0ede
+  data.tar.gz: c37774032e6e84cb0dd2c23ab9e87ef48ce22fe5
 SHA512:
-  metadata.gz: e12e4b470624fc64ca42ada7b624c4233b0d8f80d6ac98d244833a0de261ef3d0e09b11205e6740a3a24514cccad03a959780dc9cae75f56a6ac83ee26435186
-  data.tar.gz: 5a81d87b4a22644b5ea2bacf5a3ee2193ddbd896b15991f41ca9a21ae446fc74a844938cc9b761e2afe38b273cea4be184b84e43d892761d5c6d185e34478f58
+  metadata.gz: 00e370cf4194cafc3e9842c3077f1783e377466c2a2b186589ede61bc1f85faf9a47ee944ff8e29fa78db7c02760bb429a6f511301d24075fdcfcf195524f03e
+  data.tar.gz: 40a10dc8632d27a7da4b79a78288ff10494a90fd2a4b8db7aac8d41400e2b0d00e4042dab4564d49aeec48f8314b39f094ce0b783e00d4c4f2342bb761d9d35a

data/README.md

@@ -169,11 +169,17 @@ c.use Circuitbox::FaradayMiddleware, exceptions: [Faraday::Error::TimeoutError]
 * `default_value` value to return for open circuits, defaults to 503 response
   wrapping the original response given by the service and stored as
   `original_response` property of the returned 503, this can be overwritten
-  either with a static value or a `lambda` which is passed the
-  original_response.
+  with either
+  * a static value
+  * a `lambda` which is passed the `original_response` and `original_error`.
+    `original_response` will be populated if Faraday returne an error response,
+    `original_error` will be populated if an error was thrown before Faraday
+    returned a response.  (It will also accept a lambda with arity 1 that is
+    only passed `original_response`.  This use is deprecated and will be removed
+    in the next major version.)
 
 ```ruby
-c.use Circuitbox::FaradayMiddleware, default_value: lambda { |response| ... }
+c.use Circuitbox::FaradayMiddleware, default_value: lambda { |response, error| ... }
 ```
 
 * `identifier` circuit id, defaults to request url
@@ -207,6 +213,15 @@ c.use Circuitbox::FaradayMiddleware, open_circuit: lambda { |response| response.
 
 ### version next
 
+### v0.10.2
+- Faraday middleware passes two arguments to the `default_value` callback, not
+  just one.  First argument is still the error response from Faraday if there is
+  one.  Second argument is the exception that caused the call to fail if it
+  failed before Faraday returned a response.  Old behaviour is preserved if you
+  pass a lambda that takes just one argument, but this is deprecated and will be
+  removed in the next version of Circuitbox.
+  [dwaller](https://github.com/dwaller)
+
 ### 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)

data/lib/circuitbox/faraday_middleware.rb

@@ -11,9 +11,10 @@ class Circuitbox
     ]
 
     class NullResponse < Faraday::Response
-      attr_reader :original_response
-      def initialize(response = nil)
-        @original_response = response
+      attr_reader :original_response, :original_exception
+      def initialize(response = nil, exception = nil)
+        @original_response  = response
+        @original_exception = exception
         super(status: 503, response_headers: {})
       end
     end
@@ -35,8 +36,8 @@ class Circuitbox
           raise RequestFailed if open_circuit?(service_response)
         end
       end
-    rescue Circuitbox::Error
-      circuit_open_value(request_env, service_response)
+    rescue Circuitbox::Error => ex
+      circuit_open_value(request_env, service_response, ex)
     end
 
     def exceptions
@@ -66,13 +67,13 @@ class Circuitbox
       return @default_value if @default_value
 
       default = opts.fetch(:default_value) do
-        lambda { |service_response| NullResponse.new(service_response) }
+        lambda { |service_response, exception| NullResponse.new(service_response, exception) }
       end
 
       @default_value = if default.respond_to?(:call)
                          default
                        else
-                         lambda { |_| default }
+                         lambda { |*| default }
                        end
     end
 
@@ -84,8 +85,16 @@ class Circuitbox
       @circuitbox ||= opts.fetch(:circuitbox, Circuitbox)
     end
 
-    def circuit_open_value(env, service_response)
-      env[:circuit_breaker_default_value] || default_value.call(service_response)
+    def circuit_open_value(env, service_response, exception)
+      env[:circuit_breaker_default_value] || call_default_lambda(service_response, exception)
+    end
+
+    def call_default_lambda(service_response, exception)
+      if default_value.arity == 2
+        default_value.call(service_response, exception)
+      else
+        default_value.call(service_response)
+      end
     end
 
     def circuit(env)

data/lib/circuitbox/version.rb

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

data/test/faraday_middleware_test.rb

@@ -27,13 +27,25 @@ class Circuitbox
       env = { url: "url" }
       give(circuitbox).circuit("url", anything) { circuit }
       give(circuit).run!(anything) { raise Circuitbox::Error }
-      default_value_generator = lambda { |_| :sential }
+      default_value_generator = lambda { |response| :sential }
       middleware = FaradayMiddleware.new(app,
                                          circuitbox: circuitbox,
                                          default_value: default_value_generator)
       assert_equal :sential, middleware.call(env)
     end
 
+    def test_default_value_generator_lambda_passed_error
+      stub_circuitbox
+      env = { url: "url" }
+      give(circuitbox).circuit("url", anything) { circuit }
+      give(circuit).run!(anything) { raise Circuitbox::Error.new("error text") }
+      default_value_generator = lambda { |_,error| error.message }
+      middleware = FaradayMiddleware.new(app,
+                                         circuitbox: circuitbox,
+                                         default_value: default_value_generator)
+      assert_equal "error text", middleware.call(env)
+    end
+
     def test_overwrite_default_value_generator_static_value
       stub_circuitbox
       env = { url: "url" }

data/test/integration/faraday_middleware_test.rb

@@ -42,7 +42,8 @@ class Circuitbox
       open_circuit
       open_circuit_response = connection.get(failure_url)
       assert_equal open_circuit_response.status, 503
-      assert open_circuit_response.original_response.nil?
+      assert_nil open_circuit_response.original_response
+      assert_kind_of Circuitbox::OpenCircuitError, open_circuit_response.original_exception
     end
 
     def test_closed_circuit_response

metadata

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