Create global GoodJob.configuration object

lib/good_job.rb

@@ -69,6 +69,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 +141,9 @@ def self._shutdown_all(executables, method_name = :shutdown, timeout: -1)
  # @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)

lib/good_job/adapter.rb

@@ -10,6 +10,8 @@ class Adapter
  # @return [Array<GoodJob::Adapter>, nil]
  cattr_reader :instances, default: [], instance_reader: false
 
+ attr_reader :execution_mode
+
  # @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+.
  #
  # - +:inline+ executes jobs immediately in whatever process queued them (usually the web server process). This should only be used in test and development environments.
@@ -25,8 +27,7 @@ class Adapter
  # - +production+ and all other environments: +:external+
  #
  def initialize(execution_mode: nil)
- @configuration = GoodJob::Configuration.new({ execution_mode: execution_mode })
- @configuration.validate!
+ @execution_mode = (execution_mode || GoodJob::Configuration.execution_mode).to_sym
  self.class.instances << self
 
  start_async if GoodJob.async_ready?
@@ -82,7 +83,7 @@ def enqueue_at(active_job, timestamp)
  # @return [void]
  def shutdown(timeout: :default)
  timeout = if timeout == :default
- @configuration.shutdown_timeout
+ GoodJob.configuration.shutdown_timeout
  else
  timeout
  end
@@ -95,21 +96,21 @@ def shutdown(timeout: :default)
  # 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 == :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 +119,12 @@ def start_async
  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

lib/good_job/cli.rb

@@ -85,7 +85,8 @@ def exit_on_failure?
 
  def start
  set_up_application!
- configuration = GoodJob::Configuration.new(options)
+ GoodJob.configuration.options.merge!(options)
+ configuration = GoodJob.configuration
 
  Daemon.new(pidfile: configuration.pidfile).daemonize if configuration.daemonize?
 
@@ -142,10 +143,9 @@ def start
 
  def cleanup_preserved_jobs
  set_up_application!
+ GoodJob.configuration.options.merge!(options)
 
- 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

lib/good_job/configuration.rb

@@ -29,7 +29,7 @@ class Configuration
 
  # The options that were explicitly set when initializing +Configuration+.
  # @return [Hash]
- attr_reader :options
+ attr_accessor :options
 
  # The environment from which to read GoodJob's environment variables. By
  # default, this is the current process's environment, but it can be set
@@ -41,7 +41,7 @@ class Configuration
  # use. Keys are symbols that match the various methods on this class.
  # @param env [Hash] A +Hash+ from which to read environment variables that
  # might specify additional configuration values.
- def initialize(options, env: ENV)
+ def initialize(options = {}, env: ENV)
  @options = options
  @env = env
  end

lib/models/good_job/cron_entry.rb

@@ -13,7 +13,7 @@ class CronEntry
  attr_reader :params
 
  def self.all(configuration: nil)
- configuration ||= GoodJob::Configuration.new({})
+ configuration ||= GoodJob.configuration
  configuration.cron_entries
  end