good_job 3.0.2 → 3.3.0

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

@@ -7,9 +7,9 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.text :queue_name
       t.integer :priority
       t.jsonb :serialized_params
-      t.timestamp :scheduled_at
-      t.timestamp :performed_at
-      t.timestamp :finished_at
+      t.datetime :scheduled_at
+      t.datetime :performed_at
+      t.datetime :finished_at
       t.text :error
 
       t.timestamps
@@ -18,7 +18,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.text :concurrency_key
       t.text :cron_key
       t.uuid :retried_good_job_id
-      t.timestamp :cron_at
+      t.datetime :cron_at
     end
 
     create_table :good_job_processes, id: :uuid do |t|

data/lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb

@@ -7,9 +7,9 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.text :queue_name
       t.integer :priority
       t.jsonb :serialized_params
-      t.timestamp :scheduled_at
-      t.timestamp :performed_at
-      t.timestamp :finished_at
+      t.datetime :scheduled_at
+      t.datetime :performed_at
+      t.datetime :finished_at
       t.text :error
 
       t.timestamps
@@ -18,7 +18,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.text :concurrency_key
       t.text :cron_key
       t.uuid :retried_good_job_id
-      t.timestamp :cron_at
+      t.datetime :cron_at
     end
 
     create_table :good_job_processes, id: :uuid do |t|

data/lib/good_job/daemon.rb

@@ -26,7 +26,7 @@ module GoodJob
     # @return [void]
     def write_pid
       File.open(pidfile, ::File::CREAT | ::File::EXCL | ::File::WRONLY) { |f| f.write(::Process.pid.to_s) }
-      at_exit { File.delete(pidfile) if File.exist?(pidfile) }
+      at_exit { File.delete(pidfile) if File.exist?(pidfile) } # rubocop:disable Lint/NonAtomicFileOperation
     rescue Errno::EEXIST
       check_pid
       retry
@@ -34,7 +34,7 @@ module GoodJob
 
     # @return [void]
     def delete_pid
-      File.delete(pidfile) if File.exist?(pidfile)
+      File.delete(pidfile) if File.exist?(pidfile) # rubocop:disable Lint/NonAtomicFileOperation
     end
 
     # @return [void]

data/lib/good_job/job_performer.rb

@@ -24,7 +24,7 @@ module GoodJob
     # Perform the next eligible job
     # @return [Object, nil] Returns job result or +nil+ if no job was found
     def next
-      job_query.perform_with_advisory_lock
+      job_query.perform_with_advisory_lock(parsed_queues: parsed_queues)
     end
 
     # Tests whether this performer should be used in GoodJob's current state.

data/lib/good_job/version.rb

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

data/lib/models/good_job/cron_entry.rb

@@ -112,9 +112,11 @@ module GoodJob # :nodoc:
         class: job_class,
         cron: schedule,
         set: display_property(set),
-        args: display_property(args),
         description: display_property(description),
-      }
+      }.tap do |properties|
+        properties[:args] = display_property(args) if args.present?
+        properties[:kwargs] = display_property(kwargs) if kwargs.present?
+      end
     end
 
     private

data/lib/models/good_job/execution.rb

@@ -4,6 +4,7 @@ module GoodJob
   class Execution < BaseRecord
     include Lockable
     include Filterable
+    include Reportable
 
     # Raised if something attempts to execute a previously completed Execution again.
     PreviouslyPerformedError = Class.new(StandardError)
@@ -29,15 +30,21 @@ module GoodJob
     #     not match.
     #   - +{ include: Array<String> }+ indicates the listed queue names should
     #     match.
+    #   - +{ include: Array<String>, ordered_queues: true }+ indicates the listed
+    #     queue names should match, and dequeue should respect queue order.
     # @example
     #   GoodJob::Execution.queue_parser('-queue1,queue2')
     #   => { exclude: [ 'queue1', 'queue2' ] }
     def self.queue_parser(string)
       string = string.presence || '*'
 
-      if string.first == '-'
+      case string.first
+      when '-'
         exclude_queues = true
         string = string[1..-1]
+      when '+'
+        ordered_queues = true
+        string = string[1..-1]
       end
 
       queues = string.split(',').map(&:strip)
@@ -46,6 +53,11 @@ module GoodJob
         { all: true }
       elsif exclude_queues
         { exclude: queues }
+      elsif ordered_queues
+        {
+          include: queues,
+          ordered_queues: true,
+        }
       else
         { include: queues }
       end
@@ -88,6 +100,42 @@ module GoodJob
     # @return [ActiveRecord::Relation]
     scope :priority_ordered, -> { order('priority DESC NULLS LAST') }
 
