sidekiq-circuit-breaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01760e5030cfb4c3d6032deed7cc1747c6d5c955d9fc021ce0b2b7ee97a9f908
+  data.tar.gz: f79eb83bf8fdfd2221b73484b62309d976810faa99b4641f4ca5552ff2d3c786
+SHA512:
+  metadata.gz: 1931812d56c30710e8107152ee9ad9dc2b6174d12f090ed3d9c5aa0f6eac3c99604dd21791510175e9c6c2db5eed7adb36d899804c28ddb4128f90df258ffdd3
+  data.tar.gz: 268d6a3d12d94a6426de7528c373aa1df68092fa8e943dca216c4df18aabf9fbd9a49901f42c606ed0eb342d5dcb161ce3a276d0852dd97ed7076606c024b4f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-circuitbreaker.gemspec
+gemspec
+
+gem 'pry'
+gem 'activesupport'
+
+# Gemfile
+group :test do
+  gem 'rspec-sidekiq'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-circuit-breaker (0.1.0)
+      sidekiq (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-protection (2.0.3)
+      rack
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-sidekiq (3.0.3)
+      rspec-core (~> 3.0, >= 3.0.0)
+      sidekiq (>= 2.4.0)
+    rspec-support (3.7.1)
+    sidekiq (5.1.3)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-sidekiq
+  sidekiq-circuit-breaker!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nando Sousa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-circuitbreaker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-circuitbreaker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-circuitbreaker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/circuitbreaker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/circuit_breaker/api.rb

@@ -0,0 +1,72 @@
+require 'sidekiq'
+
+module Sidekiq
+  module CircuitBreaker
+    module API
+      extend self
+
+      def open_circuit(scope, ttl = 120)
+        raise ArgumentError, 'scope must not be nil' if scope.nil?
+        Sidekiq.redis do |conn|
+          conn.setex(open_key(scope), ttl, 0)
+          # 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)
+
+        _, failure_count = Sidekiq.redis do |conn|
+          conn.multi do
+            conn.expire(key, ttl)
+            conn.incr(key)
+          end
+        end
+
+        failure_count
+      end
+
+      def register_success_for_scope(scope)
+        raise ArgumentError, 'scope must not be nil' if scope.nil?
+        Sidekiq.redis do |conn|
+          conn.del(failure_key(scope), open_key(scope))
+        end
+      end
+
+      def time_to_open_the_circuit(scope)
+        Sidekiq.redis do |conn|
+          conn.ttl(open_key(scope))
+        end
+      end
+
+      def circuit_opened?(scope)
+        Sidekiq.redis do |conn|
+          conn.exists(open_key(scope))
+        end
+      end
+
+      def failure_count_for_scope(scope)
+        Sidekiq.redis do |conn|
+          conn.get(failure_key(scope))
+        end.to_i
+      end
+
+      private
+
+      def redis_key(suffix)
+        "sidekiq:circuit_breaker:#{suffix}"
+      end
+
+      def open_key(scope)
+        redis_key("open:#{scope}")
+      end
+
+      def failure_key(scope)
+        redis_key("failure:#{scope}")
+      end
+    end
+  end
+end

data/lib/sidekiq/circuit_breaker/configuration.rb

@@ -0,0 +1,19 @@
+module Sidekiq
+  module CircuitBreaker
+    class Configuration
+      attr_reader :scope
+
+      attr_accessor :failure_threshold
+      attr_accessor :max_open_time
+
+      def initialize
+        self.failure_threshold = 7
+        self.max_open_time     = 120
+      end
+
+      def set_scope(identifier = nil)
+        @scope = identifier
+      end
+    end
+  end
+end

data/lib/sidekiq/circuit_breaker/manager.rb

@@ -0,0 +1,54 @@
+require 'sidekiq/circuit_breaker/api'
+
+module Sidekiq
+  module CircuitBreaker
+   class Manager
+
+     def initialize(scope, options)
+       @scope = scope
+       @options = options
+     end
+
+     def evaluate_failure
+      count = register_failure
+      open if count >= @options.failure_threshold
+     end
+
+     def open?
+       circuit_opened?(@scope)
+     end
+
+     def closed?
+       !open?
+     end
+
+     def failure_count
+       failure_count_for_scope(@scope)
+     end
+
+     def open
+       open_circuit(@scope, @options.max_open_time)
+     end
+
+     def time_to_open
+       time_to_open_the_circuit(@scope)
+     end
+
+     def register_failure
+       register_failure_for_scope(@scope)
+     end
+
+     def failure_count
+       failure_count_for_scope(@scope)
+     end
+
+     def register_success
+       register_success_for_scope(@scope)
+     end
+
+     private
+
+     include Sidekiq::CircuitBreaker::API
+   end
+  end
+end

data/lib/sidekiq/circuit_breaker/middleware.rb

@@ -0,0 +1,95 @@
+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)
+          worker = constantize(worker_class)
+          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).to_f
+          end
+
+          yield
+        end
+
+        private
+
+        def extract_scope(options, msg)
+          scope = options.scope
+          return scope if scope.is_a?(String)
+
+          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.respond_to?(:sidekiq_circuit_breaker_enabled?)
+          return 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
+
+          options = worker.class.sidekiq_circuit_breaker_options
+          manager = worker.sidekiq_circuit_breaker_manager(args, options)
+
+          begin
+            yield
+          rescue Exception => e
+            manager.evaluate_failure
+            raise e
+          end
+
+          manager.register_success
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::CircuitBreaker::Middleware::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::CircuitBreaker::Middleware::Client
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::CircuitBreaker::Middleware::Server
+  end
+end

data/lib/sidekiq/circuit_breaker/version.rb

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

data/lib/sidekiq/circuit_breaker/worker.rb

@@ -0,0 +1,46 @@
+require 'sidekiq/circuit_breaker/configuration'
+
+module Sidekiq
+  module CircuitBreaker
+    module Worker
+      def self.included(base)
+        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)
+
+        options.scope.call(*args)
+      end
+
+
+      module ClassMethods
+        def sidekiq_circuit_breaker_enabled?
+          true
+        end
+
+        def sidekiq_circuit_breaker
+          yield(sidekiq_circuit_breaker_options) if block_given?
+        end
+
+        def sidekiq_circuit_breaker_options
+          @@setup ||= Sidekiq::CircuitBreaker::Configuration.new
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/circuit_breaker.rb

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

data/sidekiq-circuit-breaker.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/circuit_breaker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-circuit-breaker"
+  spec.version       = Sidekiq::CircuitBreaker::VERSION
+  spec.authors       = ["Nando Sousa"]
+  spec.email         = ["nandosousafr@gmail.com"]
+
+  spec.summary       = 'Circuit Breaker functionality to Sidekiq' 
+  spec.description   = 'Circuit Breaker functionality to Sidekiq'
+  spec.homepage      = 'http://shipit.resultadosdigitais.com.br/open-source/'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '>= 5.0.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-circuit-breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Sousa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Circuit Breaker functionality to Sidekiq
+email:
+- nandosousafr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/circuit_breaker.rb
+- lib/sidekiq/circuit_breaker/api.rb
+- lib/sidekiq/circuit_breaker/configuration.rb
+- lib/sidekiq/circuit_breaker/manager.rb
+- lib/sidekiq/circuit_breaker/middleware.rb
+- lib/sidekiq/circuit_breaker/version.rb
+- lib/sidekiq/circuit_breaker/worker.rb
+- sidekiq-circuit-breaker.gemspec
+homepage: http://shipit.resultadosdigitais.com.br/open-source/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Circuit Breaker functionality to Sidekiq
+test_files: []