sidekiq-retries 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddb014b67c73e8344197f534186e3a74f29a8c25
-  data.tar.gz: e42449e681a1f1668ebde836c04d1af2258cbfff
+  metadata.gz: 87c2aac2892ffd9e2b44612ab5f37a1fa78388e9
+  data.tar.gz: 6dc7a56dee7f165c425f2272656ec773530556d3
 SHA512:
-  metadata.gz: ede6f871ffc51e94be143f95b3a0df833f90cdbd90797b1bd2df4a71aeaea4718f8362bf09400bfa08f5ab4f4cef8c32b4f467974e09707fb26297060ecab0f6
-  data.tar.gz: 2a6218b7778df1bfdfbec88dea2fd897cee59fe053e27946f6238502b07a8b3350d601fca3e48d06de9cb5639a6003cf89da12013cad3291dc505b819fa35b0c
+  metadata.gz: c341f9fb8bca656566987dee920e37be30dba4b785402cf38088275c6c15a63cb09ee9ba476839ae5d6c3f07999947e9d066e5c3638cc84fe1a3128de82d1d07
+  data.tar.gz: edab40f7f4331d138dc7f24b9ce1d637a740329bdea797483f0dc15ec8336eea29822cc89301a3f8027a8be1a851cac205944c13e7fed854793911b05b15d66c

data/Gemfile

@@ -3,4 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in sidekiq-retries.gemspec
 gemspec
 
-gem 'pry'
+group :development, :test do
+  gem 'redcarpet', :platform => :ruby
+  gem 'yard'
+  gem 'pry'
+end

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.0
+* simplify retry/fail logic
+* fix retry: 0, which was going straight to the dead queue
+
 ## 0.1.0
 
 * sidekiq 3 compatibility

data/README.md

@@ -11,21 +11,29 @@ Add this line to your application's Gemfile:
 
 ## Usage
 
-    class MyWorker
+    class NoRetryJob
       include Sidekiq::Worker
-      sidekiq_options retry: false # or retry: 25, or the default...
+      sidekiq_options retry: false  # or retry: 0
 
       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
+        # force a retry
+        raise Sidekiq::Retries::Retry.new(RuntimeError.new('whatever happened'))        
+      end
+    end
+    
+    class RetryJob
+      include Sidekiq::Worker
+      sidekiq_options retry: 25
+    
+      def perform                        
+        # fail the job, don't retry it 
         raise Sidekiq::Retries::Fail.new(RuntimeError.new('whatever happened'))
       end
     end
+    
+## Caveats
+
+* Jobs with retry: 0 don't ever appear to show up in the Sidekiq 3 Dead queue
 
 ## Contributing
 

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

@@ -13,11 +13,11 @@ module Sidekiq
           raise
         rescue Sidekiq::Retries::Retry => e
           # force a retry (for workers that have retries disabled)
-          msg['retry'] ||= e.max_retries
+          msg['retry'] = e.max_retries || '1'
           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)
+          # seriously, don't retry this
           raise e.cause
         rescue Exception => e
           attempt_retry(worker, msg, queue, e) if msg['retry']
@@ -26,24 +26,28 @@ module Sidekiq
 
         private
 
-        # This is the default Sidekiq 2.17.x retry logic
+        # This is the default Sidekiq 3.2.2 retry logic
         def attempt_retry(worker, msg, queue, e)
+          # ignore, will be pushed back onto queue during hard_shutdown
+          raise Sidekiq::Shutdown if exception_caused_by_shutdown?(e)
+
+          raise e unless msg['retry']
           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['retry_queue']
+          else
+            queue
+          end
+          msg['error_message'] = e.message[0..10_000]
           msg['error_class'] = e.class.name
           count = if msg['retry_count']
-                    msg['retried_at'] = Time.now.to_f
-                    msg['retry_count'] += 1
-                  else
-                    msg['failed_at'] = Time.now.to_f
-                    msg['retry_count'] = 0
-                  end
+            msg['retried_at'] = Time.now.to_f
+            msg['retry_count'] += 1
+          else
+            msg['failed_at'] = Time.now.to_f
+            msg['retry_count'] = 0
+          end
 
           if msg['backtrace'] == true
             msg['error_backtrace'] = e.backtrace
@@ -65,6 +69,8 @@ module Sidekiq
             # Goodbye dear message, you (re)tried your best I'm sure.
             retries_exhausted(worker, msg)
           end
+
+          raise e
         end
 
       end

data/lib/sidekiq/retries/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Retries
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

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

@@ -17,14 +17,29 @@ module Sidekiq
           Sidekiq::RetrySet.new.clear
         end
 
-        context 'a worker without retry' do
+        context 'a worker with retry: false' do
           it 'should retry anyway if we raise a Sidekiq::Retries::Retry' do
             args = {'class' => 'Bob',
-                    'args' => [1],
+                    'args'  => [1],
                     'retry' => false}
             expect {
               handler.call(RetryWorker, args, queue) do
-                raise Sidekiq::Retries::Retry.new(RuntimeError.new(errmsg), 10)
+                raise Sidekiq::Retries::Retry.new(RuntimeError.new(errmsg))
+              end
+            }.to raise_error(RuntimeError, errmsg)
+            expect(Sidekiq::RetrySet.new.size).to eq(1)
+          end
+
+        end
+
+        context 'a worker with retry: 0' do
+          it 'should retry anyway if we raise a Sidekiq::Retries::Retry' do
+            args = {'class' => 'Bob',
+                    'args'  => [1],
+                    'retry' => 0}
+            expect {
+              handler.call(RetryWorker, args, queue) do
+                raise Sidekiq::Retries::Retry.new(RuntimeError.new(errmsg))
               end
             }.to raise_error(RuntimeError, errmsg)
             expect(Sidekiq::RetrySet.new.size).to eq(1)
@@ -35,7 +50,7 @@ module Sidekiq
         context 'a worker with retry' do
           it 'should not retry if we raise a Sidekiq::Retries::Fail' do
             args = {'class' => 'Bob',
-                    'args' => [1],
+                    'args'  => [1],
                     'retry' => 2}
             expect {
               handler.call(RetryWorker, args, queue) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-retries
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin Ortega
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -169,3 +169,4 @@ summary: Enhanced retry logic for Sidekiq workers
 test_files:
 - spec/lib/sidekiq/retries/server/middleware_spec.rb
 - spec/spec_helper.rb
+has_rdoc: