sidekiq-seize 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 306817cefcf71a2056aa390838be117d7d430bf8a40a0396ad8835e06ba658fc
+  data.tar.gz: f503a9231d785f0b49189a7d3069ecea50a595437d9f9b916587259b163bd021
+SHA512:
+  metadata.gz: a4025302917611d5193eba6b8eca4a6c6b7bbf42d3961e00dbc781e398df972685783c1ef0dfec619ccdddef0c00e80bb1084477377dda33e71cefcb828a9374
+  data.tar.gz: d5821e5c30d3eb8b27718479409caf3faf053d798414a26751bd2d381e36441f5bc8236e6bab374c72162448a32019a4ecebf3bac72297a0cf7c285fc25845d5

data/.gitignore

@@ -0,0 +1,7 @@
+tmp
+gemfiles/*.lock
+Gemfile.lock
+.ruby-version
+pkg
+/.bundle
+.idea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+group :test do
+  gem 'rspec', '~> 3.6'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Synaptic
+
+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,40 @@
+# sidekiq-seize
+
+Sidekiq middleware that allows capturing exceptions and throwing only after last retry, useful for integrations with sentry, airbrake, rollbar, honeybadger etc, when you don't want to raise exceptions on each retry.
+
+#### Installation
+
+```
+$ gem install sidekiq-seize
+```
+
+### Worker example
+
+``` ruby
+  class MyWorker
+    include Sidekiq::Worker
+    sidekiq_options seize: true
+
+    def perform(params)
+      ...
+    end
+  end
+```
+
+
+Seize only when certain types of exceptions occur
+
+``` ruby
+  class MyWorker
+    include Sidekiq::Worker
+    sidekiq_options seize: true, seize_exceptions_classes: [ActiveRecord::Deadlocked]
+
+    def perform(params)
+      ...
+    end
+  end
+```
+
+#### Implementation Details
+
+This middleware inherits from sidekiq `JobRetry` middleware, all exceptions in each retry until the final retry are captured and job is manually put into retry. For the last retry exception is raised naturally. 

data/Rakefile

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

data/lib/sidekiq-seize.rb

@@ -0,0 +1,7 @@
+require 'sidekiq'
+require 'sidekiq/job_retry'
+require 'sidekiq/middleware/server/seize'
+
+::Sidekiq.server_middleware do |chain|
+  chain.insert_before(::Sidekiq::JobRetry, Sidekiq::Middleware::Server::Seize)
+end

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

@@ -0,0 +1,61 @@
+require 'sidekiq'
+require 'sidekiq/util'
+require 'sidekiq/api'
+require 'sidekiq/job_retry'
+
+module Sidekiq
+  module Middleware
+    module Server
+      class Seize < ::Sidekiq::JobRetry
+
+        def call(worker, job, queue)
+          yield
+        rescue StandardError => e
+          options = worker.sidekiq_options_hash || {}
+          bubble_exception(options, job, e)
+          attempt_retry(worker, job, queue, e)
+        end
+
+        private
+
+        def bubble_exception(options, job, e)
+          raise e unless in_seize_mode?(options)
+          raise e unless retry_allowed?(options)
+          raise e unless seize_class?(options, e)
+
+          retry_count = job['retry_count'] || 0
+          last_try = retry_count ==  max_attempts_for(options) - 1
+          raise e if last_try
+        end
+
+        def retry_allowed?(options)
+          return false if !options['retry'].nil? && options['retry'] == false
+          return false if !options['retry'].nil? && options['retry'] == 0
+          true
+        end
+
+        def in_seize_mode?(options)
+          !options['seize'].nil? && options['seize'] == true
+        end
+
+        def seize_class?(options, e)
+          return true if options['seize_exceptions_classes'].nil?
+
+          options['seize_exceptions_classes'].each do |klass|
+            return true if klass == e.class
+          end
+
+          false
+        end
+
+        def max_attempts_for(options)
+          if options['retry'].is_a?(Integer)
+            options['retry']
+          else
+            @max_retries
+          end
+        end
+      end
+    end
+  end
+end

data/sidekiq-seize.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name                  = 'sidekiq-seize'
+  gem.version               = '0.4.0'
+  gem.authors               = ['Rajat Goyal']
+  gem.email                 = ['rajat@synaptic.com']
+  gem.summary               = 'Sidekiq middleware to silent errors and send only on dead'
+  gem.description           = 'Sidekiq middleware that allows capturing exceptions and throwing only after last retry, when the job goes to dead queue.'
+  gem.license               = 'MIT'
+  gem.executables           = []
+  gem.files                 = `git ls-files`.split("\n")
+  gem.test_files            = `git ls-files -- spec/*`.split("\n")
+  gem.require_paths         = ['lib']
+  gem.required_ruby_version = '>= 2.2.2'
+
+  gem.add_runtime_dependency 'sidekiq', '~> 5.0', '>= 5.0.0'
+  gem.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  gem.add_development_dependency 'byebug'
+end

data/spec/seize_spec.rb

@@ -0,0 +1,170 @@
+require 'sidekiq'
+require 'sidekiq/processor'
+
+RSpec.describe Sidekiq::Middleware::Server::Seize do
+  TEST_EXCEPTION = ArgumentError
+  MAX_RETRY = 2
+
+  def build_job_hash(worker_class, args=[])
+    {'class' => worker_class, 'args' => args}
+  end
+
+  def fetch_retry_job
+    retry_set = Sidekiq::RetrySet.new
+    retry_job = retry_set.first
+    retry_set.clear
+    retry_job
+  end
+
+  def process_job(job_hash)
+    mgr = instance_double('Manager', options: {:queues => ['default']})
+    processor = ::Sidekiq::Processor.new(mgr)
+    job_msg = Sidekiq.dump_json(job_hash)
+    processor.process(Sidekiq::BasicFetch::UnitOfWork.new('queue:default', job_msg))
+  end
+
+  def initialize_middleware
+    Sidekiq.server_middleware do |chain|
+      chain.add Sidekiq::Middleware::Server::Seize
+    end
+  end
+
+  def initialize_worker_class(sidekiq_opts=nil)
+    worker_class_name = :TestDummyWorker
+    Object.send(:remove_const, worker_class_name) if Object.const_defined?(worker_class_name)
+    klass = Class.new do
+      include Sidekiq::Worker
+      sidekiq_options sidekiq_opts if sidekiq_opts
+      def perform
+        raise TEST_EXCEPTION, 'Oops'
+      end
+    end
+    Object.const_set(worker_class_name, klass)
+  end
+
+  def cleanup_redis
+    Sidekiq.redis {|c| c.flushdb }
+  end
+
+  shared_examples_for 'it should raise multiple errors' do
+    it 'throws exception on each retry' do
+      args ||= []
+      expect {
+        process_job(build_job_hash(worker_class, args))
+      }.to raise_error(TEST_EXCEPTION, 'Oops')
+      expect(Sidekiq::RetrySet.new.size).to eq(1)
+      retry_job = fetch_retry_job
+      expect(retry_job['retry_count']).to eq(0)
+      expect(retry_job['error_class']).to eq('ArgumentError')
+      expect(retry_job['error_message']).to eq('Oops')
+
+      expect {
+        process_job(retry_job.item)
+      }.to raise_error(TEST_EXCEPTION, 'Oops')
+      expect(Sidekiq::RetrySet.new.size).to eq(1)
+      retry_job = fetch_retry_job
+      expect(retry_job['retry_count']).to eq(1)
+      expect(retry_job['error_class']).to eq('ArgumentError')
+      expect(retry_job['error_message']).to eq('Oops')
+
+      expect {
+        process_job(retry_job.item)
+      }.to raise_error(TEST_EXCEPTION, 'Oops')
+      expect(Sidekiq::RetrySet.new.size).to eq(0)
+    end
+  end
+
+  shared_examples_for 'it should raise 1 errors' do
+    it 'raises the original error at the end' do
+      args ||= []
+      expect {
+        process_job(build_job_hash(worker_class, args))
+      }.to_not raise_error(TEST_EXCEPTION)
+      expect(Sidekiq::RetrySet.new.size).to eq(1)
+      retry_job = fetch_retry_job
+      expect(retry_job['retry_count']).to eq(0)
+
+      expect {
+        process_job(retry_job.item)
+      }.to_not raise_error(TEST_EXCEPTION)
+      expect(Sidekiq::RetrySet.new.size).to eq(1)
+      retry_job = fetch_retry_job
+      expect(retry_job['retry_count']).to eq(1)
+
+      expect {
+        process_job(retry_job.item)
+      }.to raise_error(TEST_EXCEPTION, 'Oops')
+      expect(Sidekiq::RetrySet.new.size).to eq(0)
+    end
+  end
+
+  shared_examples_for 'retry disabled, it should raise one error' do
+    it 'raises the error' do
+      args ||= []
+      expect {
+        process_job(build_job_hash(worker_class, args))
+      }.to raise_error(TEST_EXCEPTION, 'Oops')
+      expect(Sidekiq::RetrySet.new.size).to eq(0)
+    end
+  end
+
+  before(:each) do
+    cleanup_redis
+  end
+
+  context 'with default middleware config' do
+    before(:each) do
+      initialize_middleware
+    end
+
+    describe 'with nothing explicitly enabled' do
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(retry: false) }
+      end
+
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(retry: 0) }
+      end
+
+      it_behaves_like 'it should raise multiple errors' do
+        let!(:worker_class) { initialize_worker_class(retry: MAX_RETRY) }
+      end
+    end
+
+    describe 'with seize explicitly disabled' do
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(seize: false, retry: 0) }
+      end
+
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(seize: false, retry: false) }
+      end
+
+      it_behaves_like 'it should raise multiple errors' do
+        let!(:worker_class) { initialize_worker_class(seize: false, retry: MAX_RETRY) }
+      end
+    end
+
+    describe 'with seize explicitly enabled' do
+      it_behaves_like 'it should raise 1 errors' do
+        let!(:worker_class) { initialize_worker_class(seize: true, retry: MAX_RETRY) }
+      end
+
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(seize: true, retry: false) }
+      end
+
+      it_behaves_like 'retry disabled, it should raise one error' do
+        let!(:worker_class) { initialize_worker_class(seize: true, retry: 0) }
+      end
+
+      it_behaves_like 'it should raise 1 errors' do
+        let!(:worker_class) { initialize_worker_class(seize: true, retry: MAX_RETRY, seize_exceptions_classes: [TEST_EXCEPTION]) }
+      end
+
+      it_behaves_like 'it should raise multiple errors' do
+        let!(:worker_class) { initialize_worker_class(seize: true, retry: MAX_RETRY, seize_exceptions_classes: [NoMemoryError]) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require 'sidekiq-seize'
+
+$TESTING = true
+
+Sidekiq::Logging.logger = nil
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-seize
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Rajat Goyal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-13 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
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sidekiq middleware that allows capturing exceptions and throwing only
+  after last retry, when the job goes to dead queue.
+email:
+- rajat@synaptic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-seize.rb
+- lib/sidekiq/middleware/server/seize.rb
+- sidekiq-seize.gemspec
+- spec/seize_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sidekiq middleware to silent errors and send only on dead
+test_files:
+- spec/seize_spec.rb
+- spec/spec_helper.rb