good_job 3.15.14 → 3.16.1

data/lib/good_job/cron_manager.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "concurrent/hash"
 require "concurrent/scheduled_task"
 require "fugit"
@@ -12,7 +13,7 @@ module GoodJob # :nodoc:
     #   @!scope class
     #   List of all instantiated CronManagers in the current process.
     #   @return [Array<GoodJob::CronManager>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # Task observer for cron task
     # @param time [Time]
@@ -35,9 +36,8 @@ module GoodJob # :nodoc:
       @cron_entries = cron_entries
       @tasks = Concurrent::Hash.new
 
-      self.class.instances << self
-
       start if start_on_initialize
+      self.class.instances << self
     end
 
     # Schedule tasks that will enqueue jobs based on their schedule

data/lib/good_job/current_thread.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 
 module GoodJob
@@ -11,6 +12,7 @@ module GoodJob
       cron_key
       error_on_discard
       error_on_retry
+      error_on_retry_stopped
       execution
       execution_interrupted
       execution_retried
@@ -40,6 +42,12 @@ module GoodJob
     #   @return [Exception, nil]
     thread_mattr_accessor :error_on_retry
 
+    # @!attribute [rw] error_on_retry_stopped
+    #   @!scope class
+    #   Error captured by retry_stopped
+    #   @return [Exception, nil]
+    thread_mattr_accessor :error_on_retry_stopped
+
     # @!attribute [rw] executions
     #   @!scope class
     #   Execution

data/lib/good_job/daemon.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # Manages daemonization of the current process.

data/lib/good_job/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Ruby on Rails integration.
   class Engine < ::Rails::Engine
@@ -19,6 +20,10 @@ module GoodJob
         GoodJob::CurrentThread.error_on_retry = event.payload[:error]
       end
 
+      ActiveSupport::Notifications.subscribe "retry_stopped.active_job" do |event|
+        GoodJob::CurrentThread.error_on_retry_stopped = event.payload[:error]
+      end
+
       ActiveSupport::Notifications.subscribe "discard.active_job" do |event|
         GoodJob::CurrentThread.error_on_discard = event.payload[:error]
       end
@@ -35,6 +40,14 @@ module GoodJob
       end
     end
 
+    initializer 'good_job.active_record' do
+      config.to_prepare do
+        ActiveSupport.on_load :good_job_base_record, run_once: true do
+          GoodJob::BaseRecord.class_eval(&GoodJob._active_record_configuration) if GoodJob._active_record_configuration
+        end
+      end
+    end
+
     initializer "good_job.start_async" do
       # This hooks into the hookable places during Rails boot, which is unfortunately not Rails.application.initialized?
       # If an Adapter is initialized during boot, we want to want to start async executors once the framework dependencies have loaded.

data/lib/good_job/interrupt_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Exception raised when a job is interrupted by a SIGKILL or power failure.
   class InterruptError < StandardError

data/lib/good_job/job_performer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'concurrent/delay'
 
 module GoodJob

data/lib/good_job/log_subscriber.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # Listens to GoodJob notifications and logs them.

data/lib/good_job/metrics.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module GoodJob # :nodoc:
+  # Metrics for the scheduler.
+  class Metrics
+    def initialize
+      @empty_executions = Concurrent::AtomicFixnum.new
+      @errored_executions = Concurrent::AtomicFixnum.new
+      @succeeded_executions = Concurrent::AtomicFixnum.new
+      @unexecutable_executions = Concurrent::AtomicFixnum.new
+    end
+
+    # Increments number of empty queried executions.
+    # @return [Integer]
+    def increment_empty_executions
+      @empty_executions.increment
+    end
+
+    # Increments number of failed executions.
+    # @return [Integer]
+    def increment_errored_executions
+      @errored_executions.increment
+    end
+
+    # Increments number of succeeded executions.
+    # @return [Integer]
+    def increment_succeeded_executions
+      @succeeded_executions.increment
+    end
+
+    # Increments number of unlocked executions.
+    # @return [Integer]
+    def increment_unexecutable_executions
+      @unexecutable_executions.increment
+    end
+
+    def to_h
+      {
+        empty_executions_count: @empty_executions.value,
+        errored_executions_count: @errored_executions.value,
+        succeeded_executions_count: @succeeded_executions.value,
+        unexecutable_executions_count: @unexecutable_executions.value,
+      }.tap do |values|
+        values[:total_executions_count] = values.values.sum
+      end
+    end
+
+    # Reset counters.
+    # @return [void]
+    def reset
+      @empty_executions.value = 0
+      @errored_executions.value = 0
+      @succeeded_executions.value = 0
+      @unexecutable_executions.value = 0
+    end
+  end
+end

data/lib/good_job/multi_scheduler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Delegates the interface of a single {Scheduler} to multiple Schedulers.
   class MultiScheduler

data/lib/good_job/notifier/process_heartbeat.rb

@@ -21,9 +21,11 @@ module GoodJob # :nodoc:
       end
 
       def refresh_process
-        GoodJob::Process.with_connection(connection) do
-          Process.logger.silence do
-            @process&.refresh_if_stale(cleanup: true)
+        Rails.application.executor.wrap do
+          GoodJob::Process.with_connection(connection) do
+            GoodJob::Process.logger.silence do
+              @process&.refresh_if_stale(cleanup: true)
+            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'
 require "good_job/notifier/process_heartbeat"
@@ -46,7 +47,7 @@ module GoodJob # :nodoc:
     #   @!scope class
     #   List of all instantiated Notifiers in the current process.
     #   @return [Array<GoodJob::Notifier>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # @!attribute [rw] connection
     #   @!scope class
@@ -77,10 +78,9 @@ module GoodJob # :nodoc:
       @connection_errors_reported = Concurrent::AtomicBoolean.new(false)
       @enable_listening = enable_listening
 
-      self.class.instances << self
-
       create_executor
       listen
+      self.class.instances << self
     end
 
     # Tests whether the notifier is active and has acquired a dedicated database connection.

data/lib/good_job/poller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'concurrent/atomic/atomic_boolean'
 
 module GoodJob # :nodoc:
@@ -17,7 +18,7 @@ module GoodJob # :nodoc:
     #   @!scope class
     #   List of all instantiated Pollers in the current process.
     #   @return [Array<GoodJob::Poller>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # Creates GoodJob::Poller from a GoodJob::Configuration instance.
     # @param configuration [GoodJob::Configuration]
@@ -38,9 +39,8 @@ module GoodJob # :nodoc:
       @timer_options = DEFAULT_TIMER_OPTIONS.dup
       @timer_options[:execution_interval] = poll_interval if poll_interval.present?
 
-      self.class.instances << self
-
       create_timer
+      self.class.instances << self
     end
 
     # Tests whether the timer is running.

data/lib/good_job/scheduler.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 require "concurrent/executor/thread_pool_executor"
 require "concurrent/executor/timer_set"
 require "concurrent/scheduled_task"
 require "concurrent/utility/processor_counter"
+require 'good_job/metrics'
 
 module GoodJob # :nodoc:
   #
@@ -32,7 +34,7 @@ module GoodJob # :nodoc:
     #   @!scope class
     #   List of all instantiated Schedulers in the current process.
     #   @return [Array<GoodJob::Scheduler>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # Creates GoodJob::Scheduler(s) and Performers from a GoodJob::Configuration instance.
     # @param configuration [GoodJob::Configuration]
@@ -74,8 +76,6 @@ module GoodJob # :nodoc:
     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
-
       @performer = performer
 
       @max_cache = max_cache || 0
@@ -88,8 +88,12 @@ module GoodJob # :nodoc:
       @executor_options[:name] = name
 
       @cleanup_tracker = CleanupTracker.new(cleanup_interval_seconds: cleanup_interval_seconds, cleanup_interval_jobs: cleanup_interval_jobs)
+      @metrics = ::GoodJob::Metrics.new
+      @executor_options[:name] = name
+
       create_executor
       warm_cache if warm_cache_on_initialize
+      self.class.instances << self
     end
 
     # Tests whether the scheduler is running.
@@ -139,6 +143,7 @@ module GoodJob # :nodoc:
 
       instrument("scheduler_restart_pools") do
         shutdown(timeout: timeout)
+        @metrics.reset
         create_executor
         warm_cache
       end
@@ -197,8 +202,20 @@ module GoodJob # :nodoc:
     # @!visibility private
     # @return [void]
     def task_observer(time, output, thread_error)
-      error = thread_error || (output.is_a?(GoodJob::ExecutionResult) ? output.unhandled_error : nil)
-      GoodJob._on_thread_error(error) if error
+      result = output.is_a?(GoodJob::ExecutionResult) ? output : nil
+
+      unhandled_error = thread_error || result&.unhandled_error
+      GoodJob._on_thread_error(unhandled_error) if unhandled_error
+
+      if unhandled_error || result&.handled_error
+        @metrics.increment_errored_executions
+      elsif result&.unexecutable
+        @metrics.increment_unexecutable_executions
+      elsif result
+        @metrics.increment_succeeded_executions
+      else
+        @metrics.increment_empty_executions
+      end
 
       instrument("finished_job_task", { result: output, error: thread_error, time: time })
       return unless output
@@ -214,15 +231,17 @@ module GoodJob # :nodoc:
     # Information about the Scheduler
     # @return [Hash]
     def stats
+      available_threads = executor.ready_worker_count
       {
-        name: performer.name,
+        name: name,
+        queues: performer.name,
         max_threads: @executor_options[:max_threads],
-        active_threads: @executor_options[:max_threads] - executor.ready_worker_count,
-        available_threads: executor.ready_worker_count,
+        active_threads: @executor_options[:max_threads] - available_threads,
+        available_threads: available_threads,
         max_cache: @max_cache,
         active_cache: cache_count,
         available_cache: remaining_cache_count,
-      }
+      }.merge!(@metrics.to_h)
     end
 
     # Preload existing runnable and future-scheduled jobs
@@ -316,7 +335,7 @@ module GoodJob # :nodoc:
 
     # Custom sub-class of +Concurrent::ThreadPoolExecutor+ to add additional worker status.
     # @private
-    class ThreadPoolExecutor < Concurrent::ThreadPoolExecutor
+    class ThreadPoolExecutor < ::Concurrent::ThreadPoolExecutor
       # Number of inactive threads available to execute tasks.
       # https://github.com/ruby-concurrency/concurrent-ruby/issues/684#issuecomment-427594437
       # @return [Integer]
@@ -335,7 +354,7 @@ module GoodJob # :nodoc:
 
     # Custom sub-class of +Concurrent::TimerSet+ for additional behavior.
     # @private
-    class TimerSet < Concurrent::TimerSet
+    class TimerSet < ::Concurrent::TimerSet
       # Number of scheduled jobs in the queue
       # @return [Integer]
       def length

data/lib/good_job/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.15.14'
+  VERSION = '3.16.1'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "active_job"
 require "active_job/queue_adapters"
 
@@ -46,7 +47,7 @@ module GoodJob
   #   @return [ActiveRecord::Base]
   #   @example Change the base class:
   #     GoodJob.active_record_parent_class = "CustomApplicationRecord"
-  mattr_accessor :active_record_parent_class, default: "ActiveRecord::Base"
+  mattr_accessor :active_record_parent_class, default: nil
 
   # @!attribute [rw] logger
   #   @!scope class
@@ -105,6 +106,19 @@ module GoodJob
     on_thread_error.call(exception) if on_thread_error.respond_to?(:call)
   end
 
+  # Custom Active Record configuration that is class_eval'ed into +GoodJob::BaseRecord+
+  # @param block Custom Active Record configuration
+  # @retyrn [void]
+  #
+  # @example
+  #   GoodJob.configure_active_record do
+  #     connects_to database: :special_database
+  #   end
+  def self.configure_active_record(&block)
+    self._active_record_configuration = block
+  end
+  mattr_accessor :_active_record_configuration, default: nil
+
   # Stop executing jobs.
   # GoodJob does its work in pools of background threads.
   # When forking processes you should shut down these background threads before forking, and restart them after forking.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.15.14
+  version: 3.16.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -343,8 +343,11 @@ files:
 - app/frontend/good_job/vendor/rails_ujs.js
 - app/frontend/good_job/vendor/stimulus.js
 - app/helpers/good_job/application_helper.rb
+- app/models/concerns/good_job/error_events.rb
 - app/models/concerns/good_job/filterable.rb
+- app/models/concerns/good_job/lockable.rb
 - app/models/concerns/good_job/reportable.rb
+- app/models/good_job/active_record_parent_class.rb
 - app/models/good_job/base_execution.rb
 - app/models/good_job/base_record.rb
 - app/models/good_job/batch.rb
@@ -353,8 +356,8 @@ files:
 - app/models/good_job/discrete_execution.rb
 - app/models/good_job/execution.rb
 - app/models/good_job/execution_result.rb
+- app/models/good_job/i18n_config.rb
 - app/models/good_job/job.rb
-- app/models/good_job/lockable.rb
 - app/models/good_job/process.rb
 - app/models/good_job/setting.rb
 - app/views/good_job/batches/_jobs.erb
@@ -394,7 +397,7 @@ files:
 - config/locales/nl.yml
 - config/locales/ru.yml
 - config/locales/tr.yml
-- config/locales/ua.yml
+- config/locales/uk.yml
 - config/routes.rb
 - exe/good_job
 - lib/active_job/queue_adapters/good_job_adapter.rb
@@ -405,6 +408,7 @@ files:
 - lib/generators/good_job/templates/update/migrations/03_create_index_good_jobs_jobs_on_priority_created_at_when_unfinished.rb.erb
 - 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/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb
@@ -426,6 +430,7 @@ files:
 - lib/good_job/interrupt_error.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/log_subscriber.rb
+- lib/good_job/metrics.rb
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
 - lib/good_job/notifier/process_heartbeat.rb