debug 1.4.0 → 1.5.0

data/lib/debug/server_dap.rb

@@ -3,52 +3,51 @@
 require 'json'
 require 'irb/completion'
 require 'tmpdir'
-require 'json'
 require 'fileutils'
 
 module DEBUGGER__
   module UI_DAP
     SHOW_PROTOCOL = ENV['DEBUG_DAP_SHOW_PROTOCOL'] == '1' || ENV['RUBY_DEBUG_DAP_SHOW_PROTOCOL'] == '1'
 
-    def self.setup sock_path
-      dir = Dir.mktmpdir("ruby-debug-vscode-")
-      at_exit{
+    def self.setup debug_port
+      if File.directory? '.vscode'
+        dir = Dir.pwd
+      else
+        dir = Dir.mktmpdir("ruby-debug-vscode-")
+        tempdir = true
+      end
+
+      at_exit do
         CONFIG[:skip_path] = [//] # skip all
-        FileUtils.rm_rf dir
-      }
+        FileUtils.rm_rf dir if tempdir
+      end
+
+      key = rand.to_s
+
       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|
+        Dir.mkdir('.vscode') if tempdir
+
+        # vscode-rdbg 0.0.9 or later is needed
+        open('.vscode/rdbg_autoattach.json', 'w') do |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,
-            }
-            ]
+            type: "rdbg",
+            name: "Attach with rdbg",
+            request: "attach",
+            rdbgPath: File.expand_path('../../exe/rdbg', __dir__),
+            debugPort: debug_port,
+            localfs: true,
+            autoAttach: key,
           })
-        }
+        end
       end
 
-      cmds = ['code', "#{dir}/", "#{dir}/README.rb"]
+      cmds = ['code', "#{dir}/"]
       cmdline = cmds.join(' ')
-      ssh_cmdline = "code --remote ssh-remote+[SSH hostname] #{dir}/ #{dir}/README.rb"
+      ssh_cmdline = "code --remote ssh-remote+[SSH hostname] #{dir}/"
 
       STDERR.puts "Launching: #{cmdline}"
       env = ENV.delete_if{|k, h| /RUBY/ =~ k}.to_h
+      env['RUBY_DEBUG_AUTOATTACH'] = key
 
       unless system(env, *cmds)
         DEBUGGER__.warn <<~MESSAGE
@@ -71,9 +70,20 @@ module DEBUGGER__
       end
     end
 
+    @local_fs = false
+
+    def self.local_fs
+      @local_fs
+    end
+
+    def self.local_fs_set
+      @local_fs = true
+    end
+
     def dap_setup bytes
       CONFIG.set_config no_color: true
       @seq = 0
+      UI_DAP.local_fs_set if self.kind_of?(UI_UnixDomainServer)
 
       show_protocol :>, bytes
       req = JSON.load(bytes)
@@ -145,8 +155,8 @@ module DEBUGGER__
     def send **kw
       kw[:seq] = @seq += 1
       str = JSON.dump(kw)
-      show_protocol '<', str
       @sock.write "Content-Length: #{str.bytesize}\r\n\r\n#{str}"
+      show_protocol '<', str
     end
 
     def send_response req, success: true, message: nil, **kw
@@ -212,15 +222,18 @@ module DEBUGGER__
         when 'launch'
           send_response req
           @is_attach = false
+          UI_DAP.local_fs_set if req.dig('arguments', 'localfs')
         when 'attach'
           send_response req
-          Process.kill(:SIGURG, Process.pid)
+          Process.kill(UI_ServerBase::TRAP_SIGNAL, Process.pid)
           @is_attach = true
+          UI_DAP.local_fs_set if req.dig('arguments', 'localfs')
         when 'setBreakpoints'
           path = args.dig('source', 'path')
-          bp_args = args['breakpoints']
+          SESSION.clear_line_breakpoints path
+
           bps = []
-          bp_args.each{|bp|
+          args['breakpoints'].each{|bp|
             line = bp['line']
             if cond = bp['condition']
               bps << SESSION.add_line_breakpoint(path, line, cond: cond)
@@ -313,7 +326,7 @@ module DEBUGGER__
           exit
         when 'pause'
           send_response req
-          Process.kill(:SIGURG, Process.pid)
+          Process.kill(UI_ServerBase::TRAP_SIGNAL, Process.pid)
         when 'reverseContinue'
           send_response req,
                         success: false, message: 'cancelled',
@@ -341,6 +354,8 @@ module DEBUGGER__
           raise "Unknown request: #{req.inspect}"
         end
       end
+    ensure
+      send_event :terminated unless @sock.closed?
     end
 
     ## called by the SESSION thread
@@ -496,7 +511,7 @@ module DEBUGGER__
       when 'source'
         ref = req.dig('arguments', 'sourceReference')
         if src = @src_map[ref]
-          @ui.respond req, content: src.join
+          @ui.respond req, content: src.join("\n")
         else
           fail_response req, message: 'not found...'
         end
@@ -595,7 +610,11 @@ module DEBUGGER__
         event! :dap_result, :backtrace, req, {
           stackFrames: @target_frames.map{|frame|
             path = frame.realpath || frame.path
-            ref = frame.file_lines unless path && File.exist?(path)
+            source_name = path ? File.basename(path) : frame.location.to_s
+
+            if !UI_DAP.local_fs || !(path && File.exist?(path))
+              ref = frame.file_lines
+            end
 
             {
               # id: ??? # filled by SESSION
@@ -603,7 +622,7 @@ module DEBUGGER__
               line: frame.location.lineno,
               column: 1,
               source: {
-                name: File.basename(frame.path),
+                name: source_name,
                 path: path,
                 sourceReference: ref,
               },
@@ -612,7 +631,7 @@ module DEBUGGER__
         }
       when :scopes
         fid = args.shift
-        frame = @target_frames[fid]
+        frame = get_frame(fid)
 
         lnum =
           if frame.binding
@@ -640,28 +659,12 @@ module DEBUGGER__
         }]
       when :scope
         fid = args.shift
-        frame = @target_frames[fid]
-        if b = frame.binding
-          vars = b.local_variables.map{|name|
-            v = b.local_variable_get(name)
-            variable(name, v)
-          }
-          special_local_variables frame do |name, val|
-            vars.unshift variable(name, val)
-          end
-          vars.unshift variable('%self', b.receiver)
-        elsif lvars = frame.local_variables
-          vars = lvars.map{|var, val|
-            variable(var, val)
-          }
-        else
-          vars = [variable('%self', frame.self)]
-          special_local_variables frame do |name, val|
-            vars.push variable(name, val)
-          end
+        frame = get_frame(fid)
+        vars = collect_locals(frame).map do |var, val|
+          variable(var, val)
         end
-        event! :dap_result, :scope, req, variables: vars, tid: self.id
 
+        event! :dap_result, :scope, req, variables: vars, tid: self.id
       when :variable
         vid = args.shift
         obj = @var_map[vid]
@@ -712,12 +715,11 @@ module DEBUGGER__
 
       when :evaluate
         fid, expr, context = args
-        frame = @target_frames[fid]
+        frame = get_frame(fid)
         message = nil
 
-        if frame && (b = frame.binding)
-          b = b.dup
-          special_local_variables current_frame do |name, var|
+        if frame && (b = frame.eval_binding)
+          special_local_variables frame do |name, var|
             b.local_variable_set(name, var) if /\%/ !~ name
           end
 
@@ -733,8 +735,7 @@ module DEBUGGER__
             case expr
             when /\A\@\S/
               begin
-                (r = b.receiver).instance_variable_defined?(expr) or raise(NameError)
-                result = r.instance_variable_get(expr)
+                result = b.receiver.instance_variable_get(expr)
               rescue NameError
                 message = "Error: Not defined instance variable: #{expr.inspect}"
               end
@@ -745,14 +746,12 @@ module DEBUGGER__
                   break false
                 end
               } and (message = "Error: Not defined global variable: #{expr.inspect}")
-            when /\A[A-Z]/
-              unless result = search_const(b, expr)
+            when /(\A((::[A-Z]|[A-Z])\w*)+)/
+              unless result = search_const(b, $1)
                 message = "Error: Not defined constants: #{expr.inspect}"
               end
             else
               begin
-                # try to check local variables
-                b.local_variable_defined?(expr) or raise NameError
                 result = b.local_variable_get(expr)
               rescue NameError
                 # try to check method
@@ -774,7 +773,7 @@ module DEBUGGER__
 
       when :completions
         fid, text = args
-        frame = @target_frames[fid]
+        frame = get_frame(fid)
 
         if (b = frame&.binding) && word = text&.split(/[\s\{]/)&.last
           words = IRB::InputCompletor::retrieve_completion_data(word, bind: b).compact
@@ -788,10 +787,8 @@ module DEBUGGER__
           end
 
           begin
-            if b&.local_variable_defined?(w)
-              v = b.local_variable_get(w)
-              phrase += " (variable:#{DEBUGGER__.safe_inspect(v)})"
-            end
+            v = b.local_variable_get(w)
+            phrase += " (variable:#{DEBUGGER__.safe_inspect(v)})"
           rescue NameError
           end
 
@@ -807,7 +804,7 @@ module DEBUGGER__
     end
 
     def search_const b, expr
-      cs = expr.split('::')
+      cs = expr.delete_prefix('::').split('::')
       [Object, *b.eval('Module.nesting')].reverse_each{|mod|
         if cs.all?{|c|
              if mod.const_defined?(c)