good_job 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11a59540e5e10acc24b9010cb14dc8cbce2f43e8c2f1fe886b6fcf0895a978f2
-  data.tar.gz: 6fea5677587740d390f6eaa3dc903cee7c26a8576f14dd91f85f8886637d634b
+  metadata.gz: d4c1686f53ec7019417a342069c499c829dccb4f8cfcbd7396623b96e9edd2fe
+  data.tar.gz: de4e3d7a20e47c63aad25dd167a640b83a9349f0b8933d4692afc6f8b12d16d3
 SHA512:
-  metadata.gz: '087af5fa1eaf81eff5078b5e3303e202aa73ea022d7018d60f01c6abb5a808a9442278e87490f846475c626bb5b5dd320537d68c16697ca54e9f30147f5b9225'
-  data.tar.gz: d19960b918937484e0f37eb0456fc3352dc2f4394fab4b0477bde7dedab789f2ce63c48b4971e38d2ff3a5d8725f1761afd425426ad384766f34cf549c35009e
+  metadata.gz: dfe017b7ea652b134c009622e5a7b1d83e7d502a4f066b49538ffca138555f4395d6279f7256a10c872e1967aa127bb82eba17a72fbf8930adcd12da9650dbf4
+  data.tar.gz: 1e5178b1d9ddf492347e6f25b10bae710dc25454974436fad322b306698a25bdf29d777f54de5c988479b56a21d2b0a8cfdc7b7f87799ae5cf6f7df4c76f4b6b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [v2.0.3](https://github.com/bensheldon/good_job/tree/v2.0.3) (2021-08-31)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.0.2...v2.0.3)
+
+**Closed issues:**
+
+- Expose CLI `cleanup_preserved_jobs` functionality via `GoodJob`? [\#351](https://github.com/bensheldon/good_job/issues/351)
+
+**Merged pull requests:**
+
+- Implement `GoodJob.cleanup_preserved_jobs`, fixes \#351 [\#356](https://github.com/bensheldon/good_job/pull/356) ([aried3r](https://github.com/aried3r))
+
 ## [v2.0.2](https://github.com/bensheldon/good_job/tree/v2.0.2) (2021-08-27)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.99.1...v2.0.2)

data/README.md

@@ -184,7 +184,7 @@ separate isolated execution pools with semicolons and threads with colons.
 
 #### `good_job cleanup_preserved_jobs`
 
-`good_job cleanup_preserved_jobs` deletes preserved job records. See [`GoodJob.preserve_job_records` for when this command is useful.
+`good_job cleanup_preserved_jobs` deletes preserved job records. See `GoodJob.preserve_job_records` for when this command is useful.
 
 ```bash
 $ bundle exec good_job help cleanup_preserved_jobs
@@ -724,7 +724,8 @@ It is also necessary to delete these preserved jobs from the database after a ce
 - For example, in a Rake task:
 
     ```ruby
-    GoodJob::Job.finished(1.day.ago).delete_all
+    GoodJob.cleanup_preserved_jobs # Will keep 1 day of job records by default.
+    GoodJob.cleanup_preserved_jobs(older_than: 7.days) # It also takes custom arguments.
     ```
 
 - For example, using the `good_job` command-line utility:

data/lib/good_job/cli.rb

@@ -134,16 +134,7 @@ module GoodJob
 
       configuration = GoodJob::Configuration.new(options)
 
-      timestamp = Time.current - configuration.cleanup_preserved_jobs_before_seconds_ago
-
-      ActiveSupport::Notifications.instrument(
-        "cleanup_preserved_jobs.good_job",
-        { before_seconds_ago: configuration.cleanup_preserved_jobs_before_seconds_ago, timestamp: timestamp }
-      ) do |payload|
-        deleted_records_count = GoodJob::Job.finished(timestamp).delete_all
-
-        payload[:deleted_records_count] = deleted_records_count
-      end
+      GoodJob.cleanup_preserved_jobs(older_than: configuration.cleanup_preserved_jobs_before_seconds_ago)
     end
 
     no_commands do

data/lib/good_job/configuration.rb

@@ -16,7 +16,7 @@ module GoodJob
     DEFAULT_DEVELOPMENT_ASYNC_POLL_INTERVAL = -1
     # Default number of threads to use per {Scheduler}
     DEFAULT_MAX_CACHE = 10000
-    # Default number of seconds to preserve jobs for {CLI#cleanup_preserved_jobs}
+    # Default number of seconds to preserve jobs for {CLI#cleanup_preserved_jobs} and {GoodJob.cleanup_preserved_jobs}
     DEFAULT_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO = 24 * 60 * 60
     # Default to always wait for jobs to finish for {Adapter#shutdown}
     DEFAULT_SHUTDOWN_TIMEOUT = -1

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -42,7 +42,8 @@ module GoodJob
   #   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 +true+, you will need to clean out jobs using the +good_job cleanup_preserved_jobs+ CLI command.
+  #   If +true+, you will need to clean out jobs using the +good_job cleanup_preserved_jobs+ CLI command or
+  #   by using +Goodjob.cleanup_preserved_jobs+.
   #   @return [Boolean, nil]
   mattr_accessor :preserve_job_records, default: false
 
@@ -114,6 +115,26 @@ module GoodJob
     end
   end
 
+  # Deletes preserved job records.
+  # By default, GoodJob deletes job records when the job is performed and this
+  # method 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 method regularly to
+  # delete old records and preserve space in your database.
+  # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs olders than this will be deleted (default: +86400+).
+  # @return [Integer] Number of jobs that were deleted.
+  def self.cleanup_preserved_jobs(older_than: nil)
+    older_than ||= GoodJob::Configuration.new({}).cleanup_preserved_jobs_before_seconds_ago
+    timestamp = Time.current - older_than
+
+    ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
+      deleted_records_count = GoodJob::Job.finished(timestamp).delete_all
+
+      payload[:deleted_records_count] = deleted_records_count
+    end
+  end
+
   def self._executables
     [].concat(
       CronManager.instances,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob