process_bot 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29f1d0a6e2f8360306d132467bcb8b562d126f799dd9d4fbc510128b58ef2f44
-  data.tar.gz: 67cfeb1bb088f7b8acaa543e216a365566993aea81fae49366cc4f19510b54c8
+  metadata.gz: 074d3e8a15a3340496bf231b14a3a8ca664bd8c96c22372ee9bf2251740e8eda
+  data.tar.gz: 2696dbf343af1d30ca5b4c34b14f69c6278e4d441728b8454943426fe3872112
 SHA512:
-  metadata.gz: 0a205be1611136f88f7bb5165f2db1a8296b2bc8a1eec383dcf7b32324a6d8ba98e824b9c29f9c1818b24b412b1964d88ba11ab60e56f291d97279b291140c49
-  data.tar.gz: b045d94ae4d0d4c92ae6f919411e0fbf33e44ddb4a0606515439c6e0313f73538baaa8674191fb5d37dcf89b81971a509d58007c8ea9d041b30b74d27fdadc2f
+  metadata.gz: 2c3d186e16d47a402c01d2e8b1468f814185662a397785cc4ced9f9cacd379b32dc67cf76f12e32d732184e91a361619f773163b1a701baada52f62d6c952291
+  data.tar.gz: 8763c67b5f30f9fef7f71f739802560b500f23b158b5d8d34cff49c9077f6cfcc06ab24d03c74a4e776aa3c13a0a27fbb4d576fa4a8a8262cc701a1f92c2b893

data/AGENTS.md

@@ -0,0 +1,15 @@
+# AGENTS
+
+## Notes
+- Added an internal logging toggle via `--log`/`--logging` and routed internal actions through the logger.
+- Added log lines for client connections, command sends, and signal handling.
+- Documented logging usage in `README.md`.
+- Branch: logging-toggle
+- PR: https://github.com/kaspernj/process_bot/pull/164
+- Made graceful shutdown waiting optional and defaulted Capistrano to not wait.
+- Kept graceful handling synchronous and verified `bundle exec rspec`.
+- Enabled ProcessBot logging by default for Capistrano hooks (configurable via `process_bot_log`).
+- Always run RuboCop against changed or created Ruby files.
+- Added `graceful_no_wait` command and Capistrano task for non-blocking graceful shutdowns.
+- Always add or update tests for new/changed functionality, and run them.
+- Added coverage for graceful_no_wait and Capistrano wait defaults.

data/Gemfile.lock

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

data/README.md

@@ -46,6 +46,43 @@ ProcessBot provides these Sidekiq tasks:
 - `process_bot:sidekiq:graceful_no_wait` (stops fetching new jobs and returns immediately)
 - `process_bot:sidekiq:restart`
 
+You can also skip waiting for graceful completion:
+
+```bash
+cap production process_bot:sidekiq:graceful_no_wait
+```
+
+### Logging
+
+ProcessBot can log its internal actions (connecting, sending commands, signals, etc.) to stdout.
+Enable this with `--log true` (or `--logging true`):
+
+```bash
+bundle exec process_bot --command start --log true
+bundle exec process_bot --command graceful --log true
+bundle exec process_bot --command graceful_no_wait --log true
+```
+
+To write logs to a file, add `--log-file-path`:
+
+```bash
+bundle exec process_bot --command start --log true --log-file-path /var/log/process_bot.log
+```
+
+### Graceful shutdown waiting
+
+Use `process_bot:sidekiq:graceful` to wait for running jobs, and
+`process_bot:sidekiq:graceful_no_wait` to return immediately while Sidekiq drains.
+
+### Capistrano logging
+
+ProcessBot logging is enabled by default in the Capistrano integration.
+You can override it with:
+
+```ruby
+set :process_bot_log, false
+```
+
 ### CLI options
 
 When running ProcessBot directly, you can control graceful waiting and log file output:

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 :process_bot_log, true
     # Rbenv, Chruby, and RVM integration
     set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a + ["sidekiq", "sidekiqctl"]
     set :rvm_map_bins, fetch(:rvm_map_bins).to_a + ["sidekiq", "sidekiqctl"]
@@ -35,6 +36,17 @@ namespace :process_bot do
       end
     end
 
+    desc "Stop Sidekiq and ProcessBot gracefully without waiting for completion"
+    task :graceful_no_wait do
+      on roles fetch(:sidekiq_roles) do |role|
+        git_plugin.switch_user(role) do
+          git_plugin.running_process_bot_processes.each do |process_bot_process|
+            git_plugin.process_bot_command(process_bot_process, :graceful_no_wait)
+          end
+        end
+      end
+    end
+
     desc "Stop Sidekiq and ProcessBot (graceful shutdown within timeout, put unfinished tasks back to Redis)"
     task :stop do
       on roles fetch(:sidekiq_roles) do |role|

data/lib/process_bot/capistrano/sidekiq_helpers.rb

@@ -36,13 +36,13 @@ module ProcessBot::Capistrano::SidekiqHelpers # rubocop:disable Metrics/ModuleLe
     raise "No port in process bot data? #{process_bot_data}" unless process_bot_data["port"]
 
     mode = "exec"
+    wait_for_gracefully_stopped = process_bot_wait_setting(command)
 
     if mode == "runner"
       args = {command: command, port: process_bot_data.fetch("port")}
+      args["log"] = fetch(:process_bot_log) unless fetch(:process_bot_log).nil?
 
-      if command == :graceful && !fetch(:process_bot_wait_for_gracefully_stopped).nil?
-        args["wait_for_gracefully_stopped"] = fetch(:process_bot_wait_for_gracefully_stopped)
-      end
+      args["wait_for_gracefully_stopped"] = wait_for_gracefully_stopped unless wait_for_gracefully_stopped.nil?
 
       escaped_args = JSON.generate(args).gsub("\"", "\\\"")
       rails_runner_command = "require 'process_bot'; ProcessBot::Process.new(ProcessBot::Options.from_args(#{escaped_args})).execute!"
@@ -55,13 +55,13 @@ module ProcessBot::Capistrano::SidekiqHelpers # rubocop:disable Metrics/ModuleLe
         "--command #{command} " \
         "--port #{process_bot_data.fetch("port")}"
 
+      backend_command << " --log #{fetch(:process_bot_log)}" unless fetch(:process_bot_log).nil?
+
       args.each do |key, value|
         backend_command << "#{key} #{value}"
       end
 
-      if command == :graceful && !fetch(:process_bot_wait_for_gracefully_stopped).nil?
-        backend_command << " --wait-for-gracefully-stopped #{fetch(:process_bot_wait_for_gracefully_stopped)}"
-      end
+      backend_command << " --wait-for-gracefully-stopped #{wait_for_gracefully_stopped}" unless wait_for_gracefully_stopped.nil?
     else
       raise "Unknown mode: #{mode}"
     end
@@ -69,6 +69,13 @@ module ProcessBot::Capistrano::SidekiqHelpers # rubocop:disable Metrics/ModuleLe
     backend.execute backend_command
   end
 
+  def process_bot_wait_setting(command)
+    return true if command == :graceful
+    return false if command == :graceful_no_wait
+
+    nil
+  end
+
   def running_process_bot_processes
     sidekiq_app_name = fetch(:sidekiq_app_name, fetch(:application))
     raise "No :sidekiq_app_name was set" unless sidekiq_app_name

data/lib/process_bot/client_socket.rb

@@ -8,7 +8,10 @@ class ProcessBot::ClientSocket
   end
 
   def client
-    @client ||= Socket.tcp("localhost", options.fetch(:port).to_i, connect_timeout: 2)
+    return @client if @client
+
+    logger.logs "Connecting to process on port #{options.fetch(:port)}"
+    @client = Socket.tcp("localhost", options.fetch(:port).to_i, connect_timeout: 2)
   end
 
   def close

data/lib/process_bot/control_socket.rb

@@ -59,7 +59,7 @@ class ProcessBot::ControlSocket
       command = JSON.parse(data)
       command_type = command.fetch("command")
 
-      if command_type == "graceful" || command_type == "stop"
+      if command_type == "graceful" || command_type == "graceful_no_wait" || command_type == "stop"
         begin
           command_options = if command["options"]
             symbolize_keys(command.fetch("options"))
@@ -67,6 +67,11 @@ class ProcessBot::ControlSocket
             {}
           end
 
+          if command_type == "graceful_no_wait"
+            command_type = "graceful"
+            command_options[:wait_for_gracefully_stopped] = false
+          end
+
           logger.logs "Command #{command_type} with options #{command_options}"
 
           process.__send__(command_type, **command_options)

data/lib/process_bot/logger.rb

@@ -10,22 +10,16 @@ class ProcessBot::Logger
   end
 
   def log(output, type: :stdout)
-    if type == :stdout || (type == :debug && options[:debug])
-      $stdout.print output
-    elsif type == :stderr
-      $stderr.print output
-    else
-      raise "Unknown type: #{type}"
-    end
+    write_output(output, type)
 
     return unless log_to_file?
+    return if type == :debug && !debug_enabled?
 
-    fp_log.write(output)
-    fp_log.flush
+    write_log_file(output)
   end
 
-  def logs(output, **args)
-    log("#{output}\n", **args)
+  def logs(output, type: :info, **args)
+    log("#{output}\n", type: type, **args)
   end
 
   def log_file_path
@@ -39,4 +33,43 @@ class ProcessBot::Logger
   def fp_log
     @fp_log ||= File.open(log_file_path, "a") if log_to_file?
   end
+
+  def write_output(output, type)
+    case type
+    when :stdout
+      $stdout.print output
+    when :stderr
+      $stderr.print output
+    when :info
+      $stdout.print output if logging_enabled?
+    when :debug
+      $stdout.print output if debug_enabled?
+    else
+      raise "Unknown type: #{type}"
+    end
+  end
+
+  def write_log_file(output)
+    fp_log.write(output)
+    fp_log.flush
+  end
+
+  def debug_enabled?
+    truthy_option?(:debug)
+  end
+
+  def logging_enabled?
+    truthy_option?(:log) || truthy_option?(:logging) || debug_enabled?
+  end
+
+  def truthy_option?(key)
+    value = options[key]
+    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
 end

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

@@ -48,7 +48,7 @@ class ProcessBot::Process::Handlers::Custom
   end
 
   def stop(**_args)
-    puts "Stop related processes"
+    logger.logs "Stop related processes"
     process.runner.stop_related_processes
   end
 end

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

@@ -79,6 +79,7 @@ class ProcessBot::Process::Handlers::Sidekiq
   end
 
   def send_tstp_or_return
+    logger.logs "Killing process with signal TSTP for PID #{current_pid}"
     Process.kill("TSTP", current_pid)
     true
   rescue Errno::ESRCH
@@ -101,6 +102,7 @@ class ProcessBot::Process::Handlers::Sidekiq
   end
 
   def terminate_pid(pid)
+    logger.logs "Killing process with signal TERM for PID #{pid}"
     Process.kill("TERM", pid)
   rescue Errno::ESRCH
     logger.logs "Sidekiq PID #{pid} is not running - nothing to stop"

data/lib/process_bot/process/runner.rb

@@ -7,7 +7,7 @@ class ProcessBot::Process::Runner
     @command = command
     @handler_instance = handler_instance
     @handler_name = handler_name
-    @logger = logger
+    @logger = logger || ProcessBot::Logger.new(options: options)
     @monitor = Monitor.new
     @options = options
   end
@@ -119,7 +119,7 @@ class ProcessBot::Process::Runner
         break
       else
         processes.each do |process|
-          logger.logs "Terminating PID #{process.pid}: #{process.data.fetch("cmd")}"
+          logger.logs "Killing process with signal TERM for PID #{process.pid}: #{process.data.fetch("cmd")}"
           Process.kill("TERM", process.pid)
         end
 
@@ -130,20 +130,28 @@ class ProcessBot::Process::Runner
 
   def find_sidekiq_pid
     Thread.new do
-      while running? && !pid
-        related_sidekiq_processes.each do |related_sidekiq_process| # rubocop:disable Lint/UnreachableLoop
-          puts "FOUND PID: #{related_sidekiq_process.pid}"
-          @pid = related_sidekiq_process.pid
-          options.events.call(:on_process_started, pid: related_sidekiq_process.pid)
+      wait_for_sidekiq_pid
+    end
+  end
 
-          break
-        end
+  def wait_for_sidekiq_pid
+    while running? && !pid
+      assign_related_sidekiq_pid
 
-        unless pid
-          puts "Waiting 1 second before trying to find Sidekiq PID again"
-          sleep 1
-        end
+      unless pid
+        logger.logs "Waiting 1 second before trying to find Sidekiq PID again"
+        sleep 1
       end
     end
   end
+
+  def assign_related_sidekiq_pid
+    related_sidekiq_processes.each do |related_sidekiq_process| # rubocop:disable Lint/UnreachableLoop
+      logger.logs "Found PID: #{related_sidekiq_process.pid}"
+      @pid = related_sidekiq_process.pid
+      options.events.call(:on_process_started, pid: related_sidekiq_process.pid)
+
+      break
+    end
+  end
 end

data/lib/process_bot/process.rb

@@ -27,13 +27,12 @@ class ProcessBot::Process
     command = options.fetch(:command)
 
     if command == "start"
+      logger.logs "Starting process"
       start
     elsif command == "graceful" || command == "stop"
-      begin
-        client.send_command(command: command, options: options.options)
-      rescue Errno::ECONNREFUSED => e
-        raise e unless options[:ignore_no_process_bot]
-      end
+      send_control_command(command)
+    elsif command == "graceful_no_wait"
+      send_control_command(command, wait_for_gracefully_stopped: false)
     else
       raise "Unknown command: #{command}"
     end
@@ -97,7 +96,7 @@ class ProcessBot::Process
   end
 
   def stop(**args)
-    puts "Stop process #{args}"
+    logger.logs "Stop process #{args}"
     @stopped = true
     handler_instance.stop
   end
@@ -106,6 +105,13 @@ class ProcessBot::Process
     runner.run
   end
 
+  def send_control_command(command, **command_options)
+    logger.logs "Sending #{command} command"
+    client.send_command(command: command, options: options.options.merge(command_options))
+  rescue Errno::ECONNREFUSED => e
+    raise e unless options[:ignore_no_process_bot]
+  end
+
   def runner
     @runner ||= ProcessBot::Process::Runner.new(
       command: handler_instance.start_command,

data/lib/process_bot/version.rb

@@ -1,3 +1,3 @@
 module ProcessBot
-  VERSION = "0.1.12".freeze
+  VERSION = "0.1.13".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - kaspernj
@@ -147,6 +147,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- AGENTS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock