good_job 3.11.1 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65cb545f93b489c6ee487cbd07924e7a9d4ad2df7d7039391c66f704b38a767d
-  data.tar.gz: 6495c9a4b8da725051e44eb05e0b4c35b6aaa7363075ebb540316ec5a7d0b1b0
+  metadata.gz: eeb15f65ff801785a0df591dec95a0e044a4f5d7e61e6b2483003c4b2afd8cb3
+  data.tar.gz: e5c631765c1303d1fee0597313bbcb5d3844b85ad49600f2609c83149885872d
 SHA512:
-  metadata.gz: 698fbb528da9f58d766ccf47880de2e270f30e2f2226e23adafc00ea7de8920194773fd1769eb40aaff96b2ff3d666c20b080f2ddda801e0979817714bcc93b6
-  data.tar.gz: 42b54be4f42c185531a490d7eae1bc26701c341c1d708167f385505141f62cd860119f52fc32a2a1dab0c6f94817518af51cb629cdff26f5cabfff3a1c61227e
+  metadata.gz: bf0ed8436074ca82d718b64a76b4b1ce36f4bc2a085fe765b04eb101ae7886d0823bb50faa7816fd3a0dcb56d308dc568a7cdd86373d0afcb49bc2d22c045105
+  data.tar.gz: 8bd8e67ebfcb2b90a7e1ce6a542cf659e8d4cd37f31782a3a3cd5d26cfedba1e85e9a57835a8a9e78cd731f304b055c21802ca1c68fc2fcffb32ec9b3050ebdf

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v3.12.0](https://github.com/bensheldon/good_job/tree/v3.12.0) (2023-02-07)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.11.1...v3.12.0)
+
+**Merged pull requests:**
+
+- Create `InterruptErrors` extension to raise an exception when an interrupted job is retried [\#830](https://github.com/bensheldon/good_job/pull/830) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.11.1](https://github.com/bensheldon/good_job/tree/v3.11.1) (2023-02-06)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.11.0...v3.11.1)

data/README.md

@@ -55,6 +55,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
         - [Exceptions](#exceptions)
         - [Retries](#retries)
         - [ActionMailer retries](#actionmailer-retries)
+        - [Interrupts](#interrupts)
     - [Timeouts](#timeouts)
     - [Optimize queues, threads, and processes](#optimize-queues-threads-and-processes)
     - [Database connections](#database-connections)
@@ -829,6 +830,23 @@ end
 Note, that `ActionMailer::MailDeliveryJob` is a default since Rails 6.0. Be sure that your app is using that class, as it
 might also be configured to use (deprecated now) `ActionMailer::DeliveryJob`.
 
+### Interrupts
+
+Jobs will be automatically retried if the process is interrupted while performing a job, for example as the result of a `SIGKILL` or power failure.
+
+If you need more control over interrupt-caused retries, include the `GoodJob::ActiveJobExtensions::InterruptErrors` extension in your job closs. When an interrupted job is retried, the extension will raise a `GoodJob::InterruptError` exception within the job, which allows you to use ActiveJob's `retry_on` and `discard_on` to control the behavior of the job.
+
+```ruby
+class MyJob < ApplicationJob
+  # The extension must be included before other extensions
+  include GoodJob::ActiveJobExtensions::InterruptErrors
+  # Discard the job if it is interrupted
+  discard_on InterruptError
+  # Retry the job if it is interrupted
+  retry_on InterruptError, wait: 0, attempts: Float::INFINITY
+end
+```
+
 ### Timeouts
 
 Job timeouts can be configured with an `around_perform`:

data/app/models/good_job/execution.rb

@@ -315,10 +315,27 @@ module GoodJob
       run_callbacks(:perform) do
         raise PreviouslyPerformedError, 'Cannot perform a job that has already been performed' if finished_at
 
-        self.performed_at = Time.current
-        save! if GoodJob.preserve_job_records
+        result = GoodJob::CurrentThread.within do |current_thread|
+          current_thread.reset
+          current_thread.execution = self
 
-        result = execute
+          current_thread.execution_interrupted = performed_at if performed_at
+          update!(performed_at: Time.current)
+
+          ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
+            value = ActiveJob::Base.execute(active_job_data)
+
+            if value.is_a?(Exception)
+              handled_error = value
+              value = nil
+            end
+            handled_error ||= current_thread.error_on_retry || current_thread.error_on_discard
+
+            ExecutionResult.new(value: value, handled_error: handled_error, retried: current_thread.error_on_retry.present?)
+          rescue StandardError => e
+            ExecutionResult.new(value: nil, unhandled_error: e)
+          end
+        end
 
         job_error = result.handled_error || result.unhandled_error
         self.error = [job_error.class, ERROR_MESSAGE_SEPARATOR, job_error.message].join if job_error
@@ -408,28 +425,6 @@ module GoodJob
       end
     end
 
-    # @return [ExecutionResult]
-    def execute
-      GoodJob::CurrentThread.within do |current_thread|
-        current_thread.reset
-        current_thread.execution = self
-
-        ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
-          value = ActiveJob::Base.execute(active_job_data)
-
-          if value.is_a?(Exception)
-            handled_error = value
-            value = nil
-          end
-          handled_error ||= current_thread.error_on_retry || current_thread.error_on_discard
-
-          ExecutionResult.new(value: value, handled_error: handled_error, retried: current_thread.error_on_retry.present?)
-        rescue StandardError => e
-          ExecutionResult.new(value: nil, unhandled_error: e)
-        end
-      end
-    end
-
     def reset_batch_values(&block)
       GoodJob::Batch.within_thread(batch_id: nil, batch_callback_id: nil, &block)
     end

data/lib/good_job/active_job_extensions/interrupt_errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module GoodJob
+  module ActiveJobExtensions
+    module InterruptErrors
+      extend ActiveSupport::Concern
+
+      included do
+        around_perform do |_job, block|
+          raise InterruptError, "Interrupted after starting perform at '#{CurrentThread.execution_interrupted}'" if CurrentThread.execution_interrupted.present?
+
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/good_job/current_thread.rb

@@ -12,6 +12,7 @@ module GoodJob
       error_on_discard
       error_on_retry
       execution
+      execution_interrupted
     ].freeze
 
     # @!attribute [rw] cron_at
@@ -44,6 +45,12 @@ module GoodJob
     #   @return [GoodJob::Execution, nil]
     thread_mattr_accessor :execution
 
+    # @!attribute [rw] execution_interrupted
+    #   @!scope class
+    #   Execution Interrupted
+    #   @return [Boolean, nil]
+    thread_mattr_accessor :execution_interrupted
+
     # Resets attributes
     # @param [Hash] values to assign
     # @return [void]

data/lib/good_job/interrupt_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module GoodJob
+  # Exception raised when a job is interrupted by a SIGKILL or power failure.
+  class InterruptError < StandardError
+  end
+end

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.11.1'
+  VERSION = '3.12.0'
 end

data/lib/good_job.rb

@@ -9,6 +9,8 @@ require "good_job/adapter"
 require "active_job/queue_adapters/good_job_adapter"
 require "good_job/active_job_extensions/batches"
 require "good_job/active_job_extensions/concurrency"
+require "good_job/interrupt_error"
+require "good_job/active_job_extensions/interrupt_errors"
 require "good_job/active_job_extensions/notify_options"
 
 require "good_job/assignable_connection"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.12.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -403,6 +403,7 @@ files:
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb
 - lib/good_job/active_job_extensions/concurrency.rb
+- lib/good_job/active_job_extensions/interrupt_errors.rb
 - lib/good_job/active_job_extensions/notify_options.rb
 - lib/good_job/adapter.rb
 - lib/good_job/assignable_connection.rb
@@ -415,6 +416,7 @@ files:
 - lib/good_job/daemon.rb
 - lib/good_job/dependencies.rb
 - lib/good_job/engine.rb
+- lib/good_job/interrupt_error.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb