activejob-retry 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4754f9d8dd24402b36af737064fb7cf2aa18f8bc
-  data.tar.gz: 8eee87bdab72957f4d6b3f89ce94f7626c9ec1c7
+  metadata.gz: 5143405bed9e31a9105b3dc8d245f6e6d6b3f772
+  data.tar.gz: 029ae74c9cce202706f109991d67b07404cef2fc
 SHA512:
-  metadata.gz: 143fd664736af53579dc7f63c3d59b8ad661d6cf209d58d1cb8158c44b4350298944daa8f1f4b2cbad6db7f84f52d80cd97ff76cb2b19125f38fd6404ad08b5a
-  data.tar.gz: 925bce50297ad6b543769ad7f2257c89ef84ad02012cd70ca7eb59f447d1737ce73bcc45ff48e95be7b9879b20076b644b2476ad918795ba33545d286ca1d6fb
+  metadata.gz: a34362c6832bf49579a692d5219d808a46ccc2a89c9ebe6b02e8a53f8158091a20ce9e546697f3b78bc7c3a9294e84ec9cf0f8fb096f4d7c444e0f54f08f22d2
+  data.tar.gz: 5b3457112e0080fd42c0e9f288b89c8fd15cf473b6ce815a801be010949ed21a8555425503dd9b5b6cf08294384ee7383039e3c12fa31231ba3774395ac985c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activejob-retry (0.4.1)
+    activejob-retry (0.4.2)
       activejob (>= 4.2)
       activesupport (>= 4.2)
 

data/README.md

@@ -62,6 +62,49 @@ if the exception is not going to be retried, or has failed the final retry.
 | `retryable_exceptions` | `nil`   | Same as for [constant_retry](#constant_retry-options).
 | `fatal_exceptions`     | `[]`    | Same as for [constant_retry](#constant_retry-options).
 
+## Supported backends
+
+Any queue adapter which supports delayed enqueuing (i.e. the `enqueue_at`
+method) will work with ActiveJob::Retry, however some queue backends have
+automatic retry logic, which should be disabled. The cleanest way to do this is
+to use a `rescue_from` in the jobs for which you're using ActiveJob::Retry, so
+the queue backend never perceives the job as having failed. E.g.:
+
+```ruby
+class MyJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  queue_as :some_job
+
+  constant_retry limit: 3, delay: 5, retryable_exceptions: [TimeoutError, NetworkError]
+
+  rescue_from(StandardError) { |error| MyErrorService.record(error) }
+
+  def perform
+    raise "Weird!"
+  end
+end
+```
+
+Since `rescue_from`s are only executed once all retries have been attempted,
+this will send the recurring error to your error service (e.g. Airbrake,
+Sentry), but will make it appear to the queue backend (e.g. Que, Sidekiq) as if
+the job has succeeded.
+
+An alternative is to alter the appropriate `JobWrapper` to alter the
+configuration of the backend to disable retries globally. For Sidekiq this
+would be:
+
+```ruby
+# config/initializers/disable_sidekiq_retries.rb
+ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper.sidekiq_options(retry: false)
+```
+
+This has the advantages of moving failed jobs to the Dead Job Queue instead of
+just executing the logic in the `rescue_from`, which makes manual re-enqueueing
+easier. On the other hand it does disable Sidekiq's automatic retrying for all
+ActiveJob jobs.
+
 Contributing
 ------------
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake/testtask'
 require 'rubygems/package_task'
 
-ACTIVEJOB_ADAPTERS = %w(backburner delayed_job que resque)
+ACTIVEJOB_ADAPTERS = %w(backburner delayed_job que resque sidekiq)
 
 task default: :test
 task test: 'test:default'

data/lib/active_job/retry.rb

@@ -16,7 +16,6 @@ module ActiveJob
       'ActiveJob::QueueAdapters::InlineAdapter',
       'ActiveJob::QueueAdapters::QuAdapter',
       'ActiveJob::QueueAdapters::QueueClassicAdapter',
-      'ActiveJob::QueueAdapters::SidekiqAdapter',
       'ActiveJob::QueueAdapters::SneakersAdapter',
       'ActiveJob::QueueAdapters::SuckerPunchAdapter'
     ].freeze

data/lib/active_job/retry/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Retry
-    VERSION = '0.4.1'
+    VERSION = '0.4.2'
   end
 end

data/test/helper.rb

@@ -8,6 +8,17 @@ GlobalID.app = 'aj'
 
 @adapter  = ENV['AJADAPTER'] || 'resque'
 
+def sidekiq?
+  @adapter == 'sidekiq'
+end
+
+def ruby_193?
+  RUBY_VERSION == '1.9.3' && RUBY_ENGINE != 'java'
+end
+
+# Sidekiq doesn't work with MRI 1.9.3
+exit if sidekiq? && ruby_193?
+
 if ENV['AJ_INTEGRATION_TESTS']
   require 'support/integration/helper'
 else

data/test/integration/queuing_test.rb

@@ -45,8 +45,7 @@ class QueuingTest < ActiveSupport::TestCase
   end
 
   test 'should call rescue_from only when retries have run out' do
-    TestJob.rescue_from(RuntimeError) { write_to_rescue_file }
-    TestJob.perform_later(@id, false, true)
+    TestJob.perform_later(@id, false, true, true)
 
     wait_for_jobs_to_finish_for(2.seconds)
     assert_not job_executed

data/test/support/integration/adapters/sidekiq.rb

@@ -1,6 +1,17 @@
 require 'sidekiq/cli'
 require 'sidekiq/api'
 
+module Sidekiq
+  class CLI
+    def boot_system_with_rescue
+      boot_system_without_rescue
+    rescue => e
+      raise unless /Application has been already initialized./ =~ e.message
+    end
+    alias_method_chain :boot_system, :rescue
+  end
+end
+
 module SidekiqJobsManager
 
   def setup

data/test/support/integration/dummy_app_template.rb

@@ -17,7 +17,15 @@ class TestJob < ActiveJob::Base
   queue_as :integration_tests
   constant_retry limit: 2, delay: 3
 
-  def perform(x, fail_first = false, fail_always = false)
+  rescue_from(RuntimeError) do |e|
+    if arguments[3]
+      write_to_rescue_file
+    else
+      raise e
+    end
+  end
+
+  def perform(x, fail_first = false, fail_always = false, rescue_file = false)
     raise "Failing first" if fail_first && retry_attempt == 1
     raise "Failing always" if fail_always
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-retry
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob