debug 1.6.2 → 1.7.1

data/lib/debug/server_dap.rb

@@ -18,7 +18,7 @@ module DEBUGGER__
       end
 
       at_exit do
-        CONFIG.skip_all
+        DEBUGGER__.skip_all
         FileUtils.rm_rf dir if tempdir
       end
 
@@ -128,7 +128,8 @@ module DEBUGGER__
 
       case self
       when UI_UnixDomainServer
-        UI_DAP.local_fs_map_set true
+        # If the user specified a mapping, respect it, otherwise, make sure that no mapping is used
+        UI_DAP.local_fs_map_set CONFIG[:local_fs_map] || true
       when UI_TcpServer
         # TODO: loopback address can be used to connect other FS env, like Docker containers
         # UI_DAP.local_fs_set if @local_addr.ipv4_loopback? || @local_addr.ipv6_loopback?
@@ -198,6 +199,13 @@ module DEBUGGER__
              # supportsInstructionBreakpoints:
       )
       send_event 'initialized'
+      puts <<~WELCOME
+        Ruby REPL: You can run any Ruby expression here.
+        Note that output to the STDOUT/ERR printed on the TERMINAL.
+        [experimental]
+          `,COMMAND` runs `COMMAND` debug command (ex: `,info`).
+          `,help` to list all debug commands.
+      WELCOME
     end
 
     def send **kw
@@ -271,18 +279,24 @@ module DEBUGGER__
         ## boot/configuration
         when 'launch'
           send_response req
-          UI_DAP.local_fs_map_set req.dig('arguments', 'localfs') || req.dig('arguments', 'localfsMap')
-          @is_launch = true
+          # `launch` runs on debuggee on the same file system
+          UI_DAP.local_fs_map_set req.dig('arguments', 'localfs') || req.dig('arguments', 'localfsMap') || true
+          @nonstop = true
 
         when 'attach'
           send_response req
           UI_DAP.local_fs_map_set req.dig('arguments', 'localfs') || req.dig('arguments', 'localfsMap')
-          @is_launch = false
+
+          if req.dig('arguments', 'nonstop') == true
+            @nonstop = true
+          else
+            @nonstop = false
+          end
 
         when 'configurationDone'
           send_response req
 
-          if @is_launch
+          if @nonstop
             @q_msg << 'continue'
           else
             if SESSION.in_subsession?
@@ -419,16 +433,30 @@ module DEBUGGER__
             }
           }
 
+        when 'evaluate'
+          expr = req.dig('arguments', 'expression')
+          if /\A\s*,(.+)\z/ =~ expr
+            dbg_expr = $1
+            send_response req,
+                          result: "",
+                          variablesReference: 0
+            debugger do: dbg_expr
+          else
+            @q_msg << req
+          end
         when 'stackTrace',
              'scopes',
              'variables',
-             'evaluate',
              'source',
              'completions'
           @q_msg << req
 
         else
-          raise "Unknown request: #{req.inspect}"
+          if respond_to? mid = "request_#{req['command']}"
+            send mid, req
+          else
+            raise "Unknown request: #{req.inspect}"
+          end
         end
       end
     ensure
@@ -443,7 +471,11 @@ module DEBUGGER__
 
     def puts result
       # STDERR.puts "puts: #{result}"
-      # send_event 'output', category: 'stderr', output: "PUTS!!: " + result.to_s
+      send_event 'output', category: 'console', output: "#{result&.chomp}\n"
+    end
+
+    def ignore_output_on_suspend?
+      true
     end
 
     def event type, *args
@@ -488,6 +520,8 @@ module DEBUGGER__
   end
 
   class Session
+    include GlobalVariablesHelper
+
     def find_waiting_tc id
       @th_clients.each{|th, tc|
         return tc if tc.id == id && tc.waiting?
@@ -534,8 +568,12 @@ module DEBUGGER__
         if ref = @var_map[varid]
           case ref[0]
           when :globals
-            vars = global_variables.map do |name|
-              gv = 'Not implemented yet...'
+            vars = safe_global_variables.sort.map do |name|
+              begin
+                gv = eval(name.to_s)
+              rescue Exception => e
+                gv = e.inspect
+              end
               {
                 name: name,
                 value: gv.inspect,
@@ -580,6 +618,7 @@ module DEBUGGER__
         if @frame_map[frame_id]
           tid, fid = @frame_map[frame_id]
           expr = req.dig('arguments', 'expression')
+
           if tc = find_waiting_tc(tid)
             request_tc [:dap, :evaluate, req, fid, expr, context]
           else
@@ -684,10 +723,33 @@ module DEBUGGER__
     end
   end
 
+  class NaiveString
+    attr_reader :str
+    def initialize str
+      @str = str
+    end
+  end
+
   class ThreadClient
-    def value_inspect obj
+    MAX_LENGTH = 180
+
+    def value_inspect obj, short: true
       # TODO: max length should be configuarable?
-      DEBUGGER__.safe_inspect obj, short: true, max_length: 4 * 1024
+      str = DEBUGGER__.safe_inspect obj, short: short, max_length: MAX_LENGTH
+
+      if str.encoding == Encoding::UTF_8
+        str.scrub
+      else
+        str.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+      end
+    end
+
+    def dap_eval b, expr, _context, prompt: '(repl_eval)'
+      begin
+        b.eval(expr.to_s, prompt)
+      rescue Exception => e
+        e
+      end
     end
 
     def process_dap args
@@ -702,9 +764,10 @@ module DEBUGGER__
         frames = []
         @target_frames.each_with_index do |frame, i|
           next if i < start_frame
-          break if (levels -= 1) < 0
 
           path = frame.realpath || frame.path
+          next if skip_path?(path) && !SESSION.stop_stepping?(path, frame.location.lineno)
+          break if (levels -= 1) < 0
           source_name = path ? File.basename(path) : frame.location.to_s
 
           if (path && File.exist?(path)) && (local_path = UI_DAP.remote_to_local_path(path))
@@ -754,7 +817,7 @@ module DEBUGGER__
           name: 'Global variables',
           presentationHint: 'globals',
           variablesReference: 1, # GLOBAL
-          namedVariables: global_variables.size,
+          namedVariables: safe_global_variables.size,
           indexedVariables: 0,
           expensive: false,
         }]
