debug 1.6.2 → 1.7.1

data/lib/debug/config.rb

@@ -14,6 +14,7 @@ module DEBUGGER__
     # UI setting
     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_evaledsrc: ['RUBY_DEBUG_SHOW_EVALEDSRC', "UI: Show actually evaluated source",         :bool, "false"],
     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"],
@@ -33,12 +34,13 @@ module DEBUGGER__
     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 ';;'"],
+    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, "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
+    open:           ['RUBY_DEBUG_OPEN',         "REMOTE: Open remote port (same as `rdbg --open` option)"],
     port:           ['RUBY_DEBUG_PORT',         "REMOTE: TCP/IP remote debugging: port"],
     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"],
@@ -46,7 +48,6 @@ module DEBUGGER__
     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
@@ -63,8 +64,6 @@ module DEBUGGER__
     end
 
     def initialize argv
-      @skip_all = false
-
       if self.class.config
         raise 'Can not make multiple configurations in one process'
       end
@@ -94,14 +93,6 @@ 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|
@@ -158,6 +149,12 @@ module DEBUGGER__
       if_updated old_conf, conf, :sigdump_sig do |old_sig, new_sig|
         setup_sigdump old_sig, new_sig
       end
+
+      if_updated old_conf, conf, :no_sigint_hook do |old, new|
+        if defined?(SESSION)
+          SESSION.set_no_sigint_hook old, new
+        end
+      end
     end
 
     private def if_updated old_conf, new_conf, key
@@ -308,8 +305,25 @@ module DEBUGGER__
                                         'If TCP/IP options are not given, a UNIX domain socket will be used.',
                                         'If FRONTEND is given, prepare for the FRONTEND.',
                                         'Now rdbg, vscode and chrome is supported.') do |f|
-          config[:remote] = true
-          config[:open_frontend] = f.downcase if f
+
+          case f # some format patterns are not documented yet
+          when nil
+            config[:open] = true
+          when /\A\d\z/
+            config[:open] = true
+            config[:port] = f.to_i
+          when /\A(\S+):(\d+)\z/
+            config[:open] = true
+            config[:host] = $1
+            config[:port] = $2.to_i
+          when 'tcp'
+            config[:open] = true
+            config[:port] ||= 0
+          when 'vscode', 'chrome', 'cdp'
+            config[:open] = f&.downcase
+          else
+            raise "Unknown option for --open: #{f}"
+          end
         end
         o.on('--sock-path=SOCK_PATH', 'UNIX Domain socket path') do |path|
           config[:sock_path] = path
@@ -479,10 +493,14 @@ module DEBUGGER__
       when /\A\s*### (.+)/
         cat = $1
         break if $1 == 'END'
-      when /\A      when (.+)/
+      when /\A      register_command (.+)/
         next unless cat
         next unless desc
-        ws = $1.split(/,\s*/).map{|e| e.gsub('\'', '')}
+
+        ws = []
+        $1.gsub(/'([a-z]+)'/){|w|
+          ws << $1
+        }
         helps[cat] << [ws, desc]
         desc = nil
         max_w = ws.max_by{|w| w.length}

data/lib/debug/local.rb

@@ -13,23 +13,28 @@ module DEBUGGER__
       false
     end
 
-    def activate session, on_fork: false
-      unless CONFIG[:no_sigint_hook]
-        prev_handler = trap(:SIGINT){
-          if session.active?
-            ThreadClient.current.on_trap :SIGINT
-          end
-        }
-        session.intercept_trap_sigint_start prev_handler
-      end
+    def activate_sigint
+      prev_handler = trap(:SIGINT){
+        if SESSION.active?
+          ThreadClient.current.on_trap :SIGINT
+        end
+      }
+      SESSION.intercept_trap_sigint_start prev_handler
     end
 
-    def deactivate
+    def deactivate_sigint
       if SESSION.intercept_trap_sigint?
         prev = SESSION.intercept_trap_sigint_end
         trap(:SIGINT, prev)
       end
+    end
+
+    def activate session, on_fork: false
+      activate_sigint unless CONFIG[:no_sigint_hook]
+    end
 
+    def deactivate
+      deactivate_sigint
       @console.deactivate
     end
 
@@ -42,6 +47,7 @@ module DEBUGGER__
     end
 
     def quit n
+      yield
       exit n
     end
 

data/lib/debug/prelude.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 return if ENV['RUBY_DEBUG_ENABLE'] == '0'
-return if defined?(::DEBUGGER__)
+return if defined?(::DEBUGGER__::Session)
 
 # Put the following line in your login script (e.g. ~/.bash_profile) with modified path:
 #

data/lib/debug/server.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'socket'
-require 'etc'
 require_relative 'config'
 require_relative 'version'
 
@@ -22,6 +21,7 @@ module DEBUGGER__
 
     class Terminate < StandardError; end
     class GreetingError < StandardError; end
+    class RetryConnection < StandardError; end
 
     def deactivate
       @reader_thread.raise Terminate
@@ -78,6 +78,8 @@ module DEBUGGER__
           next
         rescue Terminate
           raise # should catch at outer scope
+        rescue RetryConnection
+          next
         rescue => e
           DEBUGGER__.warn "ReaderThreadError: #{e}"
           pp e.backtrace
@@ -128,6 +130,8 @@ module DEBUGGER__
     def greeting
       case g = @sock.gets
       when /^info cookie:\s+(.*)$/
+        require 'etc'
+
         check_cookie $1
         @sock.puts "PID: #{Process.pid}, $0: #{$0}"
         @sock.puts "debug #{VERSION} on #{RUBY_DESCRIPTION}"
@@ -140,7 +144,8 @@ module DEBUGGER__
 
         # TODO: protocol version
         if v != VERSION
-          raise GreetingError, "Incompatible version (server:#{VERSION} and client:#{$1})"
+          @sock.puts msg = "out DEBUGGER: Incompatible version (server:#{VERSION} and client:#{$1})"
+          raise GreetingError, msg
         end
         parse_option(params)
 
@@ -157,16 +162,13 @@ module DEBUGGER__
         @need_pause_at_first = false
         dap_setup @sock.read($1.to_i)
 
-      when /^GET \/.* HTTP\/1.1/
+      when /^GET\s\/json\sHTTP\/1.1/, /^GET\s\/json\/version\sHTTP\/1.1/, /^GET\s\/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}\sHTTP\/1.1/
+        # The reason for not using @uuid here is @uuid is nil if users run debugger without `--open=chrome`.
+
         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)
-        @ws_server.handshake
+        send_chrome_response g
       else
         raise GreetingError, "Unknown greeting message: #{g}"
       end
@@ -174,17 +176,17 @@ module DEBUGGER__
 
     def process
       while true
-        DEBUGGER__.info "sleep IO.select"
-        r = IO.select([@sock])
-        DEBUGGER__.info "wakeup IO.select"
+        DEBUGGER__.debug{ "sleep IO.select" }
+        _r = IO.select([@sock])
+        DEBUGGER__.debug{ "wakeup IO.select" }
 
         line = @session.process_group.sync do
           unless IO.select([@sock], nil, nil, 0)
-            DEBUGGER__.info "UI_Server can not read"
+            DEBUGGER__.debug{ "UI_Server can not read" }
             break :can_not_read
           end
           @sock.gets&.chomp.tap{|line|
-            DEBUGGER__.info "UI_Server received: #{line}"
+            DEBUGGER__.debug{ "UI_Server received: #{line}" }
           }
         end
 
@@ -340,12 +342,12 @@ module DEBUGGER__
         if @repl
           raise "not in subsession, but received: #{line.inspect}" unless @session.in_subsession?
           line = "input #{Process.pid}"
-          DEBUGGER__.info "send: #{line}"
+          DEBUGGER__.debug{ "send: #{line}" }
           s.puts line
         end
         sleep 0.01 until @q_msg
         @q_msg.pop.tap{|msg|
-          DEBUGGER__.info "readline: #{msg.inspect}"
+          DEBUGGER__.debug{ "readline: #{msg.inspect}" }
         }
       end || 'continue')
 
@@ -361,7 +363,7 @@ module DEBUGGER__
       Process.kill(TRAP_SIGNAL, Process.pid)
     end
 
-    def quit n
+    def quit n, &_b
       # ignore n
       sock do |s|
         s.puts "quit"
@@ -395,6 +397,7 @@ module DEBUGGER__
           raise "Specify digits for port number"
         end
       end
+      @uuid = nil # for CDP
 
       super()
     end
@@ -402,11 +405,12 @@ module DEBUGGER__
     def chrome_setup
       require_relative 'server_cdp'
 
-      unless @chrome_pid = UI_CDP.setup_chrome(@local_addr.inspect_sockaddr)
+      @uuid = SecureRandom.uuid
+      unless @chrome_pid = UI_CDP.setup_chrome(@local_addr.inspect_sockaddr, @uuid)
         DEBUGGER__.warn <<~EOS
           With Chrome browser, type the following URL in the address-bar:
 
-             devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{@local_addr.inspect_sockaddr}/#{SecureRandom.uuid}
+             devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{@local_addr.inspect_sockaddr}/#{@uuid}
 
           EOS
       end
@@ -434,7 +438,7 @@ module DEBUGGER__
           #
           EOS
 
-          case CONFIG[:open_frontend]
+          case CONFIG[:open]
           when 'chrome'
             chrome_setup
           when 'vscode'
@@ -491,7 +495,7 @@ module DEBUGGER__
       end
 
       ::DEBUGGER__.warn "Debugger can attach via UNIX domain socket (#{@sock_path})"
-      vscode_setup @sock_path if CONFIG[:open_frontend] == 'vscode'
+      vscode_setup @sock_path if CONFIG[:open] == 'vscode'
 
       begin
         Socket.unix_server_loop @sock_path do |sock, client|