good_job 2.9.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba4a26a2047c0e7dd8b78264fee7c6d2c05c2dd59e38f1df402b698826b56288
-  data.tar.gz: 3bd4c49139941c2d37751abb9d32808b0efd7a33370aa7370afeed21cc845ab0
+  metadata.gz: f99dea9840ebbfd8eda79dd1c06a94b7c9d8185835d6f9991e94d5a86fc5ffea
+  data.tar.gz: 148b147b8f76c74f0362dcc8b26381631e1582eae4e7ab929021a291fa7d24fa
 SHA512:
-  metadata.gz: d2ade6a5c9b26e1d9d1bc1522dc10159f78943b5da249effa1405dccf5c3de5078f74a08c27657eef63d51967bb04eb8486d933e9d817664a25c33f3740f2280
-  data.tar.gz: 40dc9f0b3b1d210ddcec9d7ce5dd7014e2409d5602bb4b3c55314b5bf799ef29fab9fd0764931c2026242c91383a335b64c4f3243ea16d50997e59ef9c7820e3
+  metadata.gz: fe4926720862cb1e42581aa612b92c46ed9a00ea183b66a6c9ee4836165a7f77aa10b78ed32c80399bdc39189f76cd5f48e7b98e3b9b7da93b0de71c8b3cd0c7
+  data.tar.gz: 1e47650d6bbdca91983bce0df607e4e4845cd26339d87798086a85f89be822987c2c41cfab08aba164f89195c55d10b3129e593b873b95dfb4075d452e3541c2

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v2.9.1](https://github.com/bensheldon/good_job/tree/v2.9.1) (2022-01-13)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.9.0...v2.9.1)
+
+**Closed issues:**
+
+- Graceful fallback to polling when LISTEN/NOTIFY isn't available [\#482](https://github.com/bensheldon/good_job/issues/482)
+- Long running locks on latest good job [\#480](https://github.com/bensheldon/good_job/issues/480)
+
+**Merged pull requests:**
+
+- Start async adapters once `ActiveRecord` and `ActiveJob` have loaded, potentially before `Rails.application.initialized?` [\#483](https://github.com/bensheldon/good_job/pull/483) ([bensheldon](https://github.com/bensheldon))
+
 ## [v2.9.0](https://github.com/bensheldon/good_job/tree/v2.9.0) (2022-01-09)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.8.1...v2.9.0)

data/README.md

@@ -142,7 +142,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
 ## Compatibility
 
 - **Ruby on Rails:** 5.2+
-- **Ruby:** MRI 2.5+. JRuby 9.2.13+ (_JRuby's `activerecord-jdbcpostgresql-adapter` gem does not support Postgres LISTEN/NOTIFY)._
+- **Ruby:** MRI 2.5+. JRuby 9.2.13+
 - **Postgres:** 9.6+
 
 ## Configuration

data/lib/good_job/adapter.rb

@@ -27,7 +27,7 @@ module GoodJob
     # @param queues [String, nil] determines which queues to execute jobs from when +execution_mode+ is set to +:async+. See {file:README.md#optimize-queues-threads-and-processes} for more details on the format of this string. You can also set this with the environment variable +GOOD_JOB_QUEUES+. Defaults to +"*"+.
     # @param poll_interval [Integer, nil] sets the number of seconds between polls for jobs when +execution_mode+ is set to +:async+. You can also set this with the environment variable +GOOD_JOB_POLL_INTERVAL+. Defaults to +1+.
     # @param start_async_on_initialize [Boolean] whether to start the async scheduler when the adapter is initialized.
-    def initialize(execution_mode: nil, queues: nil, max_threads: nil, poll_interval: nil, start_async_on_initialize: Rails.application.initialized?)
+    def initialize(execution_mode: nil, queues: nil, max_threads: nil, poll_interval: nil, start_async_on_initialize: GoodJob.async_ready?)
       @configuration = GoodJob::Configuration.new(
         {
           execution_mode: execution_mode,

data/lib/good_job/dependencies.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GoodJob # :nodoc:
+  # Extends GoodJob module to track Rails boot dependencies.
+  module Dependencies
+    extend ActiveSupport::Concern
+
+    included do
+      # @!attribute [rw] _rails_after_initialize_hook_called
+      #   @!scope class
+      #   Whether Railtie.after_initialize has been called yet (default: +false+).
+      #   This will be set on  but before +Rails.application.initialize?+ is +true+.
+      #   @return [Boolean]
+      mattr_accessor :_rails_after_initialize_hook_called, default: false
+
+      # @!attribute [rw] _active_job_loaded
+      #   @!scope class
+      #   Whether ActiveJob has loaded (default: +false+).
+      #   @return [Boolean]
+      mattr_accessor :_active_job_loaded, default: false
+
+      # @!attribute [rw] _active_record_loaded
+      #   @!scope class
+      #   Whether ActiveRecord has loaded (default: +false+).
+      #   @return [Boolean]
+      mattr_accessor :_active_record_loaded, default: false
+    end
+
+    class_methods do
+      # Whether GoodJob's  has been initialized as of the calling of +Railtie.after_initialize+.
+      # @return [Boolean]
+      def async_ready?
+        Rails.application.initialized? || (
+           _rails_after_initialize_hook_called &&
+           _active_job_loaded &&
+           _active_record_loaded
+         )
+      end
+
+      def start_async_adapters
+        return unless async_ready?
+
+        GoodJob::Adapter.instances
+                        .select(&:execute_async?)
+                        .reject(&:async_started?)
+                        .each(&:start_async)
+      end
+    end
+  end
+end

data/lib/good_job/railtie.rb

@@ -34,8 +34,27 @@ 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 its 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::Adapter.instances.each(&:start_async)
+        ActiveSupport.on_load(:active_record) do
+          GoodJob._active_record_loaded = true
+          GoodJob.start_async_adapters
+        end
+
+        ActiveSupport.on_load(:active_job) do
+          GoodJob._active_job_loaded = true
+          GoodJob.start_async_adapters
+        end
+
+        GoodJob._rails_after_initialize_hook_called = true
+        GoodJob.start_async_adapters
       end
     end
   end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -18,6 +18,8 @@ require "good_job/railtie"
 #
 # +GoodJob+ is the top-level namespace and exposes configuration attributes.
 module GoodJob
+  include GoodJob::Dependencies
+
   DEFAULT_LOGGER = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
 
   # @!attribute [rw] active_record_parent_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -421,6 +421,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/execution.rb
 - lib/good_job/execution_result.rb
 - lib/good_job/filterable.rb