Worker, Scheduler, and Dispatcher now respect active zone

flavorjones · flavorjones · commit 53add2a2edd6 · 2025-06-08T22:27:16.000-04:00
Note that this pins Rails to a version with ActiveSupport::ReplicationCoordinator see basecamp/rails#35
diff --git a/Gemfile b/Gemfile
@@ -3,3 +3,5 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Specify your gem's dependencies in solid_queue.gemspec.
 gemspec
+
+gem "rails", github: "basecamp/rails", branch: "flavorjones/replication-coordinator"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,68 +1,129 @@
-PATH
-  remote: .
+GIT
+  remote: https://github.com/basecamp/rails.git
+  revision: ed57fc7a886571f10657b0322a8846c09ba29d73
+  branch: flavorjones/replication-coordinator
   specs:
-    solid_queue (1.1.5)
-      activejob (>= 7.1)
-      activerecord (>= 7.1)
-      concurrent-ruby (>= 1.3.1)
-      fugit (~> 1.11.0)
-      railties (>= 7.1)
-      thor (~> 1.3.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (7.1.5.1)
-      actionview (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
+    actioncable (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      activejob (= 8.1.0.alpha)
+      activerecord (= 8.1.0.alpha)
+      activestorage (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      mail (>= 2.8.0)
+    actionmailer (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      actionview (= 8.1.0.alpha)
+      activejob (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.1.0.alpha)
+      actionview (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
       nokogiri (>= 1.8.5)
-      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.5.1)
-      activesupport (= 7.1.5.1)
+      useragent (~> 0.16)
+    actiontext (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      activerecord (= 8.1.0.alpha)
+      activestorage (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.1.5.1)
-      activesupport (= 7.1.5.1)
+    activejob (8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
       globalid (>= 0.3.6)
-    activemodel (7.1.5.1)
-      activesupport (= 7.1.5.1)
-    activerecord (7.1.5.1)
-      activemodel (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
+    activemodel (8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+    activerecord (8.1.0.alpha)
+      activemodel (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
       timeout (>= 0.4.0)
-    activesupport (7.1.5.1)
+    activestorage (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      activejob (= 8.1.0.alpha)
+      activerecord (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      marcel (~> 1.0)
+    activesupport (8.1.0.alpha)
       base64
       benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
       logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
       securerandom (>= 0.3)
-      tzinfo (~> 2.0)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    rails (8.1.0.alpha)
+      actioncable (= 8.1.0.alpha)
+      actionmailbox (= 8.1.0.alpha)
+      actionmailer (= 8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      actiontext (= 8.1.0.alpha)
+      actionview (= 8.1.0.alpha)
+      activejob (= 8.1.0.alpha)
+      activemodel (= 8.1.0.alpha)
+      activerecord (= 8.1.0.alpha)
+      activestorage (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      bundler (>= 1.15.0)
+      railties (= 8.1.0.alpha)
+    railties (8.1.0.alpha)
+      actionpack (= 8.1.0.alpha)
+      activesupport (= 8.1.0.alpha)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+
+PATH
+  remote: .
+  specs:
+    solid_queue (1.1.5)
+      activejob (>= 7.1)
+      activerecord (>= 7.1)
+      concurrent-ruby (>= 1.3.1)
+      fugit (~> 1.11.0)
+      railties (>= 7.1)
+      thor (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
     ast (2.4.2)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     builder (3.3.0)
     concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
+    connection_pool (2.5.3)
     crass (1.0.6)
     date (3.4.1)
     debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    drb (2.2.1)
+    drb (2.2.3)
     erubi (1.13.1)
     et-orbi (1.2.11)
       tzinfo
@@ -71,7 +132,7 @@ GEM
       raabro (~> 1.4)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.6)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-console (0.8.0)
     irb (1.14.3)
@@ -83,17 +144,28 @@ GEM
     loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
     mini_portile2 (2.8.8)
     minitest (5.25.4)
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
-    mutex_m (0.3.0)
     mysql2 (0.5.6)
+    net-imap (0.5.8)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.0-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.0-x86_64-darwin)
-      racc (~> 1.4)
     nokogiri (1.18.0-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -109,7 +181,8 @@ GEM
     raabro (1.4.0)
     racc (1.8.1)
     rack (3.1.8)
-    rack-session (2.0.0)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
       rack (>= 3.0.0)
     rack-test (2.2.0)
       rack (>= 1.3)
@@ -122,14 +195,6 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (7.1.5.1)
-      actionpack (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
-      irb
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
     rdoc (6.8.1)
@@ -178,6 +243,12 @@ GEM
     unicode-display_width (3.1.3)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     zeitwerk (2.6.0)
 
 PLATFORMS
@@ -195,6 +266,7 @@ DEPENDENCIES
   mysql2
   pg
   puma
+  rails!
   rdoc
   rubocop-rails-omakase
   solid_queue!
diff --git a/lib/solid_queue/dispatcher.rb b/lib/solid_queue/dispatcher.rb
@@ -3,10 +3,16 @@
 module SolidQueue
   class Dispatcher < Processes::Poller
     include LifecycleHooks
+    include Processes::Standby
+
     attr_reader :batch_size
 
     after_boot :run_start_hooks
-    after_boot :start_concurrency_maintenance
+    after_boot do
+      on_active_zone { start_concurrency_maintenance }
+      on_active_zone { wake_up }
+      on_passive_zone { stop_concurrency_maintenance }
+    end
     before_shutdown :stop_concurrency_maintenance
     before_shutdown :run_stop_hooks
     after_shutdown :run_exit_hooks
@@ -29,9 +35,13 @@ def metadata
       attr_reader :concurrency_maintenance
 
       def poll
-        batch = dispatch_next_batch
+        if active_zone?
+          batch = dispatch_next_batch
 
-        batch.zero? ? polling_interval : 0.seconds
+          batch.zero? ? polling_interval : 0.seconds
+        else
+          replication_coordinator.polling_interval
+        end
       end
 
       def dispatch_next_batch
diff --git a/lib/solid_queue/processes/standby.rb b/lib/solid_queue/processes/standby.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SolidQueue::Processes
+  module Standby
+    extend ActiveSupport::Concern
+
+    delegate :on_active_zone, to: :replication_coordinator
+    delegate :on_passive_zone, to: :replication_coordinator
+    delegate :active_zone?, to: :replication_coordinator
+
+    def replication_coordinator
+      Rails.application.config.replication_coordinator
+    end
+
+    included do
+      on_start { |process| process.replication_coordinator.start_monitoring }
+      on_stop { |process| process.replication_coordinator.stop_monitoring }
+    end
+  end
+end
diff --git a/lib/solid_queue/scheduler.rb b/lib/solid_queue/scheduler.rb
@@ -4,11 +4,15 @@ module SolidQueue
   class Scheduler < Processes::Base
     include Processes::Runnable
     include LifecycleHooks
+    include Processes::Standby
 
     attr_reader :recurring_schedule
 
     after_boot :run_start_hooks
-    after_boot :schedule_recurring_tasks
+    after_boot do
+      on_active_zone { schedule_recurring_tasks }
+      on_passive_zone { unschedule_recurring_tasks }
+    end
     before_shutdown :unschedule_recurring_tasks
     before_shutdown :run_stop_hooks
     after_shutdown :run_exit_hooks
diff --git a/lib/solid_queue/worker.rb b/lib/solid_queue/worker.rb
@@ -3,8 +3,10 @@
 module SolidQueue
   class Worker < Processes::Poller
     include LifecycleHooks
+    include Processes::Standby
 
     after_boot :run_start_hooks
+    after_boot { on_active_zone { wake_up } }
     before_shutdown :run_stop_hooks
     after_shutdown :run_exit_hooks
 
@@ -27,9 +29,13 @@ def metadata
 
     private
       def poll
-        post_executions
+        if active_zone?
+          post_executions
 
-        pool.idle? ? polling_interval : 10.minutes
+          pool.idle? ? polling_interval : 10.minutes
+        else
+          replication_coordinator.polling_interval
+        end
       end
 
       def post_executions
diff --git a/test/unit/dispatcher_test.rb b/test/unit/dispatcher_test.rb
diff --git a/test/unit/scheduler_test.rb b/test/unit/scheduler_test.rb
diff --git a/test/unit/worker_test.rb b/test/unit/worker_test.rb
