good_job 3.7.4 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fda5fd7d15b1e93616e9dfa44dad4ed89abbad549c5c83d85d3d0fadcb5a3082
-  data.tar.gz: f114b7657cdd5d1845e9314688c0befaa3c1615df6b203fc6d9cd44e894e7071
+  metadata.gz: d5d0c455a8d5d8f18fda38f1f9f126cc406250d188ee313d0352717c829cd126
+  data.tar.gz: 208b61ec3b48a7973b160093100b216eafbb96eee604e5e7edc2e7fb67bedfba
 SHA512:
-  metadata.gz: d1b5bbbc7f8e407a74d65976996f29df1bea1271a327733a5c685804984c7d5e95d696e3ec823995e856e17e7c22f24edbf7c8425d7caf7ec4795f94f5038357
-  data.tar.gz: fad2cc50096beae6594326189defab7eec6527e2b2e297518e5c42f220eea3a6201ce7375864b95085ed0462d019da6829e8d34ee02e6ac042968a8f0096a059
+  metadata.gz: cac4f2c135e6c01cbdd6cd58c591d726ee8fbb66e623e3d1ed8bfb26e85e6b058e45bd60e3d2ba67b3133666df07d972db8eca75aa05df671b8284c01f45398f
+  data.tar.gz: 189ba8af30dc9e5a84c064090d5ede8a8f1da4bb56d2249f6ac4130ce3105c9c498f957ad05cf054f2697f83885570013c3c41ed5d197354c992b08518110656

data/CHANGELOG.md

@@ -1,10 +1,41 @@
 # Changelog
 
+## [v3.8.0](https://github.com/bensheldon/good_job/tree/v3.8.0) (2023-01-27)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.7.4...v3.8.0)
+
+**Implemented enhancements:**
+
+- Capture and log ActiveJob IDs that are interrupted when Scheduler is forced to shutdown [\#794](https://github.com/bensheldon/good_job/pull/794) ([bensheldon](https://github.com/bensheldon))
+
+**Fixed bugs:**
+
+- Ensure Concurrency Keys are string-like and return a better error when they cannot be cast to a string [\#791](https://github.com/bensheldon/good_job/pull/791) ([Earlopain](https://github.com/Earlopain))
+
+**Closed issues:**
+
+- Work is not being picked up at the expected rate [\#802](https://github.com/bensheldon/good_job/issues/802)
+- Cleaning up preserved jobs only removes a subset of the jobs [\#801](https://github.com/bensheldon/good_job/issues/801)
+- Dashboard fails to execute JS on latest Firefox 108 [\#792](https://github.com/bensheldon/good_job/issues/792)
+- Concurrency key doesn't handle Hash: TypeError \(can't cast Hash\) [\#784](https://github.com/bensheldon/good_job/issues/784)
+
+**Merged pull requests:**
+
+- Bump fugit from 1.8.0 to 1.8.1 [\#808](https://github.com/bensheldon/good_job/pull/808) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop-rspec from 2.17.1 to 2.18.1 [\#807](https://github.com/bensheldon/good_job/pull/807) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump globalid from 1.0.0 to 1.0.1 [\#804](https://github.com/bensheldon/good_job/pull/804) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rack from 2.2.4 to 2.2.6.2 [\#803](https://github.com/bensheldon/good_job/pull/803) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump nokogiri from 1.13.10 to 1.14.0 [\#800](https://github.com/bensheldon/good_job/pull/800) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop from 1.42.0 to 1.43.0 [\#799](https://github.com/bensheldon/good_job/pull/799) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop-rspec from 2.16.0 to 2.17.1 [\#798](https://github.com/bensheldon/good_job/pull/798) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add French translation [\#795](https://github.com/bensheldon/good_job/pull/795) ([francois-ferrandis](https://github.com/francois-ferrandis))
+- Bump rubocop-rails from 2.17.3 to 2.17.4 [\#780](https://github.com/bensheldon/good_job/pull/780) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v3.7.4](https://github.com/bensheldon/good_job/tree/v3.7.4) (2023-01-10)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.7.3...v3.7.4)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Update to es-module-shims v1.6.3 and use an inline script entry-point; remove script.js entrypoint; remove sourcemap references [\#793](https://github.com/bensheldon/good_job/pull/793) ([bensheldon](https://github.com/bensheldon))
 

data/app/controllers/good_job/jobs_controller.rb

@@ -80,7 +80,7 @@ module GoodJob
     def destroy
       @job = Job.find(params[:id])
       @job.destroy_job
-      redirect_to jobs_path, notice: "Job has been destroyed" # rubocop:disable Rails/I18nLocaleTexts
+      redirect_to jobs_path, notice: "Job has been destroyed"
     end
 
     private

data/app/models/good_job/execution.rb

@@ -212,6 +212,7 @@ module GoodJob
         break if execution.blank?
         break :unlocked unless execution&.executable?
 
+        yield(execution) if block_given?
         result = execution.perform
       end
       execution&.run_callbacks(:perform_unlocked)

data/app/models/good_job/lockable.rb

@@ -193,6 +193,7 @@ module GoodJob
         binds = [
           ActiveRecord::Relation::QueryAttribute.new('key', key, ActiveRecord::Type::String.new),
         ]
+
         locked = connection.exec_query(pg_or_jdbc_query(query), 'GoodJob::Lockable Advisory Lock', binds).first['locked']
         return locked unless block_given?
         return nil unless locked

data/config/locales/fr.yml

@@ -0,0 +1,83 @@
+---
+fr:
+  datetime:
+    distance_in_words:
+      about_x_hours:
+        one: environ 1 heure
+        other: environ %{count} heures
+      about_x_months:
+        one: environ 1 heure
+        other: environ %{count} heures
+      about_x_years:
+        one: environ 1 an
+        other: environ %{count} ans
+      almost_x_years:
+        one: presque 1 an
+        other: presque %{count} ans
+      half_a_minute: une demi-minute
+      less_than_x_minutes:
+        one: moins d'une minute
+        other: moins de %{count} minutes
+      less_than_x_seconds:
+        one: moins d'une seconde
+        other: moins de %{count} secondes
+      over_x_years:
+        one: plus d'un an
+        other: plus de %{count} ans
+      x_days:
+        one: 1 jour
+        other: "%{count} jours"
+      x_minutes:
+        one: 1 minute
+        other: "%{count} minutes"
+      x_months:
+        one: 1 mois
+        other: "%{count} mois"
+      x_seconds:
+        one: 1 seconde
+        other: "%{count} secondes"
+      x_years:
+        one: 1 an
+        other: "%{count} ans"
+  duration:
+    hours: "%{hour}h %{min}m"
+    less_than_10_seconds: "%{sec}s"
+    milliseconds: "%{ms}ms"
+    minutes: "%{min}m %{sec}s"
+    seconds: "%{sec}s"
+  good_job:
+    shared:
+      footer:
+        last_update_html: Dernière mise à jour <time id="page-updated-at" datetime="%{time}">%{time}</time>
+        wording: N'oublie pas, toi aussi tu fais du bon boulot !
+      navbar:
+        cron_schedules: Cron
+        jobs: Jobs
+        live_poll: En direct
+        name: "GoodJob 👍"
+        processes: Processus
+    status:
+      discarded: Abandonnés
+      queued: À la file
+      retried: Réessayés
+      running: En cours
+      scheduled: Programmés
+      succeeded: Réussis
+  number:
+    format:
+      delimiter: " "
+      separator: ","
+    human:
+      decimal_units:
+        format: "%n%u"
+        units:
+          billion: B
+          million: M
+          quadrillion: q
+          thousand: k
+          trillion: T
+          unit: ''
+      format:
+        delimiter: " "
+        precision: 3
+        separator: ","

data/lib/good_job/active_job_extensions/concurrency.rb

@@ -4,6 +4,8 @@ module GoodJob
     module Concurrency
       extend ActiveSupport::Concern
 
+      VALID_TYPES = [String, Symbol, Numeric, Date, Time, TrueClass, FalseClass, NilClass].freeze
+
       class ConcurrencyExceededError < StandardError
         def backtrace
           [] # suppress backtrace
@@ -30,6 +32,11 @@ module GoodJob
           # Always allow jobs to be retried because the current job's execution will complete momentarily
           next(block.call) if CurrentThread.active_job_id == job.job_id
 
+          # Only generate the concurrency key on the initial enqueue in case it is dynamic
+          job.good_job_concurrency_key ||= job._good_job_concurrency_key
+          key = job.good_job_concurrency_key
+          next(block.call) if key.blank?
+
           enqueue_limit = job.class.good_job_concurrency_config[:enqueue_limit]
           enqueue_limit = instance_exec(&enqueue_limit) if enqueue_limit.respond_to?(:call)
           enqueue_limit = nil unless enqueue_limit.present? && (0...Float::INFINITY).cover?(enqueue_limit)
@@ -43,11 +50,6 @@ module GoodJob
           limit = enqueue_limit || total_limit
           next(block.call) unless limit
 
-          # Only generate the concurrency key on the initial enqueue in case it is dynamic
-          job.good_job_concurrency_key ||= job._good_job_concurrency_key
-          key = job.good_job_concurrency_key
-          next(block.call) if key.blank?
-
           GoodJob::Execution.advisory_lock_key(key, function: "pg_advisory_lock") do
             enqueue_concurrency = if enqueue_limit
                                     GoodJob::Execution.where(concurrency_key: key).unfinished.advisory_unlocked.count
@@ -117,11 +119,10 @@ module GoodJob
         key = self.class.good_job_concurrency_config[:key]
         return if key.blank?
 
-        if key.respond_to? :call
-          instance_exec(&key)
-        else
-          key
-        end
+        key = key.respond_to?(:call) ? instance_exec(&key) : key
+        raise TypeError, "Concurrency key must be a String; was a #{key.class}" unless VALID_TYPES.any? { |type| key.is_a?(type) }
+
+        key
       end
     end
   end

data/lib/good_job/job_performer.rb

@@ -10,6 +10,8 @@ module GoodJob
   # The JobPerformer must be safe to execute across multiple threads.
   #
   class JobPerformer
+    cattr_accessor :performing_active_job_ids, default: Concurrent::Set.new
+
     # @param queue_string [String] Queues to execute jobs from
     def initialize(queue_string)
       @queue_string = queue_string
@@ -24,7 +26,13 @@ module GoodJob
     # Perform the next eligible job
     # @return [Object, nil] Returns job result or +nil+ if no job was found
     def next
-      job_query.perform_with_advisory_lock(parsed_queues: parsed_queues, queue_select_limit: GoodJob.configuration.queue_select_limit)
+      active_job_id = nil
+      job_query.perform_with_advisory_lock(parsed_queues: parsed_queues, queue_select_limit: GoodJob.configuration.queue_select_limit) do |execution|
+        active_job_id = execution.active_job_id
+        performing_active_job_ids << active_job_id
+      end
+    ensure
+      performing_active_job_ids.delete(active_job_id)
     end
 
     # Tests whether this performer should be used in GoodJob's current state.

data/lib/good_job/log_subscriber.rb

@@ -85,6 +85,19 @@ module GoodJob
       end
     end
 
+    def scheduler_shutdown_kill(event)
+      process_id = event.payload[:process_id]
+
+      warn(tags: [process_id]) do
+        active_job_ids = event.payload.fetch(:active_job_ids, [])
+        if active_job_ids.any?
+          "GoodJob scheduler has been killed. The following Active Jobs were interrupted: #{active_job_ids.join(' ')}"
+        else
+          "GoodJob scheduler has been killed."
+        end
+      end
+    end
+
     # @!macro notification_responder
     def scheduler_restart_pools(event)
       process_id = event.payload[:process_id]

data/lib/good_job/scheduler.rb

@@ -121,7 +121,11 @@ module GoodJob # :nodoc:
 
         if executor.shuttingdown? && timeout
           executor_wait = timeout.negative? ? nil : timeout
-          executor.kill unless 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
         end
       end
     end

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.7.4
+  version: 3.8.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -392,6 +392,7 @@ files:
 - app/views/layouts/good_job/application.html.erb
 - config/locales/en.yml
 - config/locales/es.yml
+- config/locales/fr.yml
 - config/locales/nl.yml
 - config/locales/ru.yml
 - config/locales/ua.yml