debug 1.5.0 → 1.6.0

data/lib/debug/config.rb

@@ -7,46 +7,50 @@ module DEBUGGER__
     ERROR:   2,
     WARN:    3,
     INFO:    4,
+    DEBUG:   5
   }.freeze
 
   CONFIG_SET = {
     # UI setting
-    log_level:      ['RUBY_DEBUG_LOG_LEVEL',      "UI: Log level same as Logger (default: WARN)",                   :loglevel],
-    show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint (default: 10 lines)", :int],
-    show_frames:    ['RUBY_DEBUG_SHOW_FRAMES',    "UI: Show n frames on breakpoint (default: 2 frames)",            :int],
-    use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)",                      :bool],
-    no_color:       ['RUBY_DEBUG_NO_COLOR',       "UI: Do not use colorize (default: false)",                       :bool],
-    no_sigint_hook: ['RUBY_DEBUG_NO_SIGINT_HOOK', "UI: Do not suspend on SIGINT (default: false)",                  :bool],
-    no_reline:      ['RUBY_DEBUG_NO_RELINE',      "UI: Do not use Reline library (default: false)",                 :bool],
+    log_level:      ['RUBY_DEBUG_LOG_LEVEL',      "UI: Log level same as Logger",               :loglevel, "WARN"],
+    show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint", :int, "10"],
+    show_frames:    ['RUBY_DEBUG_SHOW_FRAMES',    "UI: Show n frames on breakpoint",            :int, "2"],
+    use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)", :bool, "false"],
+    no_color:       ['RUBY_DEBUG_NO_COLOR',       "UI: Do not use colorize",                    :bool, "false"],
+    no_sigint_hook: ['RUBY_DEBUG_NO_SIGINT_HOOK', "UI: Do not suspend on SIGINT",               :bool, "false"],
+    no_reline:      ['RUBY_DEBUG_NO_RELINE',      "UI: Do not use Reline library",              :bool, "false"],
+    no_hint:        ['RUBY_DEBUG_NO_HINT',        "UI: Do not show the hint on the REPL",       :bool, "false"],
 
     # control setting
-    skip_path:      ['RUBY_DEBUG_SKIP_PATH',      "CONTROL: Skip showing/entering frames for given paths (default: [])", :path],
-    skip_nosrc:     ['RUBY_DEBUG_SKIP_NOSRC',     "CONTROL: Skip on no source code lines (default: false)",              :bool],
-    keep_alloc_site:['RUBY_DEBUG_KEEP_ALLOC_SITE',"CONTROL: Keep allocation site and p, pp shows it (default: false)",   :bool],
-    postmortem:     ['RUBY_DEBUG_POSTMORTEM',     "CONTROL: Enable postmortem debug (default: false)",                   :bool],
-    fork_mode:      ['RUBY_DEBUG_FORK_MODE',      "CONTROL: Control which process activates a debugger after fork (both/parent/child) (default: both)", :forkmode],
-    sigdump_sig:    ['RUBY_DEBUG_SIGDUMP_SIG',    "CONTROL: Sigdump signal (default: disabled)"],
+    skip_path:      ['RUBY_DEBUG_SKIP_PATH',      "CONTROL: Skip showing/entering frames for given paths", :path],
+    skip_nosrc:     ['RUBY_DEBUG_SKIP_NOSRC',     "CONTROL: Skip on no source code lines",              :bool, "false"],
+    keep_alloc_site:['RUBY_DEBUG_KEEP_ALLOC_SITE',"CONTROL: Keep allocation site and p, pp shows it",   :bool, "false"],
+    postmortem:     ['RUBY_DEBUG_POSTMORTEM',     "CONTROL: Enable postmortem debug",                   :bool, "false"],
+    fork_mode:      ['RUBY_DEBUG_FORK_MODE',      "CONTROL: Control which process activates a debugger after fork (both/parent/child)", :forkmode, "both"],
+    sigdump_sig:    ['RUBY_DEBUG_SIGDUMP_SIG',    "CONTROL: Sigdump signal", :bool, "false"],
 
     # boot setting
-    nonstop:        ['RUBY_DEBUG_NONSTOP',     "BOOT: Nonstop mode",                                                :bool],
-    stop_at_load:   ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location",                               :bool],
+    nonstop:        ['RUBY_DEBUG_NONSTOP',     "BOOT: Nonstop mode",                                                :bool, "false"],
+    stop_at_load:   ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location",                               :bool, "false"],
     init_script:    ['RUBY_DEBUG_INIT_SCRIPT', "BOOT: debug command script path loaded at first stop"],
     commands:       ['RUBY_DEBUG_COMMANDS',    "BOOT: debug commands invoked at first stop. commands should be separated by ';;'"],
-    no_rc:          ['RUBY_DEBUG_NO_RC',       "BOOT: ignore loading ~/.rdbgrc(.rb)",                               :bool],
-    history_file:   ['RUBY_DEBUG_HISTORY_FILE',"BOOT: history file (default: ~/.rdbg_history)"],
-    save_history:   ['RUBY_DEBUG_SAVE_HISTORY',"BOOT: maximum save history lines (default: 10,000)"],
+    no_rc:          ['RUBY_DEBUG_NO_RC',       "BOOT: ignore loading ~/.rdbgrc(.rb)",                               :bool, "false"],
+    history_file:   ['RUBY_DEBUG_HISTORY_FILE',"BOOT: history file",               :string, "~/.rdbg_history"],
+    save_history:   ['RUBY_DEBUG_SAVE_HISTORY',"BOOT: maximum save history lines", :int, "10000"],
 
     # remote setting
     port:           ['RUBY_DEBUG_PORT',         "REMOTE: TCP/IP remote debugging: port"],
-    host:           ['RUBY_DEBUG_HOST',         "REMOTE: TCP/IP remote debugging: host (localhost if not given)"],
+    host:           ['RUBY_DEBUG_HOST',         "REMOTE: TCP/IP remote debugging: host", :string, "127.0.0.1"],
     sock_path:      ['RUBY_DEBUG_SOCK_PATH',    "REMOTE: UNIX Domain Socket remote debugging: socket path"],
     sock_dir:       ['RUBY_DEBUG_SOCK_DIR',     "REMOTE: UNIX Domain Socket remote debugging: socket directory"],
+    local_fs_map:   ['RUBY_DEBUG_LOCAL_FS_MAP', "REMOTE: Specify local fs map", :path_map],
+    skip_bp:        ['RUBY_DEBUG_SKIP_BP',      "REMOTE: Skip breakpoints if no clients are attached", :bool, 'false'],
     cookie:         ['RUBY_DEBUG_COOKIE',       "REMOTE: Cookie for negotiation"],
     open_frontend:  ['RUBY_DEBUG_OPEN_FRONTEND',"REMOTE: frontend used by open command (vscode, chrome, default: rdbg)."],
     chrome_path:    ['RUBY_DEBUG_CHROME_PATH',  "REMOTE: Platform dependent path of Chrome (For more information, See [here](https://github.com/ruby/debug/pull/334/files#diff-5fc3d0a901379a95bc111b86cf0090b03f857edfd0b99a0c1537e26735698453R55-R64))"],
 
     # obsolete
-    parent_on_fork: ['RUBY_DEBUG_PARENT_ON_FORK', "OBSOLETE: Keep debugging parent process on fork (default: false)",     :bool],
+    parent_on_fork: ['RUBY_DEBUG_PARENT_ON_FORK', "OBSOLETE: Keep debugging parent process on fork",     :bool, "false"],
   }.freeze
 
   CONFIG_MAP = CONFIG_SET.map{|k, (ev, _)| [k, ev]}.to_h.freeze
@@ -59,11 +63,23 @@ module DEBUGGER__
     end
 
     def initialize argv
+      @skip_all = false
+
       if self.class.config
         raise 'Can not make multiple configurations in one process'
       end
 
-      update self.class.parse_argv(argv)
+      config = self.class.parse_argv(argv)
+
+      # apply defaults
+      CONFIG_SET.each do |k, config_detail|
+        unless config.key?(k)
+          default_value = config_detail[3]
+          config[k] = parse_config_value(k, default_value)
+        end
+      end
+
+      update config
     end
 
     def inspect
@@ -78,6 +94,14 @@ module DEBUGGER__
       set_config(key => val)
     end
 
+    def skip_all
+      @skip_all = true
+    end
+
+    def skip?
+      @skip_all
+    end
+
     def set_config(**kw)
       conf = config.dup
       kw.each{|k, v|
@@ -114,11 +138,13 @@ module DEBUGGER__
       self.class.instance_variable_set(:@config, conf.freeze)
 
       # Post process
-      if_updated old_conf, conf, :keep_alloc_site do |_, new|
+      if_updated old_conf, conf, :keep_alloc_site do |old, new|
         if new
           require 'objspace'
           ObjectSpace.trace_object_allocations_start
-        else
+        end
+
+        if old && !new
           ObjectSpace.trace_object_allocations_stop
         end
       end
@@ -215,6 +241,8 @@ module DEBUGGER__
             e
           end
         }
+      when :path_map
+        valstr.split(',').map{|e| e.split(':')}
       else
         valstr
       end
@@ -223,6 +251,7 @@ module DEBUGGER__
     def self.parse_argv argv
       config = {
         mode: :start,
+        no_color: (nc = ENV['NO_COLOR']) && !nc.empty?,
       }
       CONFIG_MAP.each{|key, evname|
         if val = ENV[evname]
@@ -361,6 +390,8 @@ module DEBUGGER__
           case CONFIG_SET[key][2]
           when :path
             valstr = config[key].map{|e| e.kind_of?(Regexp) ? e.inspect : e}.join(':')
+          when :path_map
+            valstr = config[key].map{|e| e.join(':')}.join(',')
           else
             valstr = config[key].to_s
           end
@@ -428,7 +459,7 @@ module DEBUGGER__
   end
 
   def self.create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir)
-    user = ENV['USER'] || 'ruby-debug'
+    user = ENV['USER'] || 'UnknownUser'
     File.join(base_dir, "ruby-debug-#{user}")
   end
 

data/lib/debug/console.rb

@@ -98,7 +98,7 @@ module DEBUGGER__
           when :ruby
             colorize_code(buff.chomp)
           end
-        end
+        end unless CONFIG[:no_hint]
 
         yield
 
@@ -174,7 +174,13 @@ module DEBUGGER__
     end
 
     def history_file
-      CONFIG[:history_file] || File.expand_path("~/.rdbg_history")
+      history_file = CONFIG[:history_file]
+
+      if !history_file.empty?
+        File.expand_path(history_file)
+      else
+        history_file
+      end
     end
 
     FH = "# Today's OMIKUJI: "
@@ -202,7 +208,7 @@ module DEBUGGER__
       if history && @init_history_lines
         added_records = history.to_a[@init_history_lines .. -1]
         path = history_file
-        max = CONFIG[:save_history] || 10_000
+        max = CONFIG[:save_history]
 
         if !added_records.empty? && !path.empty?
           orig_records = read_history_file

data/lib/debug/frame_info.rb

@@ -27,8 +27,8 @@ module DEBUGGER__
       location.absolute_path
     end
 
-    def pretty_path
-      return '#<none>' unless path = self.path
+    def self.pretty_path path
+      return '#<none>' unless path
       use_short_path = CONFIG[:use_short_path]
 
       case
@@ -45,15 +45,18 @@ module DEBUGGER__
       end
     end
 
+    def pretty_path
+      FrameInfo.pretty_path path
+    end
+
     def name
       # p frame_type: frame_type, self: self
       case frame_type
       when :block
-        level, block_loc, _args = block_identifier
+        level, block_loc = block_identifier
         "block in #{block_loc}#{level}"
       when :method
-        ci, _args = method_identifier
-        "#{ci}"
+        method_identifier
       when :c
         c_identifier
       when :other
@@ -83,16 +86,13 @@ module DEBUGGER__
 
     def block_identifier
       return unless frame_type == :block
-      args = parameters_info
       _, level, block_loc = location.label.match(BLOCK_LABL_REGEXP).to_a
-      [level || "", block_loc, args]
+      [level || "", block_loc]
     end
 
     def method_identifier
       return unless frame_type == :method
-      args = parameters_info
-      ci = "#{klass_sig}#{callee}"
-      [ci, args]
+      "#{klass_sig}#{callee}"
     end
 
     def c_identifier
@@ -106,7 +106,11 @@ module DEBUGGER__
     end
 
     def callee
-      self._callee ||= self.binding&.eval('__callee__')
+      self._callee ||= begin
+                         self.binding&.eval('__callee__')
+                       rescue NameError # BasicObject
+                         nil
+                       end
     end
 
     def return_str
@@ -115,6 +119,11 @@ module DEBUGGER__
       end
     end
 
+    def matchable_location
+      # realpath can sometimes be nil so we can't use it here
+      "#{path}:#{location.lineno}"
+    end
+
     def location_str
       "#{pretty_path}:#{location.lineno}"
     end
@@ -138,18 +147,6 @@ module DEBUGGER__
       end
     end
 
-    private
-
-    def get_singleton_class obj
-      obj.singleton_class # TODO: don't use it
-    rescue TypeError
-      nil
-    end
-
-    private def local_variable_get var
-      local_variables[var]
-    end
-
     def parameters_info
       vars = iseq.parameters_symbols
       vars.map{|var|
@@ -161,7 +158,17 @@ module DEBUGGER__
       }.compact
     end
 
-    def klass_sig
+    private def get_singleton_class obj
+      obj.singleton_class # TODO: don't use it
+    rescue TypeError
+      nil
+    end
+
+    private def local_variable_get var
+      local_variables[var]
+    end
+
+    private def klass_sig
       if self.class == get_singleton_class(self.self)
         "#{self.self}."
       else

data/lib/debug/server.rb

@@ -49,6 +49,7 @@ module DEBUGGER__
         accept do |server, already_connected: false|
           DEBUGGER__.warn "Connected."
           greeting_done = false
+          @need_pause_at_first = true
 
           @accept_m.synchronize{
             @sock = server
@@ -68,7 +69,7 @@ module DEBUGGER__
           } unless already_connected
 
           setup_interrupt do
-            pause unless already_connected
+            pause if !already_connected && @need_pause_at_first
             process
           end
 
@@ -106,6 +107,24 @@ module DEBUGGER__
       end
     end
 
+    def parse_option params
+      case params.strip
+      when /width:\s+(\d+)/
+        @width = $1.to_i
+        parse_option $~.post_match
+      when /cookie:\s+(\S+)/
+        check_cookie $1 if $1 != '-'
+        parse_option $~.post_match
+      when /nonstop: (true|false)/
+        @need_pause_at_first = false if $1 == 'true'
+        parse_option $~.post_match
+      when /(.+):(.+)/
+        raise GreetingError, "Unkown option: #{params}"
+      else
+        # OK
+      end
+    end
+
     def greeting
       case g = @sock.gets
       when /^info cookie:\s+(.*)$/
@@ -116,16 +135,18 @@ module DEBUGGER__
         @sock.close
         raise GreetingError, "HEAD request"
 
-      when /^version:\s+(.+)\s+width: (\d+) cookie:\s+(.*)$/
-        v, w, c = $1, $2, $3
+      when /^version:\s+(\S+)\s+(.+)$/
+        v, params = $1, $2
+
         # TODO: protocol version
         if v != VERSION
           raise GreetingError, "Incompatible version (server:#{VERSION} and client:#{$1})"
         end
+        parse_option(params)
 
-        check_cookie c
-
-        @width = w.to_i
+        puts "DEBUGGER (client): Connected. PID:#{Process.pid}, $0:#{$0}"
+        puts "DEBUGGER (client): Type `Ctrl-C` to enter the debug console." unless @need_pause_at_first
+        puts
 
       when /^Content-Length: (\d+)/
         require_relative 'server_dap'
@@ -133,12 +154,15 @@ module DEBUGGER__
         raise unless @sock.read(2) == "\r\n"
         self.extend(UI_DAP)
         @repl = false
+        @need_pause_at_first = false
         dap_setup @sock.read($1.to_i)
+
       when /^GET \/.* HTTP\/1.1/
         require_relative 'server_cdp'
 
         self.extend(UI_CDP)
         @repl = false
+        @need_pause_at_first = false
         CONFIG.set_config no_color: true
 
         @ws_server = UI_CDP::WebSocketServer.new(@sock)
@@ -164,6 +188,7 @@ module DEBUGGER__
           }
         end
 
+        return unless line
         next if line == :can_not_read
 
         case line
@@ -187,7 +212,7 @@ module DEBUGGER__
             raise "pid:#{Process.pid} but get #{line}"
           end
         else
-          STDERR.puts "unsupported: #{line}"
+          STDERR.puts "unsupported: #{line.inspect}"
           exit!
         end
       end
@@ -309,7 +334,9 @@ module DEBUGGER__
     end
 
     def readline prompt
-      input = (sock do |s|
+      input = (sock(skip: CONFIG[:skip_bp]) do |s|
+        next unless s
+
         if @repl
           raise "not in subsession, but received: #{line.inspect}" unless @session.in_subsession?
           line = "input #{Process.pid}"
@@ -353,8 +380,8 @@ module DEBUGGER__
 
   class UI_TcpServer < UI_ServerBase
     def initialize host: nil, port: nil
-      @addr = nil
-      @host = host || CONFIG[:host] || '127.0.0.1'
+      @local_addr = nil
+      @host = host || CONFIG[:host]
       @port_save_file = nil
       @port = begin
         port_str = (port && port.to_s) || CONFIG[:port] || raise("Specify listening port by RUBY_DEBUG_PORT environment variable.")
@@ -375,12 +402,12 @@ module DEBUGGER__
     def chrome_setup
       require_relative 'server_cdp'
 
-      unless @chrome_pid = UI_CDP.setup_chrome(@addr)
+      unless @chrome_pid = UI_CDP.setup_chrome(@local_addr.inspect_sockaddr)
         DEBUGGER__.warn <<~EOS
           With Chrome browser, type the following URL in the address-bar:
 
-             devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{@addr}/#{SecureRandom.uuid}
-          
+             devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{@local_addr.inspect_sockaddr}/#{SecureRandom.uuid}
+
           EOS
       end
     end
@@ -391,9 +418,9 @@ module DEBUGGER__
 
       begin
         Socket.tcp_server_sockets @host, @port do |socks|
-          @addr = socks[0].local_address.inspect_sockaddr # Change this part if `socks` are multiple.
+          @local_addr = socks.first.local_address # Change this part if `socks` are multiple.
           rdbg = File.expand_path('../../exe/rdbg', __dir__)
-          DEBUGGER__.warn "Debugger can attach via TCP/IP (#{@addr})"
+          DEBUGGER__.warn "Debugger can attach via TCP/IP (#{@local_addr.inspect_sockaddr})"
 
           if @port_save_file
             File.write(@port_save_file, "#{socks[0].local_address.ip_port.to_s}\n")
@@ -403,7 +430,7 @@ module DEBUGGER__
           DEBUGGER__.info <<~EOS
           With rdbg, use the following command line:
           #
-          #   #{rdbg} --attach #{@addr.split(':').join(' ')}
+          #   #{rdbg} --attach #{@local_addr.ip_address} #{@local_addr.ip_port}
           #
           EOS
 
@@ -411,7 +438,7 @@ module DEBUGGER__
           when 'chrome'
             chrome_setup
           when 'vscode'
-            vscode_setup @addr
+            vscode_setup @local_addr.inspect_sockaddr
           end
 
           Socket.accept_loop(socks) do |sock, client|

data/lib/debug/server_cdp.rb

@@ -346,7 +346,7 @@ module DEBUGGER__
           send_event 'Runtime.executionContextCreated',
                       context: {
                         id: SecureRandom.hex(16),
-                        origin: "http://#{@addr}",
+                        origin: "http://#{@local_addr.inspect_sockaddr}",
                         name: ''
                       }
         when 'Runtime.getIsolateId'
@@ -572,13 +572,13 @@ module DEBUGGER__
     def process_protocol_request req
       case req['method']
       when 'Debugger.stepOver', 'Debugger.stepInto', 'Debugger.stepOut', 'Debugger.resume', 'Debugger.enable'
-        @tc << [:cdp, :backtrace, req]
+        request_tc [:cdp, :backtrace, req]
       when 'Debugger.evaluateOnCallFrame'
         frame_id = req.dig('params', 'callFrameId')
         group = req.dig('params', 'objectGroup')
         if fid = @frame_map[frame_id]
           expr = req.dig('params', 'expression')
-          @tc << [:cdp, :evaluate, req, fid, expr, group]
+          request_tc [:cdp, :evaluate, req, fid, expr, group]
         else
           fail_response req,
                         code: INVALID_PARAMS,
@@ -591,9 +591,9 @@ module DEBUGGER__
           when 'local'
             frame_id = ref[1]
             fid = @frame_map[frame_id]
-            @tc << [:cdp, :scope, req, fid]
+            request_tc [:cdp, :scope, req, fid]
           when 'properties'
-            @tc << [:cdp, :properties, req, oid]
+            request_tc [:cdp, :properties, req, oid]
           when 'script', 'global'
             # TODO: Support script and global types
             @ui.respond req, result: []