activejob-retry 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26e70483f72942ecc312de55cd5bd34280ff459a
-  data.tar.gz: 771d1365fd7fc7581fced033b642ef4188e2e88d
+  metadata.gz: e81c61b7e8ca2f2d5370d1e18535cc1c30a93caa
+  data.tar.gz: 617790d33f2c4ceafaae57a3d9021a642086fdc7
 SHA512:
-  metadata.gz: d486c2b1253b045158bdb2880c0b12a0a00ed3aa1d4378de4ce0420710ae8f5c9f775089ab44c80d122384bc3bbc1504cc42f678c6d473742ded17369108a9a6
-  data.tar.gz: d9a91dd6a4beb9687d47fe9ce3df82fc5c29516a09e9d2d699fd017f6dc7b9522abdabecd7224a2952029c6d15ec38281652a64494ddaa00ce8c471183d1598b
+  metadata.gz: 6b84443eca49518480e1750059f51ce6cca79c78b7d709dbb1e1d27a8ca8155a409d60122351671cbb6c4a823242ea120a024525b208ccdcf109aa4a56e7ecf6
+  data.tar.gz: 2f81fb5b728b58c31456679e9a91a95cb9b056c630455c4eb0cf7e5e5502689dca28c74c760be899564c7105364f99b301713a18d536bcbbfd14b1d520c09db9

data/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
     - Rakefile
   Exclude:
     - .*/**/*
-    - vendor/**
+    - vendor/**/*
     - test/**/*
 
 LineLength:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0 - January 6, 2015
+
+- `rescue_from` gets called only when all retries have failed, rather than before attempting to retry (patch by [@isaacseymour](https://github.com/isaacseymour)
+
 ## 0.2.0 - January 1, 2015
 
 - Renamed retry_exceptions to retryable_exceptions (patch by [@greysteil](https://github.com/greysteil)

data/Gemfile.lock

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

data/README.md

@@ -40,38 +40,27 @@ class ProcessWebhook < ActiveJob::Base
 end
 ```
 
-#### constant_retry options
-`limit`
-:    Maximum number of times to attempt the job (default: 1).
-
-`unlimited_retries`
-:    If set to `true`, this job will be repeated indefinitely until in succeeds. Use with extreme caution.
-
-`delay`
-:    Time between attempts (default: 0).
+The retry will get executed before any `rescue_from` blocks, which will only get executed
+if the exception is not going to be retried, or has failed the final retry.
 
-`retryable_exceptions`
-:    A whitelist of exceptions to retry (default: nil, i.e. all exceptions will result in a retry).
-
-`fatal_exceptions`
-:    A blacklist of exceptions to not retry (default: []).
+#### constant_retry options
+|  Option                | Default | Description    |
+|:---------------------- |:------- |:-------------- |
+| `limit`                | `1`     | Maximum number of times to attempt the job (default: 1).
+| `unlimited_retries`    | `false` | If set to `true`, this job will be repeated indefinitely until in succeeds. Use with extreme caution.
+| `delay`                | `0`     | Time between attempts (default: 0).
+| `retryable_exceptions` | `nil`   | A whitelist of exceptions to retry. When `nil`, all exceptions will result in a retry.
+| `fatal_exceptions`     | `[]`    | A blacklist of exceptions to not retry (default: []).
 
 #### variable_retry options
 
-`delays`
-:    __required__ An array of delays between attempts. The first attempt will occur whenever you originally enqueued the job to happen.
-
-`min_delay_multiplier`
-:    If supplied, each delay will be multiplied by a random number between this and `max_delay_multiplier`.
-
-`max_delay_multiplier`
-:    The other end of the range for `min_delay_multiplier`. If one is supplied, both must be.
-
-`retryable_exceptions`
-:    Same as for `constant_retry`.
-
-`fatal_exceptions`
-:    Same as for `constant_retry`.
+| Option                 | Default | Description   |
+|:---------------------- |:------- |:------------- |
+| `delays`               |         | __required__ An array of delays between attempts. The first attempt will occur whenever you originally enqueued the job to happen.
+| `min_delay_multiplier` |         | If supplied, each delay will be multiplied by a random number between this and `max_delay_multiplier`.
+| `max_delay_multiplier` |         | The other end of the range for `min_delay_multiplier`. If one is supplied, both must be.
+| `retryable_exceptions` | `nil`   | Same as for [constant_retry](#constant_retry-options).
+| `fatal_exceptions`     | `[]`    | Same as for [constant_retry](#constant_retry-options).
 
 Contributing
 ------------

data/lib/active_job/retry.rb

@@ -83,23 +83,22 @@ module ActiveJob
     # Performing the retries #
     ##########################
 
-    # Override `rescue_with_handler` to make sure our catch is the last one, and doesn't
-    # happen if the exception has already been caught in a `rescue_from`
+    # Override `rescue_with_handler` to make sure our catch is before callbacks,
+    # so only run when the job is finally failing.
     def rescue_with_handler(exception)
-      super || retry_or_reraise(exception)
+      retry_or_reraise(exception) || super(exception)
     end
 
     private
 
     def retry_or_reraise(exception)
       unless self.class.backoff_strategy.should_retry?(retry_attempt, exception)
-        raise exception
+        return false
       end
 
       this_delay = self.class.backoff_strategy.retry_delay(retry_attempt, exception)
       # TODO: This breaks DelayedJob and Resque for some weird ActiveSupport reason.
-      # logger.log(Logger::INFO,
-      #            "Retrying (attempt #{retry_attempt + 1}, waiting #{this_delay}s)")
+      # logger.info("Retrying (attempt #{retry_attempt + 1}, waiting #{this_delay}s)")
       @retry_attempt += 1
       retry_job(wait: this_delay)
 

data/lib/active_job/retry/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Retry
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/test/integration/queuing_test.rb

@@ -43,4 +43,17 @@ class QueuingTest < ActiveSupport::TestCase
     wait_for_jobs_to_finish_for(5.seconds)
     assert job_executed
   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)
+
+    wait_for_jobs_to_finish_for(2.seconds)
+    assert_not job_executed
+    refute rescue_executed
+
+    wait_for_jobs_to_finish_for(5.seconds)
+    assert_not job_executed
+    assert rescue_executed
+  end
 end

data/test/jobs/rescue_job.rb

@@ -2,7 +2,7 @@ require_relative '../support/job_buffer'
 
 class RescueJob < ActiveJob::Base
   include ActiveJob::Retry
-  constant_retry limit: 2, delay: 0
+  constant_retry limit: 0, delay: 0
 
   class OtherError < StandardError; end
 

data/test/support/integration/dummy_app_template.rb

@@ -17,12 +17,19 @@ class TestJob < ActiveJob::Base
   queue_as :integration_tests
   constant_retry limit: 2, delay: 3
 
-  def perform(x, fail_first = false)
+  def perform(x, fail_first = false, fail_always = false)
     raise "Failing first" if fail_first && retry_attempt == 1
+    raise "Failing always" if fail_always
 
     File.open(Rails.root.join("tmp/\#{x}"), "w+") do |f|
       f.write x
     end
   end
+
+  def write_to_rescue_file
+    File.open(Rails.root.join("tmp/\#{arguments.first}_rescue"), "w+") do |f|
+      f.write arguments.first
+    end
+  end
 end
 CODE

data/test/support/integration/test_case_helpers.rb

@@ -45,4 +45,8 @@ module TestCaseHelpers
     def job_executed
       Dummy::Application.root.join("tmp/#{@id}").exist?
     end
+
+    def rescue_executed
+      Dummy::Application.root.join("tmp/#{@id}_rescue").exist?
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-retry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob