circuitbox 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0fe08dafcf12318b2880700034caf98461a2f3e
-  data.tar.gz: f136784e4d4d32ffa0b53580fb64eded3bf4d5ba
+  metadata.gz: 38c8cdbfef9e769dd2ad65c59905a6c7f1c9bad1
+  data.tar.gz: e7ed610ab1231ff949b4549a6cec911b61690431
 SHA512:
-  metadata.gz: 0e2870b5f3b3cffd2623f04937be7794fe2ee0085655b65b2533da3ba421e9e7772c4b85593097f300aa4f0984b484f590a8811eb22b667a31e7a8d81c9070d2
-  data.tar.gz: c98b3b8e64b4def135717ae7eedb833807d4a484cb6772d284c38c08cb992013a8adc64041ffaddb529fdfecda187287160216467940b63c252a5d3ce765bcb7
+  metadata.gz: 82ba7ae27fabb672864ba38c4678c0b37a2bb08104103fc67ed3f8eb9f36973105d6fe5eae03d8dcd2e42f297371f7e87775b8ddf409ea35e0ddddcdce57a0b7
+  data.tar.gz: b7b4fe13bb21d1978e620b481d188f475b78b4e9809ca59f6f9ef5b12839114b3f358e0136a6ab3e23a2e993358c5701a0d9f962cf010d8bd735d1614aa61956

data/README.md

@@ -190,7 +190,7 @@ Circuitbox.circuit :identifier, cache: Moneta.new(:Memory)
 
 ### LMDB
 
-An persisted directory backed store, which is thread and multi process save.
+An persisted directory backed store, which is thread and multi process safe.
 depends on the `lmdb` gem. It is slower than Memory or Daybreak, but can be
 used in multi thread and multi process environments like like Puma.
 
@@ -204,7 +204,7 @@ Circuitbox.circuit :identifier, cache: Moneta.new(:LMDB, dir: "./", db: "mydb")
 An persisted file backed store, which comes with the ruby
 [stdlib](http://ruby-doc.org/stdlib-2.3.0/libdoc/pstore/rdoc/PStore.html). It
 has no external dependecies and works on every ruby implementation. Due to it
-being file backed it is multi process save, good for development using Unicorn.
+being file backed it is multi process safe, good for development using Unicorn.
 
 ```ruby
 Circuitbox.circuit :identifier, cache: Moneta.new(:PStore, file: "db.pstore")
@@ -212,7 +212,7 @@ Circuitbox.circuit :identifier, cache: Moneta.new(:PStore, file: "db.pstore")
 
 ### Daybreak
 
-Persisted, file backed key value store in pure ruby. It is process save and
+Persisted, file backed key value store in pure ruby. It is process safe and
 outperforms most other stores in circuitbox. This is recommended for production
 use with Unicorn. It depends on the `daybreak` gem.
 
@@ -295,8 +295,9 @@ c.use Circuitbox::FaradayMiddleware, open_circuit: lambda { |response| response.
 ```
 
 ## CHANGELOG
-
 ### version next
+
+### v0.11.0
 - fix URI require missing (https://github.com/yammer/circuitbox/pull/42 @gottfrois)
 - configurable circuitbox store backend via Moneta supporting multi process circuits
 

data/benchmark/circuit_store_benchmark.rb

@@ -27,9 +27,7 @@ def service
 end
 
 def run_flip_flopping circuit
-  before = circuit.open?
   circuit.run { service }
-  after = circuit.open?
   circuit.try_close_next_time if circuit.open?
 end
 

data/lib/circuitbox.rb

@@ -16,7 +16,7 @@ require 'circuitbox/errors/open_circuit_error'
 require 'circuitbox/errors/service_failure_error'
 
 class Circuitbox
-  attr_accessor :circuits, :circuit_store, :stat_store
+  attr_accessor :circuits, :circuit_store
   cattr_accessor :configure
 
   def self.instance
@@ -44,14 +44,6 @@ class Circuitbox
     self.instance.circuit_store = store
   end
 
-  def self.stat_store
-    self.instance.stat_store
-  end
-
-  def self.stat_store=(store)
-    self.instance.stat_store = store
-  end
-
   def self.[](service_identifier, options = {})
     self.circuit(service_identifier, options)
   end

data/lib/circuitbox/circuit_breaker.rb

@@ -1,7 +1,7 @@
 class Circuitbox
   class CircuitBreaker
     attr_accessor :service, :circuit_options, :exceptions, :partition,
-                  :logger, :stat_store, :circuit_store, :notifier
+                  :logger, :circuit_store, :notifier
 
     DEFAULTS = {
       sleep_window:     300,
@@ -31,7 +31,6 @@ class Circuitbox
       @exceptions = [Timeout::Error] if @exceptions.blank?
 
       @logger     = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @stat_store = options.fetch(:stat_store) { Circuitbox.stat_store }
       @time_class   = options.fetch(:time_class) { Time }
       sanitize_options
     end
@@ -91,26 +90,6 @@ class Circuitbox
       end
     end
 
-    def stats(partition)
-      @partition = partition
-      options = { without_partition: @partition.blank? }
-
-      stats = []
-      end_time = Time.now
-      hour = 48.hours.ago.change(min: 0, sec: 0)
-      while hour <= end_time
-        time_object = hour
-
-        60.times do |i|
-          time = time_object.change(min: i, sec: 0).to_i
-          stats << stats_for_time(time, options) unless time > Time.now.to_i
-        end
-
-        hour += 3600
-      end
-      stats
-    end
-
     def error_rate(failures = failure_count, success = success_count)
       all_count = failures + success
       return 0.0 unless all_count > 0
@@ -194,11 +173,6 @@ class Circuitbox
     def log_event(event)
       notifier.new(service,partition).notify(event)
       log_event_to_process(event)
-
-      if stat_store.present?
-        log_event_to_stat_store(stat_storage_key(event))
-        log_event_to_stat_store(stat_storage_key(event, without_partition: true))
-      end
     end
 
     def log_metrics(error_rate, failures, successes)
@@ -217,7 +191,7 @@ class Circuitbox
       end
     end
 
-    # When there is a successful response within a stat interval, clear the failures.
+    # When there is a successful response within a count interval, clear the failures.
     def clear_failures!
       circuit_store.store(stat_storage_key(:failure), 0, raw: true)
     end
@@ -251,6 +225,7 @@ class Circuitbox
       storage_key(:stats, align_time_on_minute, event, options)
     end
 
+
     # return time representation in seconds
     def align_time_on_minute(time=nil)
       time      ||= @time_class.now.to_i
@@ -278,12 +253,5 @@ class Circuitbox
       Circuitbox.reset
     end
 
-    def stats_for_time(time, options = {})
-      stats = { time: align_time_on_minute(time) }
-      [:success, :failure, :open].each do |event|
-        stats[event] = stat_store.read(storage_key(:stats, time, event, options), raw: true) || 0
-      end
-      stats
-    end
   end
 end

data/lib/circuitbox/faraday_middleware.rb

@@ -21,10 +21,18 @@ class Circuitbox
 
     attr_reader :opts
 
+    DEFAULT_CIRCUITBOX_OPTIONS = {
+      open_circuit: lambda do |response|
+        # response.status:
+        # nil -> connection could not be established, or failed very hard
+        # 5xx -> non recoverable server error, oposed to 4xx which are client errors
+        response.status.nil? || (500 <= response.status && response.status <= 599)
+      end
+    }
+
     def initialize(app, opts = {})
       @app = app
-      default_options = { open_circuit: lambda { |response| !response.success? } }
-      @opts = default_options.merge(opts)
+      @opts = DEFAULT_CIRCUITBOX_OPTIONS.merge(opts)
       super(app)
     end
 
@@ -101,5 +109,6 @@ class Circuitbox
       id = identifier.respond_to?(:call) ? identifier.call(env) : identifier
       circuitbox.circuit id, circuit_breaker_options
     end
+
   end
 end

data/lib/circuitbox/version.rb

@@ -1,3 +1,3 @@
 class Circuitbox
-VERSION='0.11.0'
+VERSION='1.0.0'
 end

data/test/circuitbox_test.rb

@@ -6,16 +6,6 @@ describe Circuitbox do
   before { Circuitbox.reset }
   after { Circuitbox.reset }
 
-  describe "Circuitbox.configure" do
-    it "configures instance variables on init" do
-      Circuitbox.configure do
-        self.stat_store = "hello"
-      end
-
-      assert_equal "hello", Circuitbox.stat_store
-    end
-  end
-
   describe "Circuitbox.circuit_store" do
     it "is configurable" do
       example_store = Circuitbox::ExampleStore.new
@@ -24,14 +14,6 @@ describe Circuitbox do
     end
   end
 
-  describe "Circuitbox.stat_store" do
-    it "is configurable" do
-      example_store = Circuitbox::ExampleStore.new
-      Circuitbox.stat_store = example_store
-      assert_equal example_store, Circuitbox[:yammer].stat_store
-    end
-  end
-
   describe "Circuitbox[:service]" do
     it "delegates to #circuit" do
       Circuitbox.expects(:circuit).with(:yammer, {})

data/test/faraday_middleware_test.rb

@@ -64,21 +64,43 @@ class Circuitbox
     def test_overridde_success_response
       env = { url: "url" }
       app = gimme
-      give(app).call(anything) { Faraday::Response.new(status: 400) }
-      error_response = lambda { |response| response.status >= 500 }
+      give(app).call(anything) { Faraday::Response.new(status: 500) }
+      error_response = lambda { |response|  false }
       response = FaradayMiddleware.new(app, open_circuit: error_response).call(env)
       assert_kind_of Faraday::Response, response
-      assert_equal response.status, 400
+      assert_equal response.status, 500
       assert response.finished?
       refute response.success?
     end
 
     def test_default_success_response
+      env = { url: "url" }
+      app = gimme
+      give(app).call(anything) { Faraday::Response.new(status: 500) }
+      response = FaradayMiddleware.new(app).call(env)
+      assert_kind_of Faraday::Response, response
+      assert_equal response.status, 503
+      assert response.finished?
+      refute response.success?
+    end
+
+    def test_default_open_circuit_does_not_trip_on_400
       env = { url: "url" }
       app = gimme
       give(app).call(anything) { Faraday::Response.new(status: 400) }
       response = FaradayMiddleware.new(app).call(env)
       assert_kind_of Faraday::Response, response
+      assert_equal response.status, 400
+      assert response.finished?
+      refute response.success?
+    end
+
+    def test_default_open_circuit_does_trip_on_nil
+      env = { url: "url" }
+      app = gimme
+      give(app).call(anything) { Faraday::Response.new(status: nil) }
+      response = FaradayMiddleware.new(app).call(env)
+      assert_kind_of Faraday::Response, response
       assert_equal response.status, 503
       assert response.finished?
       refute response.success?

data/test/integration/circuitbox_cross_process_open_test.rb

@@ -4,7 +4,6 @@ require "typhoeus/adapters/faraday"
 require "pstore"
 
 class Circuitbox
-
   class CrossProcessTest < Minitest::Test
     include IntegrationHelpers
 
@@ -21,16 +20,17 @@ class Circuitbox
           circuit_breaker_options: { cache: Moneta.new(:PStore, file: dbfile) }
         c.adapter :typhoeus # support in_parallel
       end
-      @failure_url = "http://localhost:4713"
+      @failure_url = "http://127.0.0.1:4713"
 
       if !@@only_once
-        thread = Thread.new do
-          Rack::Handler::WEBrick.run(Proc.new { |env| ["Failure"] },
+        pid = fork do
+          Rack::Handler::WEBrick.run(lambda { |env| [500, {}, ["Failure"]] },
                                      Port: 4713,
                                      AccessLog: [],
                                      Logger: WEBrick::Log.new(DEV_NULL))
         end
-        Minitest.after_run { thread.exit }
+        sleep 0.5
+        Minitest.after_run { Process.kill "KILL", pid }
       end
     end
 
@@ -44,6 +44,7 @@ class Circuitbox
         con = Faraday.new do |c|
           c.use FaradayMiddleware, identifier: "circuitbox_test_cross_process",
             circuit_breaker_options: { cache: Moneta.new(:PStore, file: dbfile) }
+          c.adapter :typhoeus
         end
         open_circuit(con)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuitbox
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Fahim Ferdous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -261,7 +261,6 @@ files:
 - lib/circuitbox/notifier.rb
 - lib/circuitbox/railtie.rb
 - lib/circuitbox/version.rb
-- lib/tasks/circuits.rake
 - test/circuit_breaker_test.rb
 - test/circuitbox_test.rb
 - test/excon_middleware_test.rb

data/lib/tasks/circuits.rake

@@ -1,12 +0,0 @@
-namespace :circuits do
-  task :stats => :environment do
-    service = ENV['SERVICE']
-    partition_key = ENV['PARTITION']
-
-    if service.blank?
-      raise "You must specify a SERVICE env variable, eg. `bundle exec rake circuits:stats SERVICE=yammer`"
-    else
-      pp Circuitbox::CircuitBreaker.new(service).stats(partition_key)
-    end
-  end
-end