good_job 3.29.5 → 3.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e3887930fc0f923edca0286d1d6c2fff51466f5b395eb122a56f6dd4ec9171
-  data.tar.gz: 79a670cab496050ddf9cee105be9eab503a4d18f4786ac4a5b04dd3f93e3814a
+  metadata.gz: 7a62f9aed6b7846a54575fc79d8bb6e164f4236a0e1089eeaf2d2d7ded5e2561
+  data.tar.gz: cf93bd4a95f4cbd143442ecb5e4d3a1eff77cdecd9e703ee711ea22d2aba2b4e
 SHA512:
-  metadata.gz: a8f938f53fc9d1e2334b25fb9311f30abffa47fe26b9968d1d7de5f354337c1aeca217cf70fcfc2e5ab15ceba992f9a4edbc7430d5b09733a90221a970fbdebc
-  data.tar.gz: ad97c2abf1d88cab58898f983991e599b8b55e2f20cc5931b0b2d7ee08292ca9c20652452ebbf853a3f09e96c2134dd7167f158c5a0629390d94c48383a2b436
+  metadata.gz: aca712916a3b886d92ae128ee6f238a20a6af8d13bfba3b33b4064820fcbe3317f077fb6a4eac39377f14dcfb10078f0e2ed4c21f81ad9422e59769982aa6d8c
+  data.tar.gz: 2adc01f26ea9e2155073224a1cf9a42049c63f67c7bb5ffc87f07c1dd95f30cbbd958b15f9b50e0bbf645e132b331f592c9aa6cf182b110484bc807f6b024ef2

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v3.30.0](https://github.com/bensheldon/good_job/tree/v3.30.0) (2024-07-05)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.29.5...v3.30.0)
+
+**Implemented enhancements:**
+
+- Added GoodJob::DiscreteExecution\#duration column [\#1374](https://github.com/bensheldon/good_job/pull/1374) ([SebouChu](https://github.com/SebouChu))
+
+**Closed issues:**
+
+- Job retried infinitely  [\#1384](https://github.com/bensheldon/good_job/issues/1384)
+
+**Merged pull requests:**
+
+- Use newer syntax in documentation for `wait` config on `retry` [\#1380](https://github.com/bensheldon/good_job/pull/1380) ([benoittgt](https://github.com/benoittgt))
+
 ## [v3.29.5](https://github.com/bensheldon/good_job/tree/v3.29.5) (2024-06-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.29.4...v3.29.5)

data/README.md

@@ -933,7 +933,7 @@ Active Job can be configured to retry an infinite number of times, with a polyno
 
 ```ruby
 class ApplicationJob < ActiveJob::Base
-  retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
+  retry_on StandardError, wait: :polynomially_longer, attempts: Float::INFINITY
   # ...
 end
 ```
@@ -953,7 +953,7 @@ When using `retry_on` with an infinite number of retries, exceptions will never
 
 ```ruby
 class ApplicationJob < ActiveJob::Base
-  retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
+  retry_on StandardError, wait: :polynomially_longer, attempts: Float::INFINITY
 
   retry_on SpecialError, attempts: 5 do |_job, exception|
     Rails.error.report(exception)
@@ -979,7 +979,7 @@ You can use an initializer to configure `ActionMailer::MailDeliveryJob`, for exa
 
 ```ruby
 # config/initializers/good_job.rb
-ActionMailer::MailDeliveryJob.retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
+ActionMailer::MailDeliveryJob.retry_on StandardError, wait: :polynomially_longer, attempts: Float::INFINITY
 
 # With Sentry (or Bugsnag, Airbrake, Honeybadger, etc.)
 ActionMailer::MailDeliveryJob.around_perform do |_job, block|

data/app/models/good_job/discrete_execution.rb

@@ -28,6 +28,13 @@ module GoodJob # :nodoc:
       false
     end
 
+    def self.monotonic_duration_migrated?
+      return true if columns_hash["duration"].present?
+
+      migration_pending_warning!
+      false
+    end
+
     def number
       serialized_params.fetch('executions', 0) + 1
     end
@@ -37,9 +44,13 @@ module GoodJob # :nodoc:
       created_at - scheduled_at
     end
 
-    # Time between when this job started and finished
+    # Monotonic time between when this job started and finished
     def runtime_latency
-      (finished_at || Time.current) - performed_at if performed_at
+      if self.class.monotonic_duration_migrated?
+        duration
+      elsif performed_at
+        (finished_at || Time.current) - performed_at
+      end
     end
 
     def last_status_at

data/app/models/good_job/execution.rb

@@ -372,6 +372,7 @@ module GoodJob
         raise PreviouslyPerformedError, 'Cannot perform a job that has already been performed' if finished_at
 
         job_performed_at = Time.current
+        monotonic_start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
         discrete_execution = nil
         result = GoodJob::CurrentThread.within do |current_thread|
           current_thread.reset
@@ -385,12 +386,14 @@ module GoodJob
               interrupt_error_string = self.class.format_error(GoodJob::InterruptError.new("Interrupted after starting perform at '#{existing_performed_at}'"))
               self.error = interrupt_error_string
               self.error_event = ERROR_EVENT_INTERRUPTED if self.class.error_event_migrated?
+              monotonic_duration = (::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - monotonic_start).seconds
 
               discrete_execution_attrs = {
                 error: interrupt_error_string,
                 finished_at: job_performed_at,
               }
               discrete_execution_attrs[:error_event] = GoodJob::ErrorEvents::ERROR_EVENT_ENUMS[GoodJob::ErrorEvents::ERROR_EVENT_INTERRUPTED] if self.class.error_event_migrated?
+              discrete_execution_attrs[:duration] = monotonic_duration if GoodJob::DiscreteExecution.monotonic_duration_migrated?
               discrete_executions.where(finished_at: nil).where.not(performed_at: nil).update_all(discrete_execution_attrs) # rubocop:disable Rails/SkipsModelValidations
             end
           end
@@ -494,8 +497,12 @@ module GoodJob
         job_attributes.delete(:error_event) unless self.class.error_event_migrated?
 
         job_finished_at = Time.current
+        monotonic_duration = (::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - monotonic_start).seconds
         job_attributes[:finished_at] = job_finished_at
-        discrete_execution.finished_at = job_finished_at if discrete_execution
+        if discrete_execution
+          discrete_execution.finished_at = job_finished_at
+          discrete_execution.duration = monotonic_duration if GoodJob::DiscreteExecution.monotonic_duration_migrated?
+        end
 
         retry_unhandled_error = result.unhandled_error && GoodJob.retry_on_unhandled_error
         reenqueued = result.retried? || retried_good_job_id.present? || retry_unhandled_error

data/lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb

@@ -61,6 +61,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.integer :error_event, limit: 2
       t.text :error_backtrace, array: true
       t.uuid :process_id
+      t.interval :duration
     end
 
     create_table :good_job_processes, id: :uuid do |t|

data/lib/generators/good_job/templates/update/migrations/15_create_good_job_execution_duration.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateGoodJobExecutionDuration < ActiveRecord::Migration<%= migration_version %>
+  def change
+    reversible do |dir|
+      dir.up do
+        # Ensure this incremental update migration is idempotent
+        # with monolithic install migration.
+        return if connection.column_exists?(:good_job_executions, :duration)
+      end
+    end
+
+    add_column :good_job_executions, :duration, :interval
+  end
+end

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.29.5'
+  VERSION = '3.30.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -286,8 +286,8 @@ module GoodJob
   # @return [Boolean]
   def self.migrated?
     # Always update with the most recent migration check
-    GoodJob::Execution.reset_column_information
-    GoodJob::Execution.process_lock_migrated?
+    GoodJob::DiscreteExecution.reset_column_information
+    GoodJob::DiscreteExecution.monotonic_duration_migrated?
   end
 
   ActiveSupport.run_load_hooks(:good_job, self)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.29.5
+  version: 3.30.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -362,6 +362,7 @@ files:
 - lib/generators/good_job/templates/update/migrations/12_create_good_job_execution_error_backtrace.rb.erb
 - lib/generators/good_job/templates/update/migrations/13_create_good_job_process_lock_ids.rb.erb
 - lib/generators/good_job/templates/update/migrations/14_create_good_job_process_lock_indexes.rb.erb
+- lib/generators/good_job/templates/update/migrations/15_create_good_job_execution_duration.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb