good_job 3.7.2 → 3.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820584e338535d72bf53a7e41718998ee39f718a9b77bc20a5a382b4deb7a8d0
-  data.tar.gz: a9a8285fce5d8a7345ce22903f24dafc9217dc853a93161fad6e7df1efede5b4
+  metadata.gz: 98b02fbefa1bdf43b80628d2995e19295c7051f6ed8d8367c2ddb511fef90aeb
+  data.tar.gz: 92b755dd24a410c0785320c0ca891d4809a286737d46160fc425e3ef8eb42e3c
 SHA512:
-  metadata.gz: 4a52184bd60ba084f42949096149c5b85defa7db032b61aedb3204d125cbc0a84d8d39dcba6316c49ad7f0a6e23c41109b12fd9f3dc9d1df2eeb86b7c12c3268
-  data.tar.gz: 54868876aefebb9668ee83b900b123c5ce512bd6b805cd6f005dbb9a60573b947b42d559ae1608b624dd21a4f70a8379ba3ad1eacc1f2f293ec3925c77fed913
+  metadata.gz: d790addce3a69b2977ce8ab18cd97a2b5ea8f12aade94bead97ff08722ce6245767636450a35dfa76678a0d6f03ddd9a89aa363f338e95d8a45cba05286a9475
+  data.tar.gz: 6c2c63b2aa72b82ef661c4b0edbfd8346d0c30a2a3caac614761686daad00e7dbff1279e2835576615f511e24f14a343521d0300cf90ae16ef4d65d6b6d7b979

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [v3.7.3](https://github.com/bensheldon/good_job/tree/v3.7.3) (2023-01-09)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.7.2...v3.7.3)
+
+**Implemented enhancements:**
+
+- Provide clearer values/deprecation notices for `cleanup_interval_jobs` and `cleanup_interval_seconds`; setting `0` disables, `-1` always [\#776](https://github.com/bensheldon/good_job/pull/776) ([zarqman](https://github.com/zarqman))
+
+**Closed issues:**
+
+- Demo page shows Application Error [\#787](https://github.com/bensheldon/good_job/issues/787)
+- Configuration for PG Schema Other Than Public [\#774](https://github.com/bensheldon/good_job/issues/774)
+
+**Merged pull requests:**
+
+- Avoid including unnecessary pg\_locks references when counting jobs [\#789](https://github.com/bensheldon/good_job/pull/789) ([mkrfowler](https://github.com/mkrfowler))
+- Add net-\* gems to Gemfile for Heroku [\#788](https://github.com/bensheldon/good_job/pull/788) ([bensheldon](https://github.com/bensheldon))
+- Add Ruby 3.2 to test matrix [\#786](https://github.com/bensheldon/good_job/pull/786) ([bensheldon](https://github.com/bensheldon))
+- Bump rubocop from 1.41.1 to 1.42.0 [\#781](https://github.com/bensheldon/good_job/pull/781) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop from 1.40.0 to 1.41.1 [\#779](https://github.com/bensheldon/good_job/pull/779) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop-performance from 1.15.1 to 1.15.2 [\#777](https://github.com/bensheldon/good_job/pull/777) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rubocop-rspec from 2.15.0 to 2.16.0 [\#775](https://github.com/bensheldon/good_job/pull/775) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rails-html-sanitizer from 1.4.3 to 1.4.4 [\#773](https://github.com/bensheldon/good_job/pull/773) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump loofah from 2.19.0 to 2.19.1 [\#772](https://github.com/bensheldon/good_job/pull/772) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v3.7.2](https://github.com/bensheldon/good_job/tree/v3.7.2) (2022-12-12)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.7.1...v3.7.2)

data/README.md

@@ -273,8 +273,8 @@ Available configuration options are:
 - `cron` (hash) cron configuration. Defaults to `{}`. You can also set this as a JSON string with the environment variable `GOOD_JOB_CRON`
 - `cleanup_discarded_jobs` (boolean) whether to destroy discarded jobs when cleaning up preserved jobs using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `true`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_DISCARDED_JOBS`. _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
 - `cleanup_preserved_jobs_before_seconds_ago` (integer) number of seconds to preserve jobs when using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `1209600` (14 days). Can also be set with  the environment variable `GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO`.  _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
-- `cleanup_interval_jobs` (integer) Number of jobs a Scheduler will execute before cleaning up preserved jobs. Defaults to `1000`. Disable with `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_JOBS`.
-- `cleanup_interval_seconds` (integer) Number of seconds a Scheduler will wait before cleaning up preserved jobs. Defaults to `600` (10 minutes). Disable with `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_SECONDS`.
+- `cleanup_interval_jobs` (integer) Number of jobs a Scheduler will execute before cleaning up preserved jobs. Defaults to `1000`. Disable with `false`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_JOBS` and disabled with `0`).
+- `cleanup_interval_seconds` (integer) Number of seconds a Scheduler will wait before cleaning up preserved jobs. Defaults to `600` (10 minutes). Disable with `false`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_SECONDS` and disabled with `0`).
 - `inline_execution_respects_schedule` (boolean) Opt-in to future behavior of inline execution respecting scheduled jobs. Defaults to `false`.
 - `logger` ([Rails Logger](https://api.rubyonrails.org/classes/ActiveSupport/Logger.html)) lets you set a custom logger for GoodJob. It should be an instance of a Rails `Logger` (Default: `Rails.logger`).
 - `preserve_job_records` (boolean) keeps job records in your database even after jobs are completed. (Default: `true`)

data/app/filters/good_job/base_filter.rb

@@ -14,7 +14,7 @@ module GoodJob
     def records
       after_scheduled_at = params[:after_scheduled_at].present? ? Time.zone.parse(params[:after_scheduled_at]) : nil
 
-      filtered_query.display_all(
+      query_for_records.display_all(
         after_scheduled_at: after_scheduled_at,
         after_id: params[:after_id]
       ).limit(params.fetch(:limit, DEFAULT_LIMIT))
@@ -62,6 +62,10 @@ module GoodJob
 
     private
 
+    def query_for_records
+      raise NotImplementedError
+    end
+
     def default_base_query
       raise NotImplementedError
     end

data/app/filters/good_job/jobs_filter.rb

@@ -2,7 +2,7 @@
 module GoodJob
   class JobsFilter < BaseFilter
     def states
-      query = filtered_query(params.except(:state)).unscope(:select)
+      query = filtered_query(params.except(:state))
       {
         'scheduled' =>  query.scheduled.count,
         'retried' => query.retried.count,
@@ -14,7 +14,7 @@ module GoodJob
     end
 
     def filtered_query(filter_params = params)
-      query = base_query.includes(:executions).includes_advisory_locks
+      query = base_query
 
       query = query.job_class(filter_params[:job_class]) if filter_params[:job_class].present?
       query = query.where(queue_name: filter_params[:queue_name]) if filter_params[:queue_name].present?
@@ -47,6 +47,10 @@ module GoodJob
 
     private
 
+    def query_for_records
+      filtered_query.includes(:executions).includes_advisory_locks
+    end
+
     def default_base_query
       GoodJob::Job.all
     end

data/lib/good_job/cleanup_tracker.rb

@@ -7,7 +7,9 @@ module GoodJob # :nodoc:
                   :job_count,
                   :last_at
 
-    def initialize(cleanup_interval_seconds: nil, cleanup_interval_jobs: nil)
+    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
+
       self.cleanup_interval_seconds = cleanup_interval_seconds
       self.cleanup_interval_jobs = cleanup_interval_jobs
 

data/lib/good_job/configuration.rb

@@ -242,29 +242,72 @@ module GoodJob
     end
 
     # Number of jobs a {Scheduler} will execute 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]
     def cleanup_interval_jobs
-      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']
-              else
-                DEFAULT_CLEANUP_INTERVAL_JOBS
-              end
-      value.present? ? value.to_i : nil
+      if rails_config.key?(:cleanup_interval_jobs)
+        value = rails_config[:cleanup_interval_jobs]
+        if value.nil?
+          ActiveSupport::Deprecation.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
+          ActiveSupport::Deprecation.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?
+          ActiveSupport::Deprecation.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
+      else
+        value = DEFAULT_CLEANUP_INTERVAL_JOBS
+      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]
     def cleanup_interval_seconds
-      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']
-              else
-                DEFAULT_CLEANUP_INTERVAL_SECONDS
-              end
-      value.present? ? value.to_i : nil
+      if rails_config.key?(:cleanup_interval_seconds)
+        value = rails_config[:cleanup_interval_seconds]
+
+        if value.nil?
+          ActiveSupport::Deprecation.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
+          ActiveSupport::Deprecation.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?
+          ActiveSupport::Deprecation.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
+      else
+        value = DEFAULT_CLEANUP_INTERVAL_SECONDS
+      end
+
+      value ? value.to_i : false
     end
 
     # Tests whether to daemonize the process.

data/lib/good_job/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.7.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob