routemaster-drain 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb1cccd206b6825ce76f748a269bfbc261ff4328
-  data.tar.gz: a05de95ccc0c4643015f69aeeb7bbf02c4905d4f
+SHA256:
+  metadata.gz: 1ddda71d2b877bc368adcfb3d6f97d6c79916b8b2d72db9036d4bdf34ae7f5d8
+  data.tar.gz: 2c3371a3ed8b1df43f743bbc3d9e715fc8ea63ea796042b922f564c13da45467
 SHA512:
-  metadata.gz: cb053523998b5303d8c47d52963c27fac7a87181f28a33ed0a84e8739103c8031bbb3955567440a229eb0691b8878da257c585d5bcd05ac1ae5d1ba5a6028c39
-  data.tar.gz: db39fcb620c32576258a6f94ebc70eaed859cd3b5ea61f4ac899fec68df30ed7f9170cb2535b035a2c40de6425a93cd2b87b99f0e3096e6381fafacc3a3be0cb
+  metadata.gz: a4034317d864f77c4b111f0837673fc3bc9b7f1cb3f93fa79aeff4170b2d80dcf9f6a3cc58072a5a6819791013612a04c59a34baee67b2380ac0a36dd66a8c52
+  data.tar.gz: 51b7c394000cbe0efe657f53ea00b7d4d99063675796a78e8ee3f72e8708e18256311c93792bcd98875a022ac80bc29c20f6eaa034ae178ad6f6ef3196093a38

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-### 3.1.0 (2017-11-42)
+### 3.2.0 (2017-11-10)
+
+Features:
+
+- Adds a circuit breaker to GET requests (#66)
+
+### 3.1.0 (2017-11-2)
 
 Features:
 

data/README.md

@@ -329,6 +329,18 @@ response.user.show(1)
 #=> HateoasResponse
 ```
 
+### Circuit Breaker
+
+The client ships with a circuit breaker for get requests, this can be enabled by setting `ROUTEMASTER_ENABLE_API_CLIENT_CIRCUIT`. The Circuit Breaker is powered by [Circuitbox](https://github.com/yammer/circuitbox).
+
+The following parameters can be used:
+
+- `ROUTEMASTER_CIRCUIT_BREAKER_SLEEP_WINDOW` - The time in seconds the circuit will remain open once it's triggered
+- `ROUTEMASTER_CIRCUIT_BREAKER_TIME_WINDOW` - The time in seconds over which it calculates the error rate
+- `ROUTEMASTER_CIRCUIT_BREAKER_VOLUME_THRESHOLD` - The minimum amount of requests that can trigger the circuit to open
+- `ROUTEMASTER_CIRCUIT_BREAKER_ERROR_THRESHOLD` - The % of errors required for the circuit to open in the sleep window
+
+Each of these settings can be controlled on a per domain basis. To set `ROUTEMASTER_CIRCUIT_BREAKER_SLEEP_WINDOW` for `example.com` set `example.com.ROUTEMASTER_CIRCUIT_BREAKER_SLEEP_WINDOW`
 
 
 ## Internals

data/lib/routemaster/api_client.rb

@@ -8,6 +8,7 @@ require 'routemaster/middleware/response_caching'
 require 'routemaster/middleware/error_handling'
 require 'routemaster/middleware/metrics'
 require 'routemaster/responses/response_promise'
+require 'routemaster/api_client_circuit'
 
 # This is not a direct dependency, we need to load it early to prevent a
 # circular dependency in hateoas_response.rb
@@ -55,13 +56,14 @@ module Routemaster
     def get(url, params: {}, headers: {}, options: {})
       enable_caching = options.fetch(:enable_caching, true)
       response_class = options[:response_class]
-
-      _wrapped_response _request(
-        :get,
-        url: url,
-        params: params,
-        headers: headers.merge(response_cache_opt_headers(enable_caching))),
-        response_class: response_class
+      APIClientCircuit.new(url).call do
+        _wrapped_response _request(
+          :get,
+          url: url,
+          params: params,
+          headers: headers.merge(response_cache_opt_headers(enable_caching))),
+          response_class: response_class
+      end
     end
 
     # Same as {{get}}, except with

data/lib/routemaster/api_client_circuit.rb

@@ -0,0 +1,43 @@
+require 'circuitbox'
+require 'routemaster/errors'
+module Routemaster
+  class APIClientCircuit
+    def initialize(url)
+      url = URI.parse(url) unless url.is_a? URI
+      @circuit_name = url.host.downcase
+    end
+
+    def call(&block)
+      if enabled?
+        begin
+          return circuit.run!(&block)
+        rescue Circuitbox::ServiceFailureError => e
+          raise e.original
+        end
+      else
+        return block.call
+      end
+    end
+
+    private
+
+    def enabled?
+      ENV.fetch('ROUTEMASTER_ENABLE_API_CLIENT_CIRCUIT', 'NO') =~ /\A(YES|TRUE|ON|1)\Z/i
+    end
+
+    def circuit
+      Circuitbox.circuit(@circuit_name, {
+        sleep_window: configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_SLEEP_WINDOW', 60).to_i,
+        time_window: configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_TIME_WINDOW', 120).to_i,
+        volume_threshold: configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_VOLUME_THRESHOLD', 50).to_i,
+        error_threshold:  configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_ERROR_THRESHOLD', 50).to_i,
+        cache: Moneta.new(:Redis, backend: Config.cache_redis),
+        exceptions: [Routemaster::Errors::FatalResource, Faraday::TimeoutError]
+      })
+    end
+
+    def configuration_setting(circuit_name, setting_name, default)
+      ENV.fetch("#{circuit_name}.#{setting_name}", ENV.fetch(setting_name, default))
+    end
+  end
+end

data/lib/routemaster/drain.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Drain
-    VERSION = '3.1.0'.freeze
+    VERSION = '3.2.0'.freeze
   end
 end

data/routemaster-drain.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency     'hashie'
   spec.add_runtime_dependency     'redis-namespace'
   spec.add_runtime_dependency     'concurrent-ruby'
+  spec.add_runtime_dependency     'circuitbox'
 end

data/spec/routemaster/api_client_circuit_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'spec/support/uses_dotenv'
+require 'spec/support/uses_redis'
+require 'spec/support/uses_webmock'
+require 'routemaster/api_client'
+require 'routemaster/api_client_circuit'
+
+describe Routemaster::APIClientCircuit do
+  uses_webmock
+  uses_redis
+
+  context "when enabled" do
+    before do
+      sb_req
+      allow_any_instance_of(described_class).to receive(:enabled?){ true }
+    end
+
+    let(:url){ 'http://example.com/foobar' }
+
+    let(:sb_req){
+      stub_request(:get, url).to_return(
+        status:   status,
+        body:     { id: 132, type: 'widget' }.to_json,
+        headers:  {
+          'content-type' => 'application/json;v=1'
+        }
+      )
+    }
+
+    def perform
+       Routemaster::APIClient.new.get(url)
+    end
+
+    context "when not erroring" do
+      let(:status) { 200 }
+
+      it "should pass through a response" do
+        expect(perform.status).to eq 200
+      end
+    end
+
+    context "when erroring" do
+      let(:status){ 500 }
+
+      it "should pass through a single error" do
+        expect{ perform }.to raise_error Routemaster::Errors::FatalResource
+        expect(sb_req).to have_been_requested
+      end
+
+      context "after lots of errors" do
+        before do
+          60.times do
+            perform rescue Routemaster::Errors::FatalResource
+          end
+        end
+        it "should limit the amount of requests" do
+          expect(a_request(:get, url)).to have_been_made.at_least_times(49)
+          expect(a_request(:get, url)).to have_been_made.at_most_times(51)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-drain
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: circuitbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - julien.letessier@gmail.com
@@ -167,6 +181,7 @@ files:
 - gemfiles/rails_5.gemfile
 - lib/core_ext/forwardable.rb
 - lib/routemaster/api_client.rb
+- lib/routemaster/api_client_circuit.rb
 - lib/routemaster/cache.rb
 - lib/routemaster/cache_key.rb
 - lib/routemaster/config.rb
@@ -209,6 +224,7 @@ files:
 - lib/routemaster/tasks/fix_cache_ttl.rb
 - routemaster-drain.gemspec
 - spec/core_ext/forwardable_spec.rb
+- spec/routemaster/api_client_circuit_spec.rb
 - spec/routemaster/api_client_spec.rb
 - spec/routemaster/cache_spec.rb
 - spec/routemaster/config_spec.rb
@@ -270,12 +286,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.0
 signing_key: 
 specification_version: 4
 summary: Event receiver for the Routemaster bus
 test_files:
 - spec/core_ext/forwardable_spec.rb
+- spec/routemaster/api_client_circuit_spec.rb
 - spec/routemaster/api_client_spec.rb
 - spec/routemaster/cache_spec.rb
 - spec/routemaster/config_spec.rb