good_job 3.25.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f288c089d005a2b97e5fe6d7bd8fb7094d48fb52565bacf0493b5e547f6516
-  data.tar.gz: cf8cd69a7a1f64fee5172b7fd3b184d774eed0cd48d97ba0d01971af0d721646
+  metadata.gz: a51ff44544ae7fb381fce50f13d3196d6a561bcdc6a5af7f37ad1e8fb0d6b258
+  data.tar.gz: 3703fe631d3f549bb152999203e5d67ac6d305c4ac77bba5b47621f3419cef21
 SHA512:
-  metadata.gz: 3c74189b7315da1fcb5747b285cb4d7837550dcf1456899f2d6f023065a893bd99c93a7e292415b6796a64232335a732666a7783fc04f2319968fff4bfaf7dcc
-  data.tar.gz: 67fd833bfa126355ef0853263c7e72b5bfa5d013e1061bc128480408a52b49eddf9724686e3dc47293f8713696074f8029452c035159aee50940f0b320ff36ab
+  metadata.gz: ba6647af970ee04455977ccdfb835ac03648bc544ae3606e69e2007d04bf13634f0767c1263738d04101a6839949affd3227a19b1b573d27a6cb8bb4ea56a5b6
+  data.tar.gz: 3c8e79ae13f69d050f35aea95ebaf4c035a97138a89d24c57430776909d44c9fbbd9a5ab4460ca30efd65c2c16ec231780957c555f43a77dc100388dbfffb341

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [v3.26.0](https://github.com/bensheldon/good_job/tree/v3.26.0) (2024-03-01)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.25.0...v3.26.0)
+
+**Implemented enhancements:**
+
+- Add `GoodJob.current_thread_running?` and `GoodJob.current_thread_shutting_down?` for graceful shutdowns [\#1253](https://github.com/bensheldon/good_job/pull/1253) ([bensheldon](https://github.com/bensheldon))
+
+**Fixed bugs:**
+
+- Ensure "shutdown?" behavior is consistent between J Ruby and C Ruby [\#1267](https://github.com/bensheldon/good_job/pull/1267) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- PG Good Job rows add up [\#1262](https://github.com/bensheldon/good_job/issues/1262)
+- Bulk operations do not work for Batches [\#1255](https://github.com/bensheldon/good_job/issues/1255)
+- What's the difference between 'reschedule' and 'retry' in the dashboard? [\#1241](https://github.com/bensheldon/good_job/issues/1241)
+
+**Merged pull requests:**
+
+- feat: add italian locale [\#1268](https://github.com/bensheldon/good_job/pull/1268) ([metalelf0](https://github.com/metalelf0))
+
 ## [v3.25.0](https://github.com/bensheldon/good_job/tree/v3.25.0) (2024-02-22)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.24.0...v3.25.0)

data/README.md

@@ -57,7 +57,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
         - [Exceptions](#exceptions)
         - [Retries](#retries)
         - [Action Mailer retries](#action-mailer-retries)
-        - [Interrupts](#interrupts)
+        - [Interrupts, graceful shutdown, and SIGKILL](#Interrupts-graceful-shutdown-and-SIGKILL)
     - [Timeouts](#timeouts)
     - [Optimize queues, threads, and processes](#optimize-queues-threads-and-processes)
     - [Database connections](#database-connections)
@@ -974,9 +974,24 @@ end
 Note, that `ActionMailer::MailDeliveryJob` is a default since Rails 6.0. Be sure that your app is using that class, as it
 might also be configured to use (deprecated now) `ActionMailer::DeliveryJob`.
 
-### Interrupts
+### Interrupts, graceful shutdown, and SIGKILL
 
-Jobs will be automatically retried if the process is interrupted while performing a job, for example as the result of a `SIGKILL` or power failure.
+When GoodJob receives an interrupt (SIGINT, SIGTERM) or explicitly with `GoodJob.shutdown`, GoodJob will attempt to gracefully shut down, waiting for all jobs to finish before exiting based on the `shutdown_timeout` configuration.
+
+To detect the start of a graceful shutdown from within a performing job, for example while looping/iterating over multiple items, you can call `GoodJob.current_thread_shutting_down?` or `GoodJob.current_thread_running?` from within the job. For example:
+
+```ruby
+def perform(lots_of_records)
+  lots_of_records.each do |record|
+    break if GoodJob.current_thread_shutting_down? # or `unless GoodJob.current_thread.running?`
+    # process record ...
+  end
+end
+````
+
+Note that when running jobs in `:inline` execution mode, `GoodJob.current_thread_running?` will always be truthy and `GoodJob.current_thread_shutting_down?` will always be falsey.
+
+Jobs will be automatically retried if the process is interrupted while performing a job and the job is unable to finish before the timeout or as the result of a `SIGKILL` or power failure.
 
 If you need more control over interrupt-caused retries, include the `GoodJob::ActiveJobExtensions::InterruptErrors` extension in your job class. When an interrupted job is retried, the extension will raise a `GoodJob::InterruptError` exception within the job, which allows you to use Active Job's `retry_on` and `discard_on` to control the behavior of the job.
 

data/config/locales/it.yml

@@ -0,0 +1,243 @@
+---
+it:
+  good_job:
+    actions:
+      destroy: Elimina
+      discard: Scarta
+      force_discard: Forza scarto
+      inspect: Ispeziona
+      reschedule: Riprogramma
+      retry: Riprova
+    batches:
+      index:
+        older_batches: Batch più vecchi
+        pending_migrations: GoodJob ha migrazioni del database in sospeso.
+        title: Batch
+      jobs:
+        actions:
+          confirm_destroy: Sei sicuro di voler eliminare questo job?
+          confirm_discard: Sei sicuro di voler scartare questo job?
+          confirm_reschedule: Sei sicuro di voler riprogrammare questo job?
+          confirm_retry: Sei sicuro di voler riprovare questo job?
+          destroy: Elimina job
+          discard: Scarta job
+          reschedule: Riprogramma job
+          retry: Riprova job
+          title: Azioni
+        no_jobs_found: Nessun job trovato.
+      show:
+        attributes: Attributi
+        batched_jobs: Job raggruppati
+        callback_jobs: Job di callback
+      table:
+        no_batches_found: Nessun batch trovato.
+    cron_entries:
+      actions:
+        confirm_disable: Sei sicuro di voler disabilitare questa voce cron?
+        confirm_enable: Sei sicuro di voler confermare questa voce cron?
+        confirm_enqueue: Sei sicuro di voler mettere in coda questa voce cron?
+        disable: Disabilita voce cron
+        enable: Abilita voce cron
+        enqueue: Metti in coda voce cron ora
+      disable:
+        notice: Voce cron è stata disabilitata.
+      enable:
+        notice: Voce cron è stata abilitata.
+      enqueue:
+        notice: Voce cron è stata messa in coda.
+      index:
+        no_cron_schedules_found: Nessuna pianificazione cron trovata.
+        title: Pianificazioni cron
+      pending_migrations: Richiede migrazione del database GoodJob in sospeso.
+      show:
+        cron_entry_key: Chiave voce cron
+    datetime:
+      distance_in_words:
+        about_x_hours:
+          one: circa 1 ora
+          other: circa %{count} ore
+        about_x_months:
+          one: circa 1 mese
+          other: circa %{count} mesi
+        about_x_years:
+          one: circa 1 anno
+          other: circa %{count} anni
+        almost_x_years:
+          one: quasi 1 anno
+          other: quasi %{count} anni
+        half_a_minute: mezzo minuto
+        less_than_x_minutes:
+          one: meno di un minuto
+          other: meno di %{count} minuti
+        less_than_x_seconds:
+          one: meno di 1 secondo
+          other: meno di %{count} secondi
+        over_x_years:
+          one: più di 1 anno
+          other: più di %{count} anni
+        x_days:
+          one: 1 giorno
+          other: "%{count} giorni"
+        x_minutes:
+          one: 1 minuto
+          other: "%{count} minuti"
+        x_months:
+          one: 1 mese
+          other: "%{count} mesi"
+        x_seconds:
+          one: 1 secondo
+          other: "%{count} secondi"
+        x_years:
+          one: 1 anno
+          other: "%{count} anni"
+    duration:
+      hours: "%{hour}h %{min}m"
+      less_than_10_seconds: "%{sec}s"
+      milliseconds: "%{ms}ms"
+      minutes: "%{min}m %{sec}s"
+      seconds: "%{sec}s"
+    error_event:
+      discarded: Scartato
+      handled: Gestito
+      interrupted: Interrotto
+      retried: Riprovato
+      retry_stopped: Interrotto riprova
+      unhandled: Non gestito
+    helpers:
+      relative_time:
+        future: tra %{time}
+        past: "%{time} fa"
+    jobs:
+      actions:
+        confirm_destroy: Sei sicuro di voler eliminare il job?
+        confirm_discard: Sei sicuro di voler scartare il job?
+        confirm_force_discard: 'Sei sicuro di voler forzare lo scarto di questo job? Il job verrà contrassegnato come scartato ma il job in esecuzione non verrà interrotto - tuttavia, non verrà riprovato in caso di fallimento.
+
+          '
+        confirm_reschedule: Sei sicuro di voler riprogrammare il job?
+        confirm_retry: Sei sicuro di voler riprovare il job?
+        destroy: Elimina job
+        discard: Scarta job
+        force_discard: Forza scarto job
+        reschedule: Riprogramma job
+        retry: Riprova job
+      destroy:
+        notice: Il job è stato eliminato
+      discard:
+        notice: Il job è stato scartato
+      executions:
+        in_queue: in coda
+        runtime: tempo di esecuzione
+        title: Esecuzioni
+      force_discard:
+        notice: Il job è stato forzatamente scartato. Continuerà ad eseguirsi ma non verrà riprovato in caso di fallimento
+      index:
+        job_pagination: Paginazione job
+        older_jobs: Job più vecchi
+      reschedule:
+        notice: Il job è stato riprogrammato
+      retry:
+        notice: Il job è stato riprovato
+      show:
+        jobs: Job
+      table:
+        actions:
+          apply_to_all:
+            one: Applica al job (1).
+            other: Applica a tutti %{count} i job.
+          confirm_destroy_all: Sei sicuro di voler eliminare i job selezionati?
+          confirm_discard_all: Sei sicuro di voler scartare i job selezionati?
+          confirm_reschedule_all: Sei sicuro di voler riprogrammare i job selezionati?
+          confirm_retry_all: Sei sicuro di voler riprovare i job selezionati?
+          destroy_all: Elimina tutti
+          discard_all: Scarta tutti
+          reschedule_all: Riprogramma tutti
+          retry_all: Riprova tutti
+          title: Azioni
+        no_jobs_found: Nessun job trovato.
+        toggle_actions: Attiva/Disattiva Azioni
+        toggle_all_jobs: Attiva/Disattiva tutti i job
+    models:
+      batch:
+        created: Creato
+        created_at: Creato il
+        discarded: Scartato
+        discarded_at: Scartato il
+        enqueued: In coda
+        enqueued_at: In coda il
+        finished: Finito
+        finished_at: Finito il
+        jobs: Job
+        name: Nome
+      cron:
+        class: Classe
+        last_run: Ultima esecuzione
+        next_scheduled: Prossima pianificazione
+        schedule: Pianificazione
+      job:
+        arguments: Argomenti
+        attempts: Tentativi
+        priority: Priorità
+        queue: Coda
+    number:
+      format:
+        delimiter: ","
+        separator: "."
+      human:
+        decimal_units:
+          delimiter: ","
+          format: "%n%u"
+          precision: 3
+          separator: "."
+          units:
+            billion: B
+            million: M
+            quadrillion: Q
+            thousand: K
+            trillion: T
+            unit: ''
+    processes:
+      index:
+        cron_enabled: Cron abilitato
+        no_good_job_processes_found: Nessun processo GoodJob trovato.
+        process: Processo
+        schedulers: Schedulers
+        started: Avviato
+        title: Processi
+        updated: Aggiornato
+    shared:
+      boolean:
+        'false': 'No'
+        'true': Sì
+      error: Errore
+      filter:
+        all: Tutti
+        all_jobs: Tutti i job
+        all_queues: Tutte le code
+        clear: Cancella
+        job_name: Nome job
+        placeholder: Cerca per classe, ID job, parametri job e testo errore.
+        queue_name: Nome coda
+        search: Cerca
+      navbar:
+        batches: Batch
+        cron_schedules: Cron
+        jobs: Job
+        live_poll: Live Poll
+        name: "GoodJob 👍"
+        processes: Processi
+        theme:
+          auto: Auto
+          dark: Scuro
+          light: Chiaro
+          theme: Tema
+      secondary_navbar:
+        inspiration: Ricorda, stai facendo anche tu un Buon Lavoro!
+        last_updated: Ultimo aggiornamento
+    status:
+      discarded: Scartato
+      queued: In coda
+      retried: Riprovato
+      running: In esecuzione
+      scheduled: Pianificato
+      succeeded: Riuscito

data/lib/good_job/current_thread.rb

@@ -78,7 +78,7 @@ module GoodJob
     # @return [void]
     def self.reset(values = {})
       ACCESSORS.each do |accessor|
-        send("#{accessor}=", values[accessor])
+        send(:"#{accessor}=", values[accessor])
       end
     end
 

data/lib/good_job/notifier.rb

@@ -93,7 +93,7 @@ module GoodJob # :nodoc:
       if timeout.nil?
         @connected.set?
       else
-        @connected.wait(timeout == -1 ? nil : timeout)
+        @connected.wait(timeout&.negative? ? nil : timeout)
       end
     end
 
@@ -104,7 +104,7 @@ module GoodJob # :nodoc:
       if timeout.nil?
         @listening.set?
       else
-        @listening.wait(timeout == -1 ? nil : timeout)
+        @listening.wait(timeout&.negative? ? nil : timeout)
       end
     end
 
@@ -130,7 +130,7 @@ module GoodJob # :nodoc:
           @listening.reset
           @shutdown_event.set
         else
-          @shutdown_event.wait(timeout == -1 ? nil : timeout) unless timeout.nil?
+          @shutdown_event.wait(timeout&.negative? ? nil : timeout) unless timeout.nil?
           @connected.reset if @shutdown_event.set?
         end
         @shutdown_event.set?

data/lib/good_job/scheduler.rb

@@ -71,9 +71,11 @@ module GoodJob # :nodoc:
     # @return [Boolean, nil]
     delegate :running?, to: :executor, allow_nil: true
 
-    # Tests whether the scheduler is shutdown.
+    # Tests whether the scheduler is shutdown and no tasks are running.
     # @return [Boolean, nil]
-    delegate :shutdown?, to: :executor, allow_nil: true
+    def shutdown?
+      @executor.nil? || (executor.shutdown? && !executor.shuttingdown?)
+    end
 
     # Shut down the scheduler.
     # This stops all threads in the thread pool.
@@ -85,7 +87,7 @@ module GoodJob # :nodoc:
     #   * A positive number will wait that many seconds before stopping any remaining active tasks.
     # @return [void]
     def shutdown(timeout: -1)
-      return if executor.nil? || executor.shutdown?
+      return if executor.nil? || (executor.shutdown? && !executor.shuttingdown?)
 
       instrument("scheduler_shutdown_start", { timeout: timeout })
       instrument("scheduler_shutdown", { timeout: timeout }) do
@@ -96,11 +98,11 @@ module GoodJob # :nodoc:
 
         if executor.shuttingdown? && timeout
           executor_wait = timeout.negative? ? nil : timeout
+          return if executor.wait_for_termination(executor_wait)
 
-          unless executor.wait_for_termination(executor_wait)
-            instrument("scheduler_shutdown_kill", { active_job_ids: @performer.performing_active_job_ids.to_a })
-            executor.kill
-          end
+          instrument("scheduler_shutdown_kill", { active_job_ids: @performer.performing_active_job_ids.to_a })
+          executor.kill
+          executor.wait_for_termination
         end
       end
     end
@@ -268,6 +270,8 @@ module GoodJob # :nodoc:
     def create_task(delay = 0, fanout: false)
       future = Concurrent::ScheduledTask.new(delay, args: [self, performer], executor: executor, timer_set: timer_set) do |thr_scheduler, thr_performer|
         Thread.current.name = Thread.current.name.sub("-worker-", "-thread-") if Thread.current.name
+        Thread.current[:good_job_scheduler] = thr_scheduler
+
         Rails.application.reloader.wrap do
           thr_performer.next do |found|
             thr_scheduler.create_thread({ fanout: fanout }) if found && fanout

data/lib/good_job/shared_executor.rb

@@ -21,12 +21,10 @@ module GoodJob
       @executor&.running?
     end
 
+    # Tests whether the scheduler is shutdown and no tasks are running.
+    # @return [Boolean, nil]
     def shutdown?
-      if @executor
-        @executor.shutdown?
-      else
-        true
-      end
+      @executor.nil? || (@executor.shutdown? && !@executor.shuttingdown?)
     end
 
     # Shut down the SharedExecutor.
@@ -38,13 +36,16 @@ module GoodJob
     #   * A positive number will wait that many seconds before stopping any remaining active threads.
     # @return [void]
     def shutdown(timeout: -1)
-      return if @executor.nil? || @executor.shutdown?
+      return if @executor.nil? || (@executor.shutdown? && !@executor.shuttingdown?)
 
       @executor.shutdown if @executor.running?
 
       if @executor.shuttingdown? && timeout # rubocop:disable Style/GuardClause
         executor_wait = timeout.negative? ? nil : timeout
-        @executor.kill unless @executor.wait_for_termination(executor_wait)
+        return if @executor.wait_for_termination(executor_wait)
+
+        @executor.kill
+        @executor.wait_for_termination
       end
     end
 

data/lib/good_job/thread_status.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GoodJob
+  # Provides methods for determining the status of the
+  # current job execution thread. This is useful for determining
+  # whether to continue processing a job or to shut down gracefully.
+  module ThreadStatus
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Whether the current job execution thread is in a running state.
+      # @return [Boolean]
+      def current_thread_running?
+        scheduler = Thread.current[:good_job_scheduler]
+        scheduler ? scheduler.running? : true
+      end
+
+      # Whether the current job execution thread is shutting down
+      # (the opposite of running).
+      # @return [Boolean]
+      def current_thread_shutting_down?
+        scheduler = Thread.current[:good_job_scheduler]
+        scheduler && !scheduler.running?
+      end
+    end
+  end
+end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -40,12 +40,14 @@ require "good_job/probe_server/webrick_handler"
 require "good_job/scheduler"
 require "good_job/shared_executor"
 require "good_job/systemd_service"
+require "good_job/thread_status"
 
 # GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 #
 # +GoodJob+ is the top-level namespace and exposes configuration attributes.
 module GoodJob
   include GoodJob::Dependencies
+  include GoodJob::ThreadStatus
 
   # Default, null, blank value placeholder.
   NONE = Module.new.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.25.0
+  version: 3.26.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -347,6 +347,7 @@ files:
 - config/locales/en.yml
 - config/locales/es.yml
 - config/locales/fr.yml
+- config/locales/it.yml
 - config/locales/ja.yml
 - config/locales/ko.yml
 - config/locales/nl.yml
@@ -407,6 +408,7 @@ files:
 - lib/good_job/sd_notify.rb
 - lib/good_job/shared_executor.rb
 - lib/good_job/systemd_service.rb
+- lib/good_job/thread_status.rb
 - lib/good_job/version.rb
 homepage: https://github.com/bensheldon/good_job
 licenses: