good_job 2.7.4 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43ea987ac7a83911835cc6d6232839eba41f614b888dcb9752ae085cb4e30a0
-  data.tar.gz: eb7efe2336fa441d8c5b0e64fa43b017078c4306599bc30f829610ef24ca037a
+  metadata.gz: ae78ac0322802107488f4a8b55963665cf9b3f173eb05174382bf05afdcef5a6
+  data.tar.gz: 2f41dd00281bcf2d0a2c29f6124de36964dcc730436f1cbd2f4c740c873263ed
 SHA512:
-  metadata.gz: 3695aaebdb614804fa6df0210c411cc45120880674663551e6f53036bd237d6b64b12e2728bf810fac18c76f1372eb40de57f4b4daae24eda5448177218ffe63
-  data.tar.gz: d03963f9186b5c177fbd107107c4f2dcd646df4dbc96fbf9a08e91f91af01d01369a89b44ee7bbf97baa0d941c47550fa4b29e3eca326c36fdc72b21646c0796
+  metadata.gz: 0ec2d40fdd87f293f8372e27040c7b14f8668645f50bc968ce91ec758202a400bb7c4a9ecb2e31a5827d59717dc3069840d5402981e1dc9f98c113120e259258
+  data.tar.gz: 0dd784cee33ab996ad332d1bfc371c357ffe3fb9727629096cff7189cc391195c109400240569444221a2ebf3340e2ab0d2d1c7bbd2830ee1c5b2ada9117d995

data/CHANGELOG.md

@@ -1,9 +1,34 @@
 # Changelog
 
