good_job 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2225caa419c57cd76c9acba358fa94e2fd2d29c914d25459093a5a65b785087d
-  data.tar.gz: 2c6af031bb80859108ed847a7d891a2066b06004edb518fa8921b01b3c9b662a
+  metadata.gz: cabb124450eb5e88a460635fb4aa70f3e5a53406ded6554bb32018fa2aa890bc
+  data.tar.gz: 0d83085806f8a1f30eff6136df4995f7982064b90a497ee56a4f8b9d922f4fbb
 SHA512:
-  metadata.gz: 00bfcfcf22a4f3e5138bc2d85a172bbf4c74515c38759af561567c42f5464825fd47aa3f5c369f91196ede2b73211c9e1b3422f5d555bcff439e7fd32fc9db1a
-  data.tar.gz: cc28292dd555ddd951ab465534302f0775784074e456bb181eb2f5efc07f4281bcd49783fa38e4a205591fb05daa19f88ff013995fe06fe3761e675b1e84e0ba
+  metadata.gz: 7f17d4379517d9909ac771c9920b3472b1d5bbb18ce45bd78b160f76eba6b6a1169e6b89ec044cd8f3c5ad93a311be45174bd43b99468c5ff9a5c4bad088263f
+  data.tar.gz: 27f6aa3048d4035feb1e55b7cd4a3ba8410deb74ec9268fba23bac9a75c9db26bc3599d1f140bf68182b2f2307183013bc6601927a6eec19cab6051fcf03a927

data/CHANGELOG.md

@@ -1,9 +1,40 @@
 # Changelog
 
+## [v3.3.1](https://github.com/bensheldon/good_job/tree/v3.3.1) (2022-07-26)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.3.0...v3.3.1)
+
+**Implemented enhancements:**
+
+- Show basename of proctitle [\#679](https://github.com/bensheldon/good_job/pull/679) ([bkeepers](https://github.com/bkeepers))
+
+**Fixed bugs:**
+
+- Only count \_active\_ processes in the Navbar [\#680](https://github.com/bensheldon/good_job/pull/680) ([bensheldon](https://github.com/bensheldon))
+- Remove Zeitwerk and use explicit requires to be more like an engine [\#677](https://github.com/bensheldon/good_job/pull/677) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Dashboard UI Invalid count of running process  [\#678](https://github.com/bensheldon/good_job/issues/678)
+
+**Merged pull requests:**
+
+- Lock to dotenv 2.7.x for Ruby 2.5 compatibility [\#682](https://github.com/bensheldon/good_job/pull/682) ([bensheldon](https://github.com/bensheldon))
+- Create global GoodJob.configuration object [\#681](https://github.com/bensheldon/good_job/pull/681) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.3.0](https://github.com/bensheldon/good_job/tree/v3.3.0) (2022-07-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.2.0...v3.3.0)
 
+**Implemented enhancements:**
+
+- Dashboard: Update cron and processes to match jobs listing [\#676](https://github.com/bensheldon/good_job/pull/676) ([bkeepers](https://github.com/bkeepers))
+- Dashboard: improvements to jobs index and show pages [\#672](https://github.com/bensheldon/good_job/pull/672) ([bkeepers](https://github.com/bkeepers))
+
+**Fixed bugs:**
+
+- Replace "timestamp" column-type in migrations with "datetime" [\#671](https://github.com/bensheldon/good_job/pull/671) ([bensheldon](https://github.com/bensheldon))
+
 **Closed issues:**
 
 - Calculating database connections [\#669](https://github.com/bensheldon/good_job/issues/669)
@@ -14,9 +45,6 @@
 
 **Merged pull requests:**
 
-- Dashboard: Update cron and processes to match jobs listing [\#676](https://github.com/bensheldon/good_job/pull/676) ([bkeepers](https://github.com/bkeepers))
-- Dashboard: improvements to jobs index and show pages [\#672](https://github.com/bensheldon/good_job/pull/672) ([bkeepers](https://github.com/bkeepers))
-- Replace "timestamp" column-type in migrations with "datetime" [\#671](https://github.com/bensheldon/good_job/pull/671) ([bensheldon](https://github.com/bensheldon))
 - Improve Readme description of v3 job preservation defaults [\#670](https://github.com/bensheldon/good_job/pull/670) ([bensheldon](https://github.com/bensheldon))
 - update Gemfile.lock to latest dependencies [\#647](https://github.com/bensheldon/good_job/pull/647) ([jrochkind](https://github.com/jrochkind))
 
@@ -24,7 +52,7 @@
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.1.0...v3.2.0)
 
-**Merged pull requests:**
+**Implemented enhancements:**
 
 - Ordered queue handling by workers [\#665](https://github.com/bensheldon/good_job/pull/665) ([jrochkind](https://github.com/jrochkind))
 
@@ -34,7 +62,9 @@
 
 **Implemented enhancements:**
 
+- Show job/cron/process counts in the Navbar [\#663](https://github.com/bensheldon/good_job/pull/663) ([bensheldon](https://github.com/bensheldon))
 - Improve Dashboard display of parameters \(CronEntry kwargs; Process configuration; Job and Execution database values\) [\#662](https://github.com/bensheldon/good_job/pull/662) ([bensheldon](https://github.com/bensheldon))
+- Dequeing should be first-in first-out [\#651](https://github.com/bensheldon/good_job/pull/651) ([jrochkind](https://github.com/jrochkind))
 
 **Fixed bugs:**
 
@@ -47,11 +77,6 @@
 - Cron schedule page in dashboard not showing kwargs [\#608](https://github.com/bensheldon/good_job/issues/608)
 - Paralelism x database connections [\#569](https://github.com/bensheldon/good_job/issues/569)
 
-**Merged pull requests:**
-
-- Show job/cron/process counts in the Navbar [\#663](https://github.com/bensheldon/good_job/pull/663) ([bensheldon](https://github.com/bensheldon))
-- Dequeing should be first-in first-out [\#651](https://github.com/bensheldon/good_job/pull/651) ([jrochkind](https://github.com/jrochkind))
-
 ## [v3.0.2](https://github.com/bensheldon/good_job/tree/v3.0.2) (2022-07-10)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.0.1...v3.0.2)
@@ -81,13 +106,16 @@
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.0.0...v3.0.1)
 
+**Fixed bugs:**
+
+- Fix `GoodJob.cleanup_preserved_jobs` to use `delete_all` instead of `destroy_all` [\#652](https://github.com/bensheldon/good_job/pull/652) ([bensheldon](https://github.com/bensheldon))
+
 **Closed issues:**
 
 - ERROR:  relation "good\_jobs" does not exist at character 454 [\#308](https://github.com/bensheldon/good_job/issues/308)
 
 **Merged pull requests:**
 
-- Fix `GoodJob.cleanup_preserved_jobs` to use `delete_all` instead of `destroy_all` [\#652](https://github.com/bensheldon/good_job/pull/652) ([bensheldon](https://github.com/bensheldon))
 - Create codeql-analysis.yml [\#648](https://github.com/bensheldon/good_job/pull/648) ([bensheldon](https://github.com/bensheldon))
 
 ## [v3.0.0](https://github.com/bensheldon/good_job/tree/v3.0.0) (2022-06-26)

data/{lib → app}/models/good_job/cron_entry.rb

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

data/{lib → app}/models/good_job/job.rb

@@ -28,7 +28,7 @@ module GoodJob
     self.primary_key = 'active_job_id'
     self.advisory_lockable_column = 'active_job_id'
 
-    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job
+    has_many :executions, -> { order(created_at: :asc) }, class_name: 'GoodJob::Execution', foreign_key: 'active_job_id', inverse_of: :job # rubocop:disable Rails/HasManyOrHasOneDependent
 
     # Only the most-recent unretried execution represents a "Job"
     default_scope { where(retried_good_job_id: nil) }

data/{lib → app}/models/good_job/process.rb

@@ -71,5 +71,9 @@ module GoodJob # :nodoc:
       destroy!
       advisory_unlock
     end
+
+    def basename
+      File.basename(state["proctitle"])
+    end
   end
 end

data/app/views/good_job/processes/index.html.erb

@@ -25,10 +25,10 @@
       <div id="<%= dom_id(process) %>" class="<%= dom_class(process) %> list-group-item py-3" role="row">
         <div class="row align-items-center">
           <div class="col">
-            <code class="font-monospace">
+            <%= tag.code title: process.state['proctitle'], class: "font-monospace" do %>
               <span class="text-muted opacity-50">$</span>
-              <%= process.state["proctitle"] %>
-            </code>
+              <%= process.basename %>
+            <% end %>
             <div>
               <span class="text-muted small">PID</span>
               <span class="badge rounded-pill bg-light text-dark"><%= process.state["pid"] %></span>

data/app/views/good_job/shared/_navbar.erb

@@ -24,7 +24,7 @@
         <li class="nav-item">
           <%= link_to processes_path, class: ["nav-link", ("active" if controller_name == 'processes')] do %>
             <%= t(".processes") %>
-            <% processes_count = GoodJob::Process.count %>
+            <% processes_count = GoodJob::Process.active.count %>
             <span class="badge bg-secondary rounded-pill <%= "bg-danger" if processes_count == 0 %>"><%= processes_count %></span>
           <% end %>
         </li>

data/lib/good_job/adapter.rb

@@ -10,6 +10,8 @@ module GoodJob
     #   @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,8 @@ module GoodJob
     #  - +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
+      GoodJob::Configuration.validate_execution_mode(@execution_mode)
       self.class.instances << self
 
       start_async if GoodJob.async_ready?
@@ -82,7 +84,7 @@ module GoodJob
     # @return [void]
     def shutdown(timeout: :default)
       timeout = if timeout == :default
-                  @configuration.shutdown_timeout
+                  GoodJob.configuration.shutdown_timeout
                 else
                   timeout
                 end
@@ -95,21 +97,21 @@ module GoodJob
     # 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 +120,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/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.3.0'
+  VERSION = '3.3.1'
 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.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-24 00:00:00.000000000 Z
+date: 2022-07-26 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
@@ -383,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
@@ -419,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
@@ -431,8 +426,6 @@ 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/job_performer.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb
@@ -442,14 +435,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
-- lib/models/good_job/reportable.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