debug 1.3.0 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adddd814397fedb45de84db6ccb2dc49c3aefae141e73b156e3b87c29a3edf60
-  data.tar.gz: 0b0cb92d077f04ed9f7bfa1f79f56f35dc4dc9054f27ea3608d23c5f0d462274
+  metadata.gz: 58d7a886dc29b717d9f31ca7859a40a881a251a4c5e64705ac38de1cb94c0f32
+  data.tar.gz: a58994d8d302dac0aedd63775b8d81769d326a6bb0746d9953182fa8b36894fd
 SHA512:
-  metadata.gz: 3e60eb57c1ec6c164d6956e777f8ac52e15ba84c13b97443650ac67f2b503397cfc57d9f0b897f331946e7200067227d61e7b81f459c5b42e44098dbbe9161ef
-  data.tar.gz: 3a377c3da4482103142fbece04cb896522f952aa3d43f316f50dd699f35f0c24db100df3e706e6d86cbc752021800bbfdff6131a95023d497741d68c396e5ed7
+  metadata.gz: 3988bc3fd10cab3592a9f6b3b816dd2f5cabf5e8e4bceaec646011a1663b037a7f9683008c77d1c91a0a8f984540c16ef5975fa14b93f84b6cca5915e98df440
+  data.tar.gz: 4283c41adf172ae2d1e51bb34adfb65ab2b521862bae6be7bd08ba485bea178e0e2ec511db7b9f0297e2aea4e4d2ac249887bb9271f51d71d6beb76a0aee63d0

data/CONTRIBUTING.md

@@ -206,17 +206,15 @@ end
 #### gentest options
 You can get more information about `gentest` here.
 
-The default method name is `test_foo` and the class name is `FooTest`. The file name will be `[Lowercase letters with "Test" removed from the class name]_test.rb`.
-```shell
-# run without any options(test method name will be `test_foo`, class name will be `FooTest`, file name will be `foo_test.rb`)
-$ bin/gentest target.rb
-# specify the class name(test method name will be `test_foo`, class name will be `StepTest`, file name will be `step_test.rb`)
-$ bin/gentest target.rb -c StepTest
-# specify the method name(test method name will be `test_step`, class name will be `FooTest`, file name will be `foo_test.rb`)
-$ bin/gentest target.rb -m test_step
-# specify class name and method name(test method name will be `test_step`, class name will be `StepTest`, file name will be `step_test.rb`.)
-$ bin/gentest target.rb -c StepTest -m test_step
-```
+The default method name is `test_#{some integer numbers}`, the class name is `FooTest`, and the file name will be `foo_test.rb`.
+The following table shows examples of the gentest options.
+
+| Command | Description | File | Class | Method |
+| --- | --- | --- | --- | --- |
+| `$ bin/gentest target.rb` | Run without any options | `foo_test.rb` | `FooTest` | `test_#{some integer numbers}` |
+| `$ bin/gentest target.rb -c step` | Specify the class name | `step_test.rb` | `StepTest` | `test_#{some integer numbers}` |
+| `$ bin/gentest target.rb -m test_step` | Specify the method name | `foo_test.rb` | `FooTest` | `test_step` |
+| `$ bin/gentest target.rb -c step -m test_step` | Specify the class name and the method name | `step_test.rb` | `StepTest` | `test_step` |
 
 ## To Update README
 

data/README.md

@@ -11,7 +11,7 @@ New debug.rb has several advantages:
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
-  * Integeration with rich debugger frontend
+  * Integration with rich debugger frontend
     * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
     * Chrome DevTools
 * Extensible: application can introduce debugging support with several ways:
@@ -340,7 +340,7 @@ $ RUBY_DEBUG_PORT=12345 ruby target.rb
 
 ### Integration with external debugger frontend
 
-You can attach with external debuger frontend with VSCode and Chrome.
+You can attach with external debugger frontend with VSCode and Chrome.
 
 ```
 $ rdbg --open=[frontend] target.rb
@@ -352,7 +352,7 @@ Also `open` command allows opening the debug port.
 
 #### VSCode integration
 
-If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the fowllowing steps.
+If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the following steps.
 
 `rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
 
@@ -364,7 +364,7 @@ Launching: code /tmp/ruby-debug-vscode-20211014-27706-gd7e85/ /tmp/ruby-debug-vs
 DEBUGGER: Connected.
 ```
 
-And it tris to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
+And it tries to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
 
 You can also use `open vscode` command in REPL.
 

data/ext/debug/debug.c

@@ -64,7 +64,7 @@ di_body(const rb_debug_inspector_t *dc, void *ptr)
 
         if (!NIL_P(iseq)) {
             VALUE path = iseq_realpath(iseq);
-            if (!NIL_P(path) && str_start_with(path, skip_path_prefix)) continue;
+            if (!NIL_P(path) && !NIL_P(skip_path_prefix) && str_start_with(path, skip_path_prefix)) continue;
         }
 
         loc = RARRAY_AREF(locs, i);

data/lib/debug/client.rb

@@ -91,9 +91,7 @@ module DEBUGGER__
         @console.readline "(rdbg:remote\##{@pid}) "
       else
         @console.readline "(rdbg:remote) "
-      end.tap{|line|
-        p readline: line
-      }
+      end
     end
 
     def connect_unix name = nil

data/lib/debug/color.rb

@@ -79,7 +79,7 @@ module DEBUGGER__
     end
 
     if defined? IRB::Color.colorize_code
-      if SUPPORT_COLORABLE_OPTION
+      if defined? SUPPORT_COLORABLE_OPTION
         def colorize_code code
           IRB::Color.colorize_code(code, colorable: true)
         end

data/lib/debug/config.rb

@@ -371,38 +371,54 @@ module DEBUGGER__
 
   ## Unix domain socket configuration
 
-  def self.unix_domain_socket_dir
+  def self.check_dir_authority path
+    fs = File.stat(path)
+
+    unless (dir_uid = fs.uid) == (uid = Process.uid)
+      raise "#{path} uid is #{dir_uid}, but Process.uid is #{uid}"
+    end
+    unless (dir_mode = fs.mode) == 040700 # 4: dir, 7:rwx
+      raise "#{path}'s mode is #{dir_mode.to_s(8)} (should be 040700)"
+    end
+
+    path
+  end
+
+  def self.unix_domain_socket_tmpdir
     require 'tmpdir'
 
-    case
-    when path = CONFIG[:sock_dir]
-    when path = ENV['XDG_RUNTIME_DIR']
-    when tmpdir = Dir.tmpdir
+    if tmpdir = Dir.tmpdir
       path = File.join(tmpdir, "ruby-debug-sock-#{Process.uid}")
 
-      if File.exist?(path)
-        fs = File.stat(path)
-        unless (dir_uid = fs.uid) == (uid = Process.uid)
-          raise "#{path} uid is #{dir_uid}, but Process.uid is #{uid}"
-        end
-        unless (dir_mode = fs.mode) == 040700 # 4: dir, 7:rwx
-          raise "#{path}'s mode is #{dir_mode.to_s(8)} (should be 040700)"
-        end
-      else
+      unless File.exist?(path)
         d = Dir.mktmpdir
         File.rename(d, path)
       end
-    when home = ENV['HOME']
+
+      check_dir_authority(path)
+    end
+  end
+
+  def self.unix_domain_socket_homedir
+    if home = ENV['HOME']
       path = File.join(home, '.ruby-debug-sock')
 
-      case
-      when !File.exist?(path)
+      unless File.exist?(path)
         Dir.mkdir(path, 0700)
-      when !File.directory?(path)
-        raise "#{path} is not a directory."
       end
+
+      check_dir_authority(path)
+    end
+  end
+
+  def self.unix_domain_socket_dir
+    case
+    when path = CONFIG[:sock_dir]
+    when path = ENV['XDG_RUNTIME_DIR']
+    when path = unix_domain_socket_tmpdir
+    when path = unix_domain_socket_homedir
     else
-      raise 'specify RUBY_DEBUG_SOCK_DIR environment variable for UNIX domain socket directory.'
+      raise 'specify RUBY_DEBUG_SOCK_DIR environment variable.'
     end
 
     path

data/lib/debug/local.rb

@@ -86,6 +86,24 @@ module DEBUGGER__
         trap(:INT, prev_handler)
       end
     end
+
+    def after_fork_parent
+      parent_pid = Process.pid
+
+      at_exit{
+        SESSION.intercept_trap_sigint_end
+        trap(:SIGINT, :IGNORE)
+
+        if Process.pid == parent_pid
+          # only check child process from its parent
+          begin
+            # wait for all child processes to keep terminal
+            loop{ Process.waitpid }
+          rescue Errno::ESRCH, Errno::ECHILD
+          end
+        end
+      }
+    end
   end
 end
 

data/lib/debug/prelude.rb

@@ -40,7 +40,7 @@ module Kernel
     end
   end
 
-  alias b debugger if ENV['RUBY_DEBUG_B']
+  alias bb debugger if ENV['RUBY_DEBUG_BB']
 end
 
 class Binding

data/lib/debug/server.rb

@@ -116,6 +116,8 @@ module DEBUGGER__
 
         self.extend(UI_CDP)
         @repl = false
+        CONFIG.set_config no_color: true
+
         @web_sock = UI_CDP::WebSocket.new(@sock)
         @web_sock.handshake
       else
@@ -306,6 +308,10 @@ module DEBUGGER__
         s.puts "quit"
       end
     end
+
+    def after_fork_parent
+      # do nothing
+    end
   end
 
   class UI_TcpServer < UI_ServerBase
@@ -454,14 +460,27 @@ module DEBUGGER__
       ::DEBUGGER__.warn "Debugger can attach via UNIX domain socket (#{@sock_path})"
       vscode_setup if CONFIG[:open_frontend] == 'vscode'
 
-      Socket.unix_server_loop @sock_path do |sock, client|
-        @sock_for_fork = sock
-        @client_addr = client
+      begin
+        Socket.unix_server_loop @sock_path do |sock, client|
+          @sock_for_fork = sock
+          @client_addr = client
+
+          yield sock
+        ensure
+          sock.close
+          @sock_for_fork = nil
+        end
+      rescue Errno::ECONNREFUSED => _e
+        ::DEBUGGER__.warn "#{_e.message} (socket path: #{@sock_path})"
 
-        yield sock
-      ensure
-        sock.close
-        @sock_for_fork = nil
+        if @sock_path.start_with? Config.unix_domain_socket_tmpdir
+          # try on homedir
+          @sock_path = Config.create_unix_domain_socket_name(unix_domain_socket_homedir)
+          ::DEBUGGER__.warn "retry with #{@sock_path}"
+          retry
+        else
+          raise
+        end
       end
     end
   end

data/lib/debug/server_cdp.rb

@@ -14,9 +14,7 @@ module DEBUGGER__
         @sock = s
       end
 
-      def handshake
-        CONFIG.set_config no_color: true
-  
+      def handshake  
         req = @sock.readpartial 4096
         $stderr.puts '[>]' + req if SHOW_PROTOCOL
   
@@ -97,10 +95,11 @@ module DEBUGGER__
     end
 
     def process
+      bps = []
+      @src_map = {}
       loop do
         req = @web_sock.extract_data
         $stderr.puts '[>]' + req.inspect if SHOW_PROTOCOL
-        bps = []
 
         case req['method']
 
@@ -108,6 +107,7 @@ module DEBUGGER__
         when 'Page.getResourceTree'
           abs = File.absolute_path($0)
           src = File.read(abs)
+          @src_map[abs] = src
           send_response req,
                         frameTree: {
                           frame: {
@@ -124,7 +124,7 @@ module DEBUGGER__
                       url: "http://debuggee#{abs}",
                       startLine: 0,
                       startColumn: 0,
-                      endLine: src.count('\n'),
+                      endLine: src.count("\n"),
                       endColumn: 0,
                       executionContextId: 1,
                       hash: src.hash
@@ -136,7 +136,7 @@ module DEBUGGER__
                       }
         when 'Debugger.getScriptSource'
           s_id = req.dig('params', 'scriptId')
-          src = File.read(s_id)
+          src = get_source_code s_id
           send_response req, scriptSource: src
           @q_msg << req
         when 'Page.startScreencast', 'Emulation.setTouchEmulationEnabled', 'Emulation.setEmitTouchEventsForMouse',
@@ -169,7 +169,10 @@ module DEBUGGER__
         # breakpoint
         when 'Debugger.getPossibleBreakpoints'
           s_id = req.dig('params', 'start', 'scriptId')
-          line = req.dig('params', 'lineNumber')
+          line = req.dig('params', 'start', 'lineNumber')
+          src = get_source_code s_id
+          end_line = src.count("\n")
+          line = end_line  if line > end_line
           send_response req,
                         locations: [
                           { scriptId: s_id,
@@ -180,6 +183,9 @@ module DEBUGGER__
           line = req.dig('params', 'lineNumber')
           path = req.dig('params', 'url').match('http://debuggee(.*)')[1]
           cond = req.dig('params', 'condition')
+          src = get_source_code path
+          end_line = src.count("\n")
+          line = end_line  if line > end_line
           if cond != ''
             bps << SESSION.add_line_breakpoint(path, line + 1, cond: cond)
           else
@@ -202,6 +208,14 @@ module DEBUGGER__
       end
     end
 
+    def get_source_code path
+      return @src_map[path] if @src_map[path]
+
+      src = File.read(path)
+      @src_map[path] = src
+      src
+    end
+
     ## Called by the SESSION thread
 
     def readline prompt
@@ -269,7 +283,7 @@ module DEBUGGER__
                             url: frame[:url],
                             startLine: 0,
                             startColumn: 0,
-                            endLine: src.count('\n'),
+                            endLine: src.count("\n"),
                             endColumn: 0,
                             executionContextId: @script_paths.size + 1,
                             hash: src.hash

data/lib/debug/server_dap.rb

@@ -222,14 +222,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 postrmotem 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 postrmotem 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 postrmotem mode"
+          end
         when 'terminate'
           send_response req
           exit
@@ -491,7 +512,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)
 

data/lib/debug/session.rb

@@ -91,7 +91,7 @@ module DEBUGGER__
                 #   [:check, expr] => CheckBreakpoint
       #
       @tracers = {}
-      @th_clients = nil # {Thread => ThreadClient}
+      @th_clients = {} # {Thread => ThreadClient}
       @q_evt = Queue.new
       @displays = []
       @tc = nil
@@ -1358,7 +1358,7 @@ module DEBUGGER__
     end
 
     def setup_threads
-      prev_clients = @th_clients || {}
+      prev_clients = @th_clients
       @th_clients = {}
 
       Thread.list.each{|th|
@@ -1555,6 +1555,36 @@ module DEBUGGER__
       @postmortem = false
     end
 
+    def capture_exception_frames *exclude_path
+      postmortem_hook = TracePoint.new(:raise){|tp|
+        exc = tp.raised_exception
+        frames = DEBUGGER__.capture_frames(__dir__)
+
+        exclude_path.each{|ex|
+          if Regexp === ex
+            frames.delete_if{|e| ex =~ e.path}
+          else
+            frames.delete_if{|e| e.path.start_with? ex.to_s}
+          end
+        }
+        exc.instance_variable_set(:@__debugger_postmortem_frames, frames)
+      }
+      postmortem_hook.enable
+
+      begin
+        yield
+        nil
+      rescue Exception => e
+        if e.instance_variable_defined? :@__debugger_postmortem_frames
+          e
+        else
+          raise
+        end
+      ensure
+        postmortem_hook.disable
+      end
+    end
+
     def postmortem=(is_enable)
       if is_enable
         unless @postmortem_hook
@@ -1635,20 +1665,7 @@ module DEBUGGER__
     end
 
     def after_fork_parent
-      parent_pid = Process.pid
-      at_exit{
-        @intercept_trap_sigint = false
-        trap(:SIGINT, :IGNORE)
-
-        if Process.pid == parent_pid
-          # only check child process from its parent
-          begin
-            # wait for all child processes to keep terminal
-            loop{ Process.waitpid }
-          rescue Errno::ESRCH, Errno::ECHILD
-          end
-        end
-      }
+      @ui.after_fork_parent
     end
   end
 
@@ -1774,8 +1791,8 @@ module DEBUGGER__
     def sync &b
       info "sync"
 
+      lock
       begin
-        lock
         b.call if b
       ensure
         unlock
@@ -2012,8 +2029,8 @@ module DEBUGGER__
 
         parent_hook = -> child_pid {
           DEBUGGER__.warn "Detaching after fork from parent process #{Process.pid}"
-          SESSION.deactivate
           SESSION.after_fork_parent
+          SESSION.deactivate
         }
         child_hook = -> {
           DEBUGGER__.warn "Attaching after process #{parent_pid} fork to child process #{Process.pid}"
@@ -2112,6 +2129,8 @@ module Kernel
     loc = caller_locations(up_level, 1).first; ::DEBUGGER__.add_line_breakpoint loc.path, loc.lineno + 1, oneshot: true, command: cmds
     self
   end
+
+  alias bb debugger if ENV['RUBY_DEBUG_BB']
 end
 
 class Binding

data/lib/debug/version.rb

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

data/misc/README.md.erb

@@ -11,7 +11,7 @@ New debug.rb has several advantages:
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
-  * Integeration with rich debugger frontend
+  * Integration with rich debugger frontend
     * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
     * Chrome DevTools
 * Extensible: application can introduce debugging support with several ways:
@@ -340,7 +340,7 @@ $ RUBY_DEBUG_PORT=12345 ruby target.rb
 
 ### Integration with external debugger frontend
 
-You can attach with external debuger frontend with VSCode and Chrome.
+You can attach with external debugger frontend with VSCode and Chrome.
 
 ```
 $ rdbg --open=[frontend] target.rb
@@ -352,7 +352,7 @@ Also `open` command allows opening the debug port.
 
 #### VSCode integration
 
-If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the fowllowing steps.
+If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the following steps.
 
 `rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
 
@@ -364,7 +364,7 @@ Launching: code /tmp/ruby-debug-vscode-20211014-27706-gd7e85/ /tmp/ruby-debug-vs
 DEBUGGER: Connected.
 ```
 
-And it tris to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
+And it tries to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
 
 You can also use `open vscode` command in REPL.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.4
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Debugging functionality for Ruby