good_job 3.13.0 → 3.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c83cf253d12daeb00363fe9c1b3a06b463c6944aa108aa4f884bf43b0d1f5c88
-  data.tar.gz: 71738f01485fb73b1dfa71396807f4570922d53aa186bf7aa1f9c27b21e4e559
+  metadata.gz: 4d3457088e2e7120f5660f8c1395adb27887a0aad22d7b2ec816060f7619ebec
+  data.tar.gz: a6978f42d4a988b202c891633a8390dd585edbc07cf11f35511aaca005ce67e5
 SHA512:
-  metadata.gz: 25bbd078a94d5079b47d57c267ad72f7e6baa024230add7fd9c693c621eb8be7117aa517f715baba5b16cb5f0378eb0e407a41ea1569e923a16716ef0f4d391b
-  data.tar.gz: cf58cbaea01a1dd6714b53c6d618661908ccf46ef3deae58b3e2d6063f512e528d0d4f04850e7a3c4a1ccc59ece959a0919d19898488116898f78b9c78c7a5f6
+  metadata.gz: b5226e5cf17704c8cf1eaa0401fd3bc384d892bb02d6538653bde412b9f627537ba333816e589a05089f590df0d602ab163e57f2cdd4452e5ba539a9c57b7ff3
+  data.tar.gz: 49529f8c59b0a62cf6fe0f91b848ef01979c6e245b23e71cc2be3939c3497a6edfe92cb66c6171722e6473ba1d2d759a427855665a6419344ad0dbff69c73783

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [v3.14.1](https://github.com/bensheldon/good_job/tree/v3.14.1) (2023-03-14)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.14.0...v3.14.1)
+
+**Merged pull requests:**
+
+- Allow joining executions to jobs scoped by state [\#886](https://github.com/bensheldon/good_job/pull/886) ([segiddins](https://github.com/segiddins))
+- Add execution\_result to event payload for perform\_job.good\_job [\#885](https://github.com/bensheldon/good_job/pull/885) ([segiddins](https://github.com/segiddins))
+- Bump rack from 2.2.6.2 to 2.2.6.3 [\#884](https://github.com/bensheldon/good_job/pull/884) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v3.14.0](https://github.com/bensheldon/good_job/tree/v3.14.0) (2023-03-09)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.13.0...v3.14.0)
+
+**Implemented enhancements:**
+
+- Deprecate definition of job priority, change to "smaller number is higher priority" to align with Active Job definition [\#883](https://github.com/bensheldon/good_job/pull/883) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.13.0](https://github.com/bensheldon/good_job/tree/v3.13.0) (2023-03-08)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.12.8...v3.13.0)

data/app/models/good_job/execution.rb

@@ -108,7 +108,13 @@ module GoodJob
     # @!method priority_ordered
     # @!scope class
     # @return [ActiveRecord::Relation]
-    scope :priority_ordered, -> { order('priority DESC NULLS LAST') }
+    scope :priority_ordered, (lambda do
+      if GoodJob.configuration.smaller_number_is_higher_priority
+        order('priority ASC NULLS LAST')
+      else
+        order('priority DESC NULLS LAST')
+      end
+    end)
 
     # Order executions by created_at, for first-in first-out
     # @!method creation_ordered
@@ -206,6 +212,14 @@ module GoodJob
 
     # Construct a GoodJob::Execution from an ActiveJob instance.
     def self.build_for_enqueue(active_job, overrides = {})
+      if active_job.priority && GoodJob.configuration.smaller_number_is_higher_priority.nil?
+        ActiveSupport::Deprecation.warn(<<~DEPRECATION)
+          The next major version of GoodJob (v4.0) will change job `priority` to give smaller numbers higher priority (default: `0`), in accordance with Active Job's definition of priority.
+            To opt-in to this behavior now, set `config.good_job.smaller_number_is_higher_priority = true` in your GoodJob initializer or application.rb.
+            To not opt-in yet, but silence this deprecation warning, set `config.good_job.smaller_number_is_higher_priority = false`.
+        DEPRECATION
+      end
+
       execution_args = {
         active_job_id: active_job.job_id,
         queue_name: active_job.queue_name.presence || DEFAULT_QUEUE_NAME,
@@ -322,7 +336,7 @@ module GoodJob
           current_thread.execution_interrupted = performed_at if performed_at
           update!(performed_at: Time.current)
 
-          ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
+          ActiveSupport::Notifications.instrument("perform_job.good_job", { execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do |instrument_payload|
             value = ActiveJob::Base.execute(active_job_data)
 
             if value.is_a?(Exception)
@@ -331,8 +345,14 @@ module GoodJob
             end
             handled_error ||= current_thread.error_on_retry || current_thread.error_on_discard
 
+            instrument_payload.merge!(
+              value: value,
+              handled_error: handled_error,
+              retried: current_thread.error_on_retry.present?
+            )
             ExecutionResult.new(value: value, handled_error: handled_error, retried: current_thread.error_on_retry.present?)
           rescue StandardError => e
+            instrument_payload[:unhandled_error] = e
             ExecutionResult.new(value: nil, unhandled_error: e)
           end
         end

data/app/models/good_job/job.rb

@@ -23,6 +23,26 @@ module GoodJob
       def table_name=(_value)
         raise NotImplementedError, 'Assign GoodJob::Execution.table_name directly'
       end
+
+      def json_string(json, attr)
+        Arel::Nodes::Grouping.new(Arel::Nodes::InfixOperation.new('->>', json, Arel::Nodes.build_quoted(attr)))
+      end
+
+      def params_job_class
+        json_string(arel_table['serialized_params'], 'job_class')
+      end
+
+      def params_execution_count
+        Arel::Nodes::InfixOperation.new(
+          '::',
+          json_string(arel_table['serialized_params'], 'executions'),
+          Arel.sql('integer')
+        )
+      end
+
+      def coalesce_scheduled_at_created_at
+        arel_table.coalesce(arel_table['scheduled_at'], arel_table['created_at'])
+      end
     end
 
     self.primary_key = 'active_job_id'
@@ -39,7 +59,7 @@ module GoodJob
     # @!scope class
     # @param string [String] Execution class name
     # @return [ActiveRecord::Relation]
-    scope :job_class, ->(job_class) { where("serialized_params->>'job_class' = ?", job_class) }
+    scope :job_class, ->(name) { where(params_job_class.eq(name)) }
 
     # Get Jobs finished before the given timestamp.
     # @!method finished_before(timestamp)
@@ -49,11 +69,11 @@ module GoodJob
     scope :finished_before, ->(timestamp) { where(arel_table['finished_at'].lteq(timestamp)) }
 
     # First execution will run in the future
-    scope :scheduled, -> { where(finished_at: nil).where('COALESCE(scheduled_at, created_at) > ?', DateTime.current).where("(serialized_params->>'executions')::integer < 2") }
+    scope :scheduled, -> { where(finished_at: nil).where(coalesce_scheduled_at_created_at.gt(DateTime.current)).where(params_execution_count.lt(2)) }
     # Execution errored, will run in the future
-    scope :retried, -> { where(finished_at: nil).where('COALESCE(scheduled_at, created_at) > ?', DateTime.current).where("(serialized_params->>'executions')::integer > 1") }
+    scope :retried, -> { where(finished_at: nil).where(coalesce_scheduled_at_created_at.gt(DateTime.current)).where(params_execution_count.gt(1)) }
     # Immediate/Scheduled time to run has passed, waiting for an available thread run
-    scope :queued, -> { where(finished_at: nil).where('COALESCE(scheduled_at, created_at) <= ?', DateTime.current).joins_advisory_locks.where(pg_locks: { locktype: nil }) }
+    scope :queued, -> { where(finished_at: nil).where(coalesce_scheduled_at_created_at.lteq(DateTime.current)).joins_advisory_locks.where(pg_locks: { locktype: nil }) }
     # Advisory locked and executing
     scope :running, -> { where(finished_at: nil).joins_advisory_locks.where.not(pg_locks: { locktype: nil }) }
     # Finished executing (succeeded or discarded)

data/lib/good_job/configuration.rb

@@ -341,6 +341,10 @@ module GoodJob
       DEFAULT_ENABLE_LISTEN_NOTIFY
     end
 
+    def smaller_number_is_higher_priority
+      rails_config[:smaller_number_is_higher_priority]
+    end
+
     private
 
     def rails_config

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -460,7 +460,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails