debug 1.8.0 → 1.9.2

data/lib/debug/console.rb

@@ -5,30 +5,9 @@ module DEBUGGER__
       raise LoadError if CONFIG[:no_reline]
       require 'reline'
 
-      # reline 0.2.7 or later is required.
-      raise LoadError if Reline::VERSION < '0.2.7'
-
       require_relative 'color'
-      include Color
-
-      begin
-        prev = trap(:SIGWINCH, nil)
-        trap(:SIGWINCH, prev)
-        SIGWINCH_SUPPORTED = true
-      rescue ArgumentError
-        SIGWINCH_SUPPORTED = false
-      end
 
-      # 0.2.7 has SIGWINCH issue on non-main thread
-      class ::Reline::LineEditor
-        m = Module.new do
-          def reset(prompt = '', encoding:)
-            super
-            Signal.trap(:SIGWINCH, nil)
-          end
-        end
-        prepend m
-      end if SIGWINCH_SUPPORTED
+      include Color
 
       def parse_input buff, commands
         c, rest = get_command buff
@@ -56,10 +35,10 @@ module DEBUGGER__
         Reline.prompt_proc = -> args, *kw do
           case state = parse_input(args.first, commands)
           when nil, :command
-            [prompt, prompt]
+            [prompt]
           when :ruby
-            [prompt.sub('rdbg'){colorize('ruby', [:RED])}] * 2
-          end
+            [prompt.sub('rdbg'){colorize('ruby', [:RED])}]
+          end * args.size
         end
 
         Reline.completion_proc = -> given do
@@ -96,7 +75,7 @@ module DEBUGGER__
           when nil
             buff
           when :ruby
-            colorize_code(buff.chomp)
+            colorize_code(buff)
           end
         end unless CONFIG[:no_hint]
 
@@ -164,7 +143,7 @@ module DEBUGGER__
       rescue LoadError
         def readline prompt
           print prompt
-          gets
+          $stdin.gets
         end
 
         def history
@@ -224,11 +203,11 @@ module DEBUGGER__
     end
 
     def load_history
-      read_history_file.count{|line|
+      read_history_file.each{|line|
         line.strip!
         history << line unless line.empty?
-      }
+      } if history.empty?
+      history.count
     end
   end # class Console
 end
-

data/lib/debug/irb_integration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'irb'
+
+module DEBUGGER__
+  module IrbPatch
+    def evaluate(line, line_no)
+      SESSION.send(:restart_all_threads)
+      super
+      # This is to communicate with the test framework so it can feed the next input
+      puts "INTERNAL_INFO: {}" if ENV['RUBY_DEBUG_TEST_UI'] == 'terminal'
+    ensure
+      SESSION.send(:stop_all_threads)
+    end
+  end
+
+  class ThreadClient
+    def activate_irb_integration
+      IRB.setup(location, argv: [])
+      workspace = IRB::WorkSpace.new(current_frame&.binding || TOPLEVEL_BINDING)
+      irb = IRB::Irb.new(workspace)
+      IRB.conf[:MAIN_CONTEXT] = irb.context
+      IRB::Debug.setup(irb)
+      IRB::Context.prepend(IrbPatch)
+    end
+  end
+
+  class Session
+    def deactivate_irb_integration
+      Reline.completion_proc = nil
+      Reline.output_modifier_proc = nil
+      Reline.autocompletion = false
+      Reline.dig_perfect_match_proc = nil
+      reset_ui UI_LocalConsole.new
+    end
+  end
+end

data/lib/debug/prelude.rb

@@ -5,7 +5,7 @@ return if defined?(::DEBUGGER__::Session)
 
 # Put the following line in your login script (e.g. ~/.bash_profile) with modified path:
 #
-#   export RUBYOPT="-r /path/to/debug/prelude $(RUBYOPT)"
+#   export RUBYOPT="-r /path/to/debug/prelude ${RUBYOPT}"
 #
 module Kernel
   def debugger(*a, up_level: 0, **kw)

data/lib/debug/server.rb

@@ -133,7 +133,7 @@ module DEBUGGER__
         require 'etc'
 
         check_cookie $1
-        @sock.puts "PID: #{Process.pid}, $0: #{$0}"
+        @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
@@ -149,7 +149,9 @@ module DEBUGGER__
         end
         parse_option(params)
 
-        puts "DEBUGGER (client): Connected. PID:#{Process.pid}, $0:#{$0}"
+        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
 
@@ -410,7 +412,7 @@ module DEBUGGER__
       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}/#{@uuid}
+           devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&noJavaScriptCompletion=true&ws=#{@local_addr.inspect_sockaddr}/#{@uuid}
 
         EOS
     end

data/lib/debug/server_cdp.rb

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'digest/sha1'
-require 'base64'
 require 'securerandom'
 require 'stringio'
 require 'open3'
@@ -59,7 +58,7 @@ module DEBUGGER__
             ws_client.send sessionId: s_id, id: 5,
                           method: 'Page.navigate',
                           params: {
-                            url: "devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{addr}/#{uuid}",
+                            url: "devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&noJavaScriptCompletion=true&ws=#{addr}/#{uuid}",
                             frameId: f_id
                           }
           when 101
@@ -131,7 +130,7 @@ module DEBUGGER__
           stdout.close
           data = stderr.readpartial 4096
           stderr.close
-          if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+          if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
             port = $1
             path = $2
           end
@@ -158,7 +157,7 @@ module DEBUGGER__
             raise NotFoundChromeEndpointError
           end
           stderr.close
-          if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+          if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
             port = $1
             path = $2
           end
@@ -190,7 +189,7 @@ module DEBUGGER__
         while i < ITERATIONS
           i += 1
           if File.exist?(tf) && data = File.read(tf)
-            if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+            if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
               port = $1
               path = $2
               return [port, path]
@@ -297,8 +296,8 @@ module DEBUGGER__
         res = @sock.readpartial 4092
         show_protocol :<, res
 
-        if res.match /^Sec-WebSocket-Accept: (.*)\r\n/
-          correct_key = Base64.strict_encode64 Digest::SHA1.digest "#{key}==258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+        if res.match(/^Sec-WebSocket-Accept: (.*)\r\n/)
+          correct_key = Digest::SHA1.base64digest "#{key}==258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
           raise "The Sec-WebSocket-Accept value: #{$1} is not valid" unless $1 == correct_key
         else
           raise "Unknown response: #{res}"
@@ -378,8 +377,8 @@ module DEBUGGER__
         req = @sock.readpartial 4096
         show_protocol '>', req
 
-        if req.match /^Sec-WebSocket-Key: (.*)\r\n/
-          accept = Base64.strict_encode64 Digest::SHA1.digest "#{$1}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+        if req.match(/^Sec-WebSocket-Key: (.*)\r\n/)
+          accept = Digest::SHA1.base64digest "#{$1}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
           res = "HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Accept: #{accept}\r\n\r\n"
           @sock.print res
           show_protocol :<, res
@@ -474,7 +473,7 @@ module DEBUGGER__
         when 'Debugger.getScriptSource'
           @q_msg << req
         when 'Debugger.enable'
-          send_response req
+          send_response req, debuggerId: rand.to_s
           @q_msg << req
         when 'Runtime.enable'
           send_response req
@@ -658,7 +657,7 @@ module DEBUGGER__
 
     def activate_bp bps
       bps.each_key{|k|
-        if k.match /^\d+:(\d+):(.*)/
+        if k.match(/^\d+:(\d+):(.*)/)
           line = $1
           path = $2
           SESSION.add_line_breakpoint(path, line.to_i + 1)

data/lib/debug/server_dap.rb

@@ -788,7 +788,9 @@ module DEBUGGER__
 
     def dap_eval b, expr, _context, prompt: '(repl_eval)'
       begin
-        b.eval(expr.to_s, prompt)
+        tp_allow_reentry do
+          b.eval(expr.to_s, prompt)
+        end
       rescue Exception => e
         e
       end

data/lib/debug/session.rb

@@ -82,7 +82,7 @@ class RubyVM::InstructionSequence
   def first_line
     self.to_a[4][:code_location][0]
   end unless method_defined?(:first_line)
-end
+end if defined?(RubyVM::InstructionSequence)
 
 module DEBUGGER__
   PresetCommands = Struct.new(:commands, :source, :auto_continue)
@@ -133,7 +133,7 @@ module DEBUGGER__
       @commands = {}
       @unsafe_context = false
 
-      @has_keep_script_lines = RubyVM.respond_to? :keep_script_lines
+      @has_keep_script_lines = defined?(RubyVM.keep_script_lines)
 
       @tp_load_script = TracePoint.new(:script_compiled){|tp|
         eval_script = tp.eval_script unless @has_keep_script_lines
@@ -209,6 +209,12 @@ module DEBUGGER__
       first_q << :ok
 
       q.pop
+
+      # For activating irb:rdbg with startup config like `RUBY_DEBUG_IRB_CONSOLE=1`
+      # Because in that case the `Config#if_updated` callback would not be triggered
+      if CONFIG[:irb_console] && !CONFIG[:open]
+        activate_irb_integration
+      end
     end
 
     def deactivate
@@ -256,6 +262,15 @@ module DEBUGGER__
       @tc << req
     end
 
+    def request_tc_with_restarted_threads(req)
+      restart_all_threads
+      request_tc(req)
+    end
+
+    def request_eval type, src
+      request_tc_with_restarted_threads [:eval, type, src]
+    end
+
     def process_event evt
       # variable `@internal_info` is only used for test
       tc, output, ev, @internal_info, *ev_args = evt
@@ -314,7 +329,7 @@ module DEBUGGER__
         if @displays.empty?
           wait_command_loop
         else
-          request_tc [:eval, :display, @displays]
+          request_eval :display, @displays
         end
       when :result
         raise "[BUG] not in subsession" if @subsession_stack.empty?
@@ -329,6 +344,7 @@ module DEBUGGER__
             end
           end
 
+          stop_all_threads
         when :method_breakpoint, :watch_breakpoint
           bp = ev_args[1]
           if bp
@@ -342,6 +358,7 @@ module DEBUGGER__
           obj_inspect = ev_args[2]
           opt = ev_args[3]
           add_tracer ObjectTracer.new(@ui, obj_id, obj_inspect, **opt)
+          stop_all_threads
         else
           stop_all_threads
         end
@@ -685,15 +702,15 @@ module DEBUGGER__
       register_command 'bt', 'backtrace', unsafe: false do |arg|
         case arg
         when /\A(\d+)\z/
-          request_tc [:show, :backtrace, arg.to_i, nil]
+          request_tc_with_restarted_threads [:show, :backtrace, arg.to_i, nil]
         when /\A\/(.*)\/\z/
           pattern = $1
-          request_tc [:show, :backtrace, nil, Regexp.compile(pattern)]
+          request_tc_with_restarted_threads [:show, :backtrace, nil, Regexp.compile(pattern)]
         when /\A(\d+)\s+\/(.*)\/\z/
           max, pattern = $1, $2
-          request_tc [:show, :backtrace, max.to_i, Regexp.compile(pattern)]
+          request_tc_with_restarted_threads [:show, :backtrace, max.to_i, Regexp.compile(pattern)]
         else
-          request_tc [:show, :backtrace, nil, nil]
+          request_tc_with_restarted_threads [:show, :backtrace, nil, nil]
         end
       end
 
@@ -810,15 +827,15 @@ module DEBUGGER__
 
         case sub
         when nil
-          request_tc [:show, :default, pat] # something useful
+          request_tc_with_restarted_threads [:show, :default, pat] # something useful
         when :locals
-          request_tc [:show, :locals, pat]
+          request_tc_with_restarted_threads [:show, :locals, pat]
         when :ivars
-          request_tc [:show, :ivars, pat, opt]
+          request_tc_with_restarted_threads [:show, :ivars, pat, opt]
         when :consts
-          request_tc [:show, :consts, pat, opt]
+          request_tc_with_restarted_threads [:show, :consts, pat, opt]
         when :globals
-          request_tc [:show, :globals, pat]
+          request_tc_with_restarted_threads [:show, :globals, pat]
         when :threads
           thread_list
           :retry
@@ -838,7 +855,7 @@ module DEBUGGER__
       #   * Show you available methods and instance variables of the given object.
       #   * If the object is a class/module, it also lists its constants.
       register_command 'outline', 'o', 'ls', unsafe: false do |arg|
-        request_tc [:show, :outline, arg]
+        request_tc_with_restarted_threads [:show, :outline, arg]
       end
 
       # * `display`
@@ -848,9 +865,9 @@ module DEBUGGER__
       register_command 'display', postmortem: false do |arg|
         if arg && !arg.empty?
           @displays << arg
-          request_tc [:eval, :try_display, @displays]
+          request_eval :try_display, @displays
         else
-          request_tc [:eval, :display, @displays]
+          request_eval :display, @displays
         end
       end
 
@@ -864,7 +881,7 @@ module DEBUGGER__
           if @displays[n = $1.to_i]
             @displays.delete_at n
           end
-          request_tc [:eval, :display, @displays]
+          request_eval :display, @displays
         when nil
           if ask "clear all?", 'N'
             @displays.clear
@@ -922,13 +939,15 @@ module DEBUGGER__
       end
 
       # * `irb`
-      #   * Invoke `irb` on the current frame.
+      #   * Activate and switch to `irb:rdbg` console
       register_command 'irb' do |arg|
         if @ui.remote?
-          @ui.puts "not supported on the remote console."
-          :retry
+          @ui.puts "\nIRB is not supported on the remote console."
+        else
+          config_set :irb_console, true
         end
-        request_eval :irb, nil
+
+        :retry
       end
 
       ### Trace
@@ -983,7 +1002,7 @@ module DEBUGGER__
           :retry
 
         when /\Aobject\s+(.+)/
-          request_tc [:trace, :object, $1.strip, {pattern: pattern, into: into}]
+          request_tc_with_restarted_threads [:trace, :object, $1.strip, {pattern: pattern, into: into}]
 
         when /\Aoff\s+(\d+)\z/
           if t = @tracers.values[$1.to_i]
@@ -1164,11 +1183,6 @@ module DEBUGGER__
       return :retry
     end
 
-    def request_eval type, src
-      restart_all_threads
-      request_tc [:eval, type, src]
-    end
-
     def step_command type, arg
       if type == :until
         leave_subsession [:step, type, arg]
@@ -1739,15 +1753,19 @@ module DEBUGGER__
       # check breakpoints
       if file_path
         @bps.find_all do |_key, bp|
-          LineBreakpoint === bp && bp.path_is?(file_path)
+          LineBreakpoint === bp && bp.path_is?(file_path) && (iseq.first_lineno..iseq.last_line).cover?(bp.line)
         end.each do |_key, bp|
           if !bp.iseq
             bp.try_activate iseq
           elsif reloaded
             @bps.delete bp.key # to allow duplicate
-            if nbp = LineBreakpoint.copy(bp, iseq)
-              add_bp nbp
-            end
+
+            # When we delete a breakpoint from the @bps hash, we also need to deactivate it or else its tracepoint event
+            # will continue to be enabled and we'll suspend on ghost breakpoints
+            bp.delete
+
+            nbp = LineBreakpoint.copy(bp, iseq)
+            add_bp nbp
           end
         end
       else # !file_path => file_path is not existing
@@ -1860,6 +1878,12 @@ module DEBUGGER__
       end
     end
 
+    def activate_irb_integration
+      require_relative "irb_integration"
+      thc = get_thread_client(@session_server)
+      thc.activate_irb_integration
+    end
+
     def enter_postmortem_session exc
       return unless exc.instance_variable_defined? :@__debugger_postmortem_frames
 
@@ -2174,6 +2198,7 @@ module DEBUGGER__
       case loc.absolute_path
       when dir_prefix
       when %r{rubygems/core_ext/kernel_require\.rb}
+      when %r{bundled_gems\.rb}
       else
         return loc if loc.absolute_path
       end
@@ -2534,7 +2559,7 @@ module DEBUGGER__
           sig
         end
 
-      case sig&.to_s&.to_sym
+      case sym
       when :INT, :SIGINT
         if defined?(SESSION) && SESSION.active? && SESSION.intercept_trap_sigint?
           return SESSION.save_int_trap(command.empty? ? command_proc : command.first)

data/lib/debug/source_repository.rb

@@ -22,7 +22,7 @@ module DEBUGGER__
       end
     end
 
-    if RubyVM.respond_to? :keep_script_lines
+    if defined?(RubyVM.keep_script_lines)
       # Ruby 3.1 and later
       RubyVM.keep_script_lines = true
       require 'objspace'

data/lib/debug/thread_client.rb

@@ -5,6 +5,10 @@ require 'pp'
 
 require_relative 'color'
 
+class ::Thread
+  attr_accessor :debug_thread_client
+end
+
 module DEBUGGER__
   M_INSTANCE_VARIABLES = method(:instance_variables).unbind
   M_INSTANCE_VARIABLE_GET = method(:instance_variable_get).unbind
@@ -48,12 +52,7 @@ module DEBUGGER__
 
   class ThreadClient
     def self.current
-      if thc = Thread.current[:DEBUGGER__ThreadClient]
-        thc
-      else
-        thc = SESSION.get_thread_client
-        Thread.current[:DEBUGGER__ThreadClient] = thc
-      end
+      Thread.current.debug_thread_client ||= SESSION.get_thread_client
     end
 
     include Color
@@ -614,7 +613,7 @@ module DEBUGGER__
       if expr && !expr.empty?
         begin
           _self = frame_eval(expr, re_raise: true)
-        rescue Exception => e
+        rescue Exception
           # ignore
         else
           if M_KIND_OF_P.bind_call(_self, Module)
@@ -862,8 +861,18 @@ module DEBUGGER__
     class SuspendReplay < Exception
     end
 
+    if ::Fiber.respond_to?(:blocking)
+      private def fiber_blocking
+        ::Fiber.blocking{yield}
+      end
+    else
+      private def fiber_blocking
+        yield
+      end
+    end
+
     def wait_next_action
-      wait_next_action_
+      fiber_blocking{wait_next_action_}
     rescue SuspendReplay
       replay_suspend
     end
@@ -980,7 +989,7 @@ module DEBUGGER__
                   true
                 else
                   true if depth >= DEBUGGER__.frame_depth - 3 &&
-                          caller_locations(2, 1).first.label == target_location_label
+                          caller_locations(2, 1).first.base_label == target_location_label
                           # TODO: imcomplete condition
                 end
               end
@@ -996,7 +1005,7 @@ module DEBUGGER__
                   true if pat === tp.callee_id.to_s
                 else # :return, :b_return
                   true if depth >= DEBUGGER__.frame_depth - 3 &&
-                          caller_locations(2, 1).first.label == target_location_label
+                          caller_locations(2, 1).first.base_label == target_location_label
                           # TODO: imcomplete condition
                 end
               end
@@ -1047,14 +1056,6 @@ module DEBUGGER__
             end
           when :call
             result = frame_eval(eval_src)
-          when :irb
-            require 'irb' # prelude's binding.irb doesn't have show_code option
-            begin
-              result = frame_eval('binding.irb(show_code: false)', binding_location: true)
-            ensure
-              # workaround: https://github.com/ruby/debug/issues/308
-              Reline.prompt_proc = nil if defined? Reline
-            end
           when :display, :try_display
             failed_results = []
             eval_src.each_with_index{|src, i|

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.8.0"
+  VERSION = "1.9.2"
 end