+## [v2.8.0](https://github.com/bensheldon/good_job/tree/v2.8.0) (2021-12-31)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.7.4...v2.8.0)
+
+**Implemented enhancements:**
+
+- GoodJob should automatically clean up after itself and delete old job records [\#412](https://github.com/bensheldon/good_job/issues/412)
+- Track processes in the database and on the Dashboard [\#472](https://github.com/bensheldon/good_job/pull/472) ([bensheldon](https://github.com/bensheldon))
+- Allow Scheduler to automatically clean up preserved jobs every N jobs or seconds [\#465](https://github.com/bensheldon/good_job/pull/465) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Is there a way to show how many worker/process is running currently [\#471](https://github.com/bensheldon/good_job/issues/471)
+- Jobs stuck in the unfinished state [\#448](https://github.com/bensheldon/good_job/issues/448)
+
+**Merged pull requests:**
+
+- Doublequote Ruby 3.0 in testing matrix [\#473](https://github.com/bensheldon/good_job/pull/473) ([bensheldon](https://github.com/bensheldon))
+- Have demo CleanupJob use GoodJob.cleanup\_preserved\_jobs [\#470](https://github.com/bensheldon/good_job/pull/470) ([bensheldon](https://github.com/bensheldon))
+- Test with Rails 7.0.0 [\#469](https://github.com/bensheldon/good_job/pull/469) ([aried3r](https://github.com/aried3r))
+
 ## [v2.7.4](https://github.com/bensheldon/good_job/tree/v2.7.4) (2021-12-16)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.7.3...v2.7.4)
 
+**Fixed bugs:**
+
+- Add nonce: true to javascript\_include\_tag in dashboard [\#468](https://github.com/bensheldon/good_job/pull/468) ([bouk](https://github.com/bouk))
+
 **Closed issues:**
 
 - Add nonce: true to engine views  [\#467](https://github.com/bensheldon/good_job/issues/467)
@@ -11,7 +36,6 @@
 
 **Merged pull requests:**
 
-- Add nonce: true to javascript\_include\_tag in dashboard [\#468](https://github.com/bensheldon/good_job/pull/468) ([bouk](https://github.com/bouk))
 - Update appraisal for Rails 7.0.0.rc1 [\#466](https://github.com/bensheldon/good_job/pull/466) ([bensheldon](https://github.com/bensheldon))
 
 ## [v2.7.3](https://github.com/bensheldon/good_job/tree/v2.7.3) (2021-11-30)

data/README.md

@@ -271,6 +271,9 @@ Available configuration options are:
 - `shutdown_timeout` (float) number of seconds to wait for jobs to finish when shutting down before stopping the thread. Defaults to forever: `-1`. You can also set this with the environment variable `GOOD_JOB_SHUTDOWN_TIMEOUT`.
 - `enable_cron` (boolean) whether to run cron process. Defaults to `false`. You can also set this with the environment variable `GOOD_JOB_ENABLE_CRON`.
 - `cron` (hash) cron configuration. Defaults to `{}`. You can also set this as a JSON string with the environment variable `GOOD_JOB_CRON`
+- `cleanup_preserved_jobs_before_seconds_ago` (integer) number of seconds to preserve jobs when using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `86400` (1 day). Can also be set with  the environment variable `GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO`.  _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
+- `cleanup_interval_jobs` (integer) Number of jobs a Scheduler will execute before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_JOBS`.
+- `cleanup_interval_seconds` (integer) Number of seconds a Scheduler will wait before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_SECONDS`.
 - `logger` ([Rails Logger](https://api.rubyonrails.org/classes/ActiveSupport/Logger.html)) lets you set a custom logger for GoodJob. It should be an instance of a Rails `Logger` (Default: `Rails.logger`).
 - `preserve_job_records` (boolean) keeps job records in your database even after jobs are completed. (Default: `false`)
 - `retry_on_unhandled_error` (boolean) causes jobs to be re-queued and retried if they raise an instance of `StandardError`. Instances of `Exception`, like SIGINT, will *always* be retried, regardless of this attribute’s value. (Default: `true`)

data/engine/app/controllers/good_job/processes_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module GoodJob
+  class ProcessesController < GoodJob::BaseController
+    def index
+      @processes = GoodJob::Process.active.order(created_at: :desc) if GoodJob::Process.migrated?
+    end
+  end
+end

data/engine/app/views/good_job/processes/index.html.erb

@@ -0,0 +1,40 @@
+<% if !GoodJob::Process.migrated? %>
+  <div class="card my-3">
+    <div class="card-body">
+      <p class="card-text">
+        <em>Feature unavailable because of pending database migration.</em>
+      </p>
+    </div>
+  </div>
+<% elsif @processes.present? %>
+  <div class="card my-3">
+    <div class="table-responsive">
+      <table class="table card-table table-bordered table-hover table-sm mb-0">
+        <thead>
+        <tr>
+          <th>Process UUID</th>
+          <th>Created At</th></th>
+          <th>State</th>
+        </tr>
+        </thead>
+        <tbody>
+        <% @processes.each do |process| %>
+          <tr class="<%= dom_class(process) %>" id="<%= dom_id(process) %>">
+            <td><%= process.id %></td>
+            <td><%= relative_time(process.created_at) %></td>
+            <td><%= tag.pre JSON.pretty_generate(process.state) %></td>
+          </tr>
+        <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+<% else %>
+  <div class="card my-3">
+    <div class="card-body">
+      <p class="card-text">
+        <em>No GoodJob processes found.</em>
+      </p>
+    </div>
+  </div>
+<% end %>

data/engine/app/views/layouts/good_job/base.html.erb

@@ -33,23 +33,14 @@
           <li class="nav-item">
             <%= link_to "Cron Schedules", cron_entries_path, class: ["nav-link", ("active" if current_page?(cron_entries_path))] %>
           </li>
+          <li class="nav-item">
+            <%= link_to "Processes", processes_path, class: ["nav-link", ("active" if current_page?(processes_path))] %>
+          </li>
           <li class="nav-item">
             <div class="nav-link">
               <span class="badge bg-secondary">More views coming soon</span>
             </div>
           </li>
-
-          <!-- Coming Soon
-            <li class="nav-item">
-              <%= link_to "Upcoming Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
-            </li>
-            <li class="nav-item">
-              <%= link_to "Finished Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
-            </li>
-            <li class="nav-item">
-              <%= link_to "Errored Jobs", 'todo', class: ["nav-link", ("active" if current_page?('todo'))] %>
-            </li>
-          -->
         </ul>
         <div class="text-muted" title="Now is <%= Time.current %>">Times are displayed in <%= Time.current.zone %> timezone</div>
       </div>

data/engine/config/routes.rb

@@ -2,11 +2,7 @@
 GoodJob::Engine.routes.draw do
   root to: 'executions#index'
 
-  resources :cron_entries, only: %i[index show] do
-    member do
-      post :enqueue
-    end
-  end
+  resources :executions, only: %i[destroy]
 
   resources :jobs, only: %i[index show] do
     member do
@@ -15,7 +11,14 @@ GoodJob::Engine.routes.draw do
       put :retry
     end
   end
-  resources :executions, only: %i[destroy]
+
+  resources :cron_entries, only: %i[index show] do
+    member do
+      post :enqueue
+    end
+  end
+
+  resources :processes, only: %i[index]
 
   scope controller: :assets do
     constraints(format: :css) do

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

@@ -21,6 +21,11 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.timestamp :cron_at
     end
 
+    create_table :good_job_processes, id: :uuid do |t|
+      t.timestamps
+      t.jsonb :state
+    end
+
     add_index :good_jobs, :scheduled_at, where: "(finished_at IS NULL)", name: "index_good_jobs_on_scheduled_at"
     add_index :good_jobs, [:queue_name, :scheduled_at], where: "(finished_at IS NULL)", name: :index_good_jobs_on_queue_name_and_scheduled_at
     add_index :good_jobs, [:active_job_id, :created_at], name: :index_good_jobs_on_active_job_id_and_created_at

data/lib/generators/good_job/templates/update/migrations/04_create_good_job_processes.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+class CreateGoodJobProcesses < 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.table_exists?(:good_job_processes)
+      end
+    end
+
+    create_table :good_job_processes, id: :uuid do |t|
+      t.timestamps
+      t.jsonb :state
+    end
+  end
+end

data/lib/good_job/active_job_job.rb

@@ -4,10 +4,7 @@ module GoodJob
   # 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 ActiveJobJob
-  # Parent class can be configured with +GoodJob.active_record_parent_class+.
-  # @!parse
-  #   class ActiveJob < ActiveRecord::Base; end
-  class ActiveJobJob < Object.const_get(GoodJob.active_record_parent_class)
+  class ActiveJobJob < BaseRecord
     include Filterable
     include Lockable
 

data/lib/good_job/adapter.rb

@@ -121,7 +121,7 @@ module GoodJob
     end
 
     # Start async executors
-    # @return void
+    # @return [void]
     def start_async
       return unless execute_async?
 

data/lib/good_job/assignable_connection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+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
+    extend ActiveSupport::Concern
+
+    included do
+      thread_cattr_accessor :_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
+      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
+        yield
+      ensure
+        self._connection = original_conn
+      end
+    end
+  end
+end

data/lib/good_job/base_record.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module GoodJob
+  # Base ActiveRecord class that all GoodJob models inherit from.
+  # Parent class can be configured with +GoodJob.active_record_parent_class+.
+  # @!parse
+  #   class BaseRecord < ActiveRecord::Base; end
+  class BaseRecord < Object.const_get(GoodJob.active_record_parent_class)
+    self.abstract_class = true
+
+    def self.migration_pending_warning!
+      ActiveSupport::Deprecation.warn(<<~DEPRECATION)
+        GoodJob has pending database migrations. To create the migration files, run:
+            rails generate good_job:update
+        To apply the migration files, run:
+            rails db:migrate
+      DEPRECATION
+      nil
+    end
+  end
+end

data/lib/good_job/cleanup_tracker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module GoodJob # :nodoc:
+  # Tracks thresholds for cleaning up old jobs.
+  class CleanupTracker
+    attr_accessor :cleanup_interval_seconds,
+                  :cleanup_interval_jobs,
+                  :job_count,
+                  :last_at
+
+    def initialize(cleanup_interval_seconds: nil, cleanup_interval_jobs: nil)
+      self.cleanup_interval_seconds = cleanup_interval_seconds
+      self.cleanup_interval_jobs = cleanup_interval_jobs
+
+      reset
+    end
+
+    # Increments job count.
+    # @return [void]
+    def increment
+      self.job_count += 1
+    end
+
+    # Whether a cleanup should be run.
+    # @return [Boolean]
+    def cleanup?
+      (cleanup_interval_jobs && job_count > cleanup_interval_jobs) ||
+        (cleanup_interval_seconds && last_at < Time.current - cleanup_interval_seconds) ||
+        false
+    end
+
+    # Resets the counters.
+    # @return [void]
+    def reset
+      self.job_count = 0
+      self.last_at = Time.current
+    end
+  end
+end

data/lib/good_job/configuration.rb

@@ -18,6 +18,10 @@ module GoodJob
     DEFAULT_MAX_CACHE = 10000
     # Default number of seconds to preserve jobs for {CLI#cleanup_preserved_jobs} and {GoodJob.cleanup_preserved_jobs}
     DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO = 24 * 60 * 60
+    # Default number of jobs to execute between preserved job cleanup runs
+    DEFAULT_CLEANUP_INTERVAL_JOBS = nil
+    # Default number of seconds to wait between preserved job cleanup runs
+    DEFAULT_CLEANUP_INTERVAL_SECONDS = nil
     # Default to always wait for jobs to finish for {Adapter#shutdown}
     DEFAULT_SHUTDOWN_TIMEOUT = -1
     # Default to not running cron
@@ -179,6 +183,28 @@ module GoodJob
       ).to_i
     end
 
+    # Number of jobs a {Scheduler} will execute before cleaning up preserved jobs.
+    # @return [Integer, nil]
+    def cleanup_interval_jobs
+      value = (
+        rails_config[:cleanup_interval_jobs] ||
+          env['GOOD_JOB_CLEANUP_INTERVAL_JOBS'] ||
+          DEFAULT_CLEANUP_INTERVAL_JOBS
+      )
+      value.present? ? value.to_i : nil
+    end
+
+    # Number of seconds a {Scheduler} will wait before cleaning up preserved jobs.
+    # @return [Integer, nil]
+    def cleanup_interval_seconds
+      value = (
+        rails_config[:cleanup_interval_seconds] ||
+          env['GOOD_JOB_CLEANUP_INTERVAL_SECONDS'] ||
+          DEFAULT_CLEANUP_INTERVAL_SECONDS
+      )
+      value.present? ? value.to_i : nil
+    end
+
     # Tests whether to daemonize the process.
     # @return [Boolean]
     def daemonize?

data/lib/good_job/current_thread.rb

@@ -68,7 +68,7 @@ module GoodJob
 
     # @return [Integer] Current process ID
     def self.process_id
-      Process.pid
+      ::Process.pid
     end
 
     # @return [String] Current thread name

data/lib/good_job/daemon.rb

@@ -17,7 +17,7 @@ module GoodJob
     # @return [void]
     def daemonize
       check_pid
-      Process.daemon
+      ::Process.daemon
       write_pid
     end
 
@@ -25,7 +25,7 @@ module GoodJob
 
     # @return [void]
     def write_pid
-      File.open(pidfile, ::File::CREAT | ::File::EXCL | ::File::WRONLY) { |f| f.write(Process.pid.to_s) }
+      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) }
     rescue Errno::EEXIST
       check_pid
@@ -55,7 +55,7 @@ module GoodJob
       pid = ::File.read(pidfile).to_i
       return :dead if pid.zero?
 
-      Process.kill(0, pid) # check process status
+      ::Process.kill(0, pid) # check process status
       :running
     rescue Errno::ESRCH
       :dead

data/lib/good_job/execution.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
-  # Parent class can be configured with +GoodJob.active_record_parent_class+.
-  # @!parse
-  #   class Execution < ActiveRecord::Base; end
-  class Execution < Object.const_get(GoodJob.active_record_parent_class)
+  class Execution < BaseRecord
     include Lockable
     include Filterable
 
@@ -54,16 +51,6 @@ module GoodJob
       end
     end
 
-    def self._migration_pending_warning
-      ActiveSupport::Deprecation.warn(<<~DEPRECATION)
-        GoodJob has pending database migrations. To create the migration files, run:
-            rails generate good_job:update
-        To apply the migration files, run:
-            rails db:migrate
-      DEPRECATION
-      nil
-    end
-
     # Get Jobs with given ActiveJob ID
     # @!method active_job_id
     # @!scope class
@@ -224,7 +211,7 @@ module GoodJob
           if @cron_at_index
             execution_args[:cron_at] = CurrentThread.cron_at
           else
-            _migration_pending_warning
+            migration_pending_warning!
           end
         elsif CurrentThread.active_job_id && CurrentThread.active_job_id == active_job.job_id
           execution_args[:cron_key] = CurrentThread.execution.cron_key

data/lib/good_job/job_performer.rb

@@ -57,6 +57,12 @@ module GoodJob
       job_query.next_scheduled_at(after: after, limit: limit, now_limit: now_limit)
     end
 
+    # Delete expired preserved jobs
+    # @return [void]
+    def cleanup
+      GoodJob.cleanup_preserved_jobs
+    end
+
     private
 
     attr_reader :queue_string

data/lib/good_job/notifier/process_registration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GoodJob # :nodoc:
+  class Notifier # :nodoc:
+    # Extends the Notifier to register the process in the database.
+    module ProcessRegistration
+      extend ActiveSupport::Concern
+
+      included do
+        set_callback :listen, :after, :register_process
+        set_callback :unlisten, :after, :deregister_process
+      end
+
+      # Registers the current process.
+      def register_process
+        GoodJob::Process.with_connection(connection) do
+          next unless Process.migrated?
+
+          GoodJob::Process.cleanup
+          @process = GoodJob::Process.register
+        end
+      end
+
+      # Deregisters the current process.
+      def deregister_process
+        GoodJob::Process.with_connection(connection) do
+          next unless Process.migrated?
+
+          @process&.deregister
+        end
+      end
+    end
+  end
+end

data/lib/good_job/notifier.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'active_support/core_ext/module/attribute_accessors_per_thread'
 require 'concurrent/atomic/atomic_boolean'
 
 module GoodJob # :nodoc:
@@ -10,6 +11,11 @@ module GoodJob # :nodoc:
   # When a message is received, the notifier passes the message to each of its recipients.
   #
   class Notifier
+    include ActiveSupport::Callbacks
+    define_callbacks :listen, :unlisten
+
+    include Notifier::ProcessRegistration
+
     # Raised if the Database adapter does not implement LISTEN.
     AdapterCannotListenError = Class.new(StandardError)
 
@@ -43,6 +49,12 @@ module GoodJob # :nodoc:
     #   @return [Array<GoodJob::Notifier>, nil]
     cattr_reader :instances, default: [], instance_reader: false
 
+    # @!attribute [rw] connection
+    #   @!scope class
+    #   ActiveRecord Connection that has been established for the Notifier.
+    #   @return [ActiveRecord::ConnectionAdapters::AbstractAdapter, nil]
+    thread_cattr_accessor :connection
+
     # Send a message via Postgres NOTIFY
     # @param message [#to_json]
     def self.notify(message)
@@ -146,30 +158,36 @@ module GoodJob # :nodoc:
 
     def listen(delay: 0)
       future = Concurrent::ScheduledTask.new(delay, args: [@recipients, executor, @listening], executor: @executor) do |thr_recipients, thr_executor, thr_listening|
-        with_listen_connection do |conn|
-          ActiveSupport::Notifications.instrument("notifier_listen.good_job") do
-            conn.async_exec("LISTEN #{CHANNEL}").clear
-          end
+        with_connection do
+          begin
+            run_callbacks :listen do
+              ActiveSupport::Notifications.instrument("notifier_listen.good_job") do
+                connection.execute("LISTEN #{CHANNEL}")
+              end
+              thr_listening.make_true
+            end
 
-          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
-            thr_listening.make_true
-            while thr_executor.running?
-              conn.wait_for_notify(WAIT_INTERVAL) do |channel, _pid, payload|
-                next unless channel == CHANNEL
-
-                ActiveSupport::Notifications.instrument("notifier_notified.good_job", { payload: payload })
-                parsed_payload = JSON.parse(payload, symbolize_names: true)
-                thr_recipients.each do |recipient|
-                  target, method_name = recipient.is_a?(Array) ? recipient : [recipient, :call]
-                  target.send(method_name, parsed_payload)
+            ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              while thr_executor.running?
+                wait_for_notify do |channel, payload|
+                  next unless channel == CHANNEL
+
+                  ActiveSupport::Notifications.instrument("notifier_notified.good_job", { payload: payload })
+                  parsed_payload = JSON.parse(payload, symbolize_names: true)
+                  thr_recipients.each do |recipient|
+                    target, method_name = recipient.is_a?(Array) ? recipient : [recipient, :call]
+                    target.send(method_name, parsed_payload)
+                  end
                 end
               end
             end
           end
         ensure
-          thr_listening.make_false
-          ActiveSupport::Notifications.instrument("notifier_unlisten.good_job") do
-            conn.async_exec("UNLISTEN *").clear
+          run_callbacks :unlisten do
+            thr_listening.make_false
+            ActiveSupport::Notifications.instrument("notifier_unlisten.good_job") do
+              connection.execute("UNLISTEN *")
+            end
           end
         end
       end
@@ -178,17 +196,27 @@ module GoodJob # :nodoc:
       future.execute
     end
 
-    def with_listen_connection
-      ar_conn = Execution.connection_pool.checkout.tap do |conn|
+    def with_connection
+      self.connection = Execution.connection_pool.checkout.tap do |conn|
         Execution.connection_pool.remove(conn)
       end
-      pg_conn = ar_conn.raw_connection
-      raise AdapterCannotListenError unless pg_conn.respond_to? :wait_for_notify
+      connection.execute("SET application_name = #{connection.quote(self.class.name)}")
 
-      pg_conn.async_exec("SET application_name = #{pg_conn.escape_identifier(self.class.name)}").clear
-      yield pg_conn
+      yield
     ensure
-      ar_conn&.disconnect!
+      connection&.disconnect!
+      self.connection = nil
+    end
+
+    def wait_for_notify
+      raw_connection = connection.raw_connection
+      if raw_connection.respond_to?(:wait_for_notify)
+        raw_connection.wait_for_notify(WAIT_INTERVAL) do |channel, _pid, payload|
+          yield(channel, payload)
+        end
+      else
+        sleep WAIT_INTERVAL
+      end
     end
   end
 end

data/lib/good_job/process.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require 'socket'
+
+module GoodJob # :nodoc:
+  # ActiveRecord model that represents an GoodJob process (either async or CLI).
+  class Process < BaseRecord
+    include AssignableConnection
+    include Lockable
+
+    self.table_name = 'good_job_processes'
+
+    cattr_reader :mutex, default: Mutex.new
+    cattr_accessor :_current_id, default: nil
+    cattr_accessor :_pid, default: nil
+
+    # Processes that are active and locked.
+    # @!method active
+    # @!scope class
+    # @return [ActiveRecord::Relation]
+    scope :active, -> { advisory_locked }
+
+    # Processes that are inactive and unlocked (e.g. SIGKILLed)
+    # @!method active
+    # @!scope class
+    # @return [ActiveRecord::Relation]
+    scope :inactive, -> { advisory_unlocked }
+
+    # Whether the +good_job_processes+ table exsists.
+    # @return [Boolean]
+    def self.migrated?
+      return true if connection.table_exists?(table_name)
+
+      migration_pending_warning!
+      false
+    end
+
+    # UUID that is unique to the current process and changes when forked.
+    # @return [String]
+    def self.current_id
+      mutex.synchronize do
+        if _current_id.nil? || _pid != ::Process.pid
+          self._current_id = SecureRandom.uuid
+          self._pid = ::Process.pid
+        end
+        _current_id
+      end
+    end
+
+    # Hash representing metadata about the current process.
+    # @return [Hash]
+    def self.current_state
+      {
+        id: current_id,
+        hostname: Socket.gethostname,
+        pid: ::Process.pid,
+        proctitle: $PROGRAM_NAME,
+        schedulers: GoodJob::Scheduler.instances.map(&:name),
+      }
+    end
+
+    # Deletes all inactive process records.
+    def self.cleanup
+      inactive.delete_all
+    end
+
+    # Registers the current process in the database
+    # @return [GoodJob::Process]
+    def self.register
+      create(id: current_id, state: current_state, create_with_advisory_lock: true)
+    rescue ActiveRecord::RecordNotUnique
+      nil
+    end
+
+    # Unregisters the instance.
+    def deregister
+      return unless owns_advisory_lock?
+
+      destroy!
+      advisory_unlock
+    end
+  end
+end

data/lib/good_job/scheduler.rb

@@ -48,7 +48,9 @@ module GoodJob # :nodoc:
           job_performer,
           max_threads: max_threads,
           max_cache: configuration.max_cache,
-          warm_cache_on_initialize: warm_cache_on_initialize
+          warm_cache_on_initialize: warm_cache_on_initialize,
+          cleanup_interval_seconds: configuration.cleanup_interval_seconds,
+          cleanup_interval_jobs: configuration.cleanup_interval_jobs
         )
       end
 
@@ -59,11 +61,17 @@ module GoodJob # :nodoc:
       end
     end
 
+    # Human readable name of the scheduler that includes configuration values.
+    # @return [String]
+    attr_reader :name
+
     # @param performer [GoodJob::JobPerformer]
     # @param max_threads [Numeric, nil] number of seconds between polls for jobs
     # @param max_cache [Numeric, nil] maximum number of scheduled jobs to cache in memory
     # @param warm_cache_on_initialize [Boolean] whether to warm the cache immediately, or manually by calling +warm_cache+
-    def initialize(performer, max_threads: nil, max_cache: nil, warm_cache_on_initialize: false)
+    # @param cleanup_interval_seconds [Numeric, nil] number of seconds between cleaning up job records
+    # @param cleanup_interval_jobs [Numeric, nil] number of executed jobs between cleaning up job records
+    def initialize(performer, max_threads: nil, max_cache: nil, warm_cache_on_initialize: false, cleanup_interval_seconds: nil, cleanup_interval_jobs: nil)
       raise ArgumentError, "Performer argument must implement #next" unless performer.respond_to?(:next)
 
       self.class.instances << self
@@ -76,8 +84,10 @@ module GoodJob # :nodoc:
         @executor_options[:max_threads] = max_threads
         @executor_options[:max_queue] = max_threads
       end
-      @executor_options[:name] = "GoodJob::Scheduler(queues=#{@performer.name} max_threads=#{@executor_options[:max_threads]})"
+      @name = "GoodJob::Scheduler(queues=#{@performer.name} max_threads=#{@executor_options[:max_threads]})"
+      @executor_options[:name] = name
 
+      @cleanup_tracker = CleanupTracker.new(cleanup_interval_seconds: cleanup_interval_seconds, cleanup_interval_jobs: cleanup_interval_jobs)
       create_executor
       warm_cache if warm_cache_on_initialize
     end
@@ -172,7 +182,14 @@ module GoodJob # :nodoc:
       GoodJob._on_thread_error(error) if error
 
       instrument("finished_job_task", { result: output, error: thread_error, time: time })
-      create_task if output
+      return unless output
+
+      @cleanup_tracker.increment
+      if @cleanup_tracker.cleanup?
+        cleanup
+      else
+        create_task
+      end
     end
 
     # Information about the Scheduler
@@ -210,7 +227,25 @@ module GoodJob # :nodoc:
         create_task # If cache-warming exhausts the threads, ensure there isn't an executable task remaining
       end
       future.add_observer(observer, :call)
+      future.execute
+    end
+
+    # Preload existing runnable and future-scheduled jobs
+    # @return [void]
+    def cleanup
+      @cleanup_tracker.reset
 
+      future = Concurrent::Future.new(args: [self, @performer], executor: executor) do |_thr_scheduler, thr_performer|
+        Rails.application.executor.wrap do
+          thr_performer.cleanup
+        end
+      end
+
+      observer = lambda do |_time, _output, thread_error|
+        GoodJob._on_thread_error(thread_error) if thread_error
+        create_task
+      end
+      future.add_observer(observer, :call)
       future.execute
     end
 

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -131,7 +131,7 @@ module GoodJob
   # analyze or inspect job performance.
   # If you are preserving job records this way, use this method regularly to
   # delete old records and preserve space in your database.
-  # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs olders than this will be deleted (default: +86400+).
+  # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs older than this will be deleted (default: +86400+).
   # @return [Integer] Number of jobs that were deleted.
   def self.cleanup_preserved_jobs(older_than: nil)
     older_than ||= GoodJob::Configuration.new({}).cleanup_preserved_jobs_before_seconds_ago

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.7.4
+  version: 2.8.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -372,6 +372,7 @@ files:
 - engine/app/controllers/good_job/cron_entries_controller.rb
 - engine/app/controllers/good_job/executions_controller.rb
 - engine/app/controllers/good_job/jobs_controller.rb
+- engine/app/controllers/good_job/processes_controller.rb
 - engine/app/filters/good_job/base_filter.rb
 - engine/app/filters/good_job/executions_filter.rb
 - engine/app/filters/good_job/jobs_filter.rb
@@ -383,6 +384,7 @@ files:
 - engine/app/views/good_job/jobs/_table.erb
 - engine/app/views/good_job/jobs/index.html.erb
 - engine/app/views/good_job/jobs/show.html.erb
+- engine/app/views/good_job/processes/index.html.erb
 - engine/app/views/good_job/shared/_chart.erb
 - engine/app/views/good_job/shared/_filter.erb
 - engine/app/views/good_job/shared/icons/_arrow_clockwise.html.erb
@@ -402,12 +404,16 @@ files:
 - lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/02_add_cron_at_to_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/03_add_cron_key_cron_at_index_to_good_jobs.rb.erb
+- lib/generators/good_job/templates/update/migrations/04_create_good_job_processes.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions.rb
 - lib/good_job/active_job_extensions/concurrency.rb
 - lib/good_job/active_job_job.rb
 - lib/good_job/adapter.rb
+- lib/good_job/assignable_connection.rb
+- lib/good_job/base_record.rb
+- lib/good_job/cleanup_tracker.rb
 - lib/good_job/cli.rb
 - lib/good_job/configuration.rb
 - lib/good_job/cron_entry.rb
@@ -423,8 +429,10 @@ files:
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
+- lib/good_job/notifier/process_registration.rb
 - lib/good_job/poller.rb
 - lib/good_job/probe_server.rb
+- lib/good_job/process.rb
 - lib/good_job/railtie.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb