good_job 3.20.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d33742278a734dd514fc3147abd1393ee62c3fd644c4c065b10c4fc6a24755
-  data.tar.gz: 83d56214ec454cbc3d910d4cbefb0413877ca3b18577168c0d9b9b456385a7a3
+  metadata.gz: f1e8a8a3ec28224d48f23c9c2795cd15f9eb515ba9059ab2bea4316a03b42aa9
+  data.tar.gz: e469a0f1be765789433ef9d0096c6c1c3fe3e87c90a184c11996a204a36dabd1
 SHA512:
-  metadata.gz: 90a3730d4989f26837b0ac9cd8f15ea3029f0c1c474159a4798a58d695153cb2067c336d382f971ba42a6faf371f677f7b295741c8ab1557add7c6b403a1fa94
-  data.tar.gz: 684e5d8473b4f460707394fd670067b0aaf7a2749ed525be2893967c0953ed1c5afe4f35e8acfce4acaa7f7fa39ae00d16394b38d186a11f7eb8812839d65ff3
+  metadata.gz: 6546caba43d15714d87c2b6f3a072b493804685411f7fdd3c73b8aaa0aacffb2f77ae8fcbb8f3eb0d9aeed9fbfab2c4175b49adebd3d5356a8994138b92e3852
+  data.tar.gz: 30f85524258b9f1b2b774601ef0fd23965ed21eac87b0a3c0491a94c0fe85a3c70efb57b9979d11047d8ea5176cf0008317c860c27411db86ecdf8ef2fd0a69c

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [v3.21.0](https://github.com/bensheldon/good_job/tree/v3.21.0) (2023-11-06)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.20.0...v3.21.0)
+
+**Implemented enhancements:**
+
+- Add "cron enabled" column to processes index page [\#1127](https://github.com/bensheldon/good_job/pull/1127) ([bforma](https://github.com/bforma))
+- Add `limit:` kwarg to `GoodJob.perform_inline` [\#1126](https://github.com/bensheldon/good_job/pull/1126) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Cron scheduler and multiple processes [\#1128](https://github.com/bensheldon/good_job/issues/1128)
+- `GoodJob.on_thread_error` not called in tests [\#1102](https://github.com/bensheldon/good_job/issues/1102)
+
+**Merged pull requests:**
+
+- Use a Concurrent::Event for CLI signal-trapping loop [\#1141](https://github.com/bensheldon/good_job/pull/1141) ([bensheldon](https://github.com/bensheldon))
+- Update README's optimize queue explanation [\#1138](https://github.com/bensheldon/good_job/pull/1138) ([maestromac](https://github.com/maestromac))
+- Update development dependencies and light Rubocop'ing [\#1136](https://github.com/bensheldon/good_job/pull/1136) ([bensheldon](https://github.com/bensheldon))
+- Move the Rails app harness from `spec/test_app` to `demo` [\#1135](https://github.com/bensheldon/good_job/pull/1135) ([bensheldon](https://github.com/bensheldon))
+- In test, shutdown schedulers/capsules before doing assertions because of race conditions; store CI logs for Dev Env tests [\#1129](https://github.com/bensheldon/good_job/pull/1129) ([bensheldon](https://github.com/bensheldon))
+- Use a constant to represent `None` for default/blank memoizable values [\#1125](https://github.com/bensheldon/good_job/pull/1125) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.20.0](https://github.com/bensheldon/good_job/tree/v3.20.0) (2023-10-23)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.19.4...v3.20.0)

data/README.md

@@ -939,7 +939,7 @@ By default, GoodJob creates a single thread execution pool that will execute job
 
     - `transactional_messages:2`: execute jobs enqueued on `transactional_messages`, with up to 2 threads.
     - `batch_processing:1` execute jobs enqueued on `batch_processing`, with a single thread.
-    - `-transactional_messages,batch_processing`: execute jobs enqueued on _any_ queue _excluding_ `transactional_messages` or `batch_processing`, with up to 2 threads.
+    - `-transactional_messages,batch_processing:2`: execute jobs enqueued on _any_ queue _excluding_ `transactional_messages` or `batch_processing`, with up to 2 threads.
     - `*`: execute jobs on any queue, with up to 5 threads (as configured by `--max-threads=5`).
 
     When a pool is performing jobs from multiple queues, jobs will be performed from specified queues, ordered by priority and creation time. To perform jobs from queues in the queues' given order, use the `+` modifier. In this example, jobs in `batch_processing` will be performed only when there are no jobs in `transactional_messages`:
@@ -1370,7 +1370,7 @@ bin/setup
 
 #### Rails development harness
 
-A Rails application exists within `spec/test_app` that is used for development, test, and GoodJob Demo environments.
+A Rails application exists within `demo` that is used for development, test, and GoodJob Demo environments.
 
 ```bash
 # Run a local development webserver

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

@@ -8,6 +8,7 @@
       <div class="row small text-muted text-uppercase align-items-center">
         <div class="col"><%= t ".process" %></div>
         <div class="col"><%= t ".schedulers" %></div>
+        <div class="col-2 d-flex gap-2"><%= t ".cron_enabled" %></div>
         <div class="col-2 d-flex gap-2">
           <span><%= t ".started" %></span>
         </div>
@@ -44,6 +45,7 @@
               <pre class="mb-0"><%= scheduler.is_a?(Hash) ? scheduler['name'] : scheduler %></pre>
             <% end %>
           </div>
+          <div class="col-2 small"><%= t(ActiveModel::Type::Boolean.new.cast(process.state["cron_enabled"]), scope: "good_job.shared.boolean") %></div>
           <div class="col-2 small"><%= relative_time(process.created_at) %></div>
           <div class="col-2 small"><%= relative_time(process.updated_at) %></div>
           <div class="col-auto">

data/config/locales/de.yml

@@ -198,6 +198,7 @@ de:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron aktiviert
         no_good_job_processes_found: Keine GoodJob-Prozesse gefunden.
         process: Verfahren
         schedulers: Planer
@@ -205,6 +206,9 @@ de:
         title: Prozesse
         updated: Aktualisiert
     shared:
+      boolean:
+        'false': Nein
+        'true': Ja
       error: Fehler
       filter:
         all: Alle

data/config/locales/en.yml

@@ -198,6 +198,7 @@ en:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron enabled
         no_good_job_processes_found: No GoodJob processes found.
         process: Process
         schedulers: Schedulers
@@ -205,6 +206,9 @@ en:
         title: Processes
         updated: Updated
     shared:
+      boolean:
+        'false': 'No'
+        'true': 'Yes'
       error: Error
       filter:
         all: All

data/config/locales/es.yml

@@ -196,6 +196,7 @@ es:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron habilitado
         no_good_job_processes_found: No hay procesos de GoodJob.
         process: Proceso
         schedulers: Schedulers
@@ -203,6 +204,9 @@ es:
         title: Procesos
         updated: Actualizado
     shared:
+      boolean:
+        'false': 'No'
+        'true': Sí
       error: Error
       filter:
         all: Todas

data/config/locales/fr.yml

@@ -198,6 +198,7 @@ fr:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron activé
         no_good_job_processes_found: Aucun processus GoodJob trouvé.
         process: Processus
         schedulers: Schedulers
@@ -205,6 +206,9 @@ fr:
         title: Processus
         updated: Mis à jour
     shared:
+      boolean:
+        'false': Non
+        'true': Oui
       error: Erreur
       filter:
         all: Tous

data/config/locales/ja.yml

@@ -198,6 +198,7 @@ ja:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron が有効になっている
         no_good_job_processes_found: GoodJobのプロセスが見つかりませんでした。
         process: プロセス
         schedulers: スケジューラー
@@ -205,6 +206,9 @@ ja:
         title: プロセス
         updated: 更新された
     shared:
+      boolean:
+        'false': いいえ
+        'true': はい
       error: エラー
       filter:
         all: 全て

data/config/locales/nl.yml

@@ -198,6 +198,7 @@ nl:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron ingeschakeld
         no_good_job_processes_found: Geen GoodJob-processen gevonden.
         process: Proces
         schedulers: Planners
@@ -205,6 +206,9 @@ nl:
         title: Processen
         updated: Bijgewerkt
     shared:
+      boolean:
+        'false': Nee
+        'true': Ja
       error: Fout
       filter:
         all: Alle

data/config/locales/ru.yml

@@ -224,6 +224,7 @@ ru:
             unit: ''
     processes:
       index:
+        cron_enabled: Крон включен
         no_good_job_processes_found: Процессы GoodJob не найдены.
         process: Процесс
         schedulers: Планировщики
@@ -231,6 +232,9 @@ ru:
         title: Процессы
         updated: Обновлено
     shared:
+      boolean:
+        'false': Нет
+        'true': Да
       error: Ошибка
       filter:
         all: Все

data/config/locales/tr.yml

@@ -198,6 +198,7 @@ tr:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron etkin
         no_good_job_processes_found: GoodJob süreci bulunamadı.
         process: Süreç
         schedulers: Planlayıcılar
@@ -205,6 +206,9 @@ tr:
         title: Süreçler
         updated: Güncellenmiş
     shared:
+      boolean:
+        'false': Hayır
+        'true': Evet
       error: Hata
       filter:
         all: Tümü

data/config/locales/uk.yml

@@ -224,6 +224,7 @@ uk:
             unit: ''
     processes:
       index:
+        cron_enabled: Cron увімкнено
         no_good_job_processes_found: Процеси GoodJob не знайдені.
         process: Процес
         schedulers: Планувальники
@@ -231,6 +232,9 @@ uk:
         title: Процеси
         updated: Оновлено
     shared:
+      boolean:
+        'false': Ні
+        'true': Так
       error: Помилка
       filter:
         all: Всі

data/lib/good_job/adapter.rb

@@ -168,13 +168,13 @@ module GoodJob
     end
 
     # Shut down the thread pool executors.
-    # @param timeout [nil, Numeric, Symbol] Seconds to wait for active threads.
+    # @param timeout [nil, Numeric, NONE] Seconds to wait for active threads.
     #   * +nil+ trigger a shutdown but not wait for it to complete.
     #   * +-1+ wait until the shutdown is complete.
     #   * +0+ immediately shutdown and stop any threads.
     #   * A positive number will wait that many seconds before stopping any remaining active threads.
     # @return [void]
-    def shutdown(timeout: :default)
+    def shutdown(timeout: NONE)
       @capsule&.shutdown(timeout: timeout)
       @_async_started = false
     end

data/lib/good_job/capsule.rb

@@ -44,23 +44,23 @@ module GoodJob
     end
 
     # Shut down the thread pool executors.
-    # @param timeout [nil, Numeric, Symbol] Seconds to wait for active threads.
+    # @param timeout [nil, Numeric, NONE] Seconds to wait for active threads.
     #   * +-1+ will wait for all active threads to complete.
     #   * +0+ will interrupt active threads.
     #   * +N+ will wait at most N seconds and then interrupt active threads.
     #   * +nil+ will trigger a shutdown but not wait for it to complete.
     # @return [void]
-    def shutdown(timeout: :default)
-      timeout = @configuration.shutdown_timeout if timeout == :default
+    def shutdown(timeout: NONE)
+      timeout = @configuration.shutdown_timeout if timeout == NONE
       GoodJob._shutdown_all([@shared_executor, @notifier, @poller, @scheduler, @cron_manager].compact, timeout: timeout)
       @startable = false
       @running = false
     end
 
     # Shutdown and then start the capsule again.
-    # @param timeout [Numeric, Symbol] Seconds to wait for active threads.
+    # @param timeout [Numeric, NONE] Seconds to wait for active threads.
     # @return [void]
-    def restart(timeout: :default)
+    def restart(timeout: NONE)
       raise ArgumentError, "Capsule#restart cannot be called with a timeout of nil" if timeout.nil?
 
       shutdown(timeout: timeout)

data/lib/good_job/cli.rb

@@ -17,6 +17,9 @@ module GoodJob
     # Requiring this loads the application's configuration and classes.
     RAILS_ENVIRONMENT_RB = File.expand_path("config/environment.rb")
 
+    # Number of seconds between checking shutdown conditions
+    SHUTDOWN_EVENT_TIMEOUT = 10
+
     class << self
       # Whether the CLI is running from the executable
       # @return [Boolean, nil]
@@ -106,14 +109,15 @@ module GoodJob
         probe_server.start
       end
 
-      @stop_good_job_executable = false
+      require 'concurrent/atomic/event'
+      @stop_good_job_executable = Concurrent::Event.new
       %w[INT TERM].each do |signal|
-        trap(signal) { @stop_good_job_executable = true }
+        trap(signal) { Thread.new { @stop_good_job_executable.set }.join }
       end
 
       Kernel.loop do
-        sleep 0.1
-        break if @stop_good_job_executable || capsule.shutdown?
+        @stop_good_job_executable.wait(SHUTDOWN_EVENT_TIMEOUT)
+        break if @stop_good_job_executable.set? || capsule.shutdown?
       end
 
       systemd.stop do

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.20.0'
+  VERSION = '3.21.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -42,6 +42,10 @@ require "good_job/systemd_service"
 module GoodJob
   include GoodJob::Dependencies
 
+  # Default, null, blank value placeholder.
+  NONE = Module.new.freeze
+
+  # Default logger for GoodJob; overridden by Rails.logger in Railtie.
   DEFAULT_LOGGER = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
 
   # @!attribute [rw] active_record_parent_class
@@ -233,13 +237,19 @@ module GoodJob
   # This is primarily intended for usage in a test environment.
   # Unhandled job errors will be raised.
   # @param queue_string [String] Queues to execute jobs from
+  # @param limit [Integer, nil] Maximum number of iterations for the loop
   # @return [void]
-  def self.perform_inline(queue_string = "*")
+  def self.perform_inline(queue_string = "*", limit: nil)
     job_performer = JobPerformer.new(queue_string)
+    iteration = 0
     loop do
+      break if limit && iteration >= limit
+
       result = Rails.application.reloader.wrap { job_performer.next }
       break unless result
       raise result.unhandled_error if result.unhandled_error
+
+      iteration += 1
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 3.21.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob