good_job 3.17.0 → 3.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946d6d7912809cf31d3f79c0dc7e2c074b20c7bcd853d6c3a9ab35faa5f4f6aa
-  data.tar.gz: d33a7a41a7c8c259d71c5e8caa7fb268ec0db2c7516a4fb45d937c4e05d5fb64
+  metadata.gz: 8c92206b4099b3be756adba01af60f4ef531eaf8cf02a9c9cdd17129214f929c
+  data.tar.gz: 29f1e72a6b21d2f1e3d073d8b1bd9f4f2a78e417f69c21c195fc795f62ac4e5c
 SHA512:
-  metadata.gz: e849433834f758352c918379f1c727d3b992cd6843f9f27de4768d2f7845402f5c9b418cb93da285811df55882d0a0a6acac90bcedf1bdeac9dbafca66e7af54
-  data.tar.gz: fe3ae7523b7d9307a085a298a771301b3d9707495a24866eec113bbc172a83ffedfe68e452c1b925e0e04f2a5a54175a995c2c312f1f3033e860615182015c2a
+  metadata.gz: 2906c0b22dc6f6b0f0e78c607467533598e84dce2a29e654321293da877f1afd09ee59afd534d7a7b7f1481ae796d111b2492f62ec2cddcde843442e4262adbe
+  data.tar.gz: 0e8107f018f836e0d15f5836d93ebb8bdbe6e36381cba63680113302e3125f1a49d9aba5e05a2124ce50ec51cbfde7059ebed30b3cc5b64d859ce16867ae2c5e

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## [v3.17.2](https://github.com/bensheldon/good_job/tree/v3.17.2) (2023-08-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.1...v3.17.2)
+
+**Fixed bugs:**
+
+- 3.17.0 breaks health check endpoints [\#1033](https://github.com/bensheldon/good_job/issues/1033)
+- Fix NoMethodError: undefined method `silence' for nil:NilClass [\#1037](https://github.com/bensheldon/good_job/pull/1037) ([afn](https://github.com/afn))
+
+**Closed issues:**
+
+- NoMethodError in ProcessHeartbeat if ActiveRecord logger is nil [\#1036](https://github.com/bensheldon/good_job/issues/1036)
+- JRuby deprecation policy [\#1035](https://github.com/bensheldon/good_job/issues/1035)
+
+**Merged pull requests:**
+
+- Add helpful failure output for Sorbet linter [\#1038](https://github.com/bensheldon/good_job/pull/1038) ([bensheldon](https://github.com/bensheldon))
+
+## [v3.17.1](https://github.com/bensheldon/good_job/tree/v3.17.1) (2023-08-08)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.0...v3.17.1)
+
+**Fixed bugs:**
+
+- Fix Probe Server by retrying IO.select instead of returning early [\#1034](https://github.com/bensheldon/good_job/pull/1034) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Add database connection pool details to Process state [\#1014](https://github.com/bensheldon/good_job/issues/1014)
+
+**Merged pull requests:**
+
+- Add YARD warnings to lint script; fix YARD warnings [\#1032](https://github.com/bensheldon/good_job/pull/1032) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.17.0](https://github.com/bensheldon/good_job/tree/v3.17.0) (2023-08-06)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.16.4...v3.17.0)

data/app/models/good_job/base_execution.rb

@@ -12,9 +12,9 @@ module GoodJob
     self.table_name = 'good_jobs'
 
     # With a given class name
-    # @!method job_class
+    # @!method job_class(name)
     # @!scope class
-    # @param string [String] Execution class name
+    # @param name [String] Execution class name
     # @return [ActiveRecord::Relation]
     scope :job_class, ->(name) { where(params_job_class.eq(name)) }
 

data/app/models/good_job/base_record.rb

@@ -28,6 +28,18 @@ module GoodJob
       false
     end
 
+    # Runs the block with self.logger silenced.
+    # If self.logger is nil, simply runs the block.
+    def self.with_logger_silenced(&block)
+      # Assign to a local variable, just in case it's modified in another thread concurrently
+      logger = self.logger
+      if logger
+        logger.silence(&block)
+      else
+        yield
+      end
+    end
+
     ActiveSupport.run_load_hooks(:good_job_base_record, self)
   end
 end

data/app/models/good_job/batch.rb

@@ -50,7 +50,6 @@ module GoodJob
     )
 
     # Create a new batch and enqueue it
-    # @param on_finish [String, Object] The class name of the callback job to be enqueued after the batch is finished
     # @param properties [Hash] Additional properties to be stored on the batch
     # @param block [Proc] Enqueue jobs within the block to add them to the batch
     # @return [GoodJob::BatchRecord]

data/app/models/good_job/execution.rb

@@ -76,7 +76,7 @@ module GoodJob
     }, if: -> { @_destroy_job }
 
     # Get executions with given ActiveJob ID
-    # @!method active_job_id
+    # @!method active_job_id(active_job_id)
     # @!scope class
     # @param active_job_id [String]
     #   ActiveJob ID
@@ -115,7 +115,7 @@ module GoodJob
     scope :creation_ordered, -> { order(created_at: :asc) }
 
     # Order executions for de-queueing
-    # @!method dequeueing_ordered
+    # @!method dequeueing_ordered(parsed_queues)
     # @!scope class
     # @param parsed_queues [Hash]
     #   optional output of .queue_parser, parsed queues, will be used for
@@ -130,7 +130,7 @@ module GoodJob
     end)
 
     # Order executions in order of queues in array param
-    # @!method queue_ordered
+    # @!method queue_ordered(queues)
     # @!scope class
     # @param queues [Array<string] ordered names of queues
     # @return [ActiveRecord::Relation]
@@ -300,9 +300,6 @@ module GoodJob
     #   Epoch timestamp when the job should be executed, if blank will delegate to the ActiveJob instance
     # @param create_with_advisory_lock [Boolean]
     #   Whether to establish a lock on the {Execution} record after it is created.
-    # @param persist_immediately [Boolean]
-    #   Whether to save the record immediately or just initialize it with values. When bulk-inserting
-    #   jobs the caller takes care of the persistence and sets this parameter to `false`
     # @return [Execution]
     #   The new {Execution} instance representing the queued ActiveJob job.
     def self.enqueue(active_job, scheduled_at: nil, create_with_advisory_lock: false)

data/lib/good_job/http_server.rb

@@ -44,7 +44,7 @@ module GoodJob
       while @running.true?
         begin
           ready_sockets, = IO.select([@server], nil, nil, SOCKET_READ_TIMEOUT)
-          return unless ready_sockets
+          next unless ready_sockets
 
           client = @server.accept_nonblock(exception: false)
           request = client.gets

data/lib/good_job/notifier/process_heartbeat.rb

@@ -23,7 +23,7 @@ module GoodJob # :nodoc:
       def refresh_process
         Rails.application.executor.wrap do
           GoodJob::Process.with_connection(connection) do
-            GoodJob::Process.logger.silence do
+            GoodJob::Process.with_logger_silenced do
               @process&.refresh_if_stale(cleanup: true)
             end
           end

data/lib/good_job/sd_notify.rb

@@ -91,7 +91,7 @@ module SdNotify
     notify(FDSTORE, unset_env)
   end
 
-  # @param [Boolean] true if the service manager expects watchdog keep-alive
+  # @return [Boolean] true if the service manager expects watchdog keep-alive
   #   notification messages to be sent from this process.
   #
   # If the $WATCHDOG_USEC environment variable is set,

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -111,7 +111,7 @@ module GoodJob
 
   # Custom Active Record configuration that is class_eval'ed into +GoodJob::BaseRecord+
   # @param block Custom Active Record configuration
-  # @retyrn [void]
+  # @return [void]
   #
   # @example
   #   GoodJob.configure_active_record do

metadata

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