Add debug logging

Author: st0012

lib/debug/config.rb

@@ -7,6 +7,7 @@ module DEBUGGER__
     ERROR:   2,
     WARN:    3,
     INFO:    4,
+    DEBUG:   5
   }.freeze
 
   CONFIG_SET = {

lib/debug/session.rb

@@ -203,6 +203,7 @@ def session_server_main
     def process_event evt
       # variable `@internal_info` is only used for test
       tc, output, ev, @internal_info, *ev_args = evt
+      DEBUGGER__.debug_event(tc, ev, ev_args, direction: ">")
       output.each{|str| @ui.puts str} if ev != :suspend
 
       case ev
@@ -2030,6 +2031,33 @@ def self.info msg
     log :INFO, msg
   end
 
+  def self.debug msg
+    log :DEBUG, msg
+  end
+
+  # to avoid computing the large number of debug strings unnecessarily
+  DEBUG_MODE = CONFIG[:log_level] == :DEBUG
+
+  def self.debug_event(tc, ev, ev_args, direction:)
+    return unless DEBUG_MODE
+    DEBUGGER__.debug("#{direction} Event (#{ev}): #{ev_args} | #{tc} ")
+  end
+
+  def self.debug_mode(tc, old_mode, new_mode)
+    return unless DEBUG_MODE
+    DEBUGGER__.debug("Mode: #{old_mode} -> #{new_mode} | #{tc}")
+  end
+
+  def self.debug_cmd(tc, cmd, direction:)
+    return unless DEBUG_MODE
+    DEBUGGER__.debug("#{direction} Cmd #{cmd} | #{tc}")
+  end
+
+  def self.debug_suspend(tc, event)
+    return unless DEBUG_MODE
+    DEBUGGER__.debug("Suspend #{event} | #{tc}")
+  end
+
   def self.log level, msg
     @logfile = STDERR unless defined? @logfile
 

lib/debug/thread_client.rb

@@ -110,6 +110,7 @@ def mark_as_management
     end
 
     def set_mode mode
+      DEBUGGER__.debug_mode(self, @mode, mode)
       # STDERR.puts "#{@mode} => #{mode} @ #{caller.inspect}"
       # pp caller
 
@@ -180,6 +181,7 @@ def puts str = ''
     end
 
     def << req
+      DEBUGGER__.debug_cmd(self, req, direction: ">>")
       @q_cmd << req
     end
 
@@ -190,6 +192,7 @@ def generate_info
     end
 
     def event! ev, *args
+      DEBUGGER__.debug_event(self, ev, args, direction: "<")
       @q_evt << [self, @output, ev, generate_info, *args]
       @output = []
     end
@@ -235,6 +238,7 @@ def on_pause
 
     def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil, postmortem_exc: nil
       return if management?
+      DEBUGGER__.debug_suspend(self, event)
 
       @current_frame_index = 0
 
@@ -696,6 +700,8 @@ def wait_next_action_
         begin
           set_mode :waiting if !waiting?
           cmds = @q_cmd.pop
+
+          DEBUGGER__.debug_cmd(self, cmds, direction: "<<")
           # pp [self, cmds: cmds]
           break unless cmds
         ensure