good_job 3.15.13 → 3.16.0

data/config/locales/{ua.yml → uk.yml}

@@ -1,5 +1,5 @@
 ---
-ua:
+uk:
   good_job:
     actions:
       destroy: Видалити
@@ -53,40 +53,64 @@ ua:
     datetime:
       distance_in_words:
         about_x_hours:
+          few: близько %{count} годин
+          many: близько %{count} годин
           one: близько 1 години
           other: близько %{count} годин
         about_x_months:
+          few: близько %{count} місяців
+          many: близько %{count} місяців
           one: близько 1 місяця
           other: близько %{count} місяців
         about_x_years:
+          few: близько %{count} років
+          many: близько %{count} років
           one: близько 1 року
           other: близько %{count} років
         almost_x_years:
+          few: майже %{count} роки
+          many: майже %{count} років
           one: майже 1 рік
           other: майже %{count} років
         half_a_minute: півхвилини
         less_than_x_minutes:
+          few: менше %{count} хвилин
+          many: менше %{count} хвилин
           one: менше 1 хвилини
           other: менше %{count} хвилин
         less_than_x_seconds:
+          few: менше %{count} секунд
+          many: менше %{count} секунд
           one: менше 1 секунди
           other: менше %{count} секунд
         over_x_years:
+          few: більше %{count} років
+          many: більше %{count} років
           one: понад 1 рік
           other: понад %{count} років
         x_days:
+          few: "%{count} дні"
+          many: "%{count} днів"
           one: 1 день
           other: "%{count} днів"
         x_minutes:
+          few: 1 хвилини
+          many: "%{count} хвилин"
           one: 1 хвилина
           other: "%{count} хвилин"
         x_months:
+          few: "%{count} місяці"
+          many: "%{count} місяців"
           one: 1 місяць
           other: "%{count} місяців"
         x_seconds:
+          few: "%{count} секунди"
+          many: "%{count} секунд"
           one: 1 секунда
           other: "%{count} секунд"
         x_years:
+          few: "%{count} роки"
+          many: "%{count} років"
           one: 1 рік
           other: "%{count} років"
     duration:
@@ -95,6 +119,13 @@ ua:
       milliseconds: "%{ms}мс"
       minutes: "%{min}хв %{sec}с"
       seconds: "%{sec}с"
+    error_event:
+      discarded: Відкинуто
+      handled: Обробляється
+      interrupted: Перерваний
+      retried: Повторна спроба
+      retry_stopped: Повторну спробу зупинено
+      unhandled: Необроблений
     helpers:
       relative_time:
         future: за %{time}
@@ -114,7 +145,6 @@ ua:
       discard:
         notice: Завдання було відхилено
       executions:
-        error: Помилка
         in_queue: у черзі
         runtime: час виконання
         title: Виконання
@@ -192,7 +222,9 @@ ua:
         schedulers: Планувальники
         started: Розпочато
         title: Процеси
+        updated: Оновлено
     shared:
+      error: Помилка
       filter:
         all: Всі
         all_jobs: Усі роботи

data/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 GoodJob::Engine.routes.draw do
   root to: redirect(path: 'jobs')
 

data/exe/good_job

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require 'good_job/cli'
 
 GoodJob::CLI.within_exe = true

data/lib/active_job/queue_adapters/good_job_adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveJob # :nodoc:
   module QueueAdapters # :nodoc:
     # See {GoodJob::Adapter} for details.

data/lib/generators/good_job/install_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/active_record'
 

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

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
   def change
-    enable_extension 'pgcrypto'
+    # Uncomment for Postgres v12 or earlier to enable gen_random_uuid() support
+    # enable_extension 'pgcrypto'
 
     create_table :good_jobs, id: :uuid do |t|
       t.text :queue_name
@@ -26,6 +28,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.boolean :is_discrete
       t.integer :executions_count
       t.text :job_class
+      t.integer :error_event, limit: 2
     end
 
     create_table :good_job_batches, id: :uuid do |t|
@@ -52,6 +55,7 @@ class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
       t.datetime :scheduled_at
       t.datetime :finished_at
       t.text :error
+      t.integer :error_event, limit: 2
     end
 
     create_table :good_job_processes, id: :uuid do |t|

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

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
   def change
-    enable_extension 'pgcrypto'
+    # Uncomment for Postgres v12 or earlier to enable gen_random_uuid() support
+    # enable_extension 'pgcrypto'
 
     create_table :good_jobs, id: :uuid do |t|
       t.text :queue_name

data/lib/generators/good_job/templates/update/migrations/02_create_good_job_settings.rb.erb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobSettings < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

data/lib/generators/good_job/templates/update/migrations/03_create_index_good_jobs_jobs_on_priority_created_at_when_unfinished.rb.erb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateIndexGoodJobsJobsOnPriorityCreatedAtWhenUnfinished < ActiveRecord::Migration<%= migration_version %>
   disable_ddl_transaction!
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobBatches < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

data/lib/generators/good_job/templates/update/migrations/05_create_good_job_executions.rb.erb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobExecutions < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

data/lib/generators/good_job/templates/update/migrations/06_create_good_jobs_error_event.rb.erb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateGoodJobsErrorEvent < 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.column_exists?(:good_jobs, :error_event)
+      end
+    end
+
+    add_column :good_jobs, :error_event, :integer, limit: 2
+    add_column :good_job_executions, :error_event, :integer, limit: 2
+  end
+end

data/lib/generators/good_job/update_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/active_record'
 

data/lib/good_job/active_job_extensions/batches.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module Batches

data/lib/good_job/active_job_extensions/concurrency.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module Concurrency
@@ -92,7 +93,7 @@ module GoodJob
         key = self.class.good_job_concurrency_config[:key]
         return if key.blank?
 
-        key = key.respond_to?(:call) ? instance_exec(&key) : key
+        key = instance_exec(&key) if key.respond_to?(:call)
         raise TypeError, "Concurrency key must be a String; was a #{key.class}" unless VALID_TYPES.any? { |type| key.is_a?(type) }
 
         key

data/lib/good_job/active_job_extensions/interrupt_errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module InterruptErrors

data/lib/good_job/active_job_extensions/notify_options.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     # Allows configuring whether GoodJob should emit a NOTIFY event when a job is enqueued.

data/lib/good_job/adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # ActiveJob Adapter.
@@ -8,7 +9,7 @@ module GoodJob
     #   @!scope class
     #   List of all instantiated Adapters in the current process.
     #   @return [Array<GoodJob::Adapter>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # @param execution_mode [Symbol, nil] specifies how and where jobs should be executed. You can also set this with the environment variable +GOOD_JOB_EXECUTION_MODE+.
     #
@@ -29,8 +30,8 @@ module GoodJob
       GoodJob::Configuration.validate_execution_mode(@_execution_mode_override) if @_execution_mode_override
       @capsule = _capsule
 
-      self.class.instances << self
       start_async if GoodJob.async_ready?
+      self.class.instances << self
     end
 
     # Enqueues the ActiveJob job to be performed.

data/lib/good_job/assignable_connection.rb

@@ -1,4 +1,5 @@
 # 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.

data/lib/good_job/bulk.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 
 module GoodJob

data/lib/good_job/capsule.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # A GoodJob::Capsule contains the resources necessary to execute jobs, including
   # a {GoodJob::Scheduler}, {GoodJob::Poller}, {GoodJob::Notifier}, and {GoodJob::CronManager}.
@@ -8,16 +9,16 @@ module GoodJob
     #   @!scope class
     #   List of all instantiated Capsules in the current process.
     #   @return [Array<GoodJob::Capsule>, nil]
-    cattr_reader :instances, default: [], instance_reader: false
+    cattr_reader :instances, default: Concurrent::Array.new, instance_reader: false
 
     # @param configuration [GoodJob::Configuration] Configuration to use for this capsule.
     def initialize(configuration: GoodJob.configuration)
-      self.class.instances << self
       @configuration = configuration
-
       @startable = true
       @running = false
       @mutex = Mutex.new
+
+      self.class.instances << self
     end
 
     # Start the capsule once. After a shutdown, {#restart} must be used to start again.
@@ -49,7 +50,7 @@ module GoodJob
     #   * +nil+ will trigger a shutdown but not wait for it to complete.
     # @return [void]
     def shutdown(timeout: :default)
-      timeout = timeout == :default ? @configuration.shutdown_timeout : timeout
+      timeout = @configuration.shutdown_timeout if timeout == :default
       GoodJob._shutdown_all([@notifier, @poller, @scheduler, @cron_manager].compact, timeout: timeout)
       @startable = false
       @running = false

data/lib/good_job/cleanup_tracker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob # :nodoc:
   # Tracks thresholds for cleaning up old jobs.
   class CleanupTracker
@@ -17,7 +18,7 @@ module GoodJob # :nodoc:
     end
 
     # Increments job count.
-    # @return [void]
+    # @return [Integer]
     def increment
       self.job_count += 1
     end

data/lib/good_job/cli.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'thor'
 
 module GoodJob

data/lib/good_job/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # +GoodJob::Configuration+ provides normalized configuration information to
@@ -28,6 +29,8 @@ module GoodJob
     DEFAULT_ENABLE_CRON = false
     # Default to enabling LISTEN/NOTIFY
     DEFAULT_ENABLE_LISTEN_NOTIFY = true
+    # Default Dashboard I18n locale
+    DEFAULT_DASHBOARD_DEFAULT_LOCALE = :en
 
     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)
@@ -345,6 +348,10 @@ module GoodJob
       rails_config[:smaller_number_is_higher_priority]
     end
 
+    def dashboard_default_locale
+      rails_config[:dashboard_default_locale] || DEFAULT_DASHBOARD_DEFAULT_LOCALE
+    end
+
     private
 
     def rails_config

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_registration.rb → process_heartbeat.rb}

@@ -3,11 +3,12 @@
 module GoodJob # :nodoc:
   class Notifier # :nodoc:
     # Extends the Notifier to register the process in the database.
-    module ProcessRegistration
+    module ProcessHeartbeat
       extend ActiveSupport::Concern
 
       included do
         set_callback :listen, :after, :register_process
+        set_callback :tick, :before, :refresh_process
         set_callback :unlisten, :after, :deregister_process
       end
 
@@ -19,6 +20,14 @@ module GoodJob # :nodoc:
         end
       end
 
+      def refresh_process
+        GoodJob::Process.with_connection(connection) do
+          Process.logger.silence do
+            @process&.refresh_if_stale(cleanup: true)
+          end
+        end
+      end
+
       # Deregisters the current process.
       def deregister_process
         GoodJob::Process.with_connection(connection) do

data/lib/good_job/notifier.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 require 'concurrent/atomic/atomic_boolean'
-require "good_job/notifier/process_registration"
+require "good_job/notifier/process_heartbeat"
 
 module GoodJob # :nodoc:
   #
@@ -13,9 +14,9 @@ module GoodJob # :nodoc:
   #
   class Notifier
     include ActiveSupport::Callbacks
-    define_callbacks :listen, :unlisten
+    define_callbacks :listen, :tick, :unlisten
 
-    include Notifier::ProcessRegistration
+    include ProcessHeartbeat
 
     # Default Postgres channel for LISTEN/NOTIFY
     CHANNEL = 'good_job'
@@ -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.
@@ -189,18 +189,20 @@ module GoodJob # :nodoc:
             end
 
             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)
+              run_callbacks :tick do
+                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
 
-              reset_connection_errors
+                reset_connection_errors
+              end
             end
           end
         ensure