sidekiq-circuit-breaker 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d074e1a9769464f959a32c39dc3b20a8f6511e8502eadccb6d99c7484b7c68
-  data.tar.gz: f170e39551f391ab6c18b77405f15d9565baa5587218bb9039a4dcd235949196
+  metadata.gz: e51ce2527ccdcb2cf1081f47c5e37fffed8043a264c9749dcbe6d1d6ec409e44
+  data.tar.gz: eb6f8fbd9e30cc88c18b82aa51a8474d71dbcc3ef461e5470934010371ae1c67
 SHA512:
-  metadata.gz: 6e649a734c8e66bfbb1bb4aab0003de3e44c11364e93586849c8e68acd653466490616b786eafd6e5948d2aeabe846165d529b04e1c1e23d1a3b61bf46b58def
-  data.tar.gz: 4f1cfcac2b3ab7dc87302ce00991fec7f2c1ea46db2bbae5b3a69862c43a95899ded7c88912de628da27b60a8dbd2ebfec12179d953bf0f9bb8a1b23a4983052
+  metadata.gz: 42befd4cf2b41db3690590426eefeba7548fed8cc4aab59af943eec1fb4ab75454a8cbc0496e9e6178c9e3b1add247296505367ce9c2bed90aa634d7f06d27a7
+  data.tar.gz: 1efbecc602fcebbeaa07481e2e92599ad990ef44130f7528edc30d60801c2bfac41aa3c8dcbe59c0b9a035e8cbfb220c32e2fcaa3dc7cd9fceab62ce0ad2d064

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# sidekiq-circuit-breaker changes
+
+0.1.5
+----------
+
+- Just refactoring

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-circuit-breaker (0.1.4)
+    sidekiq-circuit-breaker (0.1.5)
       sidekiq (>= 5.0.0)
 
 GEM

data/lib/sidekiq/circuit_breaker.rb

@@ -1,6 +1,7 @@
 require 'sidekiq'
-require 'sidekiq/circuit_breaker/middleware'
 require 'sidekiq/circuit_breaker/worker'
+require 'sidekiq/circuit_breaker/middleware'
+
 
 module Sidekiq
   module CircuitBreaker; end

data/lib/sidekiq/circuit_breaker/api.rb

@@ -15,6 +15,17 @@ module Sidekiq
         true
       end
 
+      def close_circuit(scope)
+        raise ArgumentError, 'scope must not be nil' if scope.nil?
+        Sidekiq.redis do |conn|
+          conn.del(open_key(scope))
+          # reset failure count
+          conn.del(failure_key(scope))
+        end
+        true
+
+      end
+
       def register_failure_for_scope(scope, ttl = 120)
         raise ArgumentError, 'scope must not be nil' if scope.nil?
         key = failure_key(scope)
@@ -36,13 +47,13 @@ module Sidekiq
         end
       end
 
-      def time_to_open_the_circuit(scope)
+      def time_to_close_the_circuit(scope)
         Sidekiq.redis do |conn|
           conn.ttl(open_key(scope))
         end
       end
 
-      def circuit_opened?(scope)
+      def circuit_open?(scope)
         Sidekiq.redis do |conn|
           conn.exists(open_key(scope))
         end

data/lib/sidekiq/circuit_breaker/manager.rb

@@ -15,7 +15,7 @@ module Sidekiq
      end
 
      def open?
-       circuit_opened?(@scope)
+       circuit_open?(@scope)
      end
 
      def closed?
@@ -30,8 +30,8 @@ module Sidekiq
        open_circuit(@scope, @options.max_open_time)
      end
 
-     def time_to_open
-       time_to_open_the_circuit(@scope)
+     def time_to_close
+       time_to_close_the_circuit(@scope)
      end
 
      def register_failure

data/lib/sidekiq/circuit_breaker/middleware.rb

@@ -1,94 +1,5 @@
-require 'sidekiq/circuit_breaker/manager'
-require 'sidekiq/circuit_breaker/middleware'
-require 'sidekiq/client'
-
-module Sidekiq
-  module CircuitBreaker
-    module Middleware
-      class Client
-        def call(worker_class, msg, queue, redis_pool)
-          begin
-            worker = constantize(worker_class)
-          rescue NameError
-            return yield
-          end
-
-          circuit_breaker = worker.respond_to?(:sidekiq_circuit_breaker_enabled?)
-          return yield unless circuit_breaker
-
-          options = worker.sidekiq_circuit_breaker_options
-          scope = extract_scope(options, msg) || worker_class
-
-          mgr = CircuitBreaker::Manager.new(scope, options)
-          if mgr.open? && msg['at'].nil?
-            msg['at'] = (Time.now + (mgr.time_to_open  + additional_seconds)).to_f
-          end
-
-          yield
-        end
-
-        private
-
-        def additional_seconds
-          rand(3..10)
-        end
-
-        private
-
-        def extract_scope(options, msg)
-          scope = options.scope
-          return scope if scope.is_a?(String)
-          return unless scope.respond_to?(:call)
-
-          options.scope.call(*msg['args'])
-        end
-
-        def constantize(str)
-          names = str.split('::')
-          names.shift if names.empty? || names.first.empty?
-
-          names.inject(Object) do |constant, name|
-            constant.const_defined?(name, false) ? constant.const_get(name, false) : constant.const_missing(name)
-          end
-        end
-      end
-
-      class Server
-        def call(worker, msg, queue)
-          circuit_breaker_enabled = worker.class.respond_to?(:sidekiq_circuit_breaker_enabled?)
-          return yield unless circuit_breaker_enabled
-
-          def worker.perform(*args)
-            manager = sidekiq_circuit_breaker_manager(args)
-
-            if manager.open?
-              begin
-                Sidekiq::Client.push(
-                  'class' => self.class,
-                  'args'  => args
-                )
-                return
-              end
-            end
-
-            super(*args)
-          end
-
-          manager = worker.sidekiq_circuit_breaker_manager(msg['args'])
-
-          begin
-            yield
-          rescue => e
-            manager.evaluate_failure
-            raise e
-          end
-
-          manager.register_success
-        end
-      end
-    end
-  end
-end
+require 'sidekiq/circuit_breaker/middleware/client'
+require 'sidekiq/circuit_breaker/middleware/server'
 
 Sidekiq.configure_client do |config|
   config.client_middleware do |chain|

data/lib/sidekiq/circuit_breaker/middleware/client.rb

@@ -0,0 +1,51 @@
+require 'sidekiq/client'
+require 'sidekiq/circuit_breaker/manager'
+require 'sidekiq/circuit_breaker/scope'
+
+module Sidekiq
+  module CircuitBreaker
+    module Middleware
+      class Client
+        include Sidekiq::CircuitBreaker::Scope
+
+        def call(worker_class, msg, queue, redis_pool)
+          begin
+            worker = constantize(worker_class)
+          rescue NameError
+            return yield
+          end
+
+          circuit_breaker = worker.respond_to?(:sidekiq_circuit_breaker_enabled?)
+          return yield unless circuit_breaker
+
+          options = worker.sidekiq_circuit_breaker_options
+          scope = extract_scope(worker_class, msg, options)
+
+          mgr = CircuitBreaker::Manager.new(scope, options)
+          if mgr.open? && msg['at'].nil?
+            msg['at'] = (Time.now + (mgr.time_to_close  + additional_seconds)).to_f
+          end
+
+          yield
+        end
+
+        private
+
+        def additional_seconds
+          rand(3..10)
+        end
+
+        private
+
+        def constantize(str)
+          names = str.split('::')
+          names.shift if names.empty? || names.first.empty?
+
+          names.inject(Object) do |constant, name|
+            constant.const_defined?(name, false) ? constant.const_get(name, false) : constant.const_missing(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/circuit_breaker/middleware/server.rb

@@ -0,0 +1,39 @@
+require 'sidekiq/circuit_breaker/scope'
+
+module Sidekiq
+  module CircuitBreaker
+    module Middleware
+      class Server
+        include Sidekiq::CircuitBreaker::Scope
+
+        def call(worker, msg, queue)
+          circuit_breaker_enabled = worker.class.respond_to?(:sidekiq_circuit_breaker_enabled?)
+          return yield unless circuit_breaker_enabled
+
+          options = worker.class.sidekiq_circuit_breaker_options
+          scope   = extract_scope(worker.class.name, msg, options)
+          manager = Manager.new(scope, options)
+          resquedule_job(worker, msg) and return if manager.open?
+
+          begin
+            yield
+          rescue => e
+            manager.evaluate_failure
+            raise e
+          end
+
+          manager.register_success
+        end
+
+        def resquedule_job(worker, msg)
+          Sidekiq::Client.push(
+            'class' => worker.class.name,
+            'args'  => msg['args']
+          )
+        end
+      end
+    end
+  end
+end
+
+

data/lib/sidekiq/circuit_breaker/scope.rb

@@ -0,0 +1,18 @@
+module Sidekiq
+  module CircuitBreaker
+    module Scope
+      def extract_scope(worker_class_name, msg, options)
+        from_setup =
+          begin
+            scope = options.scope
+            return scope if scope.is_a?(String)
+            return unless scope.respond_to?(:call)
+
+            options.scope.call(*msg['args'])
+          end
+
+        from_setup || worker_class_name
+      end
+    end
+  end
+end

data/lib/sidekiq/circuit_breaker/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module CircuitBreaker
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

data/lib/sidekiq/circuit_breaker/worker.rb

@@ -7,28 +7,6 @@ module Sidekiq
         base.extend(ClassMethods)
       end
 
-      def sidekiq_circuit_breaker_manager(args)
-        options = self.class.sidekiq_circuit_breaker_options
-        scope = scope(args)
-        CircuitBreaker::Manager.new(scope, options)
-      end
-
-      private
-
-      def scope(args)
-        options = self.class.sidekiq_circuit_breaker_options
-        extract_scope(options, args) || self.class.name
-      end
-
-      def extract_scope(options, args)
-        scope = options.scope
-        return scope if scope.is_a?(String)
-        return unless scope.respond_to?(:call)
-
-        options.scope.call(*args)
-      end
-
-
       module ClassMethods
         def sidekiq_circuit_breaker_enabled?
           true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-circuit-breaker
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-04 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -88,6 +89,9 @@ files:
 - lib/sidekiq/circuit_breaker/configuration.rb
 - lib/sidekiq/circuit_breaker/manager.rb
 - lib/sidekiq/circuit_breaker/middleware.rb
+- lib/sidekiq/circuit_breaker/middleware/client.rb
+- lib/sidekiq/circuit_breaker/middleware/server.rb
+- lib/sidekiq/circuit_breaker/scope.rb
 - lib/sidekiq/circuit_breaker/version.rb
 - lib/sidekiq/circuit_breaker/worker.rb
 - sidekiq-circuit-breaker.gemspec