@@ -791,14 +854,13 @@ module DEBUGGER__
               }
             when String
               vars = [
-                variable('#length', obj.length),
-                variable('#encoding', obj.encoding)
+                variable('#lengthddsfsd', obj.length),
+                variable('#encoding', obj.encoding),
               ]
+              printed_str = value_inspect(obj)
+              vars << variable('#dump', NaiveString.new(obj)) if printed_str.end_with?('...')
             when Class, Module
-              vars = obj.instance_variables.map{|iv|
-                variable(iv, obj.instance_variable_get(iv))
-              }
-              vars.unshift variable('%ancestors', obj.ancestors[1..])
+              vars << variable('%ancestors', obj.ancestors[1..])
             when Range
               vars = [
                 variable('#begin', obj.begin),
@@ -806,10 +868,12 @@ module DEBUGGER__
               ]
             end
 
-            vars += M_INSTANCE_VARIABLES.bind_call(obj).map{|iv|
-              variable(iv, M_INSTANCE_VARIABLE_GET.bind_call(obj, iv))
-            }
-            vars.unshift variable('#class', M_CLASS.bind_call(obj))
+            unless NaiveString === obj
+              vars += M_INSTANCE_VARIABLES.bind_call(obj).sort.map{|iv|
+                variable(iv, M_INSTANCE_VARIABLE_GET.bind_call(obj, iv))
+              }
+              vars.unshift variable('#class', M_CLASS.bind_call(obj))
+            end
           end
         end
         event! :dap_result, :variable, req, variables: (vars || []), tid: self.id
@@ -826,12 +890,7 @@ module DEBUGGER__
 
           case context
           when 'repl', 'watch'
-            begin
-              result = b.eval(expr.to_s, '(DEBUG CONSOLE)')
-            rescue Exception => e
-              result = e
-            end
-
+            result = dap_eval b, expr, context, prompt: '(DEBUG CONSOLE)'
           when 'hover'
             case expr
             when /\A\@\S/
@@ -841,7 +900,7 @@ module DEBUGGER__
                 message = "Error: Not defined instance variable: #{expr.inspect}"
               end
             when /\A\$\S/
-              global_variables.each{|gvar|
+              safe_global_variables.each{|gvar|
                 if gvar.to_s == expr
                   result = eval(gvar.to_s)
                   break false
@@ -911,10 +970,14 @@ module DEBUGGER__
 
     def search_const b, expr
       cs = expr.delete_prefix('::').split('::')
-      [Object, *b.eval('Module.nesting')].reverse_each{|mod|
+      [Object, *b.eval('::Module.nesting')].reverse_each{|mod|
         if cs.all?{|c|
              if mod.const_defined?(c)
-               mod = mod.const_get(c)
+               begin
+                 mod = mod.const_get(c)
+               rescue Exception
+                 false
+               end
              else
                false
              end
@@ -927,11 +990,17 @@ module DEBUGGER__
     end
 
     def evaluate_result r
-      v = variable nil, r
-      v.delete :name
-      v.delete :value
-      v[:result] = value_inspect(r)
-      v
+      variable nil, r
+    end
+
+    def type_name obj
+      klass = M_CLASS.bind_call(obj)
+
+      begin
+        klass.name || klass.to_s
+      rescue Exception => e
+        "<Error: #{e.message} (#{e.backtrace.first}>"
+      end
     end
 
     def variable_ name, obj, indexedVariables: 0, namedVariables: 0
@@ -942,15 +1011,31 @@ module DEBUGGER__
         vid = 0
       end
 
-      ivnum = M_INSTANCE_VARIABLES.bind_call(obj).size
+      namedVariables += M_INSTANCE_VARIABLES.bind_call(obj).size
 
-      { name: name,
-        value: value_inspect(obj),
-        type: (klass = M_CLASS.bind_call(obj)).name || klass.to_s,
-        variablesReference: vid,
-        indexedVariables: indexedVariables,
-        namedVariables: namedVariables + ivnum,
-      }
+      if NaiveString === obj
+        str = obj.str.dump
+        vid = indexedVariables = namedVariables = 0
+      else
+        str = value_inspect(obj)
+      end
+
+      if name
+        { name: name,
+          value: str,
+          type: type_name(obj),
+          variablesReference: vid,
+          indexedVariables: indexedVariables,
+          namedVariables: namedVariables,
+        }
+      else
+        { result: str,
+          type: type_name(obj),
+          variablesReference: vid,
+          indexedVariables: indexedVariables,
+          namedVariables: namedVariables,
+        }
+      end
     end
 
     def variable name, obj
@@ -960,7 +1045,7 @@ module DEBUGGER__
       when Hash
         variable_ name, obj, namedVariables: obj.size
       when String
-        variable_ name, obj, namedVariables: 3 # #to_str, #length, #encoding
+        variable_ name, obj, namedVariables: 3 # #length, #encoding, #to_str
       when Struct
         variable_ name, obj, namedVariables: obj.size
       when Class, Module