good_job 3.21.2 → 3.21.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd97ba03dea3561d77db9ebb2f534d03aafed6e39b2327429c5e5eea3f971d29
-  data.tar.gz: b83947c459532713022c32d2845e8e139113cad8dc91012a4eeb45ed20e08f3b
+  metadata.gz: b2b769f6444bb3572bd5739f046469179945f8fc6f13c9fa5bd3de03b25e8e43
+  data.tar.gz: c7b0cd19944dea29a8cb75dce00ed92434879d08f07718781d91123a295f6a11
 SHA512:
-  metadata.gz: 349b6201b1add40178d726aaaf62887b0e89a36fed4f2546838d2251e7e593ce60e24ca4f08eac8c0067fd57c095f8ed1620bf2987805c5eac9fc7f327129b5d
-  data.tar.gz: b29eaf8018d61233b4245bbdf3fdc8204d8390995a583044166e25d824abd5db47f0d60c30b3ab9c1782387f2d9114d0eebf94d7aee9076bc819e719743ea659
+  metadata.gz: fff83dabf6211e76b3439bd1a6486ba2009bb5fc9ae689673deefbf5728de44245e1a982e9d56c524dc07780d6c831328765e2c3c8b3aaef950f7969ffdb1a15
+  data.tar.gz: 289f6573c18d539a7ca6918d8288fdf6f510732df036138f44a816e1bebae53529695f766146488fda2967aa120b97e4d938ea0453a69b91c636286064dbec61

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [v3.21.3](https://github.com/bensheldon/good_job/tree/v3.21.3) (2023-12-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.21.2...v3.21.3)
+
+**Implemented enhancements:**
+
+- Add `--idle-timeout` CLI option to create temporary processes that exit when inactive [\#1159](https://github.com/bensheldon/good_job/pull/1159) ([bensheldon](https://github.com/bensheldon))
+
+**Fixed bugs:**
+
+- Add correct paths to $LOAD\_PATH [\#1169](https://github.com/bensheldon/good_job/pull/1169) ([jklina](https://github.com/jklina))
+- Recreate cron indexes to be conditional [\#1163](https://github.com/bensheldon/good_job/pull/1163) ([defkode](https://github.com/defkode))
+
+**Closed issues:**
+
+- Use partial indices for cron\_key? [\#1161](https://github.com/bensheldon/good_job/issues/1161)
+- Mass Update Error [\#1157](https://github.com/bensheldon/good_job/issues/1157)
+- v3 roadmap plan [\#705](https://github.com/bensheldon/good_job/issues/705)
+- Allow customisation of the dashboard controller parent class [\#687](https://github.com/bensheldon/good_job/issues/687)
+
+**Merged pull requests:**
+
+- \[minor\] Use symbol form of index name [\#1171](https://github.com/bensheldon/good_job/pull/1171) ([andyatkinson](https://github.com/andyatkinson))
+- Fix development schema.rb to include conditional index name change [\#1168](https://github.com/bensheldon/good_job/pull/1168) ([bensheldon](https://github.com/bensheldon))
+- Create new conditional Cron indexes before dropping old indexes [\#1165](https://github.com/bensheldon/good_job/pull/1165) ([bensheldon](https://github.com/bensheldon))
+- Fix test that references Rails logger for Rails 7.2a change [\#1160](https://github.com/bensheldon/good_job/pull/1160) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.21.2](https://github.com/bensheldon/good_job/tree/v3.21.2) (2023-11-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.21.1...v3.21.2)

data/README.md

@@ -184,6 +184,7 @@ Options:
   [--shutdown-timeout=SECONDS] # Number of seconds to wait for jobs to finish when shutting down before stopping the thread. (env var: GOOD_JOB_SHUTDOWN_TIMEOUT, default: -1 (forever))
   [--enable-cron]              # Whether to run cron process (default: false)
   [--enable-listen-notify]     # Whether to enqueue and read jobs with Postgres LISTEN/NOTIFY (default: true)
+  [--idle-timeout=SECONDS]     # Exit process when no jobs have been performed for this many seconds (env var: GOOD_JOB_IDLE_TIMEOUT, default: nil)
   [--daemonize]                # Run as a background daemon (default: false)
   [--pidfile=PIDFILE]          # Path to write daemonized Process ID (env var: GOOD_JOB_PIDFILE, default: tmp/pids/good_job.pid)
   [--probe-port=PORT]          # Port for http health check (env var: GOOD_JOB_PROBE_PORT, default: nil)

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

@@ -70,12 +70,12 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.index :key, unique: true
     end
 
-    add_index :good_jobs, :scheduled_at, where: "(finished_at IS NULL)", name: "index_good_jobs_on_scheduled_at"
+    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
     add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", name: :index_good_jobs_on_concurrency_key_when_unfinished
-    add_index :good_jobs, [:cron_key, :created_at], name: :index_good_jobs_on_cron_key_and_created_at
-    add_index :good_jobs, [:cron_key, :cron_at], name: :index_good_jobs_on_cron_key_and_cron_at, unique: true
+    add_index :good_jobs, [:cron_key, :created_at], where: "(cron_key IS NOT NULL)", name: :index_good_jobs_on_cron_key_and_created_at_cond
+    add_index :good_jobs, [:cron_key, :cron_at], where: "(cron_key IS NOT NULL)", unique: true, name: :index_good_jobs_on_cron_key_and_cron_at_cond
     add_index :good_jobs, [:active_job_id], name: :index_good_jobs_on_active_job_id
     add_index :good_jobs, [:finished_at], where: "retried_good_job_id IS NULL AND finished_at IS NOT NULL", name: :index_good_jobs_jobs_on_finished_at
     add_index :good_jobs, [:priority, :created_at], order: { priority: "DESC NULLS LAST", created_at: :asc },

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

@@ -28,7 +28,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       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, :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
     add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", name: :index_good_jobs_on_concurrency_key_when_unfinished

data/lib/generators/good_job/templates/update/migrations/07_recreate_good_job_cron_indexes_with_conditional.rb.erb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class RecreateGoodJobCronIndexesWithConditional < ActiveRecord::Migration<%= migration_version %>
+  disable_ddl_transaction!
+
+  def change
+    reversible do |dir|
+      dir.up do
+        unless connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_created_at_cond)
+          add_index :good_jobs, [:cron_key, :created_at], where: "(cron_key IS NOT NULL)",
+                    name: :index_good_jobs_on_cron_key_and_created_at_cond, algorithm: :concurrently
+        end
+        unless connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at_cond)
+          add_index :good_jobs, [:cron_key, :cron_at], where: "(cron_key IS NOT NULL)", unique: true,
+                    name: :index_good_jobs_on_cron_key_and_cron_at_cond, algorithm: :concurrently
+        end
+
+        if connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_created_at)
+          remove_index :good_jobs, name: :index_good_jobs_on_cron_key_and_created_at
+        end
+        if connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at)
+          remove_index :good_jobs, name: :index_good_jobs_on_cron_key_and_cron_at
+        end
+      end
+
+      dir.down do
+        unless connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_created_at)
+          add_index :good_jobs, [:cron_key, :created_at], where: "(cron_key IS NOT NULL)",
+                    name: :index_good_jobs_on_cron_key_and_created_at, algorithm: :concurrently
+        end
+        unless connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at)
+          add_index :good_jobs, [:cron_key, :cron_at], where: "(cron_key IS NOT NULL)", unique: true,
+                    name: :index_good_jobs_on_cron_key_and_cron_at, algorithm: :concurrently
+        end
+
+        if connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_created_at_cond)
+          remove_index :good_jobs, name: :index_good_jobs_on_cron_key_and_created_at_cond
+        end
+        if connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at_cond)
+          remove_index :good_jobs, name: :index_good_jobs_on_cron_key_and_cron_at_cond
+        end
+      end
+    end
+  end
+end

data/lib/good_job/capsule.rb

@@ -15,7 +15,7 @@ module GoodJob
     def initialize(configuration: GoodJob.configuration)
       @configuration = configuration
       @startable = true
-      @running = false
+      @started_at = nil
       @mutex = Mutex.new
 
       self.class.instances << self
@@ -39,7 +39,7 @@ module GoodJob
         @cron_manager = GoodJob::CronManager.new(@configuration.cron_entries, start_on_initialize: true, executor: @shared_executor.executor) if @configuration.enable_cron?
 
         @startable = false
-        @running = true
+        @started_at = Time.current
       end
     end
 
@@ -54,7 +54,7 @@ module GoodJob
       timeout = @configuration.shutdown_timeout if timeout == NONE
       GoodJob._shutdown_all([@shared_executor, @notifier, @poller, @multi_scheduler, @cron_manager].compact, timeout: timeout)
       @startable = false
-      @running = false
+      @started_at = nil
     end
 
     # Shutdown and then start the capsule again.
@@ -69,7 +69,7 @@ module GoodJob
 
     # @return [Boolean] Whether the capsule is currently running.
     def running?
-      @running
+      @started_at.present?
     end
 
     # @return [Boolean] Whether the capsule has been shutdown.
@@ -77,6 +77,20 @@ module GoodJob
       [@shared_executor, @notifier, @poller, @multi_scheduler, @cron_manager].compact.all?(&:shutdown?)
     end
 
+    # @param duration [nil, Numeric] Length of idleness to check for (in seconds).
+    # @return [Boolean] Whether the capsule is idle
+    def idle?(duration = nil)
+      scheduler_stats = @multi_scheduler&.stats || {}
+      is_idle = scheduler_stats.fetch(:active_execution_thread_count, 0).zero?
+
+      if is_idle && duration
+        active_at = scheduler_stats.fetch(:execution_at, nil) || @started_at
+        active_at.nil? || (Time.current - active_at >= duration)
+      else
+        is_idle
+      end
+    end
+
     # Creates an execution thread(s) with the given attributes.
     # @param job_state [Hash, nil] See {GoodJob::Scheduler#create_thread}.
     # @return [Boolean, nil] Whether the thread was created.
@@ -88,7 +102,7 @@ module GoodJob
     private
 
     def startable?(force: false)
-      !@running && (@startable || force)
+      !@started_at && (@startable || force)
     end
   end
 end

data/lib/good_job/cli.rb

@@ -20,6 +20,9 @@ module GoodJob
     # Number of seconds between checking shutdown conditions
     SHUTDOWN_EVENT_TIMEOUT = 10
 
+    # Number of seconds between checking shutdown conditions when idle-timeout is enabled
+    SHUTDOWN_EVENT_TIMEOUT_FOR_IDLE_TIMEOUT = 1
+
     class << self
       # Whether the CLI is running from the executable
       # @return [Boolean, nil]
@@ -74,6 +77,10 @@ module GoodJob
                   type: :numeric,
                   banner: 'SECONDS',
                   desc: "Number of seconds to wait for jobs to finish when shutting down before stopping the thread. (env var: GOOD_JOB_SHUTDOWN_TIMEOUT, default: -1 (forever))"
+    method_option :idle_timeout,
+                  type: :numeric,
+                  banner: 'SECONDS',
+                  desc: 'Exit process when no jobs have been performed for this many seconds (env var: GOOD_JOB_IDLE_TIMEOUT, default: nil)'
     method_option :enable_cron,
                   type: :boolean,
                   desc: "Whether to run cron process (default: false)"
@@ -115,9 +122,10 @@ module GoodJob
         trap(signal) { Thread.new { @stop_good_job_executable.set }.join }
       end
 
+      loop_wait = configuration.idle_timeout ? SHUTDOWN_EVENT_TIMEOUT_FOR_IDLE_TIMEOUT : SHUTDOWN_EVENT_TIMEOUT
       Kernel.loop do
-        @stop_good_job_executable.wait(SHUTDOWN_EVENT_TIMEOUT)
-        break if @stop_good_job_executable.set? || capsule.shutdown?
+        @stop_good_job_executable.wait(loop_wait)
+        break if @stop_good_job_executable.set? || capsule.shutdown? || (configuration.idle_timeout && capsule.idle?(configuration.idle_timeout))
       end
 
       systemd.stop do

data/lib/good_job/configuration.rb

@@ -228,6 +228,16 @@ module GoodJob
       )&.to_i
     end
 
+    # The number of seconds that a good_job process will idle with out running a job before exiting
+    # @return [Integer, nil] Number of seconds or nil means do not idle out.
+    def idle_timeout
+      (
+        options[:idle_timeout] ||
+        rails_config[:idle_timeout] ||
+        env['GOOD_JOB_IDLE_TIMEOUT']
+      )&.to_i || nil
+    end
+
     # Whether to automatically destroy discarded jobs that have been preserved.
     # @return [Boolean]
     def cleanup_discarded_jobs?

data/lib/good_job/job_performer/metrics.rb

@@ -32,7 +32,6 @@ module GoodJob # :nodoc:
       # Increments number of dequeue attempts with no executions.
       # @return [Integer]
       def increment_empty_executions
-        @execution_at = Time.current
         @empty_executions.increment
       end
 

data/lib/good_job/multi_scheduler.rb

@@ -95,6 +95,7 @@ module GoodJob
         succeeded_executions_count: scheduler_stats.sum { |stats| stats.fetch(:succeeded_executions_count, 0) },
         total_executions_count: scheduler_stats.sum { |stats| stats.fetch(:total_executions_count, 0) },
         execution_at: scheduler_stats.map { |stats| stats.fetch(:execution_at, nil) }.compact.max,
+        active_execution_thread_count: scheduler_stats.sum { |stats| stats.fetch(:active_threads, 0) },
         check_queue_at: scheduler_stats.map { |stats| stats.fetch(:check_queue_at, nil) }.compact.max,
       }
     end

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.21.2
+  version: 3.21.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -344,6 +344,7 @@ files:
 - lib/generators/good_job/templates/update/migrations/04_create_good_job_batches.rb.erb
 - lib/generators/good_job/templates/update/migrations/05_create_good_job_executions.rb.erb
 - lib/generators/good_job/templates/update/migrations/06_create_good_jobs_error_event.rb.erb
+- lib/generators/good_job/templates/update/migrations/07_recreate_good_job_cron_indexes_with_conditional.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb