debug 1.4.0 → 1.9.2

data/lib/debug/server.rb

@@ -19,8 +19,9 @@ module DEBUGGER__
       @session = nil
     end
 
-    class Terminate < StandardError
-    end
+    class Terminate < StandardError; end
+    class GreetingError < StandardError; end
+    class RetryConnection < StandardError; end
 
     def deactivate
       @reader_thread.raise Terminate
@@ -47,10 +48,13 @@ module DEBUGGER__
 
         accept do |server, already_connected: false|
           DEBUGGER__.warn "Connected."
+          greeting_done = false
+          @need_pause_at_first = true
 
           @accept_m.synchronize{
             @sock = server
             greeting
+            greeting_done = true
 
             @accept_cv.signal
 
@@ -65,17 +69,23 @@ module DEBUGGER__
           } unless already_connected
 
           setup_interrupt do
-            pause unless already_connected
+            pause if !already_connected && @need_pause_at_first
             process
           end
 
+        rescue GreetingError => e
+          DEBUGGER__.warn "GreetingError: #{e.message}"
+          next
         rescue Terminate
           raise # should catch at outer scope
+        rescue RetryConnection
+          next
         rescue => e
           DEBUGGER__.warn "ReaderThreadError: #{e}"
           pp e.backtrace
         ensure
-          cleanup_reader
+          DEBUGGER__.warn "Disconnected."
+          cleanup_reader if greeting_done
         end # accept
 
       rescue Terminate
@@ -84,7 +94,7 @@ module DEBUGGER__
     end
 
     def cleanup_reader
-      DEBUGGER__.warn "Disconnected."
+      @sock.close if @sock
       @sock = nil
       @q_msg.close
       @q_msg = nil
@@ -92,21 +102,58 @@ module DEBUGGER__
       @q_ans = nil
     end
 
+    def check_cookie c
+      cookie = CONFIG[:cookie]
+      if cookie && cookie != c
+        raise GreetingError, "Cookie mismatch (#{$2.inspect} was sent)"
+      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 /^version:\s+(.+)\s+width: (\d+) cookie:\s+(.*)$/
-        v, w, c = $1, $2, $3
+      when /^info cookie:\s+(.*)$/
+        require 'etc'
+
+        check_cookie $1
+        @sock.puts "PID: #{Process.pid}, $0: #{$0}, session_name: #{CONFIG[:session_name]}"
+        @sock.puts "debug #{VERSION} on #{RUBY_DESCRIPTION}"
+        @sock.puts "uname: #{Etc.uname.inspect}"
+        @sock.close
+        raise GreetingError, "HEAD request"
+
+      when /^version:\s+(\S+)\s+(.+)$/
+        v, params = $1, $2
+
         # TODO: protocol version
         if v != VERSION
-          raise "Incompatible version (#{VERSION} client:#{$1})"
+          @sock.puts msg = "out DEBUGGER: Incompatible version (server:#{VERSION} and client:#{$1})"
+          raise GreetingError, msg
         end
+        parse_option(params)
 
-        cookie = CONFIG[:cookie]
-        if cookie && cookie != c
-          raise "Cookie mismatch (#{$2.inspect} was sent)"
-        end
-
-        @width = w.to_i
+        session_name = CONFIG[:session_name]
+        session_name_str = ", session_name:#{session_name}" if session_name
+        puts "DEBUGGER (client): Connected. PID:#{Process.pid}, $0:#{$0}#{session_name_str}"
+        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'
@@ -114,37 +161,38 @@ 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/
+
+      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
-        CONFIG.set_config no_color: true
-
-        @ws_server = UI_CDP::WebSocketServer.new(@sock)
-        @ws_server.handshake
+        send_chrome_response g
       else
-        raise "Greeting message error: #{g}"
+        raise GreetingError, "Unknown greeting message: #{g}"
       end
     end
 
     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
 
+        return unless line
         next if line == :can_not_read
 
         case line
@@ -168,7 +216,7 @@ module DEBUGGER__
             raise "pid:#{Process.pid} but get #{line}"
           end
         else
-          STDERR.puts "unsupported: #{line}"
+          STDERR.puts "unsupported: #{line.inspect}"
           exit!
         end
       end
@@ -290,16 +338,18 @@ 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}"
-          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')
 
@@ -315,7 +365,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"
@@ -325,20 +375,31 @@ module DEBUGGER__
     def after_fork_parent
       # do nothing
     end
+
+    def vscode_setup debug_port
+      require_relative 'server_dap'
+      UI_DAP.setup debug_port
+    end
   end
 
   class UI_TcpServer < UI_ServerBase
     def initialize host: nil, port: nil
-      @addr = nil
-      @host = host || CONFIG[:host] || '127.0.0.1'
-      @port = port || begin
-        port_str = CONFIG[:port] || raise("Specify listening port by RUBY_DEBUG_PORT environment variable.")
-        if /\A\d+\z/ !~ port_str
-          raise "Specify digits for port number"
-        else
+      @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.")
+        case port_str
+        when /\A\d+\z/
           port_str.to_i
+        when /\A(\d+):(.+)\z/
+          @port_save_file = $2
+          $1.to_i
+        else
+          raise "Specify digits for port number"
         end
       end
+      @uuid = nil # for CDP
 
       super()
     end
@@ -346,14 +407,14 @@ module DEBUGGER__
     def chrome_setup
       require_relative 'server_cdp'
 
-      unless @chrome_pid = UI_CDP.setup_chrome(@addr)
-        DEBUGGER__.warn <<~EOS if CONFIG[:open_frontend] == 'chrome'
-          With Chrome browser, type the following URL in the address-bar:
-          
-             devtools://devtools/bundled/inspector.html?ws=#{@addr}
-          
-          EOS
-      end
+      @uuid = SecureRandom.uuid
+      @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&noJavaScriptCompletion=true&ws=#{@local_addr.inspect_sockaddr}/#{@uuid}
+
+        EOS
     end
 
     def accept
@@ -362,18 +423,28 @@ 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 (#{@local_addr.inspect_sockaddr})"
+
+          if @port_save_file
+            File.write(@port_save_file, "#{socks[0].local_address.ip_port.to_s}\n")
+            DEBUGGER__.warn "Port is saved into #{@port_save_file}"
+          end
 
-          DEBUGGER__.warn "Debugger can attach via TCP/IP (#{@addr})"
           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
 
-          chrome_setup if CONFIG[:open_frontend] == 'chrome'
+          case CONFIG[:open]
+          when 'chrome'
+            chrome_setup
+          when 'vscode'
+            vscode_setup @local_addr.inspect_sockaddr
+          end
 
           Socket.accept_loop(socks) do |sock, client|
             @client_addr = client
@@ -397,6 +468,10 @@ module DEBUGGER__
       end
     ensure
       @sock_for_fork = nil
+
+      if @port_save_file && File.exist?(@port_save_file)
+        File.unlink(@port_save_file)
+      end
     end
   end
 
@@ -409,11 +484,6 @@ module DEBUGGER__
       super()
     end
 
-    def vscode_setup
-      require_relative 'server_dap'
-      UI_DAP.setup @sock_path
-    end
-
     def accept
       super # for fork
 
@@ -426,7 +496,7 @@ module DEBUGGER__
       end
 
       ::DEBUGGER__.warn "Debugger can attach via UNIX domain socket (#{@sock_path})"
-      vscode_setup if CONFIG[:open_frontend] == 'vscode'
+      vscode_setup @sock_path if CONFIG[:open] == 'vscode'
 
       begin
         Socket.unix_server_loop @sock_path do |sock, client|