good_job 3.4.7 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8994365182a8cc05445c3368e6dea0bb2ccedf2678f59bd5612280b8154c1ee3
-  data.tar.gz: 3a4d3f05f8e3a862abadd24a6f6b68b1bc969740b9bf14dab5328b055c9e3835
+  metadata.gz: 7cc0961bf8aed9531b101c7d9a2be80693bd16dadf7239aa76b25adfea24f27c
+  data.tar.gz: 0740f33be940345ef16ebea8a8f188ebac56fe27af260f5510e7ed3d2ce98a96
 SHA512:
-  metadata.gz: cb67c0a6c3979b29a59b74b33c1097b9c38b53f7e678e80368e9f28829fe31703fe9d4f2c2a710783e3f5e650467fc7c196433c49c1c55b0b3522c3d6d5a7645
-  data.tar.gz: 6a114ae3a9509b2987b49ad65547ac0b12adb16de93127d0d72c9a4a86850f60680bed12468e7e94a5718ad5f364419b8b2daf609800d52f1f6ec9c6c1362340
+  metadata.gz: 0bdb4e1dab74099990750ea9239fe741432969d4aa412a8fdead0cbd4b43f5a7ae07732c78ff7ce82aedd534d5c6a27122be1c4b390f75982531ec0ed37ad9e8
+  data.tar.gz: 04b50734aab939660d38b28076c1ca7fe13f19894fe419cd09f9d099c1cdb2253c9ec0d8c90fdb54fe2bdeeff58646e3f366f3bcaf86638bb9dbd579194bb4c1

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [v3.5.0](https://github.com/bensheldon/good_job/tree/v3.5.0) (2022-10-18)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.4.8...v3.5.0)
+
+**Merged pull requests:**
+
+- Fix flaky test for `Scheduler#cleanup_interval_jobs` [\#723](https://github.com/bensheldon/good_job/pull/723) ([bensheldon](https://github.com/bensheldon))
+- Pin development Puma version until Capybara is compatible [\#722](https://github.com/bensheldon/good_job/pull/722) ([bensheldon](https://github.com/bensheldon))
+- Rename Job status of `finished` to `succeeded`; `finished` now means either `succeeded` or `discarded` [\#721](https://github.com/bensheldon/good_job/pull/721) ([bensheldon](https://github.com/bensheldon))
+
+## [v3.4.8](https://github.com/bensheldon/good_job/tree/v3.4.8) (2022-10-11)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.4.7...v3.4.8)
+
+**Merged pull requests:**
+
+- When not preserving job records, ensure all prior executions are deleted after successful retry [\#719](https://github.com/bensheldon/good_job/pull/719) ([ylansegal](https://github.com/ylansegal))
+
 ## [v3.4.7](https://github.com/bensheldon/good_job/tree/v3.4.7) (2022-10-06)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.4.6...v3.4.7)

data/README.md

@@ -363,7 +363,7 @@ GoodJob includes a Dashboard as a mountable `Rails::Engine`.
     end
     ```
 
-_To view finished (successful) and discarded (failed) jobs on the Dashboard, GoodJob must be configured to preserve job records. Preservation is enabled by default._
+_To view finished jobs (succeeded and discarded) on the Dashboard, GoodJob must be configured to preserve job records. Preservation is enabled by default._
 
 **Troubleshooting the Dashboard:** Some applications are unable to autoload the Goodjob Engine. To work around this, explicitly require the Engine at the top of your `config/application.rb` file, immediately after Rails is required and before Bundler requires the Rails' groups.
 

data/app/filters/good_job/jobs_filter.rb

@@ -8,7 +8,7 @@ module GoodJob
         'retried' => query.retried.count,
         'queued' => query.queued.count,
         'running' => query.running.count,
-        'finished' => query.finished.count,
+        'succeeded' => query.succeeded.count,
         'discarded' => query.discarded.count,
       }
     end
@@ -25,8 +25,8 @@ module GoodJob
         case filter_params[:state]
         when 'discarded'
           query = query.discarded
-        when 'finished'
-          query = query.finished
+        when 'succeeded'
+          query = query.succeeded
         when 'retried'
           query = query.retried
         when 'scheduled'

data/app/helpers/good_job/application_helper.rb

@@ -24,7 +24,7 @@ module GoodJob
 
     STATUS_ICONS = {
       discarded: "exclamation",
-      finished: "check",
+      succeeded: "check",
       queued: "dash_circle",
       retried: "arrow_clockwise",
       running: "play",
@@ -33,7 +33,7 @@ module GoodJob
 
     STATUS_COLOR = {
       discarded: "danger",
-      finished: "success",
+      succeeded: "success",
       queued: "secondary",
       retried: "warning",
       running: "primary",

data/app/models/concerns/good_job/reportable.rb

@@ -8,8 +8,8 @@ module GoodJob
     #     - retried: The job previously errored on execution and will be re-executed in the future.
     #   2. The job is being executed
     #     - running: the job is actively being executed by an execution thread
-    #   3. The job will not execute
-    #     - finished: The job executed successfully
+    #   3. The job has finished
+    #     - succeeded: The job executed successfully
     #     - discarded: The job previously errored on execution and will not be re-executed in the future.
     #
     # @return [Symbol]
@@ -20,7 +20,7 @@ module GoodJob
         elsif error.present? && retried_good_job_id.nil?
           :discarded
         else
-          :finished
+          :succeeded
         end
       elsif (scheduled_at || created_at) > DateTime.current
         if serialized_params.fetch('executions', 0) > 1

data/app/models/good_job/execution.rb

@@ -66,8 +66,9 @@ module GoodJob
     end
 
     belongs_to :job, class_name: 'GoodJob::Job', foreign_key: 'active_job_id', primary_key: 'active_job_id', optional: true, inverse_of: :executions
+    after_destroy -> { self.class.active_job_id(active_job_id).delete_all }, if: -> { @_destroy_job }
 
-    # Get Jobs with given ActiveJob ID
+    # Get executions with given ActiveJob ID
     # @!method active_job_id
     # @!scope class
     # @param active_job_id [String]
@@ -75,7 +76,7 @@ module GoodJob
     # @return [ActiveRecord::Relation]
     scope :active_job_id, ->(active_job_id) { where(active_job_id: active_job_id) }
 
-    # Get Jobs with given class name
+    # Get executions with given class name
     # @!method job_class
     # @!scope class
     # @param string [String]
@@ -83,32 +84,32 @@ module GoodJob
     # @return [ActiveRecord::Relation]
     scope :job_class, ->(job_class) { where("serialized_params->>'job_class' = ?", job_class) }
 
-    # Get Jobs that have not yet been completed.
+    # Get executions that have not yet finished (succeeded or discarded).
     # @!method unfinished
     # @!scope class
     # @return [ActiveRecord::Relation]
     scope :unfinished, -> { where(finished_at: nil) }
 
-    # Get Jobs that are not scheduled for a later time than now (i.e. jobs that
+    # Get executions that are not scheduled for a later time than now (i.e. jobs that
     # are not scheduled or scheduled for earlier than the current time).
     # @!method only_scheduled
     # @!scope class
     # @return [ActiveRecord::Relation]
     scope :only_scheduled, -> { where(arel_table['scheduled_at'].lteq(Time.current)).or(where(scheduled_at: nil)) }
 
-    # Order jobs by priority (highest priority first).
+    # Order executions by priority (highest priority first).
     # @!method priority_ordered
     # @!scope class
     # @return [ActiveRecord::Relation]
     scope :priority_ordered, -> { order('priority DESC NULLS LAST') }
 
-    # Order jobs by created_at, for first-in first-out
+    # Order executions by created_at, for first-in first-out
     # @!method creation_ordered
     # @!scope class
     # @return [ActiveRecord:Relation]
     scope :creation_ordered, -> { order('created_at ASC') }
 
-    # Order jobs for de-queueing
+    # Order executions for de-queueing
     # @!method dequeueing_ordered
     # @!scope class
     # @param parsed_queues [Hash]
@@ -123,7 +124,7 @@ module GoodJob
       relation
     end)
 
-    # Order jobs in order of queues in array param
+    # Order executions in order of queues in array param
     # @!method queue_ordered
     # @!scope class
     # @param queues [Array<string] ordered names of queues
@@ -298,11 +299,11 @@ module GoodJob
 
       if result.unhandled_error && GoodJob.retry_on_unhandled_error
         save!
-      elsif GoodJob.preserve_job_records == true || (result.unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error)
+      elsif GoodJob.preserve_job_records == true || result.retried? || (result.unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error)
         self.finished_at = Time.current
         save!
       else
-        destroy!
+        destroy_job
       end
 
       result
@@ -354,6 +355,14 @@ module GoodJob
       (finished_at || Time.zone.now) - performed_at if performed_at
     end
 
+    # Destroys this execution and all executions within the same job
+    def destroy_job
+      @_destroy_job = true
+      destroy!
+    ensure
+      @_destroy_job = false
+    end
+
     private
 
     def active_job_data
@@ -379,7 +388,7 @@ module GoodJob
           end
           handled_error ||= current_thread.error_on_retry || current_thread.error_on_discard
 
-          ExecutionResult.new(value: value, handled_error: handled_error)
+          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

data/app/models/good_job/execution_result.rb

@@ -8,14 +8,18 @@ module GoodJob
     attr_reader :handled_error
     # @return [Exception, nil]
     attr_reader :unhandled_error
+    # @return [Exception, nil]
+    attr_reader :retried
+    alias retried? retried
 
     # @param value [Object, nil]
     # @param handled_error [Exception, nil]
     # @param unhandled_error [Exception, nil]
-    def initialize(value:, handled_error: nil, unhandled_error: nil)
+    def initialize(value:, handled_error: nil, unhandled_error: nil, retried: false)
       @value = value
       @handled_error = handled_error
       @unhandled_error = unhandled_error
+      @retried = retried
     end
   end
 end

data/app/models/good_job/job.rb

@@ -55,12 +55,12 @@ module GoodJob
     scope :queued, -> { where(finished_at: nil).where('COALESCE(scheduled_at, created_at) <= ?', DateTime.current).joins_advisory_locks.where(pg_locks: { locktype: nil }) }
     # Advisory locked and executing
     scope :running, -> { where(finished_at: nil).joins_advisory_locks.where.not(pg_locks: { locktype: nil }) }
+    # Finished executing (succeeded or discarded)
+    scope :finished, -> { where.not(finished_at: nil).where(retried_good_job_id: nil) }
     # Completed executing successfully
-    scope :finished, -> { not_discarded.where.not(finished_at: nil) }
+    scope :succeeded, -> { finished.where(error: nil) }
     # Errored but will not be retried
-    scope :discarded, -> { where.not(finished_at: nil).where.not(error: nil) }
-    # Not errored
-    scope :not_discarded, -> { where(error: nil) }
+    scope :discarded, -> { finished.where.not(error: nil) }
 
     # The job's ActiveJob UUID
     # @return [String]
@@ -115,7 +115,7 @@ module GoodJob
       aj_count = serialized_params.fetch('executions', 0)
       # The execution count within serialized_params is not updated
       # once the underlying execution has been executed.
-      if status.in? [:discarded, :finished, :running]
+      if status.in? [:discarded, :succeeded, :running]
         aj_count + 1
       else
         aj_count
@@ -154,6 +154,24 @@ module GoodJob
       end
     end
 
+    # Tests whether the job has finished (succeeded or discarded).
+    # @return [Boolean]
+    def finished?
+      finished_at.present? && retried_good_job_id.nil?
+    end
+
+    # Tests whether the job has finished but with an error.
+    # @return [Boolean]
+    def discarded?
+      finished? && error.present?
+    end
+
+    # Tests whether the job has finished without error
+    # @return [Boolean]
+    def succeeded?
+      finished? && !discarded?
+    end
+
     # Retry a job that has errored and been discarded.
     # This action will create a new {Execution} record for the job.
     # @return [ActiveJob::Base]

data/app/views/good_job/jobs/_table.erb

@@ -75,7 +75,7 @@
               <span class="font-monospace fw-bold"><%= job.priority %></span>
             </div>
             <div class="col-1 text-center">
-              <% if job.executions_count > 0 && job.status != :finished %>
+              <% if job.executions_count > 0 && job.status != :succeeded %>
                 <%= tag.span job.executions_count, class: "badge rounded-pill bg-danger", data: {
                       bs_toggle: "popover",
                       bs_trigger: "hover focus click",
@@ -118,7 +118,7 @@
                     <% end %>
                   </li>
                   <li>
-                    <%= link_to job_path(job.id), method: :delete, class: "dropdown-item #{'disabled' unless job.status.in? [:discarded, :finished]}", title: "Destroy job", data: { confirm: "Confirm destroy", disable: true } do %>
+                    <%= link_to job_path(job.id), method: :delete, class: "dropdown-item #{'disabled' unless job.status.in? [:discarded, :succeeded]}", title: "Destroy job", data: { confirm: "Confirm destroy", disable: true } do %>
                       <%= render_icon "trash" %>
                       Destroy
                     <% end %>

data/app/views/good_job/jobs/show.html.erb

@@ -47,7 +47,7 @@
           <% end %>
         <% end %>
 
-        <% if @job.status.in? [:discarded, :finished] %>
+        <% if @job.status.in? [:discarded, :succeeded] %>
           <%= button_to job_path(@job.id), method: :delete, class: "btn btn-sm btn-outline-primary", form_class: "d-inline-block", aria: { label: "Destroy job" }, title: "Destroy job", data: { confirm: "Confirm destroy" } do %>
             <%= render_icon "trash" %>
             Destroy

data/config/locales/en.yml

@@ -58,11 +58,11 @@ en:
         processes: Processes
     status:
       discarded: Discarded
-      finished: Finished
       queued: Queued
       retried: Retried
       running: Running
       scheduled: Scheduled
+      succeeded: Succeeded
   number:
     format:
       delimiter: ","

data/config/locales/es.yml

@@ -58,11 +58,11 @@ es:
         processes: Procesos
     status:
       discarded: Descartado
-      finished: Acabado
       queued: Puesto en cola
       retried: reintentado
       running: Corriendo
       scheduled: Programado
+      succeeded: Acierto
   number:
     format:
       delimiter: " "

data/config/locales/nl.yml

@@ -58,11 +58,11 @@ nl:
         processes: Processen
     status:
       discarded: weggegooid
-      finished: Afgewerkt
       queued: In de wachtrij
       retried: Opnieuw geprobeerd
       running: Rennen
       scheduled: Gepland
+      succeeded: Geslaagd
   number:
     format:
       delimiter: "."

data/config/locales/ru.yml

@@ -82,11 +82,11 @@ ru:
         processes: Процессы
     status:
       discarded: Отброшено
-      finished: Законченный
       queued: В очереди
       retried: Повторная попытка
       running: Бег
       scheduled: по расписанию
+      succeeded: удалось
   number:
     format:
       delimiter: " "

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -57,7 +57,7 @@ module GoodJob
   #   By default, GoodJob deletes job records after the job is completed successfully.
   #   If you want to preserve jobs for latter inspection, set this to +true+.
   #   If you want to preserve only jobs that finished with error for latter inspection, set this to +:on_unhandled_error+.
-  #   @return [Boolean, nil]
+  #   @return [Boolean, Symbol, nil]
   mattr_accessor :preserve_job_records, default: true
 
   # @!attribute [rw] retry_on_unhandled_error
@@ -157,7 +157,7 @@ module GoodJob
 
     ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
       old_jobs = GoodJob::Job.where('finished_at <= ?', timestamp)
-      old_jobs = old_jobs.not_discarded unless include_discarded
+      old_jobs = old_jobs.succeeded unless include_discarded
       old_jobs_count = old_jobs.count
 
       GoodJob::Execution.where(job: old_jobs).delete_all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.4.7
+  version: 3.5.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -252,16 +252,16 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement