activejob-retry 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb158e4b3bbb44f1212648e777ca1701f5dab910
-  data.tar.gz: a93e0a2c4949b1a3e87024ada9508e0347f3ec84
+  metadata.gz: 4fbf3f8e2eee97ef30a65fdc9f627acb6fd9c271
+  data.tar.gz: 24c084bf1714043588bcd7643a39eabfdfe71d38
 SHA512:
-  metadata.gz: 5f08d5d8a6466b54a798e988c50a8e27d6ab1c9273e5910e0c11b15a38facae0b7f75c3a5d5970b51178661f0a5e13ec624b36ffee97d1c64eae93c4946132f5
-  data.tar.gz: feef5212819586918cb91968980974c84a5e142ba94ace753d8cac05eb04e98fc3ebed1679c6582283791d8fe05ec44cea85d134e65ed75a42eb7f2a8c328e03
+  metadata.gz: c62d03830fe93de1de6f04ae1e712c9098dd2e0ed029898faafad283406b8766f00a7f6b69c2de323176038149f48ca45a6759486f6f3109cfd9efca083b5ae3
+  data.tar.gz: '094302d4b6466df850e38a94af520c64d8141284bcde467ba66e71149a8113bd3527a0d9334b9dd95562b48895989e958a0a0a032afc8ca3129b9bf83c51d72d'

data/.rubocop.yml

@@ -12,9 +12,6 @@ LineLength:
 Style/SignalException:
   EnforcedStyle: 'only_raise'
 
-Metrics/MethodLength:
-  CountComments: false
-
 Style/Documentation:
   Enabled: false
 
@@ -23,3 +20,12 @@ Style/DotPosition:
 
 Style/GuardClause:
   Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+
+Metrics/BlockLength:
+  CountComments: false
+  Exclude:
+    - Rakefile
+    - spec/**/*

data/.travis.yml

@@ -6,21 +6,26 @@ language: ruby
 matrix:
   exclude:
     # Rails 5.0 dropped support for Ruby <2.2
-    - rvm: 2.0
-      gemfile: Gemfile.activejob50
     - rvm: 2.1
       gemfile: Gemfile.activejob50
+    # Rails 4-2-stable supports Ruby 2.4, but the released version doesn't. Ignore for now.
+    - rvm: 2.4.0
+      gemfile: Gemfile.activejob42
 
 rvm:
-  - 2.0
   - 2.1
   - 2.2.2
-  - 2.3.1
+  - 2.3.3
+  - 2.4.0
 
 gemfile:
   - Gemfile.activejob42
   - Gemfile.activejob50
 
+before_install:
+  - gem update --system
+  - gem install bundler
+
 script:
   - bundle exec rubocop
   - bundle exec rspec spec
@@ -31,4 +36,4 @@ services:
   - rabbitmq
 
 addons:
-  postgresql: "9.4"
+  postgresql: "9.6"

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.6.3 - Feb 9, 2017
+
+- Add `callback` option, to be run before each retry, and potentially cancel the retry (by
+  [@doits](https://github.com/doits))
+
+## 0.6.2 - Aug 10, 2016
+
+- Rails 5 support (by [@isaacseymour](https://github.com/isaacseymour))
+
+## 0.6.1 - Jun 1, 2016
+
+- Apply retry settings to subclasses (by [@isaacseymour](https://github.com/isaacseymour))
+
 ## 0.6.0 - May 18, 2016
 
 - Change API usage to make improper use harder (by [@isaacseymour](https://github.com/isaacseymour))

data/Gemfile.activejob42

@@ -17,4 +17,7 @@ group :test, :integration do
   gem 'sqlite3'
   gem 'pg'
   gem 'rails', '~> 4.2'
+
+  # This is annoyingly required to make rubocop install
+  gem 'rake'
 end

data/Gemfile.activejob50

@@ -19,4 +19,7 @@ group :test, :integration do
   gem 'rails', '~> 5.0'
 
   gem 'pry'
+
+  # This is annoyingly required to make rubocop install
+  gem 'rake'
 end

data/README.md

@@ -65,7 +65,6 @@ if the exception is not going to be retried, or has failed the final retry.
 | `fatal_exceptions`     | `[]`    | Same as for [constant](#constant-options).
 
 #### variable options
-
 | Option                 | Default | Description   |
 |:---------------------- |:------- |:------------- |
 | `delays`               |         | __required__ An array of delays between attempts in seconds. The first attempt will occur whenever you originally enqueued the job to happen.
@@ -74,6 +73,42 @@ if the exception is not going to be retried, or has failed the final retry.
 | `retryable_exceptions` | `nil`   | Same as for [constant](#constant-options).
 | `fatal_exceptions`     | `[]`    | Same as for [constant](#constant-options).
 
+## Callback
+
+All strategies support a `callback` option:
+
+```ruby
+class ProcessWebhook < ActiveJob::Base
+  include ActiveJob::Retry.new(
+    strategy: :exponential, limit: 25,
+    callback: proc do |exception, delay|
+      # will be run before each retry
+    end
+  )
+end
+```
+
+`callback` must be a `proc` and is run before each retry. It receives the
+exception and delay before the next retry as arguments. It is evaluated on
+instance level, so you have access to all instance variables and methods (for
+example `retry_attempt`) of your job.
+
+If the callback returns `:halt`, retry chain is halted and no further retries
+will be made:
+
+```ruby
+class ProcessWebhook < ActiveJob::Base
+  include ActiveJob::Retry.new(
+    strategy: :exponential, limit: 25,
+    callback: proc do |exception, delay|
+      if some_condition
+        :halt # this will halt the retry chain
+      end
+    end
+  )
+end
+```
+
 ## Supported backends
 
 Any queue adapter which supports delayed enqueuing (i.e. the `enqueue_at`
@@ -121,9 +156,8 @@ ActiveJob jobs.
 Supported Versions
 ------------------
 
-Rails 4.2 and 5.0 are supported, on all versions of MRI which they support, except
-Ruby 1.9.3. Other Ruby runtimes (e.g. JRuby, Rubinius) probably work, but are not
-tested in Travis CI.
+Rails 4.2 and 5.0 are supported, Ruby 2.1+. Other Ruby runtimes (e.g. JRuby,
+Rubinius) probably work, but are not tested in Travis CI.
 
 Contributing
 ------------

data/lib/active_job/retry.rb

@@ -32,15 +32,12 @@ module ActiveJob
     #################
     # Configuration #
     #################
-    def initialize(strategy: nil, **options)
+    def initialize(strategy: nil, callback: nil, **options)
       check_adapter!
       @backoff_strategy = choose_strategy(strategy, options)
+      @retry_callback = callback
 
-      unless backoff_strategy_valid?
-        raise InvalidConfigurationError,
-              'Backoff strategies must define `should_retry?(attempt, exception)`, ' \
-              'and `retry_delay(attempt, exception)`.'
-      end
+      validate_params
     end
 
     def included(base)
@@ -52,11 +49,12 @@ module ActiveJob
       define_retry_attempt_tracking(base)
       define_retry_method(base)
       define_retry_logic(base)
+      define_retry_callback(base)
     end
 
     private
 
-    attr_reader :backoff_strategy
+    attr_reader :backoff_strategy, :retry_callback
 
     def define_backoff_strategy(klass)
       klass.instance_variable_set(:@backoff_strategy, @backoff_strategy)
@@ -80,6 +78,11 @@ module ActiveJob
       klass.instance_eval do
         define_method :internal_retry do |exception|
           this_delay = self.class.backoff_strategy.retry_delay(retry_attempt, exception)
+
+          cb = self.class.retry_callback &&
+               instance_exec(exception, this_delay, &self.class.retry_callback)
+          return if cb == :halt
+
           # TODO: This breaks DelayedJob and Resque for some weird ActiveSupport reason.
           # logger.info("Retrying (attempt #{retry_attempt + 1}, waiting #{this_delay}s)")
           @retry_attempt += 1
@@ -103,6 +106,11 @@ module ActiveJob
       end
     end
 
+    def define_retry_callback(klass)
+      klass.instance_variable_set(:@retry_callback, @retry_callback)
+      klass.define_singleton_method(:retry_callback) { @retry_callback }
+    end
+
     def check_adapter!
       adapter = ActiveJob::Base.queue_adapter
       adapter_name =
@@ -117,6 +125,18 @@ module ActiveJob
       end
     end
 
+    def validate_params
+      if retry_callback && !retry_callback.is_a?(Proc)
+        raise InvalidConfigurationError, 'Callback must be a `Proc`'
+      end
+
+      unless backoff_strategy_valid?
+        raise InvalidConfigurationError,
+              'Backoff strategies must define `should_retry?(attempt, exception)`, ' \
+              'and `retry_delay(attempt, exception)`.'
+      end
+    end
+
     def backoff_strategy_valid?
       backoff_strategy.respond_to?(:should_retry?) &&
         backoff_strategy.respond_to?(:retry_delay) &&

data/lib/active_job/retry/constant_options_validator.rb

@@ -29,7 +29,7 @@ module ActiveJob
       # Limit must be an integer >= 0, or nil
       def validate_limit_numericality!
         return unless options[:limit]
-        return if options[:limit].is_a?(Fixnum) && options[:limit] >= 0
+        return if options[:limit].is_a?(Integer) && options[:limit] >= 0
 
         raise InvalidConfigurationError,
               'Limit must be an integer >= 0, or nil for unlimited retries'

data/lib/active_job/retry/exponential_options_validator.rb

@@ -29,7 +29,7 @@ module ActiveJob
       # Limit must be an integer >= 0, or nil
       def validate_limit_numericality!
         return unless options[:limit]
-        return if options[:limit].is_a?(Fixnum) && options[:limit] >= 0
+        return if options[:limit].is_a?(Integer) && options[:limit] >= 0
 
         raise InvalidConfigurationError,
               'Limit must be an integer >= 0, or nil for unlimited retries'

data/lib/active_job/retry/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   class Retry < Module
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.6.3'.freeze
   end
 end

data/spec/retry_spec.rb

@@ -295,4 +295,56 @@ RSpec.describe ActiveJob::Retry do
       end
     end
   end
+
+  describe 'retry callback' do
+    let(:retry_instance) do
+      described_class.new(strategy: :constant, callback: callback, **options)
+    end
+    let(:callback_double) { double(call: nil) }
+    let(:callback) { callback_double.method(:call).to_proc }
+    let(:instance) { job.new }
+    subject(:perform) { instance.perform_now }
+
+    context 'invalid options' do
+      let(:callback) { 'not a proc' }
+
+      specify do
+        expect { retry_instance }.
+          to raise_error(ActiveJob::Retry::InvalidConfigurationError)
+      end
+    end
+
+    context 'when the job should be retried' do
+      before do
+        expect(job.backoff_strategy).to receive(:should_retry?).
+          with(1, instance_of(RuntimeError)).
+          and_return(true)
+      end
+
+      it 'executes callback proc on retry' do
+        expect(callback_double).to receive(:call)
+        perform
+      end
+
+      context 'with callback returning :halt' do
+        let(:callback) { proc { :halt } }
+
+        it 'it does not retry the job' do
+          expect(instance).not_to receive(:retry_job)
+
+          perform
+        end
+      end
+
+      context 'with callback not returning :halt' do
+        let(:callback) { proc { 'not halt' } }
+
+        it 'it retries the job' do
+          expect(instance).to receive(:retry_job)
+
+          perform
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-retry
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Automatic retry functionality for ActiveJob.