good_job 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0a8926625f33b36c56def63a1507cfb0f8981a876449e907396aa2338b0b78
-  data.tar.gz: ad45bd8133d5f68bcf190bac3f7656864e10df2e49be477024e9f0c8422ce222
+  metadata.gz: 4e6676f189c0e22c751837d8792b84ece28dfcc118941077abfcdfac7e352c18
+  data.tar.gz: 891e630829ec28fb022d516e50d5d9c61e51dc81531ce3f20c25f2facfee09c6
 SHA512:
-  metadata.gz: 2f2e5c4ac4020dfd7aaed53bfb9b7e7480ca91e0aa7cfcbc385ac60d91a4b08e40397734993ffdffc9d5121f40afab04540d363fef925bf8a30bf987938514ab
-  data.tar.gz: 3460da22048d4fad135e12644c043723b2dcba8137a69a3b5bebf3b5df11e1c1a0ed0f94a8924b64cab4d1ce8b76bd55e6090a25c43f23afde41b27d398cf59a
+  metadata.gz: d443d783208de5f01cd003773943199c618f397a46a1ecb5d7e9167a9eaedc0511f9e4b3cec6122c17cd0be328b490230727024041b7622ad1f9f8afcaf817e1
+  data.tar.gz: fc1171540d6227d0e7757a09904b617791289daeec89c3045251b46e8d82959b9df4b5ecd0b4c812a2804ac7c7626712ebea93d3718984fb08a1592c097db068

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## [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)
+
+**Implemented enhancements:**
+
+- GoodJob.cleanup\_preserved\_jobs: add :include\_discarded option [\#1550](https://github.com/bensheldon/good_job/pull/1550) ([jonleighton](https://github.com/jonleighton))
+
+**Fixed bugs:**
+
+- Fix compatibility with `rails-head` when duplicated advisory lockable column [\#1553](https://github.com/bensheldon/good_job/pull/1553) ([Earlopain](https://github.com/Earlopain))
+
+**Closed issues:**
+
+- `PG::AmbiguousColumn` after upgrade to 4.5.0 [\#1551](https://github.com/bensheldon/good_job/issues/1551)
+
+**Merged pull requests:**
+
+- Remove usage of COALESCE from dashboard chart [\#1306](https://github.com/bensheldon/good_job/pull/1306) ([bananatron](https://github.com/bananatron))
+
 ## [v4.5.0](https://github.com/bensheldon/good_job/tree/v4.5.0) (2024-11-22)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v4.4.2...v4.5.0)

data/app/charts/good_job/performance_index_chart.rb

@@ -5,7 +5,7 @@ module GoodJob
     def data
       table_name = GoodJob::Execution.table_name
 
-      sum_query = Arel.sql(GoodJob::Job.pg_or_jdbc_query(<<~SQL.squish))
+      sum_query = <<~SQL.squish
         SELECT *
         FROM generate_series(
           date_trunc('hour', $1::timestamp),

data/app/charts/good_job/performance_show_chart.rb

@@ -21,7 +21,7 @@ module GoodJob
       table_name = GoodJob::Execution.table_name
 
       interval_entries = BUCKET_INTERVALS.map { "interval '#{_1}'" }.join(",")
-      sum_query = Arel.sql(GoodJob::Job.pg_or_jdbc_query(<<~SQL.squish))
+      sum_query = <<~SQL.squish
         SELECT
           WIDTH_BUCKET(duration, ARRAY[#{interval_entries}]) as bucket_index,
           COUNT(WIDTH_BUCKET(duration, ARRAY[#{interval_entries}])) AS count

data/app/charts/good_job/scheduled_by_queue_chart.rb

@@ -8,9 +8,7 @@ module GoodJob
     end
 
     def data
-      table_name = GoodJob::Job.table_name
-
-      count_query = Arel.sql(GoodJob::Job.pg_or_jdbc_query(<<~SQL.squish))
+      count_query = <<~SQL.squish
         SELECT *
         FROM generate_series(
           date_trunc('hour', $1::timestamp),
@@ -23,7 +21,7 @@ module GoodJob
               queue_name,
               count(*) AS count
             FROM (
-              #{@filter.filtered_query.except(:select, :order).select('queue_name', "COALESCE(#{table_name}.scheduled_at, #{table_name}.created_at)::timestamp AS scheduled_at").to_sql}
+              #{@filter.filtered_query.except(:select, :order).select(:queue_name, :scheduled_at).to_sql}
             ) sources
             GROUP BY date_trunc('hour', scheduled_at), queue_name
         ) sources ON sources.scheduled_at = timestamp

data/app/models/concerns/good_job/advisory_lockable.rb

@@ -41,8 +41,16 @@ module GoodJob
       scope :advisory_lock, (lambda do |column: _advisory_lockable_column, function: advisory_lockable_function, select_limit: nil|
         original_query = self
 
+        primary_key_for_select = primary_key.to_sym
+        column_for_select = column.to_sym
+
         cte_table = Arel::Table.new(:rows)
-        cte_query = original_query.select(primary_key, column).except(:limit)
+        cte_query = original_query.except(:limit)
+        cte_query = if primary_key_for_select == column_for_select
+                      cte_query.select(primary_key_for_select)
+                    else
+                      cte_query.select(primary_key_for_select, column_for_select)
+                    end
         cte_query = cte_query.limit(select_limit) if select_limit
         cte_type = supports_cte_materialization_specifiers? ? :MATERIALIZED : :""
         composed_cte = Arel::Nodes::As.new(cte_table, Arel::Nodes::UnaryOperation.new(cte_type, cte_query.arel))

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.0'
+  VERSION = '4.6.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -203,11 +203,11 @@ module GoodJob
   # If you are preserving job records this way, use this method regularly to
   # destroy old records and preserve space in your database.
   # @param older_than [nil,Numeric,ActiveSupport::Duration] Jobs older than this will be destroyed (default: +86400+).
+  # @param include_discarded [Boolean] Whether or not to destroy discarded jobs (default: per +cleanup_discarded_jobs+ config option)
   # @return [Integer] Number of job execution records and batches that were destroyed.
-  def self.cleanup_preserved_jobs(older_than: nil, in_batches_of: 1_000)
+  def self.cleanup_preserved_jobs(older_than: nil, in_batches_of: 1_000, include_discarded: GoodJob.configuration.cleanup_discarded_jobs?)
     older_than ||= GoodJob.configuration.cleanup_preserved_jobs_before_seconds_ago
     timestamp = Time.current - older_than
-    include_discarded = GoodJob.configuration.cleanup_discarded_jobs?
 
     ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
       deleted_jobs_count = 0

metadata

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