good_job 3.17.0 → 3.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946d6d7912809cf31d3f79c0dc7e2c074b20c7bcd853d6c3a9ab35faa5f4f6aa
-  data.tar.gz: d33a7a41a7c8c259d71c5e8caa7fb268ec0db2c7516a4fb45d937c4e05d5fb64
+  metadata.gz: 581ee459525ff8cd06451a4f1867e292878266b6638a18b59a3b8f7909eca889
+  data.tar.gz: c054d0236413287311d79acb1addcd2f01e3f415891c96a30f9dc3c0919a83dc
 SHA512:
-  metadata.gz: e849433834f758352c918379f1c727d3b992cd6843f9f27de4768d2f7845402f5c9b418cb93da285811df55882d0a0a6acac90bcedf1bdeac9dbafca66e7af54
-  data.tar.gz: fe3ae7523b7d9307a085a298a771301b3d9707495a24866eec113bbc172a83ffedfe68e452c1b925e0e04f2a5a54175a995c2c312f1f3033e860615182015c2a
+  metadata.gz: d52f9217c71d2fc4c9af170570dd317f78ee39e33cd337b77aab84102ca605e56a4fde0cdb1fe9892c3d1e81f2ef67f91f7210e855b81025a57445cced43b66c
+  data.tar.gz: 81a1991701efaaacf9bfc762fc96919511862a469f5411eb905b1489beefda6b0d244947df731b7c7cb483466ef58af698746ef7e46fbb85dbca05f720df36d9

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [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:**
+
+- 3.17.0 breaks health check endpoints [\#1033](https://github.com/bensheldon/good_job/issues/1033)
+- 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/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/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.1'
 
   # 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.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob