process_bot 0.1.21 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9caad47714b9ab413bc33e85beb54b250455b6831ace86d058e6e63e84939bb
-  data.tar.gz: f5d294e5d78cf4bafa60d4ddca38cea9887310ed3cc517d0fbe91ff95673c5b4
+  metadata.gz: f3af0757fbd8fdac9c26eecdd368c222da9a659d491c64ee16d5d7fa0b1235c3
+  data.tar.gz: 7faf33b03baf64de58f27086351d553f0cbf777dc78b360fbcda2d9b82aecc04
 SHA512:
-  metadata.gz: ec5cdb7e07944681062b07f44408c0eb17962f4667a8215eead66a5b62ba6d0c78ffb521c431c94199fcff597bee5e5755df540687e79396cbb53df1daca5034
-  data.tar.gz: 3e21dba2ec87ef787ce3c4bf3b1d6f81273896862a04807ee48f81cc86b8e769712c1de043106c9e64cb16b6ac47f52f0a99d025614c0861ba60f4728fa1fb97
+  metadata.gz: 36f931dc6159ac509769c9e37ca8cf42972f6035ba58f1f311b105461acc7109a8a205690366b77fdb99cdd49c0ddfded4e2bcaec69c2357f32117776b5d0d35
+  data.tar.gz: 98e49815e07c19d8bc6e374577cd83236ded5f78a295fbfbf6c662317ede6403a33254b55edd564030d3c8617fa124f0fa77d72d7a18b71d3e05f60a5e932ab8

data/CHANGELOG.md

@@ -5,6 +5,8 @@
 - 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.
+- Guard stop-related process scanning when subprocess PID/PGID is unavailable and fail stop loudly.
 
 ## [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.23)
       knjrbfw (>= 0.0.116)
       pry
       rake
@@ -61,7 +61,7 @@ GEM
     rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
+    rspec-support (3.13.7)
     rubocop (1.82.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)

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

@@ -65,7 +65,11 @@ class ProcessBot::Process::Runner
   end
 
   def subprocess_pgid
-    @subprocess_pgid ||= Process.getpgid(subprocess_pid)
+    return @subprocess_pgid if instance_variable_defined?(:@subprocess_pgid)
+
+    @subprocess_pgid = Process.getpgid(subprocess_pid) if subprocess_pid
+  rescue Errno::ESRCH
+    @subprocess_pgid = nil
   end
 
   def sidekiq_app_name
@@ -74,6 +78,8 @@ class ProcessBot::Process::Runner
 
   def related_processes
     related_processes = []
+    process_group_id = subprocess_pgid
+    return related_processes unless process_group_id
 
     Knj::Unix_proc.list do |process|
       begin
@@ -82,7 +88,7 @@ class ProcessBot::Process::Runner
         # Process no longer running
       end
 
-      related_processes << process if subprocess_pgid == process_pgid
+      related_processes << process if process_group_id == process_pgid
     end
 
     related_processes
@@ -90,6 +96,8 @@ class ProcessBot::Process::Runner
 
   def related_sidekiq_processes
     related_sidekiq_processes = []
+    process_group_id = subprocess_pgid
+    return related_sidekiq_processes unless process_group_id
 
     Knj::Unix_proc.list("grep" => "sidekiq") do |process|
       cmd = process.data.fetch("cmd")
@@ -103,7 +111,7 @@ class ProcessBot::Process::Runner
           # Process no longer running
         end
 
-        related_sidekiq_processes << process if subprocess_pgid == sidekiq_pgid
+        related_sidekiq_processes << process if process_group_id == sidekiq_pgid
       end
     end
 
@@ -111,6 +119,8 @@ class ProcessBot::Process::Runner
   end
 
   def stop_related_processes
+    ensure_subprocess_pgid_for_stop!
+
     loop do
       processes = related_processes
 
@@ -128,6 +138,12 @@ class ProcessBot::Process::Runner
     end
   end
 
+  def ensure_subprocess_pgid_for_stop!
+    return if subprocess_pgid
+
+    raise "Unable to stop related processes because subprocess PGID could not be resolved (subprocess PID: #{subprocess_pid.inspect})"
+  end
+
   def find_sidekiq_pid
     Thread.new do
       wait_for_sidekiq_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.23".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.23
 platform: ruby
 authors:
 - kaspernj
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 2026-02-11 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