debug 1.3.1 → 1.4.0

data/lib/debug/server_dap.rb

@@ -1,10 +1,69 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'irb/completion'
+require 'tmpdir'
+require 'json'
+require 'fileutils'
 
 module DEBUGGER__
   module UI_DAP
-    SHOW_PROTOCOL = ENV['RUBY_DEBUG_DAP_SHOW_PROTOCOL'] == '1'
+    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{
+        CONFIG[:skip_path] = [//] # skip all
+        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 show_protocol dir, msg
       if SHOW_PROTOCOL
@@ -44,11 +103,12 @@ module DEBUGGER__
              ],
              supportsExceptionFilterOptions: true,
              supportsStepBack: true,
+             supportsEvaluateForHovers: true,
+             supportsCompletionsRequest: true,
 
              ## Will be supported
              # supportsExceptionOptions: true,
              # supportsHitConditionalBreakpoints:
-             # supportsEvaluateForHovers:
              # supportsSetVariable: true,
              # supportSuspendDebuggee:
              # supportsLogPoints:
@@ -58,7 +118,6 @@ module DEBUGGER__
 
              ## Possible?
              # supportsRestartFrame:
-             # supportsCompletionsRequest:
              # completionTriggerCharacters:
              # supportsModulesRequest:
              # additionalModuleColumns:
@@ -87,22 +146,22 @@ module DEBUGGER__
       kw[:seq] = @seq += 1
       str = JSON.dump(kw)
       show_protocol '<', str
-      @sock.write "Content-Length: #{str.size}\r\n\r\n#{str}"
+      @sock.write "Content-Length: #{str.bytesize}\r\n\r\n#{str}"
     end
 
-    def send_response req, success: true, **kw
+    def send_response req, success: true, message: nil, **kw
       if kw.empty?
         send type: 'response',
              command: req['command'],
              request_seq: req['seq'],
              success: success,
-             message: success ? 'Success' : 'Failed'
+             message: message || (success ? 'Success' : 'Failed')
       else
         send type: 'response',
              command: req['command'],
              request_seq: req['seq'],
              success: success,
-             message: success ? 'Success' : 'Failed',
+             message: message || (success ? 'Success' : 'Failed'),
              body: kw
       end
     end
@@ -119,29 +178,27 @@ module DEBUGGER__
     end
 
     def recv_request
-      begin
-        r = IO.select([@sock])
-
-        @session.process_group.sync do
-          raise RetryBecauseCantRead unless IO.select([@sock], nil, nil, 0)
-
-          case header = @sock.gets
-          when /Content-Length: (\d+)/
-            b = @sock.read(2)
-            raise b.inspect unless b == "\r\n"
-
-            l = @sock.read(s = $1.to_i)
-            show_protocol :>, l
-            JSON.load(l)
-          when nil
-            nil
-          else
-            raise "unrecognized line: #{l} (#{l.size} bytes)"
-          end
+      r = IO.select([@sock])
+
+      @session.process_group.sync do
+        raise RetryBecauseCantRead unless IO.select([@sock], nil, nil, 0)
+
+        case header = @sock.gets
+        when /Content-Length: (\d+)/
+          b = @sock.read(2)
+          raise b.inspect unless b == "\r\n"
+
+          l = @sock.read(s = $1.to_i)
+          show_protocol :>, l
+          JSON.load(l)
+        when nil
+          nil
+        else
+          raise "unrecognized line: #{l} (#{l.size} bytes)"
         end
-      rescue RetryBecauseCantRead
-        retry
       end
+    rescue RetryBecauseCantRead
+      retry
     end
 
     def process
@@ -222,14 +279,35 @@ module DEBUGGER__
           @q_msg << 'c'
           send_response req, allThreadsContinued: true
         when 'next'
-          @q_msg << 'n'
-          send_response req
+          begin
+            @session.check_postmortem
+            @q_msg << 'n'
+            send_response req
+          rescue PostmortemError
+            send_response req,
+                          success: false, message: 'postmortem mode',
+                          result: "'Next' is not supported while postmortem mode"
+          end
         when 'stepIn'
-          @q_msg << 's'
-          send_response req
+          begin
+            @session.check_postmortem
+            @q_msg << 's'
+            send_response req
+          rescue PostmortemError
+            send_response req,
+                          success: false, message: 'postmortem mode',
+                          result: "'stepIn' is not supported while postmortem mode"
+          end
         when 'stepOut'
-          @q_msg << 'fin'
-          send_response req
+          begin
+            @session.check_postmortem
+            @q_msg << 'fin'
+            send_response req
+          rescue PostmortemError
+            send_response req,
+                          success: false, message: 'postmortem mode',
+                          result: "'stepOut' is not supported while postmortem mode"
+          end
         when 'terminate'
           send_response req
           exit
@@ -255,7 +333,8 @@ module DEBUGGER__
              'scopes',
              'variables',
              'evaluate',
-             'source'
+             'source',
+             'completions'
           @q_msg << req
 
         else
@@ -361,7 +440,6 @@ module DEBUGGER__
           case ref[0]
           when :globals
             vars = global_variables.map do |name|
-              File.write('/tmp/x', "#{name}\n")
               gv = 'Not implemented yet...'
               {
                 name: name,
@@ -402,11 +480,13 @@ module DEBUGGER__
         end
       when 'evaluate'
         frame_id = req.dig('arguments', 'frameId')
+        context = req.dig('arguments', 'context')
+
         if @frame_map[frame_id]
           tid, fid = @frame_map[frame_id]
           expr = req.dig('arguments', 'expression')
           if tc = find_waiting_tc(tid)
-            tc << [:dap, :evaluate, req, fid, expr]
+            tc << [:dap, :evaluate, req, fid, expr, context]
           else
             fail_response req
           end
@@ -421,6 +501,21 @@ module DEBUGGER__
           fail_response req, message: 'not found...'
         end
         return :retry
+
+      when 'completions'
+        frame_id = req.dig('arguments', 'frameId')
+        tid, fid = @frame_map[frame_id]
+
+        if tc = find_waiting_tc(tid)
+          text = req.dig('arguments', 'text')
+          line = req.dig('arguments', 'line')
+          if col  = req.dig('arguments', 'column')
+            text = text.split(/\n/)[line.to_i - 1][0...(col.to_i - 1)]
+          end
+          tc << [:dap, :completions, req, fid, text]
+        else
+          fail_response req
+        end
       else
         raise "Unknown DAP request: #{req.inspect}"
       end
@@ -458,8 +553,15 @@ module DEBUGGER__
         register_vars result[:variables], tid
         @ui.respond req, result
       when :evaluate
-        tid = result.delete :tid
-        register_var result, tid
+        message = result.delete :message
+        if message
+          @ui.respond req, success: false, message: message
+        else
+          tid = result.delete :tid
+          register_var result, tid
+          @ui.respond req, result
+        end
+      when :completions
         @ui.respond req, result
       else
         raise "unsupported: #{args.inspect}"
@@ -491,7 +593,7 @@ module DEBUGGER__
       case type
       when :backtrace
         event! :dap_result, :backtrace, req, {
-          stackFrames: @target_frames.map.with_index{|frame, i|
+          stackFrames: @target_frames.map{|frame|
             path = frame.realpath || frame.path
             ref = frame.file_lines unless path && File.exist?(path)
 
@@ -544,8 +646,9 @@ module DEBUGGER__
             v = b.local_variable_get(name)
             variable(name, v)
           }
-          vars.unshift variable('%raised', frame.raised_exception) if frame.has_raised_exception
-          vars.unshift variable('%return', frame.return_value) if frame.has_return_value
+          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|
@@ -553,8 +656,9 @@ module DEBUGGER__
           }
         else
           vars = [variable('%self', frame.self)]
-          vars.push variable('%raised', frame.raised_exception) if frame.has_raised_exception
-          vars.push variable('%return', frame.return_value) if frame.has_return_value
+          special_local_variables frame do |name, val|
+            vars.push variable(name, val)
+          end
         end
         event! :dap_result, :scope, req, variables: vars, tid: self.id
 
@@ -575,7 +679,7 @@ module DEBUGGER__
             case obj
             when Hash
               vars = obj.map{|k, v|
-                variable(DEBUGGER__.short_inspect(k), v)
+                variable(DEBUGGER__.safe_inspect(k), v,)
               }
             when Struct
               vars = obj.members.map{|m|
@@ -607,32 +711,127 @@ module DEBUGGER__
         event! :dap_result, :variable, req, variables: (vars || []), tid: self.id
 
       when :evaluate
-        fid, expr = args
+        fid, expr, context = args
         frame = @target_frames[fid]
+        message = nil
 
         if frame && (b = frame.binding)
-          begin
-            result = b.eval(expr.to_s, '(DEBUG CONSOLE)')
-          rescue Exception => e
-            result = e
+          b = b.dup
+          special_local_variables current_frame do |name, var|
+            b.local_variable_set(name, var) if /\%/ !~ name
+          end
+
+          case context
+          when 'repl', 'watch'
+            begin
+              result = b.eval(expr.to_s, '(DEBUG CONSOLE)')
+            rescue Exception => e
+              result = e
+            end
+
+          when 'hover'
+            case expr
+            when /\A\@\S/
+              begin
+                (r = b.receiver).instance_variable_defined?(expr) or raise(NameError)
+                result = r.instance_variable_get(expr)
+              rescue NameError
+                message = "Error: Not defined instance variable: #{expr.inspect}"
+              end
+            when /\A\$\S/
+              global_variables.each{|gvar|
+                if gvar.to_s == expr
+                  result = eval(gvar.to_s)
+                  break false
+                end
+              } and (message = "Error: Not defined global variable: #{expr.inspect}")
+            when /\A[A-Z]/
+              unless result = search_const(b, expr)
+                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
+                if b.receiver.respond_to? expr, include_all: true
+                  result = b.receiver.method(expr)
+                else
+                  message = "Error: Can not evaluate: #{expr.inspect}"
+                end
+              end
+            end
+          else
+            message = "Error: unknown context: #{context}"
           end
         else
-          result = 'can not evaluate on this frame...'
+          result = 'Error: Can not evaluate on this frame'
         end
-        event! :dap_result, :evaluate, req, tid: self.id, **evaluate_result(result)
+
+        event! :dap_result, :evaluate, req, message: message, tid: self.id, **evaluate_result(result)
+
+      when :completions
+        fid, text = args
+        frame = @target_frames[fid]
+
+        if (b = frame&.binding) && word = text&.split(/[\s\{]/)&.last
+          words = IRB::InputCompletor::retrieve_completion_data(word, bind: b).compact
+        end
+
+        event! :dap_result, :completions, req, targets: (words || []).map{|phrase|
+          if /\b([_a-zA-Z]\w*[!\?]?)\z/ =~ phrase
+            w = $1
+          else
+            w = phrase
+          end
+
+          begin
+            if b&.local_variable_defined?(w)
+              v = b.local_variable_get(w)
+              phrase += " (variable:#{DEBUGGER__.safe_inspect(v)})"
+            end
+          rescue NameError
+          end
+
+          {
+            label: phrase,
+            text: w,
+          }
+        }
+
       else
         raise "Unknown req: #{args.inspect}"
       end
     end
 
+    def search_const b, expr
+      cs = expr.split('::')
+      [Object, *b.eval('Module.nesting')].reverse_each{|mod|
+        if cs.all?{|c|
+             if mod.const_defined?(c)
+               mod = mod.const_get(c)
+             else
+               false
+             end
+           }
+          # if-body
+          return mod
+        end
+      }
+      false
+    end
+
     def evaluate_result r
       v = variable nil, r
-      v.delete(:name)
-      v[:result] = DEBUGGER__.short_inspect(r)
+      v.delete :name
+      v.delete :value
+      v[:result] = DEBUGGER__.safe_inspect(r)
       v
     end
 
-    def variable_ name, obj, indexedVariables: 0, namedVariables: 0, use_short: true
+    def variable_ name, obj, indexedVariables: 0, namedVariables: 0
       if indexedVariables > 0 || namedVariables > 0
         vid = @var_map.size + 1
         @var_map[vid] = obj
@@ -643,7 +842,7 @@ module DEBUGGER__
       ivnum = obj.instance_variables.size
 
       { name: name,
-        value: DEBUGGER__.short_inspect(obj, use_short),
+        value: DEBUGGER__.safe_inspect(obj),
         type: obj.class.name || obj.class.to_s,
         variablesReference: vid,
         indexedVariables: indexedVariables,
@@ -658,7 +857,7 @@ module DEBUGGER__
       when Hash
         variable_ name, obj, namedVariables: obj.size
       when String
-        variable_ name, obj, use_short: false, namedVariables: 3 # #to_str, #length, #encoding
+        variable_ name, obj, namedVariables: 3 # #to_str, #length, #encoding
       when Struct
         variable_ name, obj, namedVariables: obj.size
       when Class, Module