good_job 3.2.0 → 3.3.2

data/lib/good_job/adapter.rb

@@ -25,10 +25,10 @@ module GoodJob
     #  - +production+ and all other environments: +:external+
     #
     def initialize(execution_mode: nil)
-      @configuration = GoodJob::Configuration.new({ execution_mode: execution_mode })
-      @configuration.validate!
-      self.class.instances << self
+      @_execution_mode_override = execution_mode
+      GoodJob::Configuration.validate_execution_mode(@_execution_mode_override) if @_execution_mode_override
 
+      self.class.instances << self
       start_async if GoodJob.async_ready?
     end
 
@@ -82,7 +82,7 @@ module GoodJob
     # @return [void]
     def shutdown(timeout: :default)
       timeout = if timeout == :default
-                  @configuration.shutdown_timeout
+                  GoodJob.configuration.shutdown_timeout
                 else
                   timeout
                 end
@@ -92,24 +92,31 @@ module GoodJob
       @_async_started = false
     end
 
+    # This adapter's execution mode
+    # @return [Symbol, nil]
+    def execution_mode
+      @_execution_mode_override || GoodJob.configuration.execution_mode
+    end
+
     # Whether in +:async+ execution mode.
     # @return [Boolean]
     def execute_async?
-      @configuration.execution_mode == :async_all ||
-        (@configuration.execution_mode.in?([:async, :async_server]) && in_server_process?)
+      execution_mode == :async_all ||
+        (execution_mode.in?([:async, :async_server]) && in_server_process?)
     end
 
     # Whether in +:external+ execution mode.
     # @return [Boolean]
     def execute_externally?
-      @configuration.execution_mode == :external ||
-        (@configuration.execution_mode.in?([:async, :async_server]) && !in_server_process?)
+      execution_mode.nil? ||
+        execution_mode == :external ||
+        (execution_mode.in?([:async, :async_server]) && !in_server_process?)
     end
 
     # Whether in +:inline+ execution mode.
     # @return [Boolean]
     def execute_inline?
-      @configuration.execution_mode == :inline
+      execution_mode == :inline
     end
 
     # Start async executors
@@ -118,12 +125,12 @@ module GoodJob
       return unless execute_async?
 
       @notifier = GoodJob::Notifier.new
-      @poller = GoodJob::Poller.new(poll_interval: @configuration.poll_interval)
-      @scheduler = GoodJob::Scheduler.from_configuration(@configuration, warm_cache_on_initialize: true)
+      @poller = GoodJob::Poller.new(poll_interval: GoodJob.configuration.poll_interval)
+      @scheduler = GoodJob::Scheduler.from_configuration(GoodJob.configuration, warm_cache_on_initialize: true)
       @notifier.recipients << [@scheduler, :create_thread]
       @poller.recipients << [@scheduler, :create_thread]
 
-      @cron_manager = GoodJob::CronManager.new(@configuration.cron_entries, start_on_initialize: true) if @configuration.enable_cron?
+      @cron_manager = GoodJob::CronManager.new(GoodJob.configuration.cron_entries, start_on_initialize: true) if GoodJob.configuration.enable_cron?
 
       @_async_started = true
     end

data/lib/good_job/cli.rb

@@ -85,7 +85,8 @@ module GoodJob
 
     def start
       set_up_application!
-      configuration = GoodJob::Configuration.new(options)
+      GoodJob.configuration.options.merge!(options.symbolize_keys)
+      configuration = GoodJob.configuration
 
       Daemon.new(pidfile: configuration.pidfile).daemonize if configuration.daemonize?
 
@@ -142,10 +143,9 @@ module GoodJob
 
     def cleanup_preserved_jobs
       set_up_application!
+      GoodJob.configuration.options.merge!(options.symbolize_keys)
 
-      configuration = GoodJob::Configuration.new(options)
-
-      GoodJob.cleanup_preserved_jobs(older_than: configuration.cleanup_preserved_jobs_before_seconds_ago)
+      GoodJob.cleanup_preserved_jobs(older_than: GoodJob.configuration.cleanup_preserved_jobs_before_seconds_ago)
     end
 
     no_commands do

data/lib/good_job/configuration.rb

@@ -27,7 +27,12 @@ module GoodJob
     # Default to not running cron
     DEFAULT_ENABLE_CRON = false
 
+    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)
+    end
+
     # The options that were explicitly set when initializing +Configuration+.
+    # It is safe to modify this hash in place; be sure to symbolize keys.
     # @return [Hash]
     attr_reader :options
 
@@ -47,7 +52,7 @@ module GoodJob
     end
 
     def validate!
-      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)
+      self.class.validate_execution_mode(execution_mode)
     end
 
     # Specifies how and where jobs should be executed. See {Adapter#initialize}

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/enqueuing.rb

@@ -0,0 +1,4 @@
+module GoodJob
+  module Enqueing
+  end
+end

data/lib/good_job/notifier.rb

@@ -1,6 +1,7 @@
 # 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"
 
 module GoodJob # :nodoc:
   #

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -2,19 +2,29 @@
 require "active_job"
 require "active_job/queue_adapters"
 
-require "zeitwerk"
-zeitwerk_options = Gem::Version.new(Zeitwerk::VERSION) >= Gem::Version.new("2.6.0") ? { warn_on_extra_files: false } : {}
-Zeitwerk::Loader.for_gem(**zeitwerk_options).tap do |loader|
-  loader.inflector.inflect({
-                             "cli" => "CLI",
-                           })
-  loader.push_dir("#{__dir__}/models")
-  loader.ignore("#{__dir__}/generators")
-  loader.setup
-end
-
+require "good_job/version"
 require "good_job/engine"
 
+require "good_job/adapter"
+require "active_job/queue_adapters/good_job_adapter"
+require "good_job/active_job_extensions/concurrency"
+
+require "good_job/assignable_connection"
+require "good_job/cleanup_tracker"
+require "good_job/cli"
+require "good_job/configuration"
+require "good_job/cron_manager"
+require 'good_job/current_thread'
+require "good_job/daemon"
+require "good_job/dependencies"
+require "good_job/job_performer"
+require "good_job/log_subscriber"
+require "good_job/multi_scheduler"
+require "good_job/notifier"
+require "good_job/poller"
+require "good_job/probe_server"
+require "good_job/scheduler"
+
 # GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 #
 # +GoodJob+ is the top-level namespace and exposes configuration attributes.
@@ -69,6 +79,12 @@ module GoodJob
   #   @return [Proc, nil]
   mattr_accessor :on_thread_error, default: nil
 
+  # @!attribute [rw] configuration
+  #   @!scope class
+  #   Global configuration object for GoodJob.
+  #   @return [GoodJob::Configuration, nil]
+  mattr_accessor :configuration, default: GoodJob::Configuration.new({})
+
   # Called with exception when a GoodJob thread raises an exception
   # @param exception [Exception] Exception that was raised
   # @return [void]
@@ -135,10 +151,9 @@ module GoodJob
   # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs older than this will be destroyed (default: +86400+).
   # @return [Integer] Number of jobs that were destroyed.
   def self.cleanup_preserved_jobs(older_than: nil)
-    configuration = GoodJob::Configuration.new({})
-    older_than ||= configuration.cleanup_preserved_jobs_before_seconds_ago
+    older_than ||= GoodJob.configuration.cleanup_preserved_jobs_before_seconds_ago
     timestamp = Time.current - older_than
-    include_discarded = configuration.cleanup_discarded_jobs?
+    include_discarded = GoodJob.configuration.cleanup_discarded_jobs?
 
     ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
       old_jobs = GoodJob::Job.where('finished_at <= ?', timestamp)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +154,16 @@ dependencies:
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.6
 - !ruby/object:Gem::Dependency
   name: foreman
   requirement: !ruby/object:Gem::Requirement
@@ -365,6 +351,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
@@ -382,6 +369,16 @@ files:
 - app/filters/good_job/base_filter.rb
 - app/filters/good_job/jobs_filter.rb
 - app/helpers/good_job/application_helper.rb
+- app/models/concerns/good_job/filterable.rb
+- app/models/concerns/good_job/reportable.rb
+- app/models/good_job/active_job_job.rb
+- app/models/good_job/base_record.rb
+- app/models/good_job/cron_entry.rb
+- app/models/good_job/execution.rb
+- app/models/good_job/execution_result.rb
+- app/models/good_job/job.rb
+- app/models/good_job/lockable.rb
+- app/models/good_job/process.rb
 - app/views/good_job/cron_entries/index.html.erb
 - app/views/good_job/cron_entries/show.html.erb
 - app/views/good_job/jobs/_executions.erb
@@ -398,7 +395,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
@@ -416,7 +415,6 @@ files:
 - lib/generators/good_job/templates/update/migrations/01_create_good_jobs.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/adapter.rb
 - lib/good_job/assignable_connection.rb
@@ -428,8 +426,7 @@ files:
 - lib/good_job/daemon.rb
 - lib/good_job/dependencies.rb
 - lib/good_job/engine.rb
-- lib/good_job/execution_result.rb
-- lib/good_job/filterable.rb
+- lib/good_job/enqueuing.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb
@@ -439,13 +436,6 @@ files:
 - lib/good_job/probe_server.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb
-- lib/models/good_job/active_job_job.rb
-- lib/models/good_job/base_record.rb
-- lib/models/good_job/cron_entry.rb
-- lib/models/good_job/execution.rb
-- lib/models/good_job/job.rb
-- lib/models/good_job/lockable.rb
-- lib/models/good_job/process.rb
 homepage: https://github.com/bensheldon/good_job
 licenses:
 - MIT

data/lib/good_job/active_job_extensions.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-module GoodJob
-  module ActiveJobExtensions
-  end
-end