process_bot 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9caad47714b9ab413bc33e85beb54b250455b6831ace86d058e6e63e84939bb
-  data.tar.gz: f5d294e5d78cf4bafa60d4ddca38cea9887310ed3cc517d0fbe91ff95673c5b4
+  metadata.gz: 393279b999e338c87046703fca4e6e1c22adc46ffe085a95bef758df831d3a47
+  data.tar.gz: 852bd1ad1529685294bcc54be632c444f8748490519d41fd32bd963217098ec8
 SHA512:
-  metadata.gz: ec5cdb7e07944681062b07f44408c0eb17962f4667a8215eead66a5b62ba6d0c78ffb521c431c94199fcff597bee5e5755df540687e79396cbb53df1daca5034
-  data.tar.gz: 3e21dba2ec87ef787ce3c4bf3b1d6f81273896862a04807ee48f81cc86b8e769712c1de043106c9e64cb16b6ac47f52f0a99d025614c0861ba60f4728fa1fb97
+  metadata.gz: 8e166f7a08badb085df25e770028432f4a40b5e024f7c4b363426388145e2fbce4c5b91a67e348d504c9c040b24c674ce03e1ba2c5d097d3fffa54a949549e3f
+  data.tar.gz: 1fed86f6ca3b6c6dcc579f9cbe44f2d9796b6cdc18b08227a9d03f4a3814b6b806dfa0e154a5f63e17c533496a0720ffb32b336c3e98b3f9cd84958027e97563

data/CHANGELOG.md

@@ -5,6 +5,7 @@
 - Bump version to 0.1.20.
 - Flush log output immediately so Capistrano can stream it.
 - Bump version to 0.1.21.
+- Add optional Sidekiq restart overlap and a new ProcessBot restart command.
 
 ## [0.1.0] - 2022-04-03
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    process_bot (0.1.21)
+    process_bot (0.1.22)
       knjrbfw (>= 0.0.116)
       pry
       rake

data/README.md

@@ -75,6 +75,22 @@ bundle exec process_bot --command start --log true --log-file-path /var/log/proc
 Use `process_bot:sidekiq:graceful` to wait for running jobs, and
 `process_bot:sidekiq:graceful_no_wait` to return immediately while Sidekiq drains.
 
+### Overlapping restarts
+
+You can restart Sidekiq while the old process drains by enabling overlap on the ProcessBot instance:
+
+```ruby
+set :sidekiq_restart_overlap, true
+```
+
+When enabled, `process_bot:sidekiq:restart` will use the overlap behavior.
+
+Or when running ProcessBot directly:
+
+```bash
+bundle exec process_bot --command restart --sidekiq-restart-overlap true
+```
+
 ### Capistrano logging
 
 ProcessBot logging is enabled by default in the Capistrano integration.

data/lib/process_bot/capistrano/sidekiq.rake

@@ -13,6 +13,7 @@ namespace :load do
     set :sidekiq_processes, 1
     set :sidekiq_options_per_process, nil
     set :sidekiq_user, nil
+    set :sidekiq_restart_overlap, nil
     set :process_bot_log, true
     # Rbenv, Chruby, and RVM integration
     set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a + ["sidekiq", "sidekiqctl"]
@@ -118,8 +119,27 @@ namespace :process_bot do
 
     desc "Restart Sidekiq and ProcessBot"
     task :restart do
-      invoke! "process_bot:sidekiq:stop"
-      invoke! "process_bot:sidekiq:start"
+      if fetch(:sidekiq_restart_overlap, nil)
+        on roles fetch(:sidekiq_roles) do |role|
+          git_plugin.switch_user(role) do
+            running_processes = git_plugin.running_process_bot_processes
+
+            if running_processes.any?
+              running_processes.each do |process_bot_process|
+                git_plugin.process_bot_command(process_bot_process, :restart)
+              end
+            else
+              fetch(:sidekiq_processes).times do |idx|
+                puts "Starting Sidekiq with ProcessBot #{idx}"
+                git_plugin.start_sidekiq(idx)
+              end
+            end
+          end
+        end
+      else
+        invoke! "process_bot:sidekiq:stop"
+        invoke! "process_bot:sidekiq:start"
+      end
     end
   end
 end

data/lib/process_bot/capistrano/sidekiq_helpers.rb

@@ -167,6 +167,7 @@ module ProcessBot::Capistrano::SidekiqHelpers # rubocop:disable Metrics/ModuleLe
     args += ["--sidekiq-queues", Array(fetch(:sidekiq_queue)).join(",")] if fetch(:sidekiq_queue)
     args += ["--sidekiq-config", fetch(:sidekiq_config)] if fetch(:sidekiq_config)
     args += ["--sidekiq-concurrency", fetch(:sidekiq_concurrency)] if fetch(:sidekiq_concurrency)
+    args += ["--sidekiq-restart-overlap", fetch(:sidekiq_restart_overlap)] unless fetch(:sidekiq_restart_overlap, nil).nil?
     if (process_options = fetch(:sidekiq_options_per_process))
       args += process_options[idx]
     end

data/lib/process_bot/control_socket.rb

@@ -84,7 +84,7 @@ class ProcessBot::ControlSocket
       command = JSON.parse(data)
       command_type = command.fetch("command")
 
-      if command_type == "graceful" || command_type == "graceful_no_wait" || command_type == "stop"
+      if command_type == "graceful" || command_type == "graceful_no_wait" || command_type == "restart" || command_type == "stop"
         begin
           unless process.accept_control_commands?
             client.puts(JSON.generate(type: "error", message: "ProcessBot is shutting down", backtrace: Thread.current.backtrace))

data/lib/process_bot/process/handlers/sidekiq.rb

@@ -141,8 +141,8 @@ class ProcessBot::Process::Handlers::Sidekiq
     command
   end
 
-  def graceful(**_args)
-    process.set_stopped
+  def graceful(stop_process_bot: true, **_args)
+    process.set_stopped if stop_process_bot
 
     return unless ensure_current_pid?
 
@@ -152,8 +152,8 @@ class ProcessBot::Process::Handlers::Sidekiq
     wait_for_no_jobs_and_stop_sidekiq
   end
 
-  def graceful_no_wait(**_args)
-    process.set_stopped
+  def graceful_no_wait(stop_process_bot: true, **_args)
+    process.set_stopped if stop_process_bot
 
     return unless ensure_current_pid?
 

data/lib/process_bot/process/runner_instance.rb

@@ -0,0 +1,28 @@
+class ProcessBot::Process::RunnerInstance
+  attr_reader :runner, :thread
+
+  def initialize(runner:, event_queue:, logger:)
+    @runner = runner
+    @event_queue = event_queue
+    @logger = logger
+  end
+
+  def start
+    @thread = Thread.new do
+      runner.run
+      event_queue << {type: :stopped, runner_instance: self}
+    rescue => e # rubocop:disable Style/RescueStandardError
+      logger.error e.message
+      logger.error e.backtrace
+      event_queue << {type: :error, runner_instance: self, error: e}
+    end
+  end
+
+  def running?
+    runner.running?
+  end
+
+private
+
+  attr_reader :event_queue, :logger
+end

data/lib/process_bot/process.rb

@@ -12,6 +12,7 @@ class ProcessBot::Process
 
   autoload :Handlers, "#{__dir__}/process/handlers"
   autoload :Runner, "#{__dir__}/process/runner"
+  autoload :RunnerInstance, "#{__dir__}/process/runner_instance"
 
   attr_reader :control_command_monitor, :current_pid, :current_process_title, :options, :port, :stopped
 
@@ -21,6 +22,9 @@ class ProcessBot::Process
     @accept_control_commands = true
     @control_command_monitor = Monitor.new
     @control_commands_in_flight = 0
+    @runner_events = Queue.new
+    @runner_instances = []
+    @runner_monitor = Monitor.new
 
     options.events.connect(:on_process_started, &method(:on_process_started)) # rubocop:disable Performance/MethodObjectAsBlock
     options.events.connect(:on_socket_opened, &method(:on_socket_opened)) # rubocop:disable Performance/MethodObjectAsBlock
@@ -34,7 +38,7 @@ class ProcessBot::Process
     if command == "start"
       logger.logs "Starting process"
       start
-    elsif command == "graceful" || command == "graceful_no_wait" || command == "stop"
+    elsif command == "graceful" || command == "graceful_no_wait" || command == "restart" || command == "stop"
       send_control_command(command)
     else
       raise "Unknown command: #{command}"
@@ -85,18 +89,32 @@ class ProcessBot::Process
 
   def start
     start_control_socket
+    start_runner_instance
 
     loop do
-      run
+      runner_event = runner_events.pop
+      handle_runner_event(runner_event)
 
-      if stopped
-        stop_accepting_control_commands
-        wait_for_control_commands
-        break
+      next unless stopped && runner_instances.empty?
+
+      stop_accepting_control_commands
+      wait_for_control_commands
+      break
+    end
+  end
+
+  def restart(**args)
+    logger.logs "Restart process"
+
+    if handler_name == "sidekiq"
+      if restart_overlap?(args)
+        handler_instance.graceful_no_wait(stop_process_bot: false)
+        start_runner_instance
       else
-        logger.logs "Process stopped - starting again after 1 sec"
-        sleep 1
+        handler_instance.graceful(stop_process_bot: false)
       end
+    else
+      handler_instance.stop
     end
   end
 
@@ -107,7 +125,7 @@ class ProcessBot::Process
   end
 
   def run
-    runner.run
+    start_runner_instance
   end
 
   def send_control_command(command, **command_options)
@@ -119,13 +137,7 @@ class ProcessBot::Process
   end
 
   def runner
-    @runner ||= ProcessBot::Process::Runner.new(
-      command: handler_instance.start_command,
-      handler_name: handler_name,
-      handler_instance: handler_instance,
-      logger: logger,
-      options: options
-    )
+    current_runner_instance&.runner || @runner ||= build_runner
   end
 
   def update_process_title
@@ -164,4 +176,94 @@ class ProcessBot::Process
       @control_commands_in_flight
     end
   end
+
+  def build_runner
+    ProcessBot::Process::Runner.new(
+      command: handler_instance.start_command,
+      handler_name: handler_name,
+      handler_instance: handler_instance,
+      logger: logger,
+      options: options
+    )
+  end
+
+  def start_runner_instance
+    runner_instance = ProcessBot::Process::RunnerInstance.new(
+      runner: build_runner,
+      event_queue: runner_events,
+      logger: logger
+    )
+
+    track_runner_instance(runner_instance)
+    @current_runner_instance = runner_instance
+    @runner = runner_instance.runner
+    runner_instance.start
+  end
+
+  def handle_runner_event(runner_event)
+    runner_instance = runner_event.fetch(:runner_instance)
+    remove_runner_instance(runner_instance)
+    log_runner_event_error(runner_event)
+    clear_current_runner(runner_instance)
+    restart_runner_if_needed(runner_instance)
+  end
+
+  def runner_instances
+    runner_monitor.synchronize do
+      @runner_instances.dup
+    end
+  end
+
+  def track_runner_instance(runner_instance)
+    runner_monitor.synchronize do
+      @runner_instances << runner_instance
+    end
+  end
+
+  def remove_runner_instance(runner_instance)
+    runner_monitor.synchronize do
+      @runner_instances.delete(runner_instance)
+    end
+  end
+
+  def restart_overlap?(command_options = {})
+    value = if command_options.key?(:sidekiq_restart_overlap)
+      command_options[:sidekiq_restart_overlap]
+    else
+      options[:sidekiq_restart_overlap]
+    end
+    return false if value.nil?
+    return value if value == true || value == false
+
+    normalized = value.to_s.strip.downcase
+    return false if normalized == "false" || normalized == "0" || normalized == ""
+
+    true
+  end
+
+  def log_runner_event_error(runner_event)
+    return unless runner_event.fetch(:type) == :error
+
+    logger.error "Process runner crashed: #{runner_event.fetch(:error)}"
+  end
+
+  def clear_current_runner(runner_instance)
+    return unless runner_instance == current_runner_instance
+
+    @current_runner_instance = nil
+    @runner = nil
+  end
+
+  def restart_runner_if_needed(runner_instance)
+    return if stopped
+    return unless runner_instance == current_runner_instance || current_runner_instance.nil?
+
+    logger.logs "Process stopped - starting again after 1 sec"
+    sleep 1
+    start_runner_instance
+  end
+
+private
+
+  attr_reader :current_runner_instance, :runner_events, :runner_monitor
 end

data/lib/process_bot/version.rb

@@ -1,3 +1,3 @@
 module ProcessBot
-  VERSION = "0.1.21".freeze
+  VERSION = "0.1.22".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - kaspernj
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 2026-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: knjrbfw
@@ -173,6 +173,7 @@ files:
 - lib/process_bot/process/handlers/custom.rb
 - lib/process_bot/process/handlers/sidekiq.rb
 - lib/process_bot/process/runner.rb
+- lib/process_bot/process/runner_instance.rb
 - lib/process_bot/version.rb
 - peak_flow.yml
 - process_bot.gemspec