sidekiq-retries 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-retries.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,27 @@
+License
+-------
+Copyright (c) 2013, GovDelivery, Inc.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+* Redistributions of source code must retain the above copyright notice, this 
+list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, 
+this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+* Neither the name of GovDelivery nor the names of its contributors may be used 
+to endorse or promote products derived from this software without specific 
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,36 @@
+# Sidekiq::Retries
+
+This subclasses the stock Sidekiq retries middleware to give you some additional options to conditionally retry jobs
+irrespective of whether retries are enabled for the job.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-retries'
+
+## Usage
+
+    class MyWorker
+      include Sidekiq::Worker
+      sidekiq_options retry: false # or retry: 25, or the default...
+
+      def perform
+        #force a retry even if retry: false using default retry options
+        raise Sidekiq::Retries::Retry.new(RuntimeError.new('whatever happened'))
+
+        #force a retry even if retry: false using a specific max_retries
+        raise Sidekiq::Retries::Retry.new(RuntimeError.new('whatever happened'), 10)
+
+        #if e.g. retries: true or retries: 10, skip it anyway
+        raise Sidekiq::Retries::Fail.new(RuntimeError.new('whatever happened'))
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

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/retries.rb

@@ -0,0 +1,15 @@
+require "sidekiq/retries/version"
+require 'sidekiq/retries/server/middleware'
+require 'sidekiq/retries/errors'
+
+Sidekiq.configure_server do |config|
+  require 'sidekiq/middleware/server/retry_jobs'
+  require 'sidekiq/retries/server/middleware'
+
+  stock_middleware = Sidekiq::Middleware::Server::RetryJobs
+
+  config.server_middleware do |chain|
+    chain.insert_before stock_middleware, Sidekiq::Retries::Server::Middleware
+    chain.remove stock_middleware
+  end
+end

data/lib/sidekiq/retries/errors.rb

@@ -0,0 +1,25 @@
+module Sidekiq
+  module Retries
+    class RetryError < StandardError
+      attr_accessor :cause
+
+      def initialize(cause, msg=nil)
+        super(msg)
+        self.cause=cause
+      end
+    end
+
+    class Retry < RetryError
+      attr_accessor :max_retries
+
+      def initialize(cause, max_retries=nil, msg=nil)
+        super(cause, msg)
+        self.max_retries = max_retries
+      end
+    end
+
+    class Fail < RetryError
+    end
+
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'celluloid'
+require 'sidekiq/middleware/server/retry_jobs'
+
+module Sidekiq
+  module Retries
+    module Server
+      class Middleware < Sidekiq::Middleware::Server::RetryJobs
+
+        def call(worker, msg, queue)
+          yield
+        rescue Sidekiq::Shutdown
+          # ignore, will be pushed back onto queue during hard_shutdown
+          raise
+        rescue Sidekiq::Retries::Retry => e
+          # force a retry (for workers that have retries disabled)
+          msg['retry'] ||= e.max_retries
+          attempt_retry(worker, msg, queue, e.cause)
+          raise e.cause
+        rescue Sidekiq::Retries::Fail => e
+          # don't retry this message (for workers that retry by default)
+          raise e.cause
+        rescue Exception => e
+          attempt_retry(worker, msg, queue, e) if msg['retry']
+          raise e
+        end
+
+        private
+
+        # This is the default Sidekiq 2.17.x retry logic
+        def attempt_retry(worker, msg, queue, e)
+          max_retry_attempts = retry_attempts_from(msg['retry'], @max_retries)
+
+          msg['queue'] = if msg['retry_queue']
+                           msg['retry_queue']
+                         else
+                           queue
+                         end
+          msg['error_message'] = e.message
+          msg['error_class'] = e.class.name
+          count = if msg['retry_count']
+                    msg['retried_at'] = Time.now.utc
+                    msg['retry_count'] += 1
+                  else
+                    msg['failed_at'] = Time.now.utc
+                    msg['retry_count'] = 0
+                  end
+
+          if msg['backtrace'] == true
+            msg['error_backtrace'] = e.backtrace
+          elsif msg['backtrace'] == false
+            # do nothing
+          elsif msg['backtrace'].to_i != 0
+            msg['error_backtrace'] = e.backtrace[0..msg['backtrace'].to_i]
+          end
+
+          if count < max_retry_attempts
+            delay = delay_for(worker, count)
+            logger.debug { "Failure! Retry #{count} in #{delay} seconds" }
+            retry_at = Time.now.to_f + delay
+            payload = Sidekiq.dump_json(msg)
+            Sidekiq.redis do |conn|
+              conn.zadd('retry', retry_at.to_s, payload)
+            end
+          else
+            # Goodbye dear message, you (re)tried your best I'm sure.
+            retries_exhausted(worker, msg)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sidekiq/retries/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Retries
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-retries.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/retries/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-retries"
+  spec.version       = Sidekiq::Retries::VERSION
+  spec.authors       = ["Benjamin Ortega"]
+  spec.email         = ["ben.ortega@gmail.com"]
+  spec.description   = %q{Enhanced retry logic for Sidekiq workers}
+  spec.summary       = %q{Enhanced retry logic for Sidekiq workers}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency            'sidekiq', '~>2.17'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'activesupport', '~> 3'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec-sidekiq'
+end

data/spec/lib/sidekiq/retries/server/middleware_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Sidekiq
+  module Retries
+    module Server
+      class RetryWorker
+        include Sidekiq::Worker
+      end
+
+      describe Middleware do
+        let (:handler) { Sidekiq::Retries::Server::Middleware.new }
+        let (:queue) { 'default' }
+        let (:errmsg) { 'oh man what did you do' }
+
+        before do
+          Sidekiq::RetrySet.new.clear
+        end
+
+        context 'a worker without retry' do
+          it 'should retry anyway if we raise a Sidekiq::Retries::Retry' do
+            args = {'class' => 'Bob',
+                    'args' => [1],
+                    'retry' => false}
+            expect {
+              handler.call(RetryWorker, args, queue) do
+                raise Sidekiq::Retries::Retry.new(RuntimeError.new(errmsg), 10)
+              end
+            }.to raise_error(RuntimeError, errmsg)
+            expect(Sidekiq::RetrySet.new.size).to eq(1)
+          end
+
+        end
+
+        context 'a worker with retry' do
+          it 'should not retry if we raise a Sidekiq::Retries::Fail' do
+            args = {'class' => 'Bob',
+                    'args' => [1],
+                    'retry' => 2}
+            expect {
+              handler.call(RetryWorker, args, queue) do
+                raise Sidekiq::Retries::Fail.new(RuntimeError.new(errmsg))
+              end
+            }.to raise_error(RuntimeError, errmsg)
+
+            expect(Sidekiq::RetrySet.new.size).to eq(0)
+          end
+        end
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-retries
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Ortega
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enhanced retry logic for Sidekiq workers
+email:
+- ben.ortega@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/retries.rb
+- lib/sidekiq/retries/errors.rb
+- lib/sidekiq/retries/server/middleware.rb
+- lib/sidekiq/retries/version.rb
+- sidekiq-retries.gemspec
+- spec/lib/sidekiq/retries/server/middleware_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4325984513531570110
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4325984513531570110
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Enhanced retry logic for Sidekiq workers
+test_files:
+- spec/lib/sidekiq/retries/server/middleware_spec.rb