debug 1.3.4 → 1.6.0

data/lib/debug/server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'socket'
+require 'etc'
 require_relative 'config'
 require_relative 'version'
 
@@ -19,8 +20,8 @@ module DEBUGGER__
       @session = nil
     end
 
-    class Terminate < StandardError
-    end
+    class Terminate < StandardError; end
+    class GreetingError < 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,10 +69,13 @@ 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 => e
@@ -76,11 +83,7 @@ module DEBUGGER__
           pp e.backtrace
         ensure
           DEBUGGER__.warn "Disconnected."
-          @sock = nil
-          @q_msg.close
-          @q_msg = nil
-          @q_ans.close
-          @q_ans = nil
+          cleanup_reader if greeting_done
         end # accept
 
       rescue Terminate
@@ -88,21 +91,62 @@ module DEBUGGER__
       end
     end
 
+    def cleanup_reader
+      @sock.close if @sock
+      @sock = nil
+      @q_msg.close
+      @q_msg = nil
+      @q_ans.close
+      @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+(.*)$/
+        check_cookie $1
+        @sock.puts "PID: #{Process.pid}, $0: #{$0}"
+        @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})"
-        end
-
-        cookie = CONFIG[:cookie]
-        if cookie && cookie != c
-          raise "Cookie mismatch (#{$2.inspect} was sent)"
+          raise GreetingError, "Incompatible version (server:#{VERSION} and client:#{$1})"
         end
+        parse_option(params)
 
-        @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'
@@ -110,18 +154,21 @@ 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 \/.* HTTP\/1.1/
         require_relative 'server_cdp'
 
         self.extend(UI_CDP)
         @repl = false
+        @need_pause_at_first = false
         CONFIG.set_config no_color: true
 
-        @web_sock = UI_CDP::WebSocket.new(@sock)
-        @web_sock.handshake
+        @ws_server = UI_CDP::WebSocketServer.new(@sock)
+        @ws_server.handshake
       else
-        raise "Greeting message error: #{g}"
+        raise GreetingError, "Unknown greeting message: #{g}"
       end
     end
 
@@ -141,6 +188,7 @@ module DEBUGGER__
           }
         end
 
+        return unless line
         next if line == :can_not_read
 
         case line
@@ -164,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
@@ -180,7 +228,7 @@ module DEBUGGER__
 
     def sigurg_overridden? prev_handler
       case prev_handler
-      when "SYSTEM_DEFAULT"
+      when "SYSTEM_DEFAULT", "DEFAULT"
         false
       when Proc
         if prev_handler.source_location[0] == __FILE__
@@ -193,10 +241,19 @@ module DEBUGGER__
       end
     end
 
+    begin
+      prev = trap(:SIGURG, nil)
+      trap(:SIGURG, prev)
+      TRAP_SIGNAL = :SIGURG
+    rescue ArgumentError
+      # maybe Windows?
+      TRAP_SIGNAL = :SIGINT
+    end
+
     def setup_interrupt
-      prev_handler = trap(:SIGURG) do
+      prev_handler = trap(TRAP_SIGNAL) do
         # $stderr.puts "trapped SIGINT"
-        ThreadClient.current.on_trap :SIGURG
+        ThreadClient.current.on_trap TRAP_SIGNAL
 
         case prev_handler
         when Proc
@@ -211,7 +268,7 @@ module DEBUGGER__
       end
       yield
     ensure
-      trap(:SIGURG, prev_handler)
+      trap(TRAP_SIGNAL, prev_handler)
     end
 
     attr_reader :reader_thread
@@ -277,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}"
@@ -299,7 +358,7 @@ module DEBUGGER__
 
     def pause
       # $stderr.puts "DEBUG: pause request"
-      Process.kill(:SIGURG, Process.pid)
+      Process.kill(TRAP_SIGNAL, Process.pid)
     end
 
     def quit n
@@ -312,47 +371,75 @@ 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
 
       super()
     end
 
+    def chrome_setup
+      require_relative 'server_cdp'
+
+      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=#{@local_addr.inspect_sockaddr}/#{SecureRandom.uuid}
+
+          EOS
+      end
+    end
+
     def accept
       retry_cnt = 0
       super # for fork
 
       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
 
-          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
+          case CONFIG[:open_frontend]
+          when 'chrome'
+            chrome_setup
+          when 'vscode'
+            vscode_setup @local_addr.inspect_sockaddr
+          end
 
           Socket.accept_loop(socks) do |sock, client|
             @client_addr = client
@@ -376,6 +463,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
 
@@ -388,64 +479,6 @@ module DEBUGGER__
       super()
     end
 
-    def vscode_setup
-      require 'tmpdir'
-      require 'json'
-      require 'fileutils'
-
-      dir = Dir.mktmpdir("ruby-debug-vscode-")
-      at_exit{
-        FileUtils.rm_rf dir
-      }
-      Dir.chdir(dir) do
-        Dir.mkdir('.vscode')
-        open('README.rb', 'w'){|f|
-          f.puts <<~MSG
-          # Wait for starting the attaching to the Ruby process
-          # This file will be removed at the end of the debuggee process.
-          #
-          # Note that vscode-rdbg extension is needed. Please install if you don't have.
-          MSG
-        }
-        open('.vscode/launch.json', 'w'){|f|
-          f.puts JSON.pretty_generate({
-            version: '0.2.0',
-            configurations: [
-            {
-              type: "rdbg",
-              name: "Attach with rdbg",
-              request: "attach",
-              rdbgPath: File.expand_path('../../exe/rdbg', __dir__),
-              debugPort: @sock_path,
-              autoAttach: true,
-            }
-            ]
-          })
-        }
-      end
-
-      cmds = ['code', "#{dir}/", "#{dir}/README.rb"]
-      cmdline = cmds.join(' ')
-      ssh_cmdline = "code --remote ssh-remote+[SSH hostname] #{dir}/ #{dir}/README.rb"
-
-      STDERR.puts "Launching: #{cmdline}"
-      env = ENV.delete_if{|k, h| /RUBY/ =~ k}.to_h
-
-      unless system(env, *cmds)
-        DEBUGGER__.warn <<~MESSAGE
-        Can not invoke the command.
-        Use the command-line on your terminal (with modification if you need).
-
-          #{cmdline}
-
-        If your application is running on a SSH remote host, please try:
-
-          #{ssh_cmdline}
-
-        MESSAGE
-      end
-    end
-
     def accept
       super # for fork
 
@@ -458,7 +491,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_frontend] == 'vscode'
 
       begin
         Socket.unix_server_loop @sock_path do |sock, client|