debug 1.2.4 → 1.3.0

data/lib/debug/thread_client.rb

@@ -3,7 +3,6 @@
 require 'objspace'
 require 'pp'
 
-require_relative 'frame_info'
 require_relative 'color'
 
 module DEBUGGER__
@@ -120,6 +119,7 @@ module DEBUGGER__
         raise "unknown mode: #{mode}"
       end
 
+      # DEBUGGER__.warn "#{@mode} => #{mode} @ #{self.inspect}"
       @mode = mode
     end
 
@@ -954,12 +954,14 @@ module DEBUGGER__
 
         when :dap
           process_dap args
+        when :cdp
+          process_cdp args
         else
           raise [cmd, *args].inspect
         end
       end
 
-    rescue SuspendReplay, SystemExit
+    rescue SuspendReplay, SystemExit, Interrupt
       raise
     rescue Exception => e
       pp ["DEBUGGER Exception: #{__FILE__}:#{__LINE__}", e, e.backtrace]

data/lib/debug/version.rb

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

data/misc/README.md.erb

@@ -11,7 +11,9 @@ New debug.rb has several advantages:
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
-  * VSCode/DAP integration ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
+  * Integeration 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:
   * By `rdbg` command
   * By loading libraries with `-r` command line option
@@ -336,6 +338,97 @@ By default, UNIX domain socket is used for the debugging port. To use TCP/IP, yo
 $ RUBY_DEBUG_PORT=12345 ruby target.rb
 ```
 
+### Integration with external debugger frontend
+
+You can attach with external debuger frontend with VSCode and Chrome.
+
+```
+$ rdbg --open=[frontend] target.rb
+```
+
+will open a debug port and `[frontned]` can attache to the port.
+
+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.
+
+`rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
+
+```
+$ rdbg --open=vscode target.rb
+DEBUGGER: Debugger can attach via UNIX domain socket (/tmp/ruby-debug-sock-1000/ruby-debug-ko1-27706)
+DEBUGGER: wait for debugger connection...
+Launching: code /tmp/ruby-debug-vscode-20211014-27706-gd7e85/ /tmp/ruby-debug-vscode-20211014-27706-gd7e85/README.rb
+DEBUGGER: Connected.
+```
+
+And it tris 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.
+
+```
+$ rdbg target.rb
+[1, 8] in target.rb
+     1|
+=>   2| p a = 1
+     3| p b = 2
+     4| p c = 3
+     5| p d = 4
+     6| p e = 5
+     7|
+     8| __END__
+=>#0    <main> at target.rb:2
+(rdbg) open vscode    # command
+DEBUGGER: wait for debugger connection...
+DEBUGGER: Debugger can attach via UNIX domain socket (/tmp/ruby-debug-sock-1000/ruby-debug-ko1-28337)
+Launching: code /tmp/ruby-debug-vscode-20211014-28337-kg9dm/ /tmp/ruby-debug-vscode-20211014-28337-kg9dm/README.rb
+DEBUGGER: Connected.
+```
+
+If the machine which runs the Ruby process doesn't have a `code` command, the following message will be shown:
+
+```
+(rdbg) open vscode
+DEBUGGER: wait for debugger connection...
+DEBUGGER: Debugger can attach via UNIX domain socket (/tmp/ruby-debug-sock-1000/ruby-debug-ko1-455)
+Launching: code /tmp/ruby-debug-vscode-20211014-455-gtjpwi/ /tmp/ruby-debug-vscode-20211014-455-gtjpwi/README.rb
+DEBUGGER: Can not invoke the command.
+Use the command-line on your terminal (with modification if you need).
+
+  code /tmp/ruby-debug-vscode-20211014-455-gtjpwi/ /tmp/ruby-debug-vscode-20211014-455-gtjpwi/README.rb
+
+If your application is running on a SSH remote host, please try:
+
+  code --remote ssh-remote+[SSH hostname] /tmp/ruby-debug-vscode-20211014-455-gtjpwi/ /tmp/ruby-debug-vscode-20211014-455-gtjpwi/README.rb
+
+```
+
+and try to use proposed commands.
+
+Note that you can attach with `rdbg --attach` and continue REPL debugging.
+
+#### Chrome DevTool integration
+
+With `rdbg --open=chrome` command will shows the following message.
+
+```
+$ rdbg target.rb --open=chrome
+DEBUGGER: Debugger can attach via TCP/IP (127.0.0.1:43633)
+DEBUGGER: With Chrome browser, type the following URL in the address-bar:
+
+   devtools://devtools/bundled/inspector.html?ws=127.0.0.1:43633
+
+DEBUGGER: wait for debugger connection...
+```
+
+Type `devtools://devtools/bundled/inspector.html?ws=127.0.0.1:43633` in the address-bar on Chrome browser, and you can continue the debugging with chrome browser.
+
+Also `open chrome` command works like `open vscode`.
+
+For more information about how to use Chrome debugging, you might want to read [here](https://developer.chrome.com/docs/devtools/)
+
 ## Configuration
 
 You can configure the debugger's behavior with debug commands and environment variables.
@@ -480,3 +573,4 @@ Please also check the [contributing guideline](/CONTRIBUTING.md).
 # Acknowledgement
 
 * Some tests are based on [deivid-rodriguez/byebug: Debugging in Ruby 2](https://github.com/deivid-rodriguez/byebug)
+* Several codes in `server_cdp.rb` are based on [geoffreylitt/ladybug: Visual Debugger](https://github.com/geoffreylitt/ladybug)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -78,7 +78,9 @@ files:
 - lib/debug/local.rb
 - lib/debug/open.rb
 - lib/debug/open_nonstop.rb
+- lib/debug/prelude.rb
 - lib/debug/server.rb
+- lib/debug/server_cdp.rb
 - lib/debug/server_dap.rb
 - lib/debug/session.rb
 - lib/debug/source_repository.rb