good_job 4.5.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c4f55ae789dad6bc4920527bdb107d7bc4422cbaec192dfc036b01ada67c54c
-  data.tar.gz: 8757dec952a510559eae0f7bf1a3210128b72e21d6ed3d17763507b47c4628e8
+  metadata.gz: 00f71f047b33832b758797f8fb9c7987a13eae1abb1750467dcbbab12c7680b0
+  data.tar.gz: 4a9f501a236f45781904d2468cef99d05cea42ac5d76568d8b72ae437823e3e6
 SHA512:
-  metadata.gz: da3bf2a776ffca2181d2d205250e015bc138bc23a95004a65c703631d195e1891bd9eafc86733017dbc10233fb1b978615dadac4cbcb384ce9823c28f7b5e36f
-  data.tar.gz: a32557214eb62cc0cecb1d17750e83f074de0aef958b771c4846ff7e543432a1e9d474d0f922a241880b21beb07f96e6397bf0445f12286f169d5891cd61496c
+  metadata.gz: 575e7338adaaaa661f4f0d219ddbaac20dff3547f9878098d51ab71a54dce5660467d2f45d492dd6fa79496143f6482e170557a7b8a230e25853297c9811eba6
+  data.tar.gz: 5bdd469825d81387e4071900576ea664e820c98c74f7d6a710d3d39fc5c750af4db0a63fc4d0e0af9faf5481e73f1b6107b3ff88c77a257c9c49d02dda7667f8

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [v4.7.0](https://github.com/bensheldon/good_job/tree/v4.7.0) (2024-12-31)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.6.0...v4.7.0)
+
+**Implemented enhancements:**
+
+- Expose good job labels in dashboard [\#1561](https://github.com/bensheldon/good_job/pull/1561) ([BClark88](https://github.com/BClark88))
+
+**Merged pull requests:**
+
+- Allow cron configuration `class` value to be a proc [\#1566](https://github.com/bensheldon/good_job/pull/1566) ([bensheldon](https://github.com/bensheldon))
+- Add Ruby 3.4 to CI [\#1565](https://github.com/bensheldon/good_job/pull/1565) ([Earlopain](https://github.com/Earlopain))
+
+## [v4.6.0](https://github.com/bensheldon/good_job/tree/v4.6.0) (2024-12-12)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.5.1...v4.6.0)
+
+**Implemented enhancements:**
+
+- Set job execution thread priority to `-3` when in async mode [\#1560](https://github.com/bensheldon/good_job/pull/1560) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Attaching metadata to jobs [\#1558](https://github.com/bensheldon/good_job/issues/1558)
+- Lower Ruby Thread priority for jobs by default when running in Async mode [\#1554](https://github.com/bensheldon/good_job/issues/1554)
+- NoMethodError:  undefined method `\<' for nil \(process.rb:125 in stale?\) [\#1363](https://github.com/bensheldon/good_job/issues/1363)
+- Install PgHero on the Demo app [\#1166](https://github.com/bensheldon/good_job/issues/1166)
+
+**Merged pull requests:**
+
+- Bump rails-html-sanitizer from 1.6.0 to 1.6.1 [\#1557](https://github.com/bensheldon/good_job/pull/1557) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add PGHero to the demo app [\#1294](https://github.com/bensheldon/good_job/pull/1294) ([mec](https://github.com/mec))
+
 ## [v4.5.1](https://github.com/bensheldon/good_job/tree/v4.5.1) (2024-11-29)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v4.5.0...v4.5.1)

data/app/models/good_job/cron_entry.rb

@@ -101,8 +101,12 @@ module GoodJob # :nodoc:
         current_thread.cron_key = key
         current_thread.cron_at = cron_at
 
-        configured_job = job_class.constantize.set(set_value)
         I18n.with_locale(I18n.default_locale) do
+          job_klass = job_class_value
+          job_klass = job_klass.constantize if job_klass.is_a?(String)
+          next unless job_klass.is_a?(Class)
+
+          configured_job = job_klass.set(set_value)
           kwargs_value.present? ? configured_job.perform_later(*args_value, **kwargs_value) : configured_job.perform_later(*args_value)
         end
       end
@@ -118,6 +122,7 @@ module GoodJob # :nodoc:
         set: display_property(set),
         description: display_property(description),
       }.tap do |properties|
+        properties[:class] = display_property(job_class) if job_class.present?
         properties[:args] = display_property(args) if args.present?
         properties[:kwargs] = display_property(kwargs) if kwargs.present?
       end
@@ -160,6 +165,11 @@ module GoodJob # :nodoc:
       @_fugit ||= Fugit.parse(cron)
     end
 
+    def job_class_value
+      value = job_class || nil
+      value.respond_to?(:call) ? value.call : value
+    end
+
     def set_value
       value = set || {}
       value.respond_to?(:call) ? value.call : value

data/app/views/good_job/batches/_jobs.erb

@@ -5,6 +5,7 @@
         <div class="col-4"><%= t("good_job.models.batch.jobs") %></div>
           <div class="d-none d-lg-block col-lg-1 text-lg-center"><%= t "good_job.models.job.queue" %></div>
           <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.priority" %></div>
+          <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.labels" %></div>
           <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.attempts" %></div>
           <div class="col text-end">
             <%= tag.button type: "button", class: "btn btn-sm text-muted", role: "button",
@@ -33,6 +34,12 @@
                 <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.priority" %></div>
                 <span class="font-monospace fw-bold"><%= job.priority %></span>
               </div>
+              <div class="col-4 col-lg-1 text-lg-end">
+                <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.labels" %></div>
+                <% job.labels&.each do |label| %>
+                  <span class="badge rounded-pill bg-secondary font-monospace"><%= label %></span>
+                <% end %>
+              </div>
               <div class="col-4 col-lg-1 text-lg-end">
                 <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.attempts" %></div>
                 <% if job.error %>

data/app/views/good_job/jobs/_table.erb

@@ -35,6 +35,7 @@
           </div>
           <div class="d-none d-lg-block col-lg-1 text-lg-center"><%= t "good_job.models.job.queue" %></div>
           <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.priority" %></div>
+          <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.labels" %></div>
           <div class="d-none d-lg-block col-lg-1 text-lg-end"><%= t "good_job.models.job.attempts" %></div>
           <div class="col text-end">
             <%= tag.button type: "button", class: "btn btn-sm text-muted", role: "button",
@@ -82,6 +83,12 @@
                 <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.priority" %></div>
                 <%= job.priority %>
               </div>
+              <div class="col-4 col-lg-1 text-wrap text-lg-end">
+                <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.labels" %></div>
+                <% job.labels&.each do |label| %>
+                  <span class="badge rounded-pill bg-secondary font-monospace"><%= label %></span>
+                <% end %>
+              </div>
               <div class="col-4 col-lg-1 text-lg-end">
                 <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.job.attempts" %></div>
                 <% if job.error %>

data/config/locales/de.yml

@@ -194,6 +194,7 @@ de:
       job:
         arguments: Argumente
         attempts: Versuche
+        labels: Etiketten
         priority: Priorität
         queue: Warteschlange
     number:

data/config/locales/en.yml

@@ -194,6 +194,7 @@ en:
       job:
         arguments: Arguments
         attempts: Attempts
+        labels: Labels
         priority: Priority
         queue: Queue
     number:

data/config/locales/es.yml

@@ -194,6 +194,7 @@ es:
       job:
         arguments: Argumentos
         attempts: Intentos
+        labels: Etiquetas
         priority: Prioridad
         queue: Cola
     number:

data/config/locales/fr.yml

@@ -194,6 +194,7 @@ fr:
       job:
         arguments: Paramètres
         attempts: Tentatives
+        labels: Étiquettes
         priority: Priorité
         queue: File d'attente
     number:

data/config/locales/it.yml

@@ -194,6 +194,7 @@ it:
       job:
         arguments: Argomenti
         attempts: Tentativi
+        labels: Etichette
         priority: Priorità
         queue: Coda
     number:

data/config/locales/ja.yml

@@ -194,6 +194,7 @@ ja:
       job:
         arguments: 引数
         attempts: 試行回数
+        labels: ラベル
         priority: 優先度
         queue: キュー
     number:

data/config/locales/ko.yml

@@ -194,6 +194,7 @@ ko:
       job:
         arguments: 인수
         attempts: 시도 횟수
+        labels: 레이블
         priority: 우선순위
         queue: 큐
     number:

data/config/locales/nl.yml

@@ -194,6 +194,7 @@ nl:
       job:
         arguments: Argumenten
         attempts: Pogingen
+        labels: Labels
         priority: Prioriteit
         queue: Wachtrij
     number:

data/config/locales/pt-BR.yml

@@ -194,6 +194,7 @@ pt-BR:
       job:
         arguments: Argumentos
         attempts: Tentativas
+        labels: Rótulos
         priority: Prioridade
         queue: Fila
     number:

data/config/locales/ru.yml

@@ -220,6 +220,7 @@ ru:
       job:
         arguments: Параметры
         attempts: Попытки
+        labels: Метки
         priority: Приоритет
         queue: Очередь исполнения
     number:

data/config/locales/tr.yml

@@ -194,6 +194,7 @@ tr:
       job:
         arguments: Argümanlar
         attempts: Denemeler
+        labels: Etiketler
         priority: Öncelik
         queue: Kuyruk
     number:

data/config/locales/uk.yml

@@ -220,6 +220,7 @@ uk:
       job:
         arguments: Аргументи
         attempts: Спроби
+        labels: Мітки
         priority: Пріоритет
         queue: Черга
     number:

data/lib/good_job/adapter.rb

@@ -216,6 +216,7 @@ module GoodJob
       return unless execute_async?
 
       @capsule.start
+      @capsule.lower_thread_priority = true if GoodJob.configuration.lower_thread_priority.in?([true, nil])
       @_async_started = true
     end
 

data/lib/good_job/capsule.rb

@@ -24,6 +24,7 @@ module GoodJob
 
       @shared_executor = GoodJob::SharedExecutor.new
       @tracker = GoodJob::CapsuleTracker.new(executor: @shared_executor)
+      @lower_thread_priority = nil
 
       self.class.instances << self
     end
@@ -38,7 +39,9 @@ module GoodJob
 
         @notifier = GoodJob::Notifier.new(enable_listening: configuration.enable_listen_notify, capsule: self, executor: @shared_executor)
         @poller = GoodJob::Poller.new(poll_interval: configuration.poll_interval)
-        @multi_scheduler = GoodJob::MultiScheduler.from_configuration(configuration, capsule: self, warm_cache_on_initialize: true)
+        @multi_scheduler = GoodJob::MultiScheduler.from_configuration(configuration, capsule: self, warm_cache_on_initialize: true).tap do |multischeduler|
+          multischeduler.lower_thread_priority = @lower_thread_priority unless @lower_thread_priority.nil?
+        end
         @notifier.recipients.push([@multi_scheduler, :create_thread])
         @poller.recipients.push(-> { @multi_scheduler.create_thread({ fanout: true }) })
 
@@ -110,6 +113,11 @@ module GoodJob
       @tracker.process_id
     end
 
+    def lower_thread_priority=(value)
+      @lower_thread_priority = value
+      @multi_scheduler&.lower_thread_priority = value
+    end
+
     private
 
     def configuration

data/lib/good_job/configuration.rb

@@ -383,6 +383,14 @@ module GoodJob
       end || false
     end
 
+    def lower_thread_priority
+      return options[:lower_thread_priority] unless options[:lower_thread_priority].nil?
+      return rails_config[:lower_thread_priority] unless rails_config[:lower_thread_priority].nil?
+      return ActiveModel::Type::Boolean.new.cast(env['GOOD_JOB_LOWER_THREAD_PRIORITY']) unless env['GOOD_JOB_LOWER_THREAD_PRIORITY'].nil?
+
+      nil
+    end
+
     # Whether to take an advisory lock on the process record in the notifier reactor.
     # @return [Boolean]
     def advisory_lock_heartbeat

data/lib/good_job/multi_scheduler.rb

@@ -19,7 +19,8 @@ module GoodJob
           max_cache: configuration.max_cache,
           warm_cache_on_initialize: warm_cache_on_initialize,
           cleanup_interval_seconds: configuration.cleanup_interval_seconds,
-          cleanup_interval_jobs: configuration.cleanup_interval_jobs
+          cleanup_interval_jobs: configuration.cleanup_interval_jobs,
+          lower_thread_priority: configuration.lower_thread_priority
         )
       end
 
@@ -85,6 +86,12 @@ module GoodJob
       end
     end
 
+    def lower_thread_priority=(value)
+      schedulers.each do |scheduler|
+        scheduler.lower_thread_priority = value
+      end
+    end
+
     def stats
       scheduler_stats = schedulers.map(&:stats)
 

data/lib/good_job/scheduler.rb

@@ -29,6 +29,9 @@ module GoodJob # :nodoc:
       fallback_policy: :discard,
     }.freeze
 
+    # In CRuby, this sets the thread quantum to ~12.5ms ( 100ms * 2^(-3) ).
+    LOW_THREAD_PRIORITY = -3
+
     # @!attribute [r] instances
     #   @!scope class
     #   List of all instantiated Schedulers in the current process.
@@ -39,13 +42,18 @@ module GoodJob # :nodoc:
     # @return [String]
     attr_reader :name
 
+    # Whether to lower the thread priority to a fixed value
+    # @return [Boolean]
+    attr_accessor :lower_thread_priority
+
     # @param performer [GoodJob::JobPerformer]
     # @param max_threads [Numeric, nil] number of seconds between polls for jobs
     # @param max_cache [Numeric, nil] maximum number of scheduled jobs to cache in memory
     # @param warm_cache_on_initialize [Boolean] whether to warm the cache immediately, or manually by calling +warm_cache+
     # @param cleanup_interval_seconds [Numeric, nil] number of seconds between cleaning up job records
     # @param cleanup_interval_jobs [Numeric, nil] number of executed jobs between cleaning up job records
-    def initialize(performer, max_threads: nil, max_cache: nil, warm_cache_on_initialize: false, cleanup_interval_seconds: nil, cleanup_interval_jobs: nil)
+    # @param lower_thread_priority [Boolean] whether to lower the thread priority of execution threads
+    def initialize(performer, max_threads: nil, max_cache: nil, warm_cache_on_initialize: false, cleanup_interval_seconds: nil, cleanup_interval_jobs: nil, lower_thread_priority: false)
       raise ArgumentError, "Performer argument must implement #next" unless performer.respond_to?(:next)
 
       @performer = performer
@@ -62,6 +70,8 @@ module GoodJob # :nodoc:
       @cleanup_tracker = CleanupTracker.new(cleanup_interval_seconds: cleanup_interval_seconds, cleanup_interval_jobs: cleanup_interval_jobs)
       @executor_options[:name] = name
 
+      self.lower_thread_priority = lower_thread_priority
+
       create_executor
       warm_cache if warm_cache_on_initialize
       self.class.instances << self
@@ -271,6 +281,7 @@ module GoodJob # :nodoc:
       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
+        Thread.current.priority = -3 if thr_scheduler.lower_thread_priority
 
         Rails.application.reloader.wrap do
           thr_performer.next do |found|

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob