good_job 3.18.1 → 3.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2573770a9539b895705eee99e074ec34cc74a1b2fffc491c6b01fe2218792bf3
-  data.tar.gz: 49ae57e1ccfd0cf54421c349b1e0659dab195530f89ecce2bd6f29c37315e86d
+  metadata.gz: 930bb77e947ac155ee655210ab15ef32ac40fc2d6487eaf80b0005d7e5675156
+  data.tar.gz: b3e26f0b7f4d60483a6d0646d5797654e447542b8d6cb9eca22e2cb7cbfaac78
 SHA512:
-  metadata.gz: aa1cdc0760d2d139acd4f76d95aab2093480930dd04b1a93673510497abb0f5d589ff1d71741d4e6f940d0c983bb003cbadeb06d9702a7b1165ba0f45bb13a47
-  data.tar.gz: 7184e6f9816441a85d2d2574482fbb36ea39a3c0f76bb9a5169df9ee7ad63e7a5f150f110087eba9938bfc87af79745c4a9427391906a04457ed1993b7c2f6f2
+  metadata.gz: d92deaa0fa930cd8e8bf9b6b51f37c6d8ec1b75d221d939b6b5d2cb2ec30153931873951bbfca9af5dd24867e6131133f865368845a2cf783e8212137ed3bd76
+  data.tar.gz: 0c3ff2fd89cb38061ab145d74180596334fc8f38cba5f2a61d11fcf791d03534b823361bd9546cea4cea316d04d3cfba979d459b1b3d8185386298cdb71593a0

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [v3.18.3](https://github.com/bensheldon/good_job/tree/v3.18.3) (2023-09-16)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.18.2...v3.18.3)
+
+**Fixed bugs:**
+
+- Allow Probe Server's `/connect` to handle a certain number of reconnects before statusing [\#1075](https://github.com/bensheldon/good_job/pull/1075) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+-  ActiveRecord::RecordNotUnique good\_jobs.id error in rspec test suite [\#1072](https://github.com/bensheldon/good_job/issues/1072)
+- Probe failures on heavy usage of dashboard\(?\) [\#1068](https://github.com/bensheldon/good_job/issues/1068)
+
+**Merged pull requests:**
+
+- Bump actions/checkout from 3 to 4 [\#1070](https://github.com/bensheldon/good_job/pull/1070) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add Skylight for demo site; create distinct development, lint, demo, production Gemfile groups; a little bit of Rubocop [\#1069](https://github.com/bensheldon/good_job/pull/1069) ([bensheldon](https://github.com/bensheldon))
+- Add JRuby 9.4 to testing matrix; nerf ActiveJob::TestQueueAdapter overrides [\#1067](https://github.com/bensheldon/good_job/pull/1067) ([bensheldon](https://github.com/bensheldon))
+- Reorganize dependencies to make booting JRuby easier [\#1066](https://github.com/bensheldon/good_job/pull/1066) ([bensheldon](https://github.com/bensheldon))
+- Slight refactoring to CronEntry [\#1063](https://github.com/bensheldon/good_job/pull/1063) ([bensheldon](https://github.com/bensheldon))
+
+## [v3.18.2](https://github.com/bensheldon/good_job/tree/v3.18.2) (2023-09-02)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.18.1...v3.18.2)
+
+**Fixed bugs:**
+
+- Fix compatibility with Global ID v1.2.0 [\#1064](https://github.com/bensheldon/good_job/pull/1064) ([bensheldon](https://github.com/bensheldon))
+
+**Merged pull requests:**
+
+- Bump pg from 1.5.3 to 1.5.4 [\#1061](https://github.com/bensheldon/good_job/pull/1061) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v3.18.1](https://github.com/bensheldon/good_job/tree/v3.18.1) (2023-08-30)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.18.0...v3.18.1)

data/app/filters/good_job/batches_filter.rb

@@ -16,7 +16,7 @@ module GoodJob
     end
 
     def default_base_query
-      GoodJob::BatchRecord.all.includes(:jobs)
+      GoodJob::BatchRecord.includes(:jobs)
     end
   end
 end

data/app/models/good_job/batch.rb

@@ -59,6 +59,10 @@ module GoodJob
       end
     end
 
+    def self.primary_key
+      :id
+    end
+
     def self.find(id)
       new _record: BatchRecord.find(id)
     end

data/app/models/good_job/cron_entry.rb

@@ -60,29 +60,15 @@ module GoodJob # :nodoc:
 
     def next_at(previously_at: nil)
       if cron_proc?
-        result = Rails.application.executor.wrap { cron.call(previously_at || last_at) }
-        return Fugit.parse(result).next_time.to_t if result.is_a?(String)
-
-        return result
-
+        result = Rails.application.executor.wrap { cron.call(previously_at || last_job_at) }
+        if result.is_a?(String)
+          Fugit.parse(result).next_time.to_t
+        else
+          result
+        end
+      else
+        fugit.next_time.to_t
       end
-      fugit.next_time.to_t
-    end
-
-    def schedule
-      return "Custom schedule" if cron_proc?
-
-      fugit.original
-    end
-
-    def jobs
-      GoodJob::Job.where(cron_key: key)
-    end
-
-    def last_at
-      return if last_job.blank?
-
-      (last_job.cron_at || last_job.created_at).localtime
     end
 
     def enabled?
@@ -113,15 +99,11 @@ module GoodJob # :nodoc:
       false
     end
 
-    def last_job
-      jobs.order("cron_at DESC NULLS LAST").first
-    end
-
     def display_properties
       {
         key: key,
         class: job_class,
-        cron: schedule,
+        cron: display_schedule,
         set: display_property(set),
         description: display_property(description),
       }.tap do |properties|
@@ -130,6 +112,24 @@ module GoodJob # :nodoc:
       end
     end
 
+    def display_schedule
+      cron_proc? ? display_property(cron) : fugit.original
+    end
+
+    def jobs
+      GoodJob::Job.where(cron_key: key)
+    end
+
+    def last_job
+      jobs.order("cron_at DESC NULLS LAST").first
+    end
+
+    def last_job_at
+      return if last_job.blank?
+
+      (last_job.cron_at || last_job.created_at).localtime
+    end
+
     private
 
     def cron
@@ -163,7 +163,7 @@ module GoodJob # :nodoc:
       case value
       when NilClass
         "None"
-      when Proc
+      when Callable
         "Lambda/Callable"
       else
         value

data/app/views/good_job/cron_entries/index.html.erb

@@ -31,7 +31,7 @@
           <div class="col-12 col-lg-2 text-wrap"><%= tag.span tag.code(cron_entry.job_class), class: "fs-5 mb-0" %></div>
           <div class="col-6 col-lg-2 text-wrap">
             <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.cron.schedule" %></div>
-            <span class="font-monospace fw-bold"><%= cron_entry.schedule %></span>
+            <span class="font-monospace fw-bold"><%= cron_entry.display_schedule %></span>
           </div>
           <div class="col-6 col-lg-2 text-wrap small">
             <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.cron.next_scheduled" %></div>
@@ -40,7 +40,7 @@
           <div class="col-6 col-lg-2 text-wrap small">
             <% if cron_entry.last_job.present? %>
               <div class="d-lg-none small text-muted mt-1"><%= t "good_job.models.cron.last_run" %></div>
-              <%= link_to relative_time(cron_entry.last_at), cron_entry_path(cron_entry), title: "Job #{cron_entry.last_job.id}" %>
+              <%= link_to relative_time(cron_entry.last_job_at), cron_entry_path(cron_entry), title: "Job #{cron_entry.last_job.id}" %>
             <% end %>
           </div>
           <div class="col d-flex gap-3 justify-content-end">

data/lib/good_job/callable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GoodJob
+  # An object that has case-equality to a Proc or Lambda by responding to #call.
+  # This can be used to duck-type match in a case statement.
+  module Callable
+    # Whether the object responds to #call
+    def self.===(other)
+      other.respond_to?(:call)
+    end
+  end
+end

data/lib/good_job/notifier.rb

@@ -24,6 +24,9 @@ module GoodJob # :nodoc:
     WAIT_INTERVAL = 1
     # Seconds to wait if database cannot be connected to
     RECONNECT_INTERVAL = 5
+    # Number of consecutive connection errors before reporting an error
+    CONNECTION_ERRORS_REPORTING_THRESHOLD = 6
+
     # Connection errors that will wait {RECONNECT_INTERVAL} before reconnecting
     CONNECTION_ERRORS = %w[
       ActiveRecord::ConnectionNotEstablished
@@ -31,7 +34,6 @@ module GoodJob # :nodoc:
       PG::UnableToSend
       PG::Error
     ].freeze
-    CONNECTION_ERRORS_REPORTING_THRESHOLD = 3
 
     # @!attribute [r] instances
     #   @!scope class
@@ -69,8 +71,8 @@ module GoodJob # :nodoc:
       @mutex = Mutex.new
       @shutdown_event = Concurrent::Event.new.tap(&:set)
       @running = Concurrent::AtomicBoolean.new(false)
-      @connected = Concurrent::AtomicBoolean.new(false)
-      @listening = Concurrent::AtomicBoolean.new(false)
+      @connected = Concurrent::Event.new
+      @listening = Concurrent::Event.new
       @connection_errors_count = Concurrent::AtomicFixnum.new(0)
       @connection_errors_reported = Concurrent::AtomicBoolean.new(false)
       @enable_listening = enable_listening
@@ -85,15 +87,25 @@ module GoodJob # :nodoc:
     end
 
     # Tests whether the notifier is active and has acquired a dedicated database connection.
+    # @param timeout [Numeric, nil] Seconds to wait for condition to be true, -1 is forever
     # @return [true, false, nil]
-    def connected?
-      @connected.true?
+    def connected?(timeout: nil)
+      if timeout.nil?
+        @connected.set?
+      else
+        @connected.wait(timeout == -1 ? nil : timeout)
+      end
     end
 
     # Tests whether the notifier is listening for new messages.
+    # @param timeout [Numeric, nil] Seconds to wait for condition to be true, -1 is forever
     # @return [true, false, nil]
-    def listening?
-      @listening.true?
+    def listening?(timeout: nil)
+      if timeout.nil?
+        @listening.set?
+      else
+        @listening.wait(timeout == -1 ? nil : timeout)
+      end
     end
 
     def shutdown?
@@ -114,11 +126,12 @@ module GoodJob # :nodoc:
 
         if @executor.shutdown? || @task&.complete?
           # clean up in the even the executor is killed
-          @connected.make_false
-          @listening.make_false
+          @connected.reset
+          @listening.reset
           @shutdown_event.set
         else
           @shutdown_event.wait(timeout == -1 ? nil : timeout) unless timeout.nil?
+          @connected.reset if @shutdown_event.set?
         end
         @shutdown_event.set?
       end
@@ -152,6 +165,7 @@ module GoodJob # :nodoc:
         if connection_error
           @connection_errors_count.increment
           if @connection_errors_reported.false? && @connection_errors_count.value >= CONNECTION_ERRORS_REPORTING_THRESHOLD
+            @connected.reset
             GoodJob._on_thread_error(thread_error)
             @connection_errors_reported.make_true
           end
@@ -180,15 +194,17 @@ module GoodJob # :nodoc:
     end
 
     def create_listen_task(delay: 0)
-      @task = Concurrent::ScheduledTask.new(delay, args: [@recipients, @running, @executor, @enable_listening, @listening], executor: @executor) do |thr_recipients, thr_running, thr_executor, thr_enable_listening, thr_listening|
+      @task = Concurrent::ScheduledTask.new(delay, args: [@recipients, @running, @executor, @enable_listening, @connected, @listening], executor: @executor) do |thr_recipients, thr_running, thr_executor, thr_enable_listening, thr_connected, thr_listening|
         with_connection do
+          thr_connected.set
+
           begin
             Rails.application.executor.wrap do
               run_callbacks :listen do
                 if thr_enable_listening
                   ActiveSupport::Notifications.instrument("notifier_listen.good_job") do
                     connection.execute("LISTEN #{CHANNEL}")
-                    thr_listening.make_true
+                    thr_listening.set
                   end
                 end
               end
@@ -216,7 +232,7 @@ module GoodJob # :nodoc:
             run_callbacks :unlisten do
               if thr_enable_listening
                 ActiveSupport::Notifications.instrument("notifier_unlisten.good_job") do
-                  thr_listening.make_false
+                  thr_listening.reset
                   connection.execute("UNLISTEN *")
                 end
               end
@@ -237,11 +253,9 @@ module GoodJob # :nodoc:
         end
       end
       connection.execute("SET application_name = #{connection.quote(self.class.name)}")
-      @connected.make_true
 
       yield
     ensure
-      @connected.make_false
       connection&.disconnect!
       self.connection = nil
     end

data/lib/good_job/probe_server.rb

@@ -37,7 +37,7 @@ module GoodJob
         started ? [200, {}, ["Started"]] : [503, {}, ["Not started"]]
       when '/status/connected'
         connected = GoodJob::Scheduler.instances.any? && GoodJob::Scheduler.instances.all?(&:running?) &&
-                    GoodJob::Notifier.instances.any? && GoodJob::Notifier.instances.all?(&:listening?)
+                    GoodJob::Notifier.instances.any? && GoodJob::Notifier.instances.all?(&:connected?)
         connected ? [200, {}, ["Connected"]] : [503, {}, ["Not connected"]]
       else
         [404, {}, ["Not found"]]

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -16,6 +16,7 @@ require "good_job/active_job_extensions/notify_options"
 
 require "good_job/assignable_connection"
 require "good_job/bulk"
+require "good_job/callable"
 require "good_job/capsule"
 require "good_job/cleanup_tracker"
 require "good_job/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.18.1
+  version: 3.18.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -122,62 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-- !ruby/object:Gem::Dependency
-  name: foreman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: gem-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -408,6 +352,7 @@ files:
 - lib/good_job/adapter.rb
 - lib/good_job/assignable_connection.rb
 - lib/good_job/bulk.rb
+- lib/good_job/callable.rb
 - lib/good_job/capsule.rb
 - lib/good_job/cleanup_tracker.rb
 - lib/good_job/cli.rb