good_job 3.27.1 → 3.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f6e4655250d166696f48733e756d69164f1c1b6371d925fa5333fd538c7850c
-  data.tar.gz: c65cd8ace06f23e8647ff6747eb754151a39a732a7ac9cb79534573016f20b87
+  metadata.gz: 31870d7c454658e1b6b3865535a8af35898f6ac3a1b4e9112da7a485a97506a1
+  data.tar.gz: 9776e26adab4e551c10351b33ef223c16340440ad9e9189eecff533aa5583d62
 SHA512:
-  metadata.gz: 1bb8b51381b2e61dcb024d15fd555f2cc36a5dbd1abb0439b20e8db182c332f136be433108a07cc0fdfcc7a2321035f1136676833a81387783694db5a9c6ea32
-  data.tar.gz: 1054014eb0dea19141fde93ef3a99b6533804f9f5714a97be43bb9bf57183297371df458f7ac55c0c77fd3bf7d8504d49c980d9ed5f5b94f378f1468356d6c68
+  metadata.gz: 2e8cd2f1e317f5f6421a4a50ce5a3c0af8f0e51199eb5a0c8db0d93f9f5a1d7ded7d621cf79498e756e7c9dbe7c72da24830706975e59a20c0c0b6852c3d60b9
+  data.tar.gz: a852a1e0de8dbfaac4b00baa4aa74672846364b617fb392d12a3bbdb0394be1e8183d9cf44d1ced788ba79b05bbe7ab3a986b57dfa67d38873d82cf627ae098a

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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)
+
+**Fixed bugs:**
+
+- Use scope-resolutioned constants in Notifier loop [\#1300](https://github.com/bensheldon/good_job/pull/1300) ([bensheldon](https://github.com/bensheldon))
+- Invoke inline Bootstrap Color Mode javascript above CSS link tag to better avoid flash of un-themed content [\#1298](https://github.com/bensheldon/good_job/pull/1298) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Buggy theme animation while switching tabs [\#1224](https://github.com/bensheldon/good_job/issues/1224)
+
 ## [v3.27.1](https://github.com/bensheldon/good_job/tree/v3.27.1) (2024-03-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.27.0...v3.27.1)

data/README.md

@@ -11,6 +11,8 @@ GoodJob is a multithreaded, Postgres-based, Active Job backend for Ruby on Rails
 - **Designed for Active Job.** Complete support for [async, queues, delays, priorities, timeouts, and retries](https://edgeguides.rubyonrails.org/active_job_basics.html) with near-zero configuration.
 - **Built for Rails.** Fully adopts Ruby on Rails [threading and code execution guidelines](https://guides.rubyonrails.org/threading_and_code_execution.html) with [Concurrent::Ruby](https://github.com/ruby-concurrency/concurrent-ruby).
 - **Backed by Postgres.** Relies upon Postgres integrity, session-level Advisory Locks to provide run-once safety and stay within the limits of `schema.rb`, and LISTEN/NOTIFY to reduce queuing latency.
+- **Fully featured.** Includes support for cron-like scheduled jobs, batches, concurrency and throttling controls, and a powerful Web Dashboard (check out the [Demo](https://goodjob-demo.herokuapp.com/)).
+- **Flexible and lightweight.** Safely runnable within a single existing web process or scaled via an independent CLI process across development, test, and production environments.
 - **For most workloads.** Targets full-stack teams, economy-minded solo developers, and applications that enqueue 1-million jobs/day and more.
 
 For more of the story of GoodJob, read the [introductory blog post](https://island94.org/2020/07/introducing-goodjob-1-0).
@@ -21,6 +23,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
 |                 | Queues, priority, retries | Database                              | Concurrency       | Reliability/Integrity  | Latency                  |
 |-----------------|---------------------------|---------------------------------------|-------------------|------------------------|--------------------------|
 | **GoodJob**     | ✅ Yes                     | ✅ Postgres                            | ✅ Multithreaded   | ✅ ACID, Advisory Locks | ✅ Postgres LISTEN/NOTIFY |
+| **Solid Queue** | ✅ Yes                     | ✅ Postgres and other databases ✨     | 🔶 Multithreaded in forked process   | ✅ ACID, Advisory Locks | 🔶 Polling |
 | **Que**         | ✅ Yes                     | 🔶️ Postgres, requires  `structure.sql` | ✅ Multithreaded   | ✅ ACID, Advisory Locks | ✅ Postgres LISTEN/NOTIFY |
 | **Delayed Job** | ✅ Yes                     | ✅ Postgres                            | 🔴 Single-threaded | ✅ ACID, record-based   | 🔶 Polling                |
 | **Sidekiq**     | ✅ Yes                     | 🔴 Redis                               | ✅ Multithreaded   | 🔴 Crashes lose jobs    | ✅ Redis BRPOP            |

data/app/views/layouts/good_job/application.html.erb

@@ -6,6 +6,20 @@
     <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
+
+    <%# Bootstrap Color Modes
+      "It is suggested to include the JavaScript at the top of your page
+      to reduce potential screen flickering during reloading of your site."
+      https://getbootstrap.com/docs/5.3/customize/color-modes/#javascript
+    %>
+    <%= tag.script "", nonce: content_security_policy_nonce do %>
+      let theme = localStorage.getItem('good_job-theme');
+      if (!["light", "dark"].includes(theme)) {
+        theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+      }
+      document.documentElement.setAttribute('data-bs-theme', theme);
+    <% end %>
+
     <%# Do not use asset tag helpers to avoid paths being overriden by config.asset_host %>
     <%= tag.link rel: "stylesheet", href: frontend_static_path(:bootstrap, format: :css, v: GoodJob::VERSION, locale: nil), nonce: content_security_policy_nonce %>
     <%= tag.link rel: "stylesheet", href: frontend_static_path(:style, format: :css, v: GoodJob::VERSION, locale: nil), nonce: content_security_policy_nonce %>
@@ -16,14 +30,6 @@
     <% importmaps = GoodJob::FrontendsController.js_modules.keys.index_with { |module_name| frontend_module_path(module_name, format: :js, locale: nil, v: GoodJob::VERSION) } %>
     <%= tag.script({ imports: importmaps }.to_json.html_safe, type: "importmap", nonce: content_security_policy_nonce) %>
     <%= tag.script "", type: "module", nonce: content_security_policy_nonce do %> import "application"; <% end %>
-    <%= tag.script "", nonce: content_security_policy_nonce do %>
-      // Ensure theme is updated before dom loads to avoid flash of style
-      let theme = localStorage.getItem('good_job-theme');
-      if (!["light", "dark"].includes(theme)) {
-      theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
-      }
-      document.documentElement.setAttribute('data-bs-theme', theme);
-    <% end %>
   </head>
   <body>
     <div class="d-flex flex-column min-vh-100">

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/notifier.rb

@@ -50,7 +50,7 @@ module GoodJob # :nodoc:
     # Send a message via Postgres NOTIFY
     # @param message [#to_json]
     def self.notify(message)
-      connection = Execution.connection
+      connection = ::GoodJob::Execution.connection
       connection.exec_query <<~SQL.squish
         NOTIFY #{CHANNEL}, #{connection.quote(message.to_json)}
       SQL
@@ -248,8 +248,8 @@ module GoodJob # :nodoc:
 
     def with_connection
       Rails.application.executor.wrap do
-        self.connection = Execution.connection_pool.checkout.tap do |conn|
-          Execution.connection_pool.remove(conn)
+        self.connection = ::GoodJob::Execution.connection_pool.checkout.tap do |conn|
+          ::GoodJob::Execution.connection_pool.remove(conn)
         end
       end
       connection.execute("SET application_name = #{connection.quote(self.class.name)}")

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.27.1'
+  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.1
+  version: 3.27.3
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-24 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