circuitbox 2.0.0.pre1 → 2.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b0453c7aac74192f9ecfe6e1409cd18f11dcc186deac73eeff80b1d8e8b948
-  data.tar.gz: 390bebb8b034c0d40de18d35aaa2785ba40bef371fe282fc0f3a726f176d7483
+  metadata.gz: 8b5dd933e4972d92fa8a3715fb5546b99442f50ca34056a4fe90faec5586377d
+  data.tar.gz: 3391ed4af7fbb92abfebd1f95f814d6c2dac42752a45f0cf001f57ffc2f8ee42
 SHA512:
-  metadata.gz: d9cb247b2544c06f9223457ea52a9c67453c3994a7f441597c1cc3f20d39c4219cbda02c9a944255cbe7d96d8052d2d9fc3b3fe292ae9a7ee0cea6091026396d
-  data.tar.gz: e9aef10565a19824743a88698ea82c6756e2e2d55c5941f1b919c4cf9c8979cc7731d1ce07d3b3d73af6b2adc49e7ae29e75d8bf7a50af6fc472482874490ea8
+  metadata.gz: de9aede3e20400e85a98b821b5cc56034effd8dac20ff8486ef51c8de48019b16a3e4ee152b2509029e5fd1ba7432875d745343b88998a3c971bf470bc60e81c
+  data.tar.gz: 716dc649ca0f3da37a7de004f2609ddee6fbdb0d217dab1fe9d6835ab24224957b1b8ce0b5da916ae21e905f8578fa771c613be7433d4e260beee480f5eb5023

data/README.md

@@ -10,7 +10,7 @@ Resources about the circuit breaker pattern:
 ## Usage
 
 ```ruby
-Circuitbox[:your_service, exceptions: [Net::ReadTimeout]] do
+Circuitbox.circuit(:your_service, exceptions: [Net::ReadTimeout]) do
   Net::HTTP.get URI('http://example.com/api/messages')
 end
 ```

data/lib/circuitbox.rb

@@ -12,11 +12,7 @@ class Circuitbox
   class << self
     include Configuration
 
-    def [](service_name, options = {})
-      circuit(service_name, options)
-    end
-
-    def circuit(service_name, options = {})
+    def circuit(service_name, options)
       circuit = (cached_circuits[service_name] ||= CircuitBreaker.new(service_name, options))
 
       return circuit unless block_given?

data/lib/circuitbox/circuit_breaker.rb

@@ -53,7 +53,7 @@ class Circuitbox
     end
 
     def run(circuitbox_exceptions: true)
-      if open_flag?
+      if open?
         skipped!
         raise Circuitbox::OpenCircuitError.new(service) if circuitbox_exceptions
       else
@@ -78,11 +78,7 @@ class Circuitbox
     end
 
     def open?
-      if open_flag?
-        true
-      else
-        false
-      end
+      circuit_store.key?(open_storage_key)
     end
 
     def error_rate(failures = failure_count, success = success_count)
@@ -123,7 +119,7 @@ class Circuitbox
 
     def half_open_failure
       @state_change_mutex.synchronize do
-        return if open_flag? || !half_open?
+        return if open? || !half_open?
 
         trip
       end
@@ -135,7 +131,7 @@ class Circuitbox
 
     def open!
       @state_change_mutex.synchronize do
-        return if open_flag?
+        return if open?
 
         trip
       end
@@ -160,7 +156,7 @@ class Circuitbox
         # If the circuit is not open, the half_open key will be deleted from the store
         # if half_open exists the deleted value is returned and allows us to continue
         # if half_open doesn't exist nil is returned, causing us to return early
-        return unless !open_flag? && circuit_store.delete(half_open_storage_key)
+        return unless !open? && circuit_store.delete(half_open_storage_key)
       end
 
       # Running event outside of the synchronize block to allow other threads
@@ -169,23 +165,19 @@ class Circuitbox
       logger.debug(circuit_closed_message)
     end
 
-    def open_flag?
-      circuit_store.key?(open_storage_key)
-    end
-
     def half_open?
       circuit_store.key?(half_open_storage_key)
     end
 
     def success!
-      notify_and_increment_event('success')
+      increment_and_notify_event('success')
       logger.debug(circuit_success_message)
 
       close! if half_open?
     end
 
     def failure!
-      notify_and_increment_event('failure')
+      increment_and_notify_event('failure')
       logger.debug(circuit_failure_message)
 
       if half_open?
@@ -205,10 +197,10 @@ class Circuitbox
       notifier.notify(service, event)
     end
 
-    # Send notification and increment stat store
-    def notify_and_increment_event(event)
-      notify_event(event)
+    # Increment stat store and send notification
+    def increment_and_notify_event(event)
       circuit_store.increment(stat_storage_key(event), 1, expires: (option_value(:time_window) * 2))
+      notify_event(event)
     end
 
     def check_sleep_window

data/lib/circuitbox/configuration.rb

@@ -1,4 +1,6 @@
 require_relative 'memory_store'
+require_relative 'timer/monotonic'
+require_relative 'timer/null'
 require_relative 'timer/simple'
 require_relative 'notifier/active_support'
 require_relative 'notifier/null'

data/lib/circuitbox/memory_store.rb

@@ -1,6 +1,6 @@
-# frozen-string-literal: true
+# frozen_string_literal: true
 
-require_relative 'memory_store/compactor'
+require_relative 'memory_store/monotonic_time'
 require_relative 'memory_store/container'
 
 class Circuitbox
@@ -10,7 +10,8 @@ class Circuitbox
     def initialize(compaction_frequency: 60)
       @store = {}
       @mutex = Mutex.new
-      @compactor = Compactor.new(store: @store, frequency: compaction_frequency)
+      @compaction_frequency = compaction_frequency
+      @compact_after = current_second + compaction_frequency
     end
 
     def store(key, value, opts = {})
@@ -53,13 +54,15 @@ class Circuitbox
   private
 
     def fetch_container(key)
-      @compactor.run
+      current_time = current_second
+
+      compact(current_time) if @compact_after < current_time
 
       container = @store[key]
 
       return unless container
 
-      if container.expired?
+      if container.expired_at?(current_time)
         @store.delete(key)
         nil
       else
@@ -72,5 +75,10 @@ class Circuitbox
       return unless container
       container.value
     end
+
+    def compact(current_time)
+      @store.delete_if { |_, value| value.expired_at?(current_time) }
+      @compact_after = current_time + @compaction_frequency
+    end
   end
 end

data/lib/circuitbox/version.rb

@@ -1,3 +1,3 @@
 class Circuitbox
-  VERSION = '2.0.0.pre1'.freeze
+  VERSION = '2.0.0.pre2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuitbox
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre1
+  version: 2.0.0.pre2
 platform: ruby
 authors:
 - Fahim Ferdous
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,6 @@ files:
 - lib/circuitbox/excon_middleware.rb
 - lib/circuitbox/faraday_middleware.rb
 - lib/circuitbox/memory_store.rb
-- lib/circuitbox/memory_store/compactor.rb
 - lib/circuitbox/memory_store/container.rb
 - lib/circuitbox/memory_store/monotonic_time.rb
 - lib/circuitbox/notifier/active_support.rb

data/lib/circuitbox/memory_store/compactor.rb

@@ -1,35 +0,0 @@
-# frozen-string-literal: true
-
-require_relative 'monotonic_time'
-
-class Circuitbox
-  class MemoryStore
-    class Compactor
-      include MonotonicTime
-
-      attr_reader :store, :frequency, :compact_after
-
-      def initialize(store:, frequency:)
-        @store = store
-        @frequency = frequency
-        set_next_compaction_time
-      end
-
-      def run
-        compaction_attempted_at = current_second
-
-        return unless compact_after < compaction_attempted_at
-
-        @store.delete_if { |_, value| value.expired_at?(compaction_attempted_at) }
-
-        set_next_compaction_time
-      end
-
-    private
-
-      def set_next_compaction_time
-        @compact_after = current_second + frequency
-      end
-    end
-  end
-end