sidekiq-circuit-breaker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01760e5030cfb4c3d6032deed7cc1747c6d5c955d9fc021ce0b2b7ee97a9f908
-  data.tar.gz: f79eb83bf8fdfd2221b73484b62309d976810faa99b4641f4ca5552ff2d3c786
+  metadata.gz: aae6bd24fc3af2bdfeb344bacc69ec93e6f4175150b1115a03fda4afa9100a2c
+  data.tar.gz: fbe37e0353ed5b7a7511d356e2109bc3df69d50cfd9ad1c495496580bd3b1e37
 SHA512:
-  metadata.gz: 1931812d56c30710e8107152ee9ad9dc2b6174d12f090ed3d9c5aa0f6eac3c99604dd21791510175e9c6c2db5eed7adb36d899804c28ddb4128f90df258ffdd3
-  data.tar.gz: 268d6a3d12d94a6426de7528c373aa1df68092fa8e943dca216c4df18aabf9fbd9a49901f42c606ed0eb342d5dcb161ce3a276d0852dd97ed7076606c024b4f4
+  metadata.gz: 69e364ebd646ce52632043ff1839c20165cfb2a16051a41eacefe8d74f7f20f5e50ceb5f63c85914a3ddf49dcfbbd381a2da7422a6849b7d5133446766799401
+  data.tar.gz: 3a4b270002105a6edb203bbbe66bbcdc3cd4745c6af682d1157cee89725013e0190bf3e3d552f370bb0d795627577d8247d337b76b27864e76c47949cda6edd5

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/README.md

@@ -1,15 +1,15 @@
-# Sidekiq::Circuitbreaker
+# Sidekiq::CircuitBreaker
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq/circuitbreaker`. To experiment with that code, run `bin/console` for an interactive prompt.
+CircuitBreaker is a Sidekiq plugin that adds circuit breaker functionality.
 
-TODO: Delete this and the text above, and describe your gem
+Based on [Circuit Breaker pattern](https://docs.microsoft.com/en-us/azure/architecture/patterns/circuit-breaker).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sidekiq-circuitbreaker'
+gem 'sidekiq-circuit-breaker', require: 'sidekiq/circuit_breaker'
 ```
 
 And then execute:
@@ -18,11 +18,43 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install sidekiq-circuitbreaker
+    $ gem install sidekiq-circuit-breaker
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say you have a Worker called WebhookNotificationJob, that basically sends webhook notifications to extenal customer endpoints.
+
+```ruby
+class WebhookNotificationJob
+  include Sidekiq::Worker
+  
+  def perform(endpoint, payload)
+    post_to_endpoint(endpoint, body: payload)
+  end
+end  
+```
+
+The problem of this is when some endpoint start to respond with errors or take to long to respond, the overall queue latency increases significantly.
+
+With this gem you can apply CircuiBreaker pattern like this:
+
+```ruby
+class WebhookNotificationJob
+  include Sidekiq::Worker
+  include Sidekiq::CircuitBreaker::Worker
+  
+  sidekiq_circuit_breaker do |config|
+    config.set_scope ->(endpoint, _payload) do
+      uri = URI.parse(endpoint)
+      uri.hostname #=> The scope will be only the hostname i.e: google.com
+    end
+  end
+    
+  def perform(endpoint, payload)
+    post_to_endpoint(endpoint, payload)
+  end
+end
+```
 
 ## Development
 
@@ -32,7 +64,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-circuitbreaker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ResultadosDigitais/sidekiq-circuitbreaker.
 
 ## License
 

data/lib/sidekiq/circuit_breaker/middleware.rb

@@ -16,7 +16,7 @@ module Sidekiq
 
           mgr = CircuitBreaker::Manager.new(scope, options)
           if mgr.open? && msg['at'].nil?
-            msg['at'] = (Time.now + mgr.time_to_open).to_f
+            msg['at'] = (Time.now + mgr.time_to_open + rand(10)).to_f
           end
 
           yield
@@ -43,8 +43,8 @@ module Sidekiq
 
       class Server
         def call(worker, msg, queue)
-          circuit_breaker_enabled = worker.respond_to?(:sidekiq_circuit_breaker_enabled?)
-          return unless circuit_breaker_enabled
+          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)
@@ -62,12 +62,11 @@ module Sidekiq
             super(*args)
           end
 
-          options = worker.class.sidekiq_circuit_breaker_options
-          manager = worker.sidekiq_circuit_breaker_manager(args, options)
+          manager = worker.sidekiq_circuit_breaker_manager(msg['args'])
 
           begin
             yield
-          rescue Exception => e
+          rescue => e
             manager.evaluate_failure
             raise e
           end

data/lib/sidekiq/circuit_breaker/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module CircuitBreaker
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-circuit-breaker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nando Sousa