good_job 3.16.1 → 3.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364c1bd829e85f9b002b0265bf57b4e29b517ca314ed8335affab915320eb09c
-  data.tar.gz: 035dc69a55772e2516ac73783cec24bd47c1974a3ba3b3b8a568649985b9a37e
+  metadata.gz: 3929d3de9d0c69de6aa34b238573dd19eabb0b6753b28a06b186cfc6972b621b
+  data.tar.gz: d927b1cc39f993f64a4b07594cb7215975e02d55cb212b420122b2c672d5f2d4
 SHA512:
-  metadata.gz: 124c045c8948530ba298410381bba29717de39b95b1b2fb53c06957c528c86bd84359fe14658b2b2bee84c31c0e83afb85194bca964f6255cc907cf95c72e5c3
-  data.tar.gz: da74da4e4a00efa81bc995339df665c2a400ac54377078694ba961f8f788c0635b53865b76fee479197e4e478d744888ef393565a854441da935622c5a74a34f
+  metadata.gz: 34ac854233932322ad76eaea4d41879b9d97c08a204b6f689affedbe861b86bc5c83b6c02dd1132c267f7f9129d4e0ace042e9299f4fe522fdf9d590b6c0cf33
+  data.tar.gz: a8007ea55894eb72494935dff5269d1e54d157eab334b823769884cc3d83d1a37be3d9cb44e603ba5a132cb3993ba8dd8e306c4d3974f9a2bf4dc2603add5706

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [v3.16.3](https://github.com/bensheldon/good_job/tree/v3.16.3) (2023-07-18)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.16.2...v3.16.3)
+
+**Fixed bugs:**
+
+- Fix bulk enqueue for unmigrated 'error\_event'; add `GoodJob.migrated?` check method; use custom enum implementation [\#1011](https://github.com/bensheldon/good_job/pull/1011) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- GoodJob::Bulk.enqueue not handling missing migrations [\#1010](https://github.com/bensheldon/good_job/issues/1010)
+
+**Merged pull requests:**
+
+- Move shared `BaseExecution` concerns into the base class. [\#1009](https://github.com/bensheldon/good_job/pull/1009) ([dixpac](https://github.com/dixpac))
+
+## [v3.16.2](https://github.com/bensheldon/good_job/tree/v3.16.2) (2023-07-13)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.16.1...v3.16.2)
+
+**Closed issues:**
+
+- Support for customized job display name [\#956](https://github.com/bensheldon/good_job/issues/956)
+
+**Merged pull requests:**
+
+- Add `GoodJob::Job#display_name` to allow customizing dashboard job display [\#1008](https://github.com/bensheldon/good_job/pull/1008) ([paul](https://github.com/paul))
+
 ## [v3.16.1](https://github.com/bensheldon/good_job/tree/v3.16.1) (2023-07-11)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.16.0...v3.16.1)

data/README.md

@@ -703,7 +703,9 @@ GoodJob follows semantic versioning, though updates may be encouraged through de
 
 #### Upgrading minor versions
 
-Upgrading between minor versions (e.g. v1.4 to v1.5) should not introduce breaking changes, but can introduce new deprecation warnings and database migration notices.
+Upgrading between minor versions (e.g. v1.4 to v1.5) should not introduce breaking changes, but can introduce new deprecation warnings and database migration warnings.
+
+Database migrations introduced in minor releases are _not required_ to be applied until the next major release. If you would like apply newly introduced migrations immediately, assert `GoodJob.migrated?` in your application's test suite.
 
 To perform upgrades to the GoodJob database tables:
 

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

@@ -14,15 +14,32 @@ module GoodJob
       ERROR_EVENT_DISCARDED = 'discarded',
     ].freeze
 
-    included do
-      enum error_event: {
-        ERROR_EVENT_INTERRUPTED => 0,
-        ERROR_EVENT_UNHANDLED => 1,
-        ERROR_EVENT_HANDLED => 2,
-        ERROR_EVENT_RETRIED => 3,
-        ERROR_EVENT_RETRY_STOPPED => 4,
-        ERROR_EVENT_DISCARDED => 5,
-      }.freeze, _prefix: :error_event
+    ERROR_EVENT_ENUMS = {
+      ERROR_EVENT_INTERRUPTED => 0,
+      ERROR_EVENT_UNHANDLED => 1,
+      ERROR_EVENT_HANDLED => 2,
+      ERROR_EVENT_RETRIED => 3,
+      ERROR_EVENT_RETRY_STOPPED => 4,
+      ERROR_EVENT_DISCARDED => 5,
+    }.freeze
+
+    # TODO: GoodJob v4 can make this an `enum` once migrations are guaranteed.
+    def error_event
+      return unless self.class.columns_hash['error_event']
+
+      enum = super
+      return unless enum
+
+      ERROR_EVENT_ENUMS.key(enum)
+    end
+
+    def error_event=(event)
+      return unless self.class.columns_hash['error_event']
+
+      enum = ERROR_EVENT_ENUMS[event]
+      raise(ArgumentError, "Invalid error_event: #{event}") if event && !enum
+
+      super(enum)
     end
   end
 end

data/app/models/good_job/base_execution.rb

@@ -5,6 +5,9 @@ module GoodJob
   # which both read out of the same table.
   class BaseExecution < BaseRecord
     include ErrorEvents
+    include Filterable
+    include Lockable
+    include Reportable
 
     self.table_name = 'good_jobs'
 

data/app/models/good_job/execution.rb

@@ -3,10 +3,6 @@
 module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
   class Execution < BaseExecution
-    include Lockable
-    include Filterable
-    include Reportable
-
     # Raised if something attempts to execute a previously completed Execution again.
     PreviouslyPerformedError = Class.new(StandardError)
 
@@ -384,7 +380,7 @@ module GoodJob
                 error: interrupt_error_string,
                 finished_at: Time.current,
               }
-              discrete_execution_attrs[:error_event] = GoodJob::DiscreteExecution.error_events[GoodJob::DiscreteExecution::ERROR_EVENT_INTERRUPTED] if self.class.error_event_migrated?
+              discrete_execution_attrs[:error_event] = GoodJob::ErrorEvents::ERROR_EVENT_ENUMS[GoodJob::ErrorEvents::ERROR_EVENT_INTERRUPTED] if self.class.error_event_migrated?
               discrete_executions.where(finished_at: nil).where.not(performed_at: nil).update_all(discrete_execution_attrs) # rubocop:disable Rails/SkipsModelValidations
             end
           end

data/app/models/good_job/job.rb

@@ -7,10 +7,6 @@ module GoodJob
   # A single row from the +good_jobs+ table of executions is fetched to represent a Job.
   #
   class Job < BaseExecution
-    include Filterable
-    include Lockable
-    include Reportable
-
     # Raised when an inappropriate action is applied to a Job based on its state.
     ActionForStateMismatchError = Class.new(StandardError)
     # Raised when an action requires GoodJob to be the ActiveJob Queue Adapter but GoodJob is not.
@@ -149,6 +145,12 @@ module GoodJob
                               })
     end
 
+    # Used when displaying this job in the GoodJob dashboard.
+    # @return [String]
+    def display_name
+      job_class
+    end
+
     # Tests whether the job is being executed right now.
     # @return [Boolean]
     def running?
@@ -222,9 +224,12 @@ module GoodJob
 
         update_execution = proc do
           execution.update(
-            finished_at: Time.current,
-            error: GoodJob::Execution.format_error(job_error),
-            error_event: :discarded
+            {
+              finished_at: Time.current,
+              error: GoodJob::Execution.format_error(job_error),
+            }.tap do |attrs|
+              attrs[:error_event] = ERROR_EVENT_DISCARDED if self.class.error_event_migrated?
+            end
           )
         end
 

data/app/views/good_job/batches/_jobs.erb

@@ -23,7 +23,7 @@
             <div class="row align-items-center">
               <div class="col-lg-4">
                 <%= tag.code link_to(job.id, job_path(job), class: "small text-muted text-decoration-none") %>
-                <%= tag.h5 tag.code(link_to(job.job_class, job_path(job), class: "text-reset text-decoration-none")), class: "text-reset mb-0" %>
+                <%= tag.h5 tag.code(link_to(job.display_name, job_path(job), class: "text-reset text-decoration-none")), class: "text-reset mb-0" %>
               </div>
               <div class="col-4 col-lg-1 text-lg-center">
                 <div class="d-lg-none small text-muted mt-1"><%=t "good_job.models.job.queue" %></div>

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

@@ -64,7 +64,7 @@
               <%= check_box_tag 'job_ids[]', job.id, false, id: dom_id(job, :checkbox), data: { "checkbox-toggle-each": "job_ids" } %>
               <div class="ms-2">
                 <%= tag.code link_to(job.id, job_path(job), class: "small text-muted text-decoration-none") %>
-                <%= tag.h5 tag.code(link_to(job.job_class, job_path(job), class: "text-reset text-decoration-none")), class: "text-reset mb-0" %>
+                <%= tag.h5 tag.code(link_to(job.display_name, job_path(job), class: "text-reset text-decoration-none")), class: "text-reset mb-0" %>
                 <% if job.error %>
                   <div class="mt-1 small">
                     <strong class="small"><%=t "good_job.shared.error" %>:</strong>

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

@@ -13,7 +13,7 @@
     </nav>
     <div class="row align-items-center">
       <div class="col-md-5">
-        <h2 class="mb-2 mb-md-0"><%= tag.code @job.job_class %></h2>
+        <h2 class="mb-2 mb-md-0"><%= tag.code @job.display_name %></h2>
       </div>
       <div class="col-6 col-md-2">
         <div class="small text-muted text-uppercase"><%= t "good_job.models.job.queue" %></div>

data/lib/good_job/adapter.rb

@@ -64,7 +64,15 @@ module GoodJob
 
       inline_executions = []
       GoodJob::Execution.transaction(requires_new: true, joinable: false) do
-        results = GoodJob::Execution.insert_all(executions.map(&:attributes), returning: %w[id active_job_id]) # rubocop:disable Rails/SkipsModelValidations
+        execution_attributes = executions.map do |execution|
+          if GoodJob::Execution.error_event_migrated?
+            execution.attributes
+          else
+            execution.attributes.except('error_event')
+          end
+        end
+
+        results = GoodJob::Execution.insert_all(execution_attributes, returning: %w[id active_job_id]) # rubocop:disable Rails/SkipsModelValidations
 
         job_id_to_provider_job_id = results.each_with_object({}) { |result, hash| hash[result['active_job_id']] = result['id'] }
         active_jobs.each do |active_job|

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -246,5 +246,14 @@ module GoodJob
     end
   end
 
+  # Whether all GoodJob migrations have been applied.
+  # For use in tests/CI to validate GoodJob is up-to-date.
+  # @return [Boolean]
+  def self.migrated?
+    # Always update with the most recent migration check
+    GoodJob::Execution.reset_column_information
+    GoodJob::Execution.error_event_migrated?
+  end
+
   ActiveSupport.run_load_hooks(:good_job, self)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.16.1
+  version: 3.16.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob