good_job 3.6.2 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bcf55b958dd5e2d0c0711ff1d1a52e94daa21a0f54c96e264934be70f4eb71a
-  data.tar.gz: bafd6907fd2f9ed5bf41b04b0d3f844407c85de9b488f6c0715413a77134ef27
+  metadata.gz: 66b60bc23382c00854b271e6de89adaa7d488b41bc1dc172ffe9411ceb1c5211
+  data.tar.gz: 80ed47811e016b45e3bb9f2c18cd0f3225e743d6f9e2b9b3cec8c7ab8efef782
 SHA512:
-  metadata.gz: 34ea4a118657a0ea9fb43ef82e6d01fc275269bb8d172d9a6baa4db30af141faf90256e350a77fe09bb821cfdf51c4efe0416576576809b377ed68a4408cc339
-  data.tar.gz: 96f8567cbd0c52742dd5e60046c8e81d249de5a78a6a7f3dde1f0185316407e965f060275bcfce2fc902df3c27ae83124d37351f241dba7241443c652a168837
+  metadata.gz: 6c066709c1b40fc84651809540e08350128b563e5f5392d3dec694ad619a9271c0546e2e248ef3135e524b94a998488600544784461015762f461039fe664ce3
+  data.tar.gz: 1e795fbd067f2e38f141ee473652a7f9394ef1369b338fd4ef44df7f307e08334056c651325bd1ffdab701c2445fab62db0256809f34cc6ad7b9ed9834fefbbc

data/CHANGELOG.md

@@ -1,12 +1,38 @@
 # Changelog
 
+## [v3.7.0](https://github.com/bensheldon/good_job/tree/v3.7.0) (2022-12-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.6.2...v3.7.0)
+
+**Implemented enhancements:**
+
+- Add GoodJob version to start banner [\#766](https://github.com/bensheldon/good_job/pull/766) ([zarqman](https://github.com/zarqman))
+
+**Fixed bugs:**
+
+- Always preserve job records created by cron [\#767](https://github.com/bensheldon/good_job/pull/767) ([bensheldon](https://github.com/bensheldon))
+
+**Merged pull requests:**
+
+- Bump nokogiri from 1.13.9 to 1.13.10 [\#765](https://github.com/bensheldon/good_job/pull/765) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Remove JRuby 9.2 from testing matrix [\#763](https://github.com/bensheldon/good_job/pull/763) ([bensheldon](https://github.com/bensheldon))
+- Bump actions/cache from 1 to 3 [\#762](https://github.com/bensheldon/good_job/pull/762) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump actions/upload-artifact from 2 to 3 [\#761](https://github.com/bensheldon/good_job/pull/761) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump actions/add-to-project from 0.3.0 to 0.4.0 [\#759](https://github.com/bensheldon/good_job/pull/759) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump alex-page/github-project-automation-plus from 9a05133789dbc96bd560ec84223a0ad49253d342 to 1f8873e97e3c8f58161a323b7c568c1f623a1c4d [\#758](https://github.com/bensheldon/good_job/pull/758) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump selenium-webdriver from 4.6.1 to 4.7.1 [\#757](https://github.com/bensheldon/good_job/pull/757) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add explicit ruby version in Gemfile for Heroku demo [\#755](https://github.com/bensheldon/good_job/pull/755) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.6.2](https://github.com/bensheldon/good_job/tree/v3.6.2) (2022-12-04)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.6.1...v3.6.2)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Redirect to Jobs path after destroy [\#754](https://github.com/bensheldon/good_job/pull/754) ([BilalBudhani](https://github.com/BilalBudhani))
+
+**Merged pull requests:**
+
 - Bump pg from 1.4.4 to 1.4.5 [\#751](https://github.com/bensheldon/good_job/pull/751) ([dependabot[bot]](https://github.com/apps/dependabot))
 
 ## [v3.6.1](https://github.com/bensheldon/good_job/tree/v3.6.1) (2022-11-30)

data/README.md

@@ -203,17 +203,10 @@ Usage:
 Options:
   [--before-seconds-ago=SECONDS] # Destroy records finished more than this many seconds ago (env var:  GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 1209600 (14 days))
 
-Destroys preserved job records.
+Manually destroys preserved job records.
 
-By default, GoodJob destroys job records when the job is performed and this
-command is not necessary.
-
-However, when `GoodJob.preserve_job_records = true`, the jobs will be
-preserved in the database. This is useful when wanting to analyze or
-inspect job performance.
-
-If you are preserving job records this way, use this command regularly
-to destroy old records and preserve space in your database.
+By default, GoodJob automatically destroys job records when the job is performed
+and this command is not required to be used.
 ```
 
 ### Configuration options
@@ -460,7 +453,9 @@ GoodJob's concurrency control strategy for `perform_limit` is "optimistic retry
 
 GoodJob can enqueue jobs on a recurring basis that can be used as a replacement for cron.
 
-Cron-style jobs are run on every GoodJob process (e.g. CLI or `async` execution mode) when `config.good_job.enable_cron = true`, but GoodJob's cron uses unique indexes to ensure that only a single job is enqueued at the given time interval.
+Cron-style jobs are run on every GoodJob process (e.g. CLI or `async` execution mode) when `config.good_job.enable_cron = true`.
+
+GoodJob's cron uses unique indexes to ensure that only a single job is enqueued at the given time interval. In order for this to work, GoodJob must preserve cron-created job records; these records will be automatically deleted like any other preserved record.
 
 Cron-format is parsed by the [`fugit`](https://github.com/floraison/fugit) gem, which has support for seconds-level resolution (e.g. `* * * * * *`) and natural language parsing (e.g. `every second`).
 

data/app/models/good_job/execution.rb

@@ -300,7 +300,7 @@ module GoodJob
       reenqueued = result.retried? || retried_good_job_id.present?
       if result.unhandled_error && GoodJob.retry_on_unhandled_error
         save!
-      elsif GoodJob.preserve_job_records == true || reenqueued || (result.unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error)
+      elsif GoodJob.preserve_job_records == true || reenqueued || (result.unhandled_error && GoodJob.preserve_job_records == :on_unhandled_error) || cron_key.present?
         self.finished_at = Time.current
         save!
       else

data/lib/good_job/cli.rb

@@ -128,17 +128,10 @@ module GoodJob
     # @!macro thor.desc
     desc :cleanup_preserved_jobs, "Destroys preserved job records."
     long_desc <<~DESCRIPTION
-      Destroys preserved job records.
+      Manually destroys preserved job records.
 
-      By default, GoodJob destroys job records when the job is performed and this
-      command is not necessary.
-
-      However, when `GoodJob.preserve_job_records = true`, the jobs will be
-      preserved in the database. This is useful when wanting to analyze or
-      inspect job performance.
-
-      If you are preserving job records this way, use this command regularly
-      to destroy old records and preserve space in your database.
+      By default, GoodJob automatically destroys job records when the job is performed
+      and this command is not required to be used.
 
     DESCRIPTION
     method_option :before_seconds_ago,

data/lib/good_job/configuration.rb

@@ -221,8 +221,7 @@ module GoodJob
       )&.to_i
     end
 
-    # Whether to destroy discarded jobs when cleaning up preserved jobs.
-    # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
+    # Whether to automatically destroy discarded jobs that have been preserved.
     # @return [Boolean]
     def cleanup_discarded_jobs?
       return rails_config[:cleanup_discarded_jobs] unless rails_config[:cleanup_discarded_jobs].nil?
@@ -231,8 +230,7 @@ module GoodJob
       true
     end
 
-    # Number of seconds to preserve jobs when using the +good_job cleanup_preserved_jobs+ CLI command.
-    # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
+    # Number of seconds to preserve jobs before automatic destruction.
     # @return [Integer]
     def cleanup_preserved_jobs_before_seconds_ago
       (
@@ -243,7 +241,7 @@ module GoodJob
       ).to_i
     end
 
-    # Number of jobs a {Scheduler} will execute before cleaning up preserved jobs.
+    # Number of jobs a {Scheduler} will execute before automatically cleaning up preserved jobs.
     # @return [Integer, nil]
     def cleanup_interval_jobs
       value = (
@@ -254,7 +252,7 @@ module GoodJob
       value.present? ? value.to_i : nil
     end
 
-    # Number of seconds a {Scheduler} will wait before cleaning up preserved jobs.
+    # Number of seconds a {Scheduler} will wait before automatically cleaning up preserved jobs.
     # @return [Integer, nil]
     def cleanup_interval_seconds
       value = (

data/lib/good_job/log_subscriber.rb

@@ -53,7 +53,7 @@ module GoodJob
       process_id = event.payload[:process_id]
 
       info(tags: [process_id]) do
-        "GoodJob started scheduler with queues=#{performer_name} max_threads=#{max_threads}."
+        "GoodJob #{GoodJob::VERSION} started scheduler with queues=#{performer_name} max_threads=#{max_threads}."
       end
     end
 

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -54,9 +54,10 @@ module GoodJob
   # @!attribute [rw] preserve_job_records
   #   @!scope class
   #   Whether to preserve job records in the database after they have finished (default: +true+).
-  #   By default, GoodJob deletes job records after the job is completed successfully.
   #   If you want to preserve jobs for latter inspection, set this to +true+.
   #   If you want to preserve only jobs that finished with error for latter inspection, set this to +:on_unhandled_error+.
+  #   If you do not want to preserve jobs, set this to +false+.
+  #   When using GoodJob's cron functionality, job records will be preserved for a brief time to prevent duplicate jobs.
   #   @return [Boolean, Symbol, nil]
   mattr_accessor :preserve_job_records, default: true
 

metadata

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