good_job 3.27.2 → 3.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f1caf94daea82b4e273aeaa01d2a44def87934a36275fbe5ca007a27bfceb4d
-  data.tar.gz: ad46d59cc2166d6386a17a3d0924f27f81c16e1670121b7f252ec9515da4b011
+  metadata.gz: 31870d7c454658e1b6b3865535a8af35898f6ac3a1b4e9112da7a485a97506a1
+  data.tar.gz: 9776e26adab4e551c10351b33ef223c16340440ad9e9189eecff533aa5583d62
 SHA512:
-  metadata.gz: 0c2be38cdbbfc7bb63f65451efc85ac51519f1ebabe7f9324ff5a652344b2e06fb75e93a0f0db0cda5038cf562ea793cf5eab6022cc219a304cab5be42b8dd0c
-  data.tar.gz: fe5e5d39d0f02a071d8906b155bac1b9467167565544595c38932870e85aff88569b5c9194ea20cf8ea403c134b3a8833e5075e3c8c0bda51982ddea31e6c406
+  metadata.gz: 2e8cd2f1e317f5f6421a4a50ce5a3c0af8f0e51199eb5a0c8db0d93f9f5a1d7ded7d621cf79498e756e7c9dbe7c72da24830706975e59a20c0c0b6852c3d60b9
+  data.tar.gz: a852a1e0de8dbfaac4b00baa4aa74672846364b617fb392d12a3bbdb0394be1e8183d9cf44d1ced788ba79b05bbe7ab3a986b57dfa67d38873d82cf627ae098a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v3.27.3](https://github.com/bensheldon/good_job/tree/v3.27.3) (2024-03-29)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.27.2...v3.27.3)
+
+**Merged pull requests:**
+
+- Revert "Start async adapters `after_initialize` instead of once Active Job and Active Record are loaded and Rails initialized?" [\#1303](https://github.com/bensheldon/good_job/pull/1303) ([bensheldon](https://github.com/bensheldon))
+
 ## [v3.27.2](https://github.com/bensheldon/good_job/tree/v3.27.2) (2024-03-27)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.27.1...v3.27.2)

data/lib/good_job/adapter.rb

@@ -30,7 +30,7 @@ module GoodJob
       GoodJob::Configuration.validate_execution_mode(@_execution_mode_override) if @_execution_mode_override
       @capsule = _capsule
 
-      start_async if GoodJob._async_ready?
+      start_async if GoodJob.async_ready?
       self.class.instances << self
     end
 

data/lib/good_job/dependencies.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GoodJob # :nodoc:
+  # Extends GoodJob module to track Rails boot dependencies.
+  module Dependencies
+    extend ActiveSupport::Concern
+
+    included do
+      mattr_accessor :_framework_ready, default: false
+    end
+
+    class_methods do
+      # Whether Rails framework has sufficiently initialized to enable Async execution.
+      def async_ready?
+        Rails.application.initialized? || _framework_ready
+      end
+
+      def _start_async_adapters
+        return unless async_ready?
+
+        ActiveJob::Base.queue_adapter # Ensure Active Job is initialized
+        GoodJob::Adapter.instances
+                        .select(&:execute_async?)
+                        .reject(&:async_started?)
+                        .each(&:start_async)
+      end
+    end
+  end
+end

data/lib/good_job/engine.rb

@@ -49,17 +49,22 @@ module GoodJob
     end
 
     initializer "good_job.start_async" do
+      # This hooks into the hookable places during Rails boot, which is unfortunately not Rails.application.initialized?
+      # If an Adapter is initialized during boot, we want to want to start async executors once the framework dependencies have loaded.
+      # When exactly that happens is out of our control because gems or application code may touch things earlier than expected.
+      # For example, as of Rails 6.1, if an ActiveRecord model is touched during boot, that triggers ActiveRecord to load,
+      # which touches DestroyAssociationAsyncJob, which loads ActiveJob, which may initialize a GoodJob::Adapter, all of which
+      # happens _before_ ActiveRecord finishes loading. GoodJob will deadlock if an async executor is started in the middle of
+      # ActiveRecord loading.
       config.after_initialize do
-        GoodJob._async_ready = true
-
-        # Ensure Active Record and Active Job are fully loaded
-        ActiveRecord::Base # rubocop:disable Lint/Void
-        ActiveJob::Base.queue_adapter
-
-        GoodJob::Adapter.instances
-                        .select(&:execute_async?)
-                        .reject(&:async_started?)
-                        .each(&:start_async)
+        ActiveSupport.on_load(:active_record) do
+          ActiveSupport.on_load(:active_job) do
+            GoodJob._framework_ready = true
+            GoodJob._start_async_adapters
+          end
+          GoodJob._start_async_adapters
+        end
+        GoodJob._start_async_adapters
       end
     end
   end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -25,6 +25,7 @@ require_relative "good_job/configuration"
 require_relative "good_job/cron_manager"
 require_relative "good_job/current_thread"
 require_relative "good_job/daemon"
+require_relative "good_job/dependencies"
 require_relative "good_job/job_performer"
 require_relative "good_job/job_performer/metrics"
 require_relative "good_job/log_subscriber"
@@ -45,6 +46,7 @@ require_relative "good_job/thread_status"
 #
 # +GoodJob+ is the top-level namespace and exposes configuration attributes.
 module GoodJob
+  include GoodJob::Dependencies
   include GoodJob::ThreadStatus
 
   # Default, null, blank value placeholder.
@@ -112,11 +114,6 @@ module GoodJob
   #   @return [GoodJob::Capsule, nil]
   mattr_accessor :capsule, default: GoodJob::Capsule.new(configuration: configuration)
 
-  mattr_accessor :_async_ready, default: false
-  def self._async_ready?
-    _async_ready
-  end
-
   # Called with exception when a GoodJob thread raises an exception
   # @param exception [Exception] Exception that was raised
   # @return [void]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.27.2
+  version: 3.27.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -404,6 +404,7 @@ files:
 - lib/good_job/cron_manager.rb
 - lib/good_job/current_thread.rb
 - lib/good_job/daemon.rb
+- lib/good_job/dependencies.rb
 - lib/good_job/engine.rb
 - lib/good_job/interrupt_error.rb
 - lib/good_job/job_performer.rb