good_job 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5725006ff1eae761677d25b8f89d55903532b80c6850a8a58ad6506823316763
-  data.tar.gz: fe91ce725bd86202334c86c308443a3c5e5b0c71b680be4d5086b87b0349fe8a
+  metadata.gz: 41adaae5b9a9c016ba000f7610efa23d533a177374e61039f135a1d152be146c
+  data.tar.gz: 92443b132e11697ae1ba31758852a818e5fbaf201cf080649f1c948d927265d4
 SHA512:
-  metadata.gz: 96ca288be634ed11773a66da6e3cad2f60c6cf8736cd33b41f5ce85681160d3a26e283f63f15914e480b5e8587b257ba95e9baed8f08c08c084c28c961320a29
-  data.tar.gz: d7d6fee108acbfd3743a6520b9f6283bb3cb999a7ce51f87c4d3ae80864d8b0cfe1e34bbb0517c42c8b807145dae315f60f8907bbc601d2aade905b8ff37fa53
+  metadata.gz: 155174df9c9d4daf50f4e898585e2cf40898de46eb5974592acdf32cc435cb4cb13b6d4953862a89a3b8223d7bbd2c9e79c60d4a974642f180092d836d04ebb2
+  data.tar.gz: 84b922a4853ffb85da2380ab80c20b3d7392f403218838c3fdcb8872726d2df469d81edeaa28cb2f5a76401280460839c1d3f6ca1f2c9a98c4a1b275ff99cee4

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## [v4.0.3](https://github.com/bensheldon/good_job/tree/v4.0.3) (2024-07-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.0.2...v4.0.3)
+
+**Fixed bugs:**
+
+- Only set duration attribute to interval on Rails 6.1 [\#1412](https://github.com/bensheldon/good_job/pull/1412) ([bdewater-thatch](https://github.com/bdewater-thatch))
+
+**Closed issues:**
+
+- GoodJob error: TypeError: can't cast ActiveSupport::Duration \(on v4.0.0\) [\#1413](https://github.com/bensheldon/good_job/issues/1413)
+- Question: is it possible to clean a set of scheduled jobs \(by class name\) from console? [\#1410](https://github.com/bensheldon/good_job/issues/1410)
+- "Couldn't find GoodJob::BatchRecord" error [\#1387](https://github.com/bensheldon/good_job/issues/1387)
+- Empty alerts "\[\]"? [\#1372](https://github.com/bensheldon/good_job/issues/1372)
+- Release GoodJob 4.0 [\#764](https://github.com/bensheldon/good_job/issues/764)
+
+**Merged pull requests:**
+
+- Add Active Support load hooks for Job and \(Discrete\)Execution; move all outside class definition bodies [\#1414](https://github.com/bensheldon/good_job/pull/1414) ([bensheldon](https://github.com/bensheldon))
+
+## [v4.0.2](https://github.com/bensheldon/good_job/tree/v4.0.2) (2024-07-08)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v4.0.1...v4.0.2)
+
+**Fixed bugs:**
+
+- Fix a rails 6.1 deprecation warning for the duration attribute [\#1408](https://github.com/bensheldon/good_job/pull/1408) ([Earlopain](https://github.com/Earlopain))
+- Actually remove deprecated configuration for `cleanup_interval_seconds`, `cleanup_interval_jobs`; remove deprecated `Lockable` [\#1406](https://github.com/bensheldon/good_job/pull/1406) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- PG::UndefinedColumn: ERROR:  column good\_job\_processes.lock\_type does not exist [\#1405](https://github.com/bensheldon/good_job/issues/1405)
+- undefined method `duration=' for an instance of GoodJob::Execution [\#1404](https://github.com/bensheldon/good_job/issues/1404)
+- v3 deprecations are still present [\#1399](https://github.com/bensheldon/good_job/issues/1399)
+
+**Merged pull requests:**
+
+- Fix Batch integration test to not exhaust database connection thread pool [\#1409](https://github.com/bensheldon/good_job/pull/1409) ([bensheldon](https://github.com/bensheldon))
+- Discrete cleanup [\#1401](https://github.com/bensheldon/good_job/pull/1401) ([Earlopain](https://github.com/Earlopain))
+
 ## [v4.0.1](https://github.com/bensheldon/good_job/tree/v4.0.1) (2024-07-08)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v4.0.0...v4.0.1)

data/app/controllers/good_job/application_controller.rb

@@ -57,7 +57,7 @@ module GoodJob
         I18n.default_locale
       end
     end
-
-    ActiveSupport.run_load_hooks(:good_job_application_controller, self)
   end
 end
+
+ActiveSupport.run_load_hooks(:good_job_application_controller, GoodJob::ApplicationController)

data/app/models/good_job/base_execution.rb

@@ -25,6 +25,8 @@ module GoodJob
     self.advisory_lockable_column = 'active_job_id'
     self.implicit_order_column = 'created_at'
 
+    self.ignored_columns += ["is_discrete"]
+
     define_model_callbacks :perform
     define_model_callbacks :perform_unlocked, only: :after
 
@@ -216,14 +218,6 @@ module GoodJob
       def coalesce_scheduled_at_created_at
         arel_table.coalesce(arel_table['scheduled_at'], arel_table['created_at'])
       end
-
-      def discrete_support?
-        true
-      end
-    end
-
-    def discrete?
-      is_discrete?
     end
 
     # Build an ActiveJob instance and deserialize the arguments, using `#active_job_data`.
@@ -545,17 +539,6 @@ module GoodJob
       false
     end
 
-    def make_discrete
-      self.is_discrete = true
-      self.id = active_job_id
-      self.job_class = serialized_params['job_class']
-      self.executions_count ||= 0
-
-      current_time = Time.current
-      self.created_at ||= current_time
-      self.scheduled_at ||= current_time
-    end
-
     # Return formatted serialized_params for display in the dashboard
     # @return [Hash]
     def display_serialized_params

data/app/models/good_job/base_record.rb

@@ -43,7 +43,7 @@ module GoodJob
     def self.bind_value(name, value, type_class)
       Arel::Nodes::BindParam.new(ActiveRecord::Relation::QueryAttribute.new(name, value, type_class.new))
     end
-
-    ActiveSupport.run_load_hooks(:good_job_base_record, self)
   end
 end
+
+ActiveSupport.run_load_hooks(:good_job_base_record, GoodJob::BaseRecord)

data/app/models/good_job/discrete_execution.rb

@@ -14,6 +14,9 @@ module GoodJob # :nodoc:
 
     alias_attribute :performed_at, :created_at
 
+    # TODO: Remove when support for Rails 6.1 is dropped
+    attribute :duration, :interval if ActiveJob.version.canonical_segments.take(2) == [6, 1]
+
     def number
       serialized_params.fetch('executions', 0) + 1
     end
@@ -57,3 +60,5 @@ module GoodJob # :nodoc:
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:good_job_execution, GoodJob::DiscreteExecution)

data/app/models/good_job/job.rb

@@ -46,8 +46,6 @@ module GoodJob
     # Errored but will not be retried
     scope :discarded, -> { finished.where.not(error: nil) }
 
-    scope :unfinished_undiscrete, -> { where(finished_at: nil, retried_good_job_id: nil, is_discrete: [nil, false]) }
-
     # TODO: it would be nice to enforce these values at the model
     # validates :active_job_id, presence: true
     # validates :scheduled_at, presence: true
@@ -226,3 +224,5 @@ module GoodJob
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:good_job_job, GoodJob::Job)

data/lib/good_job/cleanup_tracker.rb

@@ -9,7 +9,7 @@ module GoodJob # :nodoc:
                   :last_at
 
     def initialize(cleanup_interval_seconds: false, cleanup_interval_jobs: false)
-      raise ArgumentError, "Do not use `0`. Use `false` to disable, or -1 to always run" if cleanup_interval_seconds == 0 || cleanup_interval_jobs == 0 # rubocop:disable Style/NumericPredicate
+      raise ArgumentError, "Do not use `0` for cleanup intervals. Use `false` to disable, or -1 to always run" if cleanup_interval_seconds == 0 || cleanup_interval_jobs == 0 # rubocop:disable Style/NumericPredicate
 
       self.cleanup_interval_seconds = cleanup_interval_seconds
       self.cleanup_interval_jobs = cleanup_interval_jobs

data/lib/good_job/configuration.rb

@@ -230,8 +230,8 @@ module GoodJob
     def queue_select_limit
       (
         options[:queue_select_limit] ||
-        rails_config[:queue_select_limit] ||
-        env['GOOD_JOB_QUEUE_SELECT_LIMIT']
+          rails_config[:queue_select_limit] ||
+          env['GOOD_JOB_QUEUE_SELECT_LIMIT']
       )&.to_i
     end
 
@@ -240,8 +240,8 @@ module GoodJob
     def idle_timeout
       (
         options[:idle_timeout] ||
-        rails_config[:idle_timeout] ||
-        env['GOOD_JOB_IDLE_TIMEOUT']
+          rails_config[:idle_timeout] ||
+          env['GOOD_JOB_IDLE_TIMEOUT']
       )&.to_i || nil
     end
 
@@ -269,69 +269,38 @@ module GoodJob
     # Positive values will clean up after that many jobs have run, false or 0 will disable, and -1 will clean up after every job.
     # @return [Integer, Boolean, nil]
     def cleanup_interval_jobs
-      if rails_config.key?(:cleanup_interval_jobs)
-        value = rails_config[:cleanup_interval_jobs]
-        if value.nil?
-          GoodJob.deprecator.warn(
-            %(Setting `config.good_job.cleanup_interval_jobs` to `nil` will no longer disable count-based cleanups in GoodJob v4. Set to `false` to disable, or `-1` to run every time.)
-          )
-          value = false
-        elsif value == 0 # rubocop:disable Style/NumericPredicate
-          GoodJob.deprecator.warn(
-            %(Setting `config.good_job.cleanup_interval_jobs` to `0` will disable count-based cleanups in GoodJob v4. Set to `false` to disable, or `-1` to run every time.)
-          )
-          value = -1
-        end
-      elsif env.key?('GOOD_JOB_CLEANUP_INTERVAL_JOBS')
-        value = env['GOOD_JOB_CLEANUP_INTERVAL_JOBS']
-        if value.blank?
-          GoodJob.deprecator.warn(
-            %(Setting `GOOD_JOB_CLEANUP_INTERVAL_JOBS` to `""` will no longer disable count-based cleanups in GoodJob v4. Set to `0` to disable, or `-1` to run every time.)
-          )
-          value = false
-        elsif value == '0'
-          value = false
-        end
+      value = if rails_config.key?(:cleanup_interval_jobs)
+                rails_config[:cleanup_interval_jobs]
+              elsif env.key?('GOOD_JOB_CLEANUP_INTERVAL_JOBS')
+                env['GOOD_JOB_CLEANUP_INTERVAL_JOBS']
+              end
+
+      if value.in? [nil, "", true]
+        DEFAULT_CLEANUP_INTERVAL_JOBS
+      elsif value.in? [0, "0", false, "false"]
+        false
       else
-        value = DEFAULT_CLEANUP_INTERVAL_JOBS
+        value ? value.to_i : false
       end
-
-      value ? value.to_i : false
     end
 
     # Number of seconds a {Scheduler} will wait before automatically cleaning up preserved jobs.
     # Positive values will clean up after that many jobs have run, false or 0 will disable, and -1 will clean up after every job.
-    # @return [Integer, nil]
+    # @return [Integer, Boolean, nil]
     def cleanup_interval_seconds
-      if rails_config.key?(:cleanup_interval_seconds)
-        value = rails_config[:cleanup_interval_seconds]
-
-        if value.nil?
-          GoodJob.deprecator.warn(
-            %(Setting `config.good_job.cleanup_interval_seconds` to `nil` will no longer disable time-based cleanups in GoodJob v4. Set to `false` to disable, or `-1` to run every time.)
-          )
-          value = false
-        elsif value == 0 # rubocop:disable Style/NumericPredicate
-          GoodJob.deprecator.warn(
-            %(Setting `config.good_job.cleanup_interval_seconds` to `0` will disable time-based cleanups in GoodJob v4. Set to `false` to disable, or `-1` to run every time.)
-          )
-          value = -1
-        end
-      elsif env.key?('GOOD_JOB_CLEANUP_INTERVAL_SECONDS')
-        value = env['GOOD_JOB_CLEANUP_INTERVAL_SECONDS']
-        if value.blank?
-          GoodJob.deprecator.warn(
-            %(Setting `GOOD_JOB_CLEANUP_INTERVAL_SECONDS` to `""` will no longer disable time-based cleanups in GoodJob v4. Set to `0` to disable, or `-1` to run every time.)
-          )
-          value = false
-        elsif value == '0'
-          value = false
-        end
+      value = if rails_config.key?(:cleanup_interval_seconds)
+                rails_config[:cleanup_interval_seconds]
+              elsif env.key?('GOOD_JOB_CLEANUP_INTERVAL_SECONDS')
+                env['GOOD_JOB_CLEANUP_INTERVAL_SECONDS']
+              end
+
+      if value.nil? || value == "" || value == true
+        DEFAULT_CLEANUP_INTERVAL_SECONDS
+      elsif value.in? [0, "0", false, "false"]
+        false
       else
-        value = DEFAULT_CLEANUP_INTERVAL_SECONDS
+        value ? value.to_i : false
       end
-
-      value ? value.to_i : false
     end
 
     # Tests whether to daemonize the process.

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -269,7 +269,11 @@ module GoodJob
   # Tests whether GoodJob can be safely upgraded to v4
   # @return [Boolean]
   def self.v4_ready?
-    GoodJob::Job.discrete_support? && GoodJob::Job.where(finished_at: nil).where(is_discrete: [nil, false]).none?
+    GoodJob.deprecator.warn(<<~MSG)
+      Calling `GoodJob.v4_ready?` is deprecated and will be removed in GoodJob v5.
+      If you are reading this deprecation you are already on v4.
+    MSG
+    true
   end
 
   # Deprecator for providing deprecation warnings.
@@ -281,15 +285,12 @@ module GoodJob
     end
   end
 
-  include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-  deprecate_constant :Lockable, 'GoodJob::AdvisoryLockable', deprecator: deprecator
-
   # Whether all GoodJob migrations have been applied.
   # For use in tests/CI to validate GoodJob is up-to-date.
   # @return [Boolean]
   def self.migrated?
     true
   end
-
-  ActiveSupport.run_load_hooks(:good_job, self)
 end
+
+ActiveSupport.run_load_hooks(:good_job, GoodJob)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob