good_job 3.24.0 → 3.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b464ea5a307aa615b5800649e4ff4083276900fe42bfb32edfc9ed66c470914
-  data.tar.gz: 7ff522ebb69f55a222a089ddc7c2b1fc2e0835603bcf515a630b2b27a2e90b7a
+  metadata.gz: 47f288c089d005a2b97e5fe6d7bd8fb7094d48fb52565bacf0493b5e547f6516
+  data.tar.gz: cf8cd69a7a1f64fee5172b7fd3b184d774eed0cd48d97ba0d01971af0d721646
 SHA512:
-  metadata.gz: ae2eb90d2b35711d3d4ade8ed678bba89e36fa32eb36b6bb291a4b99fbe0d60b4ea2a143521f9b20b6d386b745d690f8e6b99467b0ec1b05d9e44709f71a6b7f
-  data.tar.gz: a695f55188543d9ea6d53f1f25c4e3cfb311d4a4d7dddbed342b8034e5d09cf911f212e57fe4fba0ab64c0cc8ce0f9dcb2529756dc9c701403e5e6ee1b8113e7
+  metadata.gz: 3c74189b7315da1fcb5747b285cb4d7837550dcf1456899f2d6f023065a893bd99c93a7e292415b6796a64232335a732666a7783fc04f2319968fff4bfaf7dcc
+  data.tar.gz: 67fd833bfa126355ef0853263c7e72b5bfa5d013e1061bc128480408a52b49eddf9724686e3dc47293f8713696074f8029452c035159aee50940f0b320ff36ab

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [v3.25.0](https://github.com/bensheldon/good_job/tree/v3.25.0) (2024-02-22)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.24.0...v3.25.0)
+
+**Implemented enhancements:**
+
+- Allow disabling of Dashboard Live Polling configuration [\#1235](https://github.com/bensheldon/good_job/pull/1235) ([erick-tmr](https://github.com/erick-tmr))
+- Add customizable extension partials to good\_job/jobs\#show view [\#1200](https://github.com/bensheldon/good_job/pull/1200) ([grncdr](https://github.com/grncdr))
+
+**Fixed bugs:**
+
+- Fix default engine cron value [\#1258](https://github.com/bensheldon/good_job/pull/1258) ([hss-mateus](https://github.com/hss-mateus))
+- Print an error when daemon pidfile dir doesn't exist [\#1252](https://github.com/bensheldon/good_job/pull/1252) ([thepry](https://github.com/thepry))
+
+**Closed issues:**
+
+- Production deployment question [\#1257](https://github.com/bensheldon/good_job/issues/1257)
+- Daemon and App not connecting to secondary database [\#1254](https://github.com/bensheldon/good_job/issues/1254)
+- Logging with logger.warn in classes is suppressed by good job? \(semantic\_logger\) [\#1250](https://github.com/bensheldon/good_job/issues/1250)
+
+**Merged pull requests:**
+
+- Fix Active Record connection changes on Rails head [\#1259](https://github.com/bensheldon/good_job/pull/1259) ([bensheldon](https://github.com/bensheldon))
+- \[Docs\] Bulk.enqueue takes an array of jobs [\#1256](https://github.com/bensheldon/good_job/pull/1256) ([jpcamara](https://github.com/jpcamara))
+- Clean up icon helpers for less noisy view rendering [\#1248](https://github.com/bensheldon/good_job/pull/1248) ([bensheldon](https://github.com/bensheldon))
+- Use dotenv-rails instead of dotenv [\#1247](https://github.com/bensheldon/good_job/pull/1247) ([bensheldon](https://github.com/bensheldon))
+- Perform inline retries iteratively instead of recursively [\#1246](https://github.com/bensheldon/good_job/pull/1246) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.24.0](https://github.com/bensheldon/good_job/tree/v3.24.0) (2024-02-12)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.23.0...v3.24.0)

data/README.md

@@ -41,6 +41,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Dashboard](#dashboard)
         - [API-only Rails applications](#api-only-rails-applications)
         - [Live polling](#live-polling)
+        - [Extending dashboard views](#extending-dashboard-views)
     - [Job priority](#job-priority)
     - [Concurrency controls](#concurrency-controls)
         - [How concurrency controls work](#how-concurrency-controls-work)
@@ -451,6 +452,42 @@ end
 
 The Dashboard can be set to automatically refresh by checking "Live Poll" in the Dashboard header, or by setting `?poll=10` with the interval in seconds (default 30 seconds).
 
+#### Extending dashboard views
+
+GoodJob exposes some views that are intended to be overriden by placing views in your application:
+
+- [`app/views/good_job/jobs/_custom_job_details.html.erb`](app/views/good_job/_custom_job_details.html.erb): content added to this partial will be displayed above the argument list on the good_job/jobs#show page.
+- [`app/views/good_job/jobs/_custom_execution_details.html.erb`](app/views/good_job/_custom_execution_details.html.erb): content added to this partial will be displayed above each execution on the good_job/jobs#show page.
+
+**Warning:** these partials expose classes (such as `GoodJob::Job`) that are considered internal implementation details of GoodJob. You should always test your custom partials after upgrading GoodJob.
+
+For example, if your app deals with widgets and you want to show a link to the widget a job acted on, you can add the following to `app/views/good_job/_custom_job_details.html.erb`:
+
+```erb
+<%# file: app/views/good_job/_custom_job_details.html.erb %>
+<% arguments = job.active_job.arguments rescue [] %>
+<% widgets = arguments.select { |arg| arg.is_a?(Widget) } %>
+<% if widgets.any? %>
+  <div class="my-4">
+    <h5>Widgets</h5>
+    <ul>
+      <% widgets.each do |widget| %>
+        <li><%= link_to widget.name, main_app.widget_url(widget) %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>
+```
+
+As a second example, you may wish to show a link to a log aggregator next to each job execution. You can do this by adding the following to `app/views/good_job/_custom_execution_details.html.erb`:
+
+```erb
+<%# file: app/views/good_job/_custom_execution_details.html.erb %>
+<div class="py-3">
+  <%= link_to "Logs", main_app.logs_url(filter: { job_id: job.id }, start_time: execution.performed_at, end_time: execution.finished_at + 1.minute) %>
+</div>
+```
+
 ### Job priority
 
 Higher priority numbers run first in all versions of GoodJob v3.x and below. GoodJob v4.x will change job `priority` to give smaller numbers higher priority (default: `0`), in accordance with Active Job's definition of priority (see #524). To opt-in to this behavior now, set `config.good_job.smaller_number_is_higher_priority = true` in your GoodJob initializer or `application.rb`.
@@ -609,7 +646,7 @@ end
 active_jobs.all?(&:provider_job_id)
 
 # Bulk enqueue Active Job instances directly without using `.perform_later`:
-GoodJob::Bulk.enqueue(MyJob.new, AnotherJob.new)
+GoodJob::Bulk.enqueue([MyJob.new, AnotherJob.new])
 ```
 
 ### Batches

data/app/helpers/good_job/application_helper.rb

@@ -2,6 +2,11 @@
 
 module GoodJob
   module ApplicationHelper
+    # Explicit helper inclusion because ApplicationController inherits from the host app.
+    #
+    # We can't rely on +config.action_controller.include_all_helpers = true+ in the host app.
+    include IconsHelper
+
     def format_duration(sec)
       return unless sec
 
@@ -24,42 +29,6 @@ module GoodJob
       tag.time(text, datetime: timestamp, title: timestamp)
     end
 
-    STATUS_ICONS = {
-      discarded: "exclamation",
-      succeeded: "check",
-      queued: "dash_circle",
-      retried: "arrow_clockwise",
-      running: "play",
-      scheduled: "clock",
-    }.freeze
-
-    STATUS_COLOR = {
-      discarded: "danger",
-      succeeded: "success",
-      queued: "secondary",
-      retried: "warning",
-      running: "primary",
-      scheduled: "secondary",
-    }.freeze
-
-    def status_badge(status)
-      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: 'good_job.status', count: 1),
-                  class: "badge rounded-pill bg-#{STATUS_COLOR.fetch(status)} d-inline-flex gap-2 ps-1 pe-3 align-items-center"
-    end
-
-    def status_icon(status, **options)
-      options[:class] ||= "text-#{STATUS_COLOR.fetch(status)}"
-      icon = render_icon STATUS_ICONS.fetch(status)
-      content_tag :span, icon, **options
-    end
-
-    def render_icon(name, **options)
-      # workaround to render svg icons without all of the log messages
-      partial = lookup_context.find_template("good_job/shared/icons/#{name}", [], true)
-      options[:class] = Array(options[:class]).join(" ")
-      partial.render(self, { class: options[:class] })
-    end
-
     def translate_hash(key, **options)
       translation_exists?(key, **options) ? translate(key, **options) : {}
     end

data/app/helpers/good_job/icons_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GoodJob
+  module IconsHelper
+    STATUS_ICONS = {
+      discarded: "exclamation",
+      succeeded: "check",
+      queued: "dash_circle",
+      retried: "arrow_clockwise",
+      running: "play",
+      scheduled: "clock",
+    }.freeze
+
+    STATUS_COLOR = {
+      discarded: "danger",
+      succeeded: "success",
+      queued: "secondary",
+      retried: "warning",
+      running: "primary",
+      scheduled: "secondary",
+    }.freeze
+
+    def status_badge(status)
+      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: 'good_job.status', count: 1),
+                  class: "badge rounded-pill bg-#{STATUS_COLOR.fetch(status)} d-inline-flex gap-2 ps-1 pe-3 align-items-center"
+    end
+
+    def status_icon(status, **options)
+      options[:class] ||= "text-#{STATUS_COLOR.fetch(status)}"
+      icon = render_icon STATUS_ICONS.fetch(status)
+      content_tag :span, icon, **options
+    end
+
+    def render_icon(name, **options)
+      # workaround to render svg icons without all of the log messages
+      partial = lookup_context.find_template("good_job/shared/icons/#{name}", [], true)
+      options[:class] = Array(options[:class]).join(" ")
+      partial.render(self, { class: options[:class] })
+    end
+  end
+end

data/app/models/good_job/execution.rb

@@ -343,8 +343,10 @@ module GoodJob
         execution.save!
 
         if retried
-          CurrentThread.execution_retried = true
+          CurrentThread.execution_retried = execution
           CurrentThread.execution.retried_good_job_id = execution.id unless current_execution.discrete?
+        else
+          CurrentThread.execution_retried = nil
         end
 
         active_job.provider_job_id = execution.id
@@ -367,22 +369,24 @@ module GoodJob
       run_callbacks(:perform) do
         raise PreviouslyPerformedError, 'Cannot perform a job that has already been performed' if finished_at
 
+        job_performed_at = Time.current
         discrete_execution = nil
         result = GoodJob::CurrentThread.within do |current_thread|
           current_thread.reset
           current_thread.execution = self
 
-          if performed_at
-            current_thread.execution_interrupted = performed_at
+          existing_performed_at = performed_at
+          if existing_performed_at
+            current_thread.execution_interrupted = existing_performed_at
 
             if discrete?
-              interrupt_error_string = self.class.format_error(GoodJob::InterruptError.new("Interrupted after starting perform at '#{performed_at}'"))
+              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?
 
               discrete_execution_attrs = {
                 error: interrupt_error_string,
-                finished_at: Time.current,
+                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_executions.where(finished_at: nil).where.not(performed_at: nil).update_all(discrete_execution_attrs) # rubocop:disable Rails/SkipsModelValidations
@@ -391,18 +395,17 @@ module GoodJob
 
           if discrete?
             transaction do
-              now = Time.current
               discrete_execution = discrete_executions.create!(
                 job_class: job_class,
                 queue_name: queue_name,
                 serialized_params: serialized_params,
                 scheduled_at: (scheduled_at || created_at),
-                created_at: now
+                created_at: job_performed_at
               )
-              update!(performed_at: now, executions_count: ((executions_count || 0) + 1))
+              update!(performed_at: job_performed_at, executions_count: ((executions_count || 0) + 1))
             end
           else
-            update!(performed_at: Time.current)
+            update!(performed_at: job_performed_at)
           end
 
           ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do |instrument_payload|
@@ -427,7 +430,7 @@ module GoodJob
             instrument_payload.merge!(
               value: value,
               handled_error: handled_error,
-              retried: current_thread.execution_retried,
+              retried: current_thread.execution_retried.present?,
               error_event: error_event
             )
             ExecutionResult.new(value: value, handled_error: handled_error, error_event: error_event, retried: current_thread.execution_retried)
@@ -445,47 +448,49 @@ module GoodJob
           end
         end
 
-        job_error = result.handled_error || result.unhandled_error
+        job_attributes = {}
 
+        job_error = result.handled_error || result.unhandled_error
         if job_error
           error_string = self.class.format_error(job_error)
-          self.error = error_string
-          self.error_event = result.error_event if self.class.error_event_migrated?
+
+          job_attributes[:error] = error_string
+          job_attributes[:error_event] = result.error_event if self.class.error_event_migrated?
           if discrete_execution
             discrete_execution.error = error_string
-            discrete_execution.error_event = result.error_event if discrete_execution.class.error_event_migrated?
+            discrete_execution.error_event = result.error_event
           end
         else
-          self.error = nil
-          self.error_event = nil if self.class.error_event_migrated?
+          job_attributes[:error] = nil
+          job_attributes[:error_event] = nil
         end
+        job_attributes.delete(:error_event) unless self.class.error_event_migrated?
+
+        job_finished_at = Time.current
+        job_attributes[:finished_at] = job_finished_at
+        discrete_execution.finished_at = job_finished_at if discrete_execution
 
-        reenqueued = result.retried? || retried_good_job_id.present?
-        if result.unhandled_error && GoodJob.retry_on_unhandled_error
+        retry_unhandled_error = result.unhandled_error && GoodJob.retry_on_unhandled_error
+        reenqueued = result.retried? || retried_good_job_id.present? || retry_unhandled_error
+        if reenqueued
           if discrete_execution
-            transaction do
-              discrete_execution.update!(finished_at: Time.current)
-              update!(performed_at: nil, finished_at: nil, retried_good_job_id: nil)
-            end
+            job_attributes[:performed_at] = nil
+            job_attributes[:finished_at] = nil
           else
-            save!
+            job_attributes[:retried_good_job_id] = retried_good_job_id
+            job_attributes[:finished_at] = nil if retry_unhandled_error
           end
-        elsif GoodJob.preserve_job_records == true || reenqueued || (result.unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error) || cron_key.present?
-          now = Time.current
+        end
+
+        preserve_unhandled = (result.unhandled_error && (GoodJob.retry_on_unhandled_error || GoodJob.preserve_job_records == :on_unhandled_error))
+        if GoodJob.preserve_job_records == true || reenqueued || preserve_unhandled || cron_key.present?
           if discrete_execution
-            if reenqueued
-              self.performed_at = nil
-            else
-              self.finished_at = now
-            end
-            discrete_execution.finished_at = now
             transaction do
               discrete_execution.save!
-              save!
+              update!(job_attributes)
             end
           else
-            self.finished_at = now
-            save!
+            update!(job_attributes)
           end
         else
           destroy_job
@@ -556,6 +561,12 @@ module GoodJob
       @_destroy_job = false
     end
 
+    def job_state
+      state = { queue_name: queue_name }
+      state[:scheduled_at] = scheduled_at if scheduled_at
+      state
+    end
+
     private
 
     def reset_batch_values(&block)

data/app/models/good_job/execution_result.rb

@@ -13,9 +13,8 @@ module GoodJob
     attr_reader :error_event
     # @return [Boolean, nil]
     attr_reader :unexecutable
-    # @return [Boolean, nil]
+    # @return [GoodJob::Execution, nil]
     attr_reader :retried
-    alias retried? retried
 
     # @param value [Object, nil]
     # @param handled_error [Exception, nil]
@@ -23,7 +22,7 @@ module GoodJob
     # @param error_event [String, nil]
     # @param unexecutable [Boolean, nil]
     # @param retried [Boolean, nil]
-    def initialize(value:, handled_error: nil, unhandled_error: nil, error_event: nil, unexecutable: nil, retried: false)
+    def initialize(value:, handled_error: nil, unhandled_error: nil, error_event: nil, unexecutable: nil, retried: nil)
       @value = value
       @handled_error = handled_error
       @unhandled_error = unhandled_error
@@ -34,7 +33,12 @@ module GoodJob
 
     # @return [Boolean]
     def succeeded?
-      !(handled_error || unhandled_error || unexecutable || retried)
+      !(handled_error || unhandled_error || unexecutable || retried?)
+    end
+
+    # @return [Boolean]
+    def retried?
+      retried.present?
     end
   end
 end

data/app/models/good_job/job.rb

@@ -195,12 +195,20 @@ module GoodJob
         # Do not update `exception_executions` because that comes from rescue_from's arguments
         active_job.executions = (active_job.executions || 0) + 1
 
+        begin
+          error_class, error_message = execution.error.split(GoodJob::Execution::ERROR_MESSAGE_SEPARATOR).map(&:strip)
+          error = error_class.constantize.new(error_message)
+        rescue StandardError
+          error = StandardError.new(execution.error)
+        end
+
         new_active_job = nil
         GoodJob::CurrentThread.within do |current_thread|
           current_thread.execution = execution
+          current_thread.retry_now = true
 
           execution.class.transaction(joinable: false, requires_new: true) do
-            new_active_job = active_job.retry_job(wait: 0, error: execution.error)
+            new_active_job = active_job.retry_job(wait: 0, error: error)
             execution.error_event = ERROR_EVENT_RETRIED if execution.error && execution.class.error_event_migrated?
             execution.save!
           end

data/app/models/good_job/process.rb

@@ -6,7 +6,7 @@ module GoodJob # :nodoc:
   # ActiveRecord model that represents an GoodJob process (either async or CLI).
   class Process < BaseRecord
     include AdvisoryLockable
-    include AssignableConnection
+    include OverridableConnection
 
     # Interval until the process record being updated
     STALE_INTERVAL = 30.seconds

data/app/views/good_job/_custom_execution_details.html.erb

@@ -0,0 +1,11 @@
+<%#
+Content added to this partial will be displayed above the collapsible JSON representation of each execution on the jobs#show view.
+
+You can make use of the following variables:
+
+- `job`: The `GoodJob::Job` instance.
+- `execution`: The `GoodJob::DiscreteExecution` instance.
+- `main_app`: Use this to access helpers (e.g. route helpers) from your application.
+
+Note: the `GoodJob::Job` and `GoodJob::Execution` classes are considered an internal implementation detail of GoodJob and may change at any time. Please test your view extensions when upgrading.
+%>

data/app/views/good_job/_custom_job_details.html.erb

@@ -0,0 +1,10 @@
+<%#
+Content added to this partial will be displayed above the argument list on the good_job/jobs#show page.
+
+You can make use of the following variables:
+
+- `job`: The `GoodJob::Job` instance. Calling `job.active_job` will deserialize an instance of your ActiveJob class.
+- `main_app`: Use this to access helpers (e.g. route helpers) from your application.
+
+Note: the `GoodJob::Job` class is considered an internal implementation detail and may change at any time. Please test your view extensions when upgrading.
+%>

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

@@ -52,27 +52,27 @@
 
                 <div class="dropdown float-end">
                   <button class="d-flex align-items-center btn btn-sm" type="button" id="<%= dom_id(job, :actions) %>" data-bs-toggle="dropdown" aria-expanded="false">
-                    <%= render "good_job/shared/icons/dots" %>
+                    <%= render_icon :dots %>
                     <span class="visually-hidden"><%=t ".actions.title" %></span>
                   </button>
                   <ul class="dropdown-menu shadow" aria-labelledby="<%= dom_id(job, :actions) %>">
                     <li>
                       <% job_reschedulable = job.status.in? [:scheduled, :retried, :queued] %>
                       <%= link_to reschedule_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job_reschedulable}", title: t(".actions.reschedule"), data: { confirm: t(".actions.confirm_reschedule"), disable: true } do %>
-                        <%= render "good_job/shared/icons/skip_forward" %>
+                        <%= render_icon "skip_forward" %>
                         <%=t "good_job.actions.reschedule" %>
                       <% end %>
                     </li>
                     <li>
                       <% job_discardable = job.status.in? [:scheduled, :retried, :queued] %>
                       <%= link_to discard_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job_discardable}", title: t(".actions.discard"), data: { confirm: t(".actions.confirm_discard"), disable: true } do %>
-                        <%= render "good_job/shared/icons/stop" %>
+                        <%= render_icon "stop" %>
                         <%=t "good_job.actions.discard" %>
                       <% end %>
                     </li>
                     <li>
                       <%= link_to retry_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job.status == :discarded}", title: t(".actions.retry"), data: { confirm: t(".actions.confirm_retry"), disable: true } do %>
-                        <%= render "good_job/shared/icons/arrow_clockwise" %>
+                        <%= render_icon "arrow_clockwise" %>
                         <%=t "good_job.actions.retry" %>
                       <% end %>
                     </li>

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

@@ -40,6 +40,7 @@
           </div>
         <% end %>
       <% end %>
+      <%= render 'good_job/custom_execution_details', execution: execution, job: @job %>
       <%= tag.div id: dom_id(execution, "params"), class: "list-group-item collapse small bg-dark text-light" do %>
         <%= tag.pre JSON.pretty_generate(execution.display_serialized_params) %>
       <% end %>

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

@@ -109,34 +109,34 @@
 
                 <div class="dropdown float-end">
                   <button class="d-flex align-items-center btn btn-sm" type="button" id="<%= dom_id(job, :actions) %>" data-bs-toggle="dropdown" aria-expanded="false">
-                    <%= render "good_job/shared/icons/dots" %>
+                    <%= render_icon "dots" %>
                     <span class="visually-hidden"><%=t ".actions.title" %></span>
                   </button>
                   <ul class="dropdown-menu shadow" aria-labelledby="<%= dom_id(job, :actions) %>">
                     <li>
                       <% job_reschedulable = job.status.in? [:scheduled, :retried, :queued] %>
                       <%= link_to reschedule_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job_reschedulable}", title: t("good_job.jobs.actions.reschedule"), data: { confirm: t("good_job.jobs.actions.confirm_reschedule"), disable: true } do %>
-                        <%= render "good_job/shared/icons/skip_forward" %>
+                        <%= render_icon "skip_forward" %>
                         <%=t "good_job.actions.reschedule" %>
                       <% end %>
                     </li>
                     <li>
                       <% job_discardable = job.status.in? [:scheduled, :retried, :queued] %>
                       <%= link_to discard_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job_discardable}", title: t("good_job.jobs.actions.discard"), data: { confirm: t("good_job.jobs.actions.confirm_discard"), disable: true } do %>
-                        <%= render "good_job/shared/icons/stop" %>
+                        <%= render_icon "stop" %>
                         <%=t "good_job.actions.discard" %>
                       <% end %>
                     </li>
                     <li>
                       <% job_force_discardable = job.status.in? [:running] %>
                       <%= link_to force_discard_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job_force_discardable}", title: t("good_job.jobs.actions.force_discard"), data: { confirm: t("good_job.jobs.actions.confirm_force_discard"), disable: true } do %>
-                        <%= render "good_job/shared/icons/eject" %>
+                        <%= render_icon "eject" %>
                         <%=t "good_job.actions.force_discard" %>
                       <% end %>
                     </li>
                     <li>
                       <%= link_to retry_job_path(job.id), method: :put, class: "dropdown-item #{'disabled' unless job.status == :discarded}", title: t("good_job.jobs.actions.retry"), data: { confirm: t("good_job.jobs.actions.confirm_retry"), disable: true } do %>
-                        <%= render "good_job/shared/icons/arrow_clockwise" %>
+                        <%= render_icon "arrow_clockwise" %>
                         <%=t "good_job.actions.retry" %>
                       <% end %>
                     </li>

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

@@ -67,6 +67,8 @@
   </div>
 </div>
 
+<%= render 'good_job/custom_job_details', job: @job %>
+
 <div class="my-4">
   <h5>
     <%= t "good_job.models.job.arguments" %>

data/app/views/good_job/shared/_alert.erb

@@ -2,7 +2,7 @@
   <% if notice %>
     <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
       <div class="toast-body d-flex align-items-center gap-2">
-        <%= render "good_job/shared/icons/check", class: "flex-shrink-0 text-success" %>
+        <%= render_icon "check", class: "flex-shrink-0 text-success" %>
         <div class="flex-fill"><%= notice %></div>
         <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
       </div>
@@ -11,7 +11,7 @@
   <% if alert %>
     <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
       <div class="toast-body d-flex align-items-center gap-2">
-        <%= render "good_job/shared/icons/exclamation", class: "flex-shrink-0 text-danger" %>
+        <%= render_icon "exclamation", class: "flex-shrink-0 text-danger" %>
         <div class="flex-fill"><%= alert %></div>
         <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
       </div>

data/app/views/good_job/shared/_navbar.erb

@@ -60,7 +60,7 @@
 
         <li class="nav-item d-flex flex-column justify-content-center">
           <div class="form-check form-switch m-0">
-            <%= check_box_tag "live_poll", params.fetch("poll", 30), params[:poll].present?, role: "switch", class: "form-check-input" %>
+            <%= check_box_tag "live_poll", params.fetch("poll", 30), (GoodJob.configuration.dashboard_live_poll_enabled && params[:poll].present?), role: "switch", class: "form-check-input", disabled: !GoodJob.configuration.dashboard_live_poll_enabled %>
             <label class="form-check-label navbar-text p-0" for="live_poll">
               <%= t(".live_poll") %>
             </label>

data/app/views/good_job/shared/icons/_check.html.erb

@@ -1,5 +1,5 @@
 <!-- https://icons.getbootstrap.com/icons/check-circle/ -->
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-check-circle" viewBox="0 0 16 16">
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-check-circle <%= local_assigns[:class] %>" viewBox="0 0 16 16">
   <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z" />
   <path d="M10.97 4.97a.235.235 0 0 0-.02.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-1.071-1.05z" />
 </svg>

data/app/views/good_job/shared/icons/_exclamation.html.erb

@@ -1,5 +1,5 @@
 <!-- https://icons.getbootstrap.com/icons/exclamation-circle/ -->
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-exclamation-circle" viewBox="0 0 16 16">
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-exclamation-circle <%= local_assigns[:class] %>" viewBox="0 0 16 16">
   <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z" />
   <path d="M7.002 11a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 4.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995z" />
 </svg>

data/lib/good_job/adapter.rb

@@ -96,6 +96,13 @@ module GoodJob
             begin
               inline_execution = inline_executions.shift
               inline_result = inline_execution.perform
+
+              retried_execution = inline_result.retried
+              while retried_execution && retried_execution.scheduled_at <= Time.current
+                inline_execution = retried_execution
+                inline_result = inline_execution.perform
+                retried_execution = inline_result.retried
+              end
             ensure
               inline_execution.advisory_unlock
               inline_execution.run_callbacks(:perform_unlocked)
@@ -141,26 +148,43 @@ module GoodJob
 
       Rails.application.executor.wrap do
         will_execute_inline = execute_inline? && (scheduled_at.nil? || scheduled_at <= Time.current)
-        execution = GoodJob::Execution.enqueue(
-          active_job,
-          scheduled_at: scheduled_at,
-          create_with_advisory_lock: will_execute_inline
-        )
-
-        if will_execute_inline
+        will_retry_inline = will_execute_inline && CurrentThread.execution&.active_job_id == active_job.job_id && !CurrentThread.retry_now
+
+        if will_retry_inline
+          execution = GoodJob::Execution.enqueue(
+            active_job,
+            scheduled_at: scheduled_at
+          )
+        elsif will_execute_inline
+          execution = GoodJob::Execution.enqueue(
+            active_job,
+            scheduled_at: scheduled_at,
+            create_with_advisory_lock: true
+          )
           begin
             result = execution.perform
+
+            retried_execution = result.retried
+            while retried_execution && (retried_execution.scheduled_at.nil? || retried_execution.scheduled_at <= Time.current)
+              execution = retried_execution
+              result = execution.perform
+              retried_execution = result.retried
+            end
+
+            Notifier.notify(retried_execution.job_state) if retried_execution&.scheduled_at && retried_execution.scheduled_at > Time.current && send_notify?(active_job)
           ensure
             execution.advisory_unlock
             execution.run_callbacks(:perform_unlocked)
           end
           raise result.unhandled_error if result.unhandled_error
         else
-          job_state = { queue_name: execution.queue_name }
-          job_state[:scheduled_at] = execution.scheduled_at if execution.scheduled_at
+          execution = GoodJob::Execution.enqueue(
+            active_job,
+            scheduled_at: scheduled_at
+          )
 
-          executed_locally = execute_async? && @capsule&.create_thread(job_state)
-          Notifier.notify(job_state) if !executed_locally && send_notify?(active_job)
+          executed_locally = execute_async? && @capsule&.create_thread(execution.job_state)
+          Notifier.notify(execution.job_state) if !executed_locally && send_notify?(active_job)
         end
 
         execution

data/lib/good_job/configuration.rb

@@ -31,6 +31,8 @@ module GoodJob
     DEFAULT_ENABLE_LISTEN_NOTIFY = true
     # Default Dashboard I18n locale
     DEFAULT_DASHBOARD_DEFAULT_LOCALE = :en
+    # Default Dashboard Live Poll button enabled
+    DEFAULT_DASHBOARD_LIVE_POLL_ENABLED = true
 
     def self.validate_execution_mode(execution_mode)
       raise ArgumentError, "GoodJob execution mode must be one of #{EXECUTION_MODES.join(', ')}. It was '#{execution_mode}' which is not valid." unless execution_mode.in?(EXECUTION_MODES)
@@ -204,9 +206,10 @@ module GoodJob
 
     def cron
       env_cron = JSON.parse(ENV.fetch('GOOD_JOB_CRON'), symbolize_names: true) if ENV['GOOD_JOB_CRON'].present?
+      rails_config_cron = rails_config[:cron].presence
 
       options[:cron] ||
-        rails_config[:cron] ||
+        rails_config_cron ||
         env_cron ||
         {}
     end
@@ -380,6 +383,12 @@ module GoodJob
       rails_config[:dashboard_default_locale] || DEFAULT_DASHBOARD_DEFAULT_LOCALE
     end
 
+    def dashboard_live_poll_enabled
+      return rails_config[:dashboard_live_poll_enabled] unless rails_config[:dashboard_live_poll_enabled].nil?
+
+      DEFAULT_DASHBOARD_LIVE_POLL_ENABLED
+    end
+
     # Whether running in a web server process.
     # @return [Boolean, nil]
     def in_webserver?

data/lib/good_job/current_thread.rb

@@ -16,6 +16,7 @@ module GoodJob
       execution
       execution_interrupted
       execution_retried
+      retry_now
     ].freeze
 
     # @!attribute [rw] cron_at
@@ -66,6 +67,12 @@ module GoodJob
     #   @return [Boolean, nil]
     thread_mattr_accessor :execution_retried
 
+    # @!attribute [rw] retry_now
+    #   @!scope class
+    #   Execution Retried
+    #   @return [Boolean, nil]
+    thread_mattr_accessor :retry_now
+
     # Resets attributes
     # @param [Hash] values to assign
     # @return [void]

data/lib/good_job/daemon.rb

@@ -17,6 +17,7 @@ module GoodJob
     # Daemonizes the current process and writes out a pidfile.
     # @return [void]
     def daemonize
+      check_pid_dir
       check_pid
       ::Process.daemon
       write_pid
@@ -38,6 +39,14 @@ module GoodJob
       File.delete(pidfile) if File.exist?(pidfile) # rubocop:disable Lint/NonAtomicFileOperation
     end
 
+    # @return [void]
+    def check_pid_dir
+      dirname = File.dirname(pidfile)
+      return if Dir.exist?(dirname)
+
+      abort "Pidfile directory \"#{dirname}\" doesn't exist. Aborting..."
+    end
+
     # @return [void]
     def check_pid
       case pid_status(pidfile)

data/lib/good_job/notifier/process_heartbeat.rb

@@ -14,7 +14,7 @@ module GoodJob # :nodoc:
 
       # Registers the current process.
       def register_process
-        GoodJob::Process.with_connection(connection) do
+        GoodJob::Process.override_connection(connection) do
           GoodJob::Process.cleanup
           @process = GoodJob::Process.register
         end
@@ -22,7 +22,7 @@ module GoodJob # :nodoc:
 
       def refresh_process
         Rails.application.executor.wrap do
-          GoodJob::Process.with_connection(connection) do
+          GoodJob::Process.override_connection(connection) do
             GoodJob::Process.with_logger_silenced do
               @process&.refresh_if_stale(cleanup: true)
             end
@@ -32,7 +32,7 @@ module GoodJob # :nodoc:
 
       # Deregisters the current process.
       def deregister_process
-        GoodJob::Process.with_connection(connection) do
+        GoodJob::Process.override_connection(connection) do
           @process&.deregister
         end
       end

data/lib/good_job/{assignable_connection.rb → overridable_connection.rb}

@@ -3,36 +3,29 @@
 module GoodJob # :nodoc:
   # Extends an ActiveRecord odel to override the connection and use
   # an explicit connection that has been removed from the pool.
-  module AssignableConnection
+  module OverridableConnection
     extend ActiveSupport::Concern
 
     included do
-      thread_cattr_accessor :_connection
+      thread_cattr_accessor :_overridden_connection
     end
 
     class_methods do
-      # Assigns a connection to the model.
-      # @param conn [ActiveRecord::ConnectionAdapters::AbstractAdapter]
-      # @return [void]
-      def connection=(conn)
-        self._connection = conn
-      end
-
       # Overrides the existing connection method to use the assigned connection
       # @return [ActiveRecord::ConnectionAdapters::AbstractAdapter]
       def connection
-        _connection || super
+        _overridden_connection || super
       end
 
       # Block interface to assign the connection, yield, then unassign the connection.
       # @param conn [ActiveRecord::ConnectionAdapters::AbstractAdapter]
       # @return [void]
-      def with_connection(conn)
-        original_conn = _connection
-        self.connection = conn
+      def override_connection(conn)
+        original_conn = _overridden_connection
+        self._overridden_connection = conn
         yield
       ensure
-        self._connection = original_conn
+        self._overridden_connection = original_conn
       end
     end
   end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -15,7 +15,7 @@ require "good_job/active_job_extensions/interrupt_errors"
 require "good_job/active_job_extensions/labels"
 require "good_job/active_job_extensions/notify_options"
 
-require "good_job/assignable_connection"
+require "good_job/overridable_connection"
 require "good_job/bulk"
 require "good_job/callable"
 require "good_job/capsule"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.25.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -288,6 +288,7 @@ files:
 - app/frontend/good_job/vendor/rails_ujs.js
 - app/frontend/good_job/vendor/stimulus.js
 - app/helpers/good_job/application_helper.rb
+- app/helpers/good_job/icons_helper.rb
 - app/models/concerns/good_job/advisory_lockable.rb
 - app/models/concerns/good_job/error_events.rb
 - app/models/concerns/good_job/filterable.rb
@@ -305,6 +306,8 @@ files:
 - app/models/good_job/job.rb
 - app/models/good_job/process.rb
 - app/models/good_job/setting.rb
+- app/views/good_job/_custom_execution_details.html.erb
+- app/views/good_job/_custom_job_details.html.erb
 - app/views/good_job/batches/_jobs.erb
 - app/views/good_job/batches/_table.erb
 - app/views/good_job/batches/index.html.erb
@@ -375,7 +378,6 @@ files:
 - lib/good_job/active_job_extensions/labels.rb
 - lib/good_job/active_job_extensions/notify_options.rb
 - lib/good_job/adapter.rb
-- lib/good_job/assignable_connection.rb
 - lib/good_job/bulk.rb
 - lib/good_job/callable.rb
 - lib/good_job/capsule.rb
@@ -394,6 +396,7 @@ files:
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
 - lib/good_job/notifier/process_heartbeat.rb
+- lib/good_job/overridable_connection.rb
 - lib/good_job/poller.rb
 - lib/good_job/probe_server.rb
 - lib/good_job/probe_server/healthcheck_middleware.rb