+    # Order jobs 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
+    # @!method dequeueing_ordered
+    # @!scope class
+    # @param parsed_queues [Hash]
+    #   optional output of .queue_parser, parsed queues, will be used for
+    #   ordered queues.
+    # @return [ActiveRecord::Relation]
+    scope :dequeueing_ordered, (lambda do |parsed_queues|
+      relation = self
+      relation = relation.queue_ordered(parsed_queues[:include]) if parsed_queues && parsed_queues[:ordered_queues] && parsed_queues[:include]
+      relation = relation.priority_ordered.creation_ordered
+
+      relation
+    end)
+
+    # Order jobs in order of queues in array param
+    # @!method queue_ordered
+    # @!scope class
+    # @param queues [Array<string] ordered names of queues
+    # @return [ActiveRecord::Relation]
+    scope :queue_ordered, (lambda do |queues|
+      clauses = queues.map.with_index do |queue_name, index|
+        "WHEN queue_name = '#{queue_name}' THEN #{index}"
+      end
+
+      order(
+        Arel.sql("(CASE #{clauses.join(' ')} ELSE #{queues.length} END)")
+      )
+    end)
+
     # Order jobs by scheduled or created (oldest first).
     # @!method schedule_ordered
     # @!scope class
@@ -153,8 +201,8 @@ module GoodJob
     #   return value for the job's +#perform+ method, and the exception the job
     #   raised, if any (if the job raised, then the second array entry will be
     #   +nil+). If there were no jobs to execute, returns +nil+.
-    def self.perform_with_advisory_lock
-      unfinished.priority_ordered.only_scheduled.limit(1).with_advisory_lock(unlock_session: true) do |executions|
+    def self.perform_with_advisory_lock(parsed_queues: nil)
+      unfinished.dequeueing_ordered(parsed_queues).only_scheduled.limit(1).with_advisory_lock(unlock_session: true) do |executions|
         execution = executions.first
         break if execution.blank?
         break :unlocked unless execution&.executable?
@@ -265,56 +313,31 @@ module GoodJob
       end
     end
 
-    # There are 3 buckets of non-overlapping statuses:
-    #   1. The job will be executed
-    #     - queued: The job will execute immediately when an execution thread becomes available.
-    #     - scheduled: The job is scheduled to execute in the future.
-    #     - 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
-    #     - discarded: The job previously errored on execution and will not be re-executed in the future.
-    #
-    # @return [Symbol]
-    def status
-      if finished_at.present?
-        if error.present?
-          :discarded
-        else
-          :finished
-        end
-      elsif (scheduled_at || created_at) > DateTime.current
-        if serialized_params.fetch('executions', 0) > 1
-          :retried
-        else
-          :scheduled
-        end
-      elsif running?
-        :running
-      else
-        :queued
-      end
+    # Return formatted serialized_params for display in the dashboard
+    # @return [Hash]
+    def display_serialized_params
+      serialized_params.merge({
+                                _good_job: attributes.except('serialized_params', 'locktype', 'owns_advisory_lock'),
+                              })
     end
 
     def running?
-      performed_at? && !finished_at?
+      if has_attribute?(:locktype)
+        self['locktype'].present?
+      else
+        advisory_locked?
+      end
     end
 
     def number
       serialized_params.fetch('executions', 0) + 1
     end
 
-    # The last relevant timestamp for this execution
-    def last_status_at
-      finished_at || performed_at || scheduled_at || created_at
-    end
-
     # Time between when this job was expected to run and when it started running
     def queue_latency
       now = Time.zone.now
       expected_start = scheduled_at || created_at
-      actual_start = performed_at || now
+      actual_start = performed_at || finished_at || now
 
       actual_start - expected_start unless expected_start >= now
     end

data/lib/models/good_job/job.rb

@@ -3,10 +3,12 @@ module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
   # There is not a table in the database whose discrete rows represents "Jobs".
   # The +good_jobs+ table is a table of individual {GoodJob::Execution}s that share the same +active_job_id+.
-  # A single row from the +good_jobs+ table of executions is fetched to represent an Job
+  # A single row from the +good_jobs+ table of executions is fetched to represent a Job.
+  #
   class Job < BaseRecord
     include Filterable
     include Lockable
+    include Reportable
 
     # Raised when an inappropriate action is applied to a Job based on its state.
     ActionForStateMismatchError = Class.new(StandardError)
@@ -72,9 +74,25 @@ module GoodJob
       serialized_params['job_class']
     end
 
-    # The status of the Job, based on the state of its most recent execution.
-    # @return [Symbol]
-    delegate :status, :last_status_at, to: :head_execution
+    # Override #reload to add a custom scope to ensure the reloaded record is the head execution
+    # @return [Job]
+    def reload(options = nil)
+      self.class.connection.clear_query_cache
+
+      # override with the `where(retried_good_job_id: nil)` scope
+      override_query = self.class.where(retried_good_job_id: nil)
+      fresh_object =
+        if options && options[:lock]
+          self.class.unscoped { override_query.lock(options[:lock]).find(id) }
+        else
+          self.class.unscoped { override_query.find(id) }
+        end
+
+      @attributes = fresh_object.instance_variable_get(:@attributes)
+      @new_record = false
+      @previously_new_record = false
+      self
+    end
 
     # This job's most recent {Execution}
     # @param reload [Booelan] whether to reload executions
@@ -94,7 +112,7 @@ module GoodJob
     # The number of times this job has been executed, according to ActiveJob's serialized state.
     # @return [Numeric]
     def executions_count
-      aj_count = head_execution.serialized_params.fetch('executions', 0)
+      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]
@@ -114,7 +132,15 @@ module GoodJob
     # If the job has been retried, the error will be fetched from the previous {Execution} record.
     # @return [String]
     def recent_error
-      head_execution.error || executions[-2]&.error
+      error || executions[-2]&.error
+    end
+
+    # Return formatted serialized_params for display in the dashboard
+    # @return [Hash]
+    def display_serialized_params
+      serialized_params.merge({
+                                _good_job: attributes.except('serialized_params', 'locktype', 'owns_advisory_lock'),
+                              })
     end
 
     # Tests whether the job is being executed right now.
@@ -192,7 +218,6 @@ module GoodJob
 
         raise ActionForStateMismatchError if execution.finished_at.present?
 
-        execution = head_execution(reload: true)
         execution.update(scheduled_at: scheduled_at)
       end
     end

data/lib/models/good_job/process.rb

@@ -45,6 +45,8 @@ module GoodJob # :nodoc:
         hostname: Socket.gethostname,
         pid: ::Process.pid,
         proctitle: $PROGRAM_NAME,
+        preserve_job_records: GoodJob.preserve_job_records,
+        retry_on_unhandled_error: GoodJob.retry_on_unhandled_error,
         schedulers: GoodJob::Scheduler.instances.map(&:name),
       }
     end

data/lib/models/good_job/reportable.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module GoodJob
+  module Reportable
+    # There are 3 buckets of non-overlapping statuses:
+    #   1. The job will be executed
+    #     - queued: The job will execute immediately when an execution thread becomes available.
+    #     - scheduled: The job is scheduled to execute in the future.
+    #     - 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
+    #     - discarded: The job previously errored on execution and will not be re-executed in the future.
+    #
+    # @return [Symbol]
+    def status
+      if finished_at.present?
+        if error.present? && retried_good_job_id.present?
+          :retried
+        elsif error.present? && retried_good_job_id.nil?
+          :discarded
+        else
+          :finished
+        end
+      elsif (scheduled_at || created_at) > DateTime.current
+        if serialized_params.fetch('executions', 0) > 1
+          :retried
+        else
+          :scheduled
+        end
+      elsif running?
+        :running
+      else
+        :queued
+      end
+    end
+
+    # The last relevant timestamp for this execution
+    def last_status_at
+      finished_at || performed_at || scheduled_at || created_at
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-10 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -365,6 +365,7 @@ files:
 - app/assets/good_job/modules/checkbox_toggle.js
 - app/assets/good_job/modules/document_ready.js
 - app/assets/good_job/modules/live_poll.js
+- app/assets/good_job/modules/popovers.js
 - app/assets/good_job/modules/toasts.js
 - app/assets/good_job/scripts.js
 - app/assets/good_job/style.css
@@ -398,7 +399,9 @@ files:
 - app/views/good_job/shared/icons/_check.html.erb
 - app/views/good_job/shared/icons/_clock.html.erb
 - app/views/good_job/shared/icons/_dash_circle.html.erb
+- app/views/good_job/shared/icons/_dots.html.erb
 - app/views/good_job/shared/icons/_exclamation.html.erb
+- app/views/good_job/shared/icons/_info.html.erb
 - app/views/good_job/shared/icons/_play.html.erb
 - app/views/good_job/shared/icons/_skip_forward.html.erb
 - app/views/good_job/shared/icons/_stop.html.erb
@@ -446,6 +449,7 @@ files:
 - lib/models/good_job/job.rb
 - lib/models/good_job/lockable.rb
 - lib/models/good_job/process.rb
+- lib/models/good_job/reportable.rb
 homepage: https://github.com/bensheldon/good_job
 licenses:
 - MIT