process_bot 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1350c2c61a67e05723a9ddd83a397fc9d65c759c82b05d777cbda5a2c68053fc
-  data.tar.gz: 85624825d215e8a1ac7f13679d4ea186809795c5fa240e41c5dc3d70b0818fc3
+  metadata.gz: f9caad47714b9ab413bc33e85beb54b250455b6831ace86d058e6e63e84939bb
+  data.tar.gz: f5d294e5d78cf4bafa60d4ddca38cea9887310ed3cc517d0fbe91ff95673c5b4
 SHA512:
-  metadata.gz: 1a9aaca8ea763914a57929c0a29f9c6c2ea3d17de99569bcfa5abcf367ea3c417f4962f1b7558940ccfaa047cc434b21e77057715bb4f38d0ad6a25c7801f13a
-  data.tar.gz: 26be8cb0ca5a22cddcc1d946ebae6b1d535dc67f755bf4573c41993276808b819db839be70e770e587299736b0556e2c4a7905eecd37f8823ab49a4665d27376
+  metadata.gz: ec5cdb7e07944681062b07f44408c0eb17962f4667a8215eead66a5b62ba6d0c78ffb521c431c94199fcff597bee5e5755df540687e79396cbb53df1daca5034
+  data.tar.gz: 3e21dba2ec87ef787ce3c4bf3b1d6f81273896862a04807ee48f81cc86b8e769712c1de043106c9e64cb16b6ac47f52f0a99d025614c0861ba60f4728fa1fb97

data/AGENTS.md

@@ -13,3 +13,4 @@
 - 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.
+- Bumped version to 0.1.20 for log streaming updates.

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 - Stop accepting new control commands during shutdown so in-flight responses complete reliably.
+- Stream ProcessBot logs to connected control clients for Capistrano output.
+- Sanitize broadcast log output to keep JSON encoding safe.
+- Bump version to 0.1.20.
+- Flush log output immediately so Capistrano can stream it.
+- Bump version to 0.1.21.
 
 ## [0.1.0] - 2022-04-03
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    process_bot (0.1.19)
+    process_bot (0.1.21)
       knjrbfw (>= 0.0.116)
       pry
       rake
@@ -83,7 +83,7 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.8.0)
+    rubocop-rspec (3.9.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.81)
     ruby-progressbar (1.13.0)

data/lib/process_bot/client_socket.rb

@@ -1,3 +1,4 @@
+require "json"
 require "socket"
 
 class ProcessBot::ClientSocket
@@ -26,23 +27,41 @@ class ProcessBot::ClientSocket
     logger.logs "Sending: #{data}"
     begin
       client.puts(JSON.generate(data))
-      response_raw = client.gets
-    rescue Errno::ECONNRESET, Errno::EPIPE
-      return :nil
-    end
+      loop do
+        response_raw = client.gets
+        return :nil if response_raw.nil?
 
-    # Happens if process is interrupted
-    return :nil if response_raw.nil?
+        response = JSON.parse(response_raw)
 
-    response = JSON.parse(response_raw)
+        case response.fetch("type")
+        when "log"
+          write_log_output(response)
+        when "success"
+          return :success
+        when "error"
+          error = RuntimeError.new("Command raised an error: #{response.fetch("message")}")
+          error.set_backtrace(response.fetch("backtrace") + Thread.current.backtrace)
 
-    return :success if response.fetch("type") == "success"
+          raise error
+        else
+          raise "Unknown response type: #{response.fetch("type")}"
+        end
+      end
+    rescue Errno::ECONNRESET, Errno::EPIPE
+      :nil
+    end
+  end
 
-    if response.fetch("type") == "error"
-      error = RuntimeError.new("Command raised an error: #{response.fetch("message")}")
-      error.set_backtrace(response.fetch("backtrace") + Thread.current.backtrace)
+  def write_log_output(response)
+    output = response["output"].to_s
+    stream = response.fetch("stream", "stdout")
 
-      raise error
+    if stream == "stderr"
+      $stderr.print output
+      $stderr.flush
+    else
+      $stdout.print output
+      $stdout.flush
     end
   end
 end

data/lib/process_bot/control_socket.rb

@@ -3,12 +3,14 @@ require "json"
 require "knjrbfw"
 
 class ProcessBot::ControlSocket
-  attr_reader :options, :port, :process, :server
+  attr_reader :clients, :clients_mutex, :options, :port, :process, :server
 
   def initialize(options:, process:)
     @options = options
     @process = process
     @port = options.fetch(:port).to_i
+    @clients = []
+    @clients_mutex = Mutex.new
   end
 
   def logger
@@ -20,6 +22,9 @@ class ProcessBot::ControlSocket
     run_client_loop
     logger.logs "TCPServer started"
     options.events.call(:on_socket_opened, port: @port)
+    options.events.connect(:on_log) do |event_name, output:, type:|
+      broadcast_log(event_name, output: output, type: type)
+    end
   end
 
   def start_tcp_server
@@ -70,6 +75,8 @@ class ProcessBot::ControlSocket
   end
 
   def handle_client(client) # rubocop:disable Metrics/AbcSize
+    add_client(client)
+
     loop do
       data = client.gets
       break if data.nil? # Client disconnected
@@ -105,6 +112,42 @@ class ProcessBot::ControlSocket
         client.puts(JSON.generate(type: "error", message: "Unknown command: #{command_type}", backtrace: Thread.current.backtrace))
       end
     end
+  ensure
+    remove_client(client)
+    client.close unless client.closed?
+  end
+
+  def broadcast_log(_event_name, output:, type:)
+    safe_output = normalize_output(output)
+    payload = JSON.generate(type: "log", stream: type.to_s, output: safe_output)
+
+    clients_snapshot.each do |client|
+      client.puts(payload)
+    rescue IOError, Errno::EPIPE, Errno::ECONNRESET
+      remove_client(client)
+    end
+  end
+
+  def add_client(client)
+    clients_mutex.synchronize do
+      clients << client
+    end
+  end
+
+  def remove_client(client)
+    clients_mutex.synchronize do
+      clients.delete(client)
+    end
+  end
+
+  def clients_snapshot
+    clients_mutex.synchronize do
+      clients.dup
+    end
+  end
+
+  def normalize_output(output)
+    output.to_s.encode("UTF-8", invalid: :replace, undef: :replace, replace: "?")
   end
 
   def symbolize_keys(hash)

data/lib/process_bot/logger.rb

@@ -11,6 +11,7 @@ class ProcessBot::Logger
 
   def log(output, type: :stdout)
     write_output(output, type)
+    broadcast_log(output, type)
 
     return unless log_to_file?
     return if type == :debug && !debug_enabled?
@@ -38,12 +39,16 @@ class ProcessBot::Logger
     case type
     when :stdout
       $stdout.print output
+      $stdout.flush
     when :stderr
       $stderr.print output
+      $stderr.flush
     when :info
       $stdout.print output if logging_enabled?
+      $stdout.flush if logging_enabled?
     when :debug
       $stdout.print output if debug_enabled?
+      $stdout.flush if debug_enabled?
     else
       raise "Unknown type: #{type}"
     end
@@ -54,6 +59,25 @@ class ProcessBot::Logger
     fp_log.flush
   end
 
+  def broadcast_log(output, type)
+    return unless should_broadcast?(type)
+
+    options.events.call(:on_log, output: output, type: type)
+  end
+
+  def should_broadcast?(type)
+    case type
+    when :stdout, :stderr
+      true
+    when :info
+      logging_enabled?
+    when :debug
+      debug_enabled?
+    else
+      false
+    end
+  end
+
   def debug_enabled?
     truthy_option?(:debug)
   end

data/lib/process_bot/options.rb

@@ -24,6 +24,7 @@ class ProcessBot::Options
       require "knjrbfw"
 
       event_handler = ::Knj::Event_handler.new
+      event_handler.add_event(name: :on_log)
       event_handler.add_event(name: :on_process_started)
       event_handler.add_event(name: :on_socket_opened)
       event_handler

data/lib/process_bot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.21
 platform: ruby
 authors:
 - kaspernj