debug 1.7.1 → 1.9.1

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)
@@ -128,16 +128,16 @@ module DEBUGGER__
       @obj_map = {} # { object_id => ... } for CDP
 
       @tp_thread_begin = nil
+      @tp_thread_end = nil
+
       @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|
-        if !has_keep_script_lines || bps_pending_until_load?
-          eval_script = tp.eval_script unless has_keep_script_lines
-          ThreadClient.current.on_load tp.instruction_sequence, eval_script
-        end
+        eval_script = tp.eval_script unless @has_keep_script_lines
+        ThreadClient.current.on_load tp.instruction_sequence, eval_script
       }
       @tp_load_script.enable
 
@@ -169,12 +169,17 @@ module DEBUGGER__
       @ui = ui if ui
 
       @tp_thread_begin&.disable
+      @tp_thread_end&.disable
       @tp_thread_begin = nil
-
+      @tp_thread_end = nil
       @ui.activate self, on_fork: on_fork
 
       q = Queue.new
+      first_q = Queue.new
       @session_server = Thread.new do
+        # make sure `@session_server` is assigned
+        first_q.pop; first_q = nil
+
         Thread.current.name = 'DEBUGGER__::SESSION@server'
         Thread.current.abort_on_exception = true
 
@@ -192,10 +197,21 @@ module DEBUGGER__
         end
         @tp_thread_begin.enable
 
+        @tp_thread_end = TracePoint.new(:thread_end) do |tp|
+          @th_clients.delete(Thread.current)
+        end
+        @tp_thread_end.enable
+
+        if CONFIG[:irb_console] && !CONFIG[:open]
+          require_relative "irb_integration"
+          thc.activate_irb_integration
+        end
+
         # session start
         q << true
         session_server_main
       end
+      first_q << :ok
 
       q.pop
     end
@@ -205,6 +221,7 @@ module DEBUGGER__
       @thread_stopper.disable
       @tp_load_script.disable
       @tp_thread_begin.disable
+      @tp_thread_end.disable
       @bps.each_value{|bp| bp.disable}
       @th_clients.each_value{|thc| thc.close}
       @tracers.values.each{|t| t.disable}
@@ -219,11 +236,13 @@ module DEBUGGER__
 
       # activate new ui
       @tp_thread_begin.disable
+      @tp_thread_end.disable
       @ui.activate self
       if @ui.respond_to?(:reader_thread) && thc = get_thread_client(@ui.reader_thread)
         thc.mark_as_management
       end
       @tp_thread_begin.enable
+      @tp_thread_end.enable
     end
 
     def pop_event
@@ -242,6 +261,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
@@ -300,7 +328,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?
@@ -315,6 +343,7 @@ module DEBUGGER__
             end
           end
 
+          stop_all_threads
         when :method_breakpoint, :watch_breakpoint
           bp = ev_args[1]
           if bp
@@ -328,17 +357,15 @@ 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
-          # ignore
+          stop_all_threads
         end
 
         wait_command_loop
 
-      when :dap_result
-        dap_event ev_args # server.rb
-        wait_command_loop
-      when :cdp_result
-        cdp_event ev_args
+      when :protocol_result
+        process_protocol_result ev_args
         wait_command_loop
       end
     end
@@ -480,9 +507,9 @@ module DEBUGGER__
       # * `u[ntil]`
       #   * Similar to `next` command, but only stop later lines or the end of the current frame.
       #   * Similar to gdb's `advance` command.
-      # * `u[ntil] <[file:]line>
+      # * `u[ntil] <[file:]line>`
       #   * Run til the program reaches given location or the end of the current frame.
-      # * `u[ntil] <name>
+      # * `u[ntil] <name>`
       #   * Run til the program invokes a method `<name>`. `<name>` can be a regexp with `/name/`.
       register_command 'u', 'until',
                        repeat: true,
@@ -674,15 +701,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
 
@@ -799,15 +826,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
@@ -827,7 +854,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`
@@ -837,9 +864,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
 
@@ -853,7 +880,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
@@ -889,13 +916,13 @@ module DEBUGGER__
       # * `p <expr>`
       #   * Evaluate like `p <expr>` on the current frame.
       register_command 'p' do |arg|
-        request_tc [:eval, :p, arg.to_s]
+        request_eval :p, arg.to_s
       end
 
       # * `pp <expr>`
       #   * Evaluate like `pp <expr>` on the current frame.
       register_command 'pp' do |arg|
-        request_tc [:eval, :pp, arg.to_s]
+        request_eval :pp, arg.to_s
       end
 
       # * `eval <expr>`
@@ -906,7 +933,7 @@ module DEBUGGER__
           @ui.puts "\nTo evaluate the variable `#{cmd}`, use `pp #{cmd}` instead."
           :retry
         else
-          request_tc [:eval, :call, arg]
+          request_eval :call, arg
         end
       end
 
@@ -914,10 +941,11 @@ module DEBUGGER__
       #   * Invoke `irb` on the current frame.
       register_command 'irb' do |arg|
         if @ui.remote?
-          @ui.puts "not supported on the remote console."
+          @ui.puts "\nIRB is not supported on the remote console."
           :retry
+        else
+          request_eval :irb, nil
         end
-        request_tc [:eval, :irb]
       end
 
       ### Trace
@@ -972,7 +1000,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]
@@ -1137,7 +1165,7 @@ module DEBUGGER__
         @repl_prev_line = nil
         check_unsafe
 
-        request_tc [:eval, :pp, line]
+        request_eval :pp, line
       end
 
     rescue Interrupt
@@ -1321,10 +1349,6 @@ module DEBUGGER__
 
     # breakpoint management
 
-    def bps_pending_until_load?
-      @bps.any?{|key, bp| bp.pending_until_load?}
-    end
-
     def iterate_bps
       deleted_bps = []
       i = 0
@@ -1500,7 +1524,7 @@ module DEBUGGER__
     def clear_line_breakpoints path
       path = resolve_path(path)
       clear_breakpoints do |k, bp|
-        bp.is_a?(LineBreakpoint) && DEBUGGER__.compare_path(k.first, path)
+        bp.is_a?(LineBreakpoint) && bp.path_is?(path)
       end
     rescue Errno::ENOENT
       # just ignore
@@ -1524,7 +1548,7 @@ module DEBUGGER__
     # tracers
 
     def add_tracer tracer
-      if @tracers.has_key? tracer.key
+      if @tracers[tracer.key]&.enabled?
         tracer.disable
         @ui.puts "Duplicated tracer: #{tracer}"
       else
@@ -1724,25 +1748,30 @@ module DEBUGGER__
       file_path, reloaded = @sr.add(iseq, src)
       @ui.event :load, file_path, reloaded
 
-      pending_line_breakpoints = @bps.find_all do |key, bp|
-        LineBreakpoint === bp && !bp.iseq
-      end
+      # check breakpoints
+      if file_path
+        @bps.find_all do |_key, bp|
+          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
 
-      pending_line_breakpoints.each do |_key, bp|
-        if DEBUGGER__.compare_path(bp.path, (iseq.absolute_path || iseq.path))
-          bp.try_activate iseq
-        end
-      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
 
-      if reloaded
-        @bps.find_all do |key, bp|
-          LineBreakpoint === bp && DEBUGGER__.compare_path(bp.path, file_path)
-        end.each do |_key, bp|
-          @bps.delete bp.key # to allow duplicate
-          if nbp = LineBreakpoint.copy(bp, iseq)
+            nbp = LineBreakpoint.copy(bp, iseq)
             add_bp nbp
           end
         end
+      else # !file_path => file_path is not existing
+        @bps.find_all do |_key, bp|
+          LineBreakpoint === bp && !bp.iseq && DEBUGGER__.compare_path(bp.path, (iseq.absolute_path || iseq.path))
+        end.each do |_key, bp|
+          bp.try_activate iseq
+        end
       end
     end
 
@@ -1980,6 +2009,13 @@ module DEBUGGER__
     def after_fork_parent
       @ui.after_fork_parent
     end
+
+    # experimental API
+    def extend_feature session: nil, thread_client: nil, ui: nil
+      Session.include session if session
+      ThreadClient.include thread_client if thread_client
+      @ui.extend ui if ui
+    end
   end
 
   class ProcessGroup
@@ -2154,6 +2190,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
@@ -2438,7 +2475,7 @@ module DEBUGGER__
     end
 
     module DaemonInterceptor
-      def daemon
+      def daemon(*args)
         return super unless defined?(SESSION) && SESSION.active?
 
         _, child_hook = __fork_setup_for_debugger(:child)
@@ -2504,7 +2541,17 @@ module DEBUGGER__
 
   module TrapInterceptor
     def trap sig, *command, &command_proc
-      case sig&.to_sym
+      sym =
+        case sig
+        when String
+          sig.to_sym
+        when Integer
+          Signal.signame(sig)&.to_sym
+        else
+          sig
+        end
+
+      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'
@@ -34,7 +34,7 @@ module DEBUGGER__
       end
 
       def add iseq, src
-        # do nothing
+        # only manage loaded file names
         if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
           if @loaded_file_map.has_key? path
             return path, true # reloaded
@@ -49,7 +49,7 @@ module DEBUGGER__
         lines = iseq.script_lines&.map(&:chomp)
         line = iseq.first_line
         if line > 1
-          lines = [*([''] * (line - 1)), *lines]
+          [*([''] * (line - 1)), *lines]
         else
           lines
         end

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
@@ -14,6 +18,7 @@ module DEBUGGER__
   M_RESPOND_TO_P = method(:respond_to?).unbind
   M_METHOD = method(:method).unbind
   M_OBJECT_ID = method(:object_id).unbind
+  M_NAME = method(:name).unbind
 
   module SkipPathHelper
     def skip_path?(path)
@@ -47,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
@@ -468,10 +468,14 @@ module DEBUGGER__
       if file_lines = frame.file_lines
         frame_line = frame.location.lineno - 1
 
-        lines = file_lines.map.with_index do |e, i|
-          cur = i == frame_line ? '=>' : '  '
-          line = colorize_dim('%4d|' % (i+1))
-          "#{cur}#{line} #{e}"
+        if CONFIG[:no_lineno]
+          lines = file_lines
+        else
+          lines = file_lines.map.with_index do |e, i|
+            cur = i == frame_line ? '=>' : '  '
+            line = colorize_dim('%4d|' % (i+1))
+            "#{cur}#{line} #{e}"
+          end
         end
 
         unless start_line
@@ -607,12 +611,17 @@ module DEBUGGER__
 
     def get_consts expr = nil, only_self: false, &block
       if expr && !expr.empty?
-        _self = frame_eval(expr)
-        if M_KIND_OF_P.bind_call(_self, Module)
-          iter_consts _self, &block
-          return
+        begin
+          _self = frame_eval(expr, re_raise: true)
+        rescue Exception
+          # ignore
         else
-          raise "#{_self.inspect} (by #{expr}) is not a Module."
+          if M_KIND_OF_P.bind_call(_self, Module)
+            iter_consts _self, &block
+            return
+          else
+            puts "#{_self.inspect} (by #{expr}) is not a Module."
+          end
         end
       elsif _self = current_frame&.self
         cs = {}
@@ -852,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
@@ -1038,13 +1057,8 @@ module DEBUGGER__
           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
+            require_relative "irb_integration"
+            activate_irb_integration
           when :display, :try_display
             failed_results = []
             eval_src.each_with_index{|src, i|
@@ -1230,7 +1244,15 @@ module DEBUGGER__
     rescue SuspendReplay, SystemExit, Interrupt
       raise
     rescue Exception => e
-      pp ["DEBUGGER Exception: #{__FILE__}:#{__LINE__}", e, e.backtrace]
+      STDERR.puts e.cause.inspect
+      STDERR.puts e.inspect
+      Thread.list.each{|th|
+        STDERR.puts "@@@ #{th}"
+        th.backtrace.each{|b|
+          STDERR.puts " > #{b}"
+        }
+      }
+      p ["DEBUGGER Exception: #{__FILE__}:#{__LINE__}", e, e.backtrace]
       raise
     ensure
       @returning = false
@@ -1292,10 +1314,14 @@ module DEBUGGER__
               frame._callee = b.eval('__callee__')
             end
           }
-          @log << frames
+          append(frames)
         }
       end
 
+      def append frames
+        @log << frames
+      end
+
       def enable
         unless @tp_recorder.enabled?
           @log.clear

data/lib/debug/tracer.rb

@@ -54,6 +54,10 @@ module DEBUGGER__
       @tracer.disable
     end
 
+    def enabled?
+      @tracer.enabled?
+    end
+
     def description
       nil
     end
@@ -85,11 +89,6 @@ module DEBUGGER__
       end
     end
 
-    def puts msg
-      @output.puts msg
-      @output.flush
-    end
-
     def minfo tp
       return "block{}" if tp.event == :b_call
 

data/lib/debug/version.rb

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