Extract Timer for Supervisor's timed tasks

Author: rosa

lib/solid_queue/supervisor.rb

@@ -9,12 +9,12 @@ def start(mode: :fork, load_configuration_from: nil)
         SolidQueue.supervisor = true
         configuration = Configuration.new(load_from: load_configuration_from)
 
-        Forks.new(*configuration.processes).start
+        Forks.new(configuration).start
       end
     end
 
-    def initialize(*configuration)
-      @configuration = Array(configuration)
+    def initialize(configuration)
+      @configuration = configuration
       @processes = {}
     end
 
@@ -26,7 +26,7 @@ def start
 
       supervise
     rescue GracefulTerminationRequested
-      graceful_termination
+      terminate_gracefully
     rescue ImmediateTerminationRequested
       immediate_termination
     ensure
@@ -43,7 +43,7 @@ def boot
       end
 
       def start_processes
-        configuration.each { |configured_process| start_process(configured_process) }
+        configuration.processes.each { |configured_process| start_process(configured_process) }
       end
 
       def supervise
@@ -79,11 +79,11 @@ def shutdown
         delete_pidfile
       end
 
-      def graceful_termination
+      def terminate_gracefully
         SolidQueue.instrument(:graceful_termination, supervisor_pid: ::Process.pid, supervised_processes: processes.keys) do |payload|
           term_processes
 
-          wait_until(SolidQueue.shutdown_timeout, -> { all_processes_terminated? }) do
+          Timer.wait_until(SolidQueue.shutdown_timeout, -> { all_processes_terminated? }) do
             reap_terminated_processes
           end
 
@@ -103,25 +103,5 @@ def immediate_termination
       def delete_pidfile
         @pidfile&.delete
       end
-
-      def wait_until(timeout, condition, &block)
-        if timeout > 0
-          deadline = monotonic_time_now + timeout
-
-          while monotonic_time_now < deadline && !condition.call
-            sleep 0.1
-            block.call
-          end
-        else
-          while !condition.call
-            sleep 0.5
-            block.call
-          end
-        end
-      end
-
-      def monotonic_time_now
-        ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      end
   end
 end

lib/solid_queue/supervisor/maintenance.rb

@@ -2,25 +2,26 @@ module SolidQueue
   module Supervisor::Maintenance
     extend ActiveSupport::Concern
 
-      private
-        def launch_maintenance_task
-          @maintenance_task = Concurrent::TimerTask.new(run_now: true, execution_interval: SolidQueue.process_alive_threshold) do
-            prune_dead_processes
-            release_orphaned_executions
-          end
-          @maintenance_task.execute
-        end
+    private
 
-        def stop_maintenance_task
-          @maintenance_task&.shutdown
-        end
+    def launch_maintenance_task
+      @maintenance_task = Concurrent::TimerTask.new(run_now: true, execution_interval: SolidQueue.process_alive_threshold) do
+        prune_dead_processes
+        release_orphaned_executions
+      end
+      @maintenance_task.execute
+    end
+
+    def stop_maintenance_task
+      @maintenance_task&.shutdown
+    end
 
-        def prune_dead_processes
-          wrap_in_app_executor { SolidQueue::Process.prune }
-        end
+    def prune_dead_processes
+      wrap_in_app_executor { SolidQueue::Process.prune }
+    end
 
-        def release_orphaned_executions
-          wrap_in_app_executor { SolidQueue::ClaimedExecution.orphaned.release_all }
-        end
+    def release_orphaned_executions
+      wrap_in_app_executor { SolidQueue::ClaimedExecution.orphaned.release_all }
     end
+  end
 end

lib/solid_queue/timer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidQueue
+  module Timer
+    extend self
+
+    def wait_until(timeout, condition, &block)
+      if timeout > 0
+        deadline = monotonic_time_now + timeout
+
+        while monotonic_time_now < deadline && !condition.call
+          sleep 0.1
+          block.call
+        end
+      else
+        while !condition.call
+          sleep 0.5
+          block.call
+        end
+      end
+    end
+
+    private
+      def monotonic_time_now
+        ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      end
+  end
+end

test/integration/puma/plugin_test.rb

@@ -52,7 +52,7 @@ class PumaPluginTest < ActiveSupport::TestCase
   end
 
   test "stop puma when solid queue's supervisor dies" do
-    supervisor = find_processes_registered_as("Supervisor").first
+    supervisor = find_processes_registered_as("Supervisor(forks)").first
 
     signal_process(supervisor.pid, :KILL)
     wait_for_process_termination_with_timeout(@pid)

test/unit/supervisor_test.rb

@@ -140,7 +140,7 @@ def assert_registered_dispatcher(supervisor_pid:, **metadata)
 
     def assert_registered_supervisor(pid)
       skip_active_record_query_cache do
-        processes = find_processes_registered_as("Supervisor")
+        processes = find_processes_registered_as("Supervisor(forks)")
         assert_equal 1, processes.count
         assert_nil processes.first.supervisor
         assert_equal pid, processes.first.pid