byebug-dap 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9695c31c89057519d92567d4b14faf182a108aeaad4994d92104733c966f1e32
-  data.tar.gz: d030b0a78edd8010d05f3a8af5e6adbc88ab553671f429babdc1f14390a222c1
+  metadata.gz: cdcb974e222d9a64fea6f7f070e0352dc746dfd6f331d4b7230aad278ba563db
+  data.tar.gz: 91af303a92685b001c2fee3039f47cba119b67f3edefdeb11b9f28d54d6e2608
 SHA512:
-  metadata.gz: e37dd536e602234f326c4d86b179046f1896fc8913979bbe193646a0387a829975abe6f4e7cad1d42d1615fff02436242d7caeaff030e34ec1472c82547e9cdc
-  data.tar.gz: f9efa4e3ca7cec53cd8c2b9dc89212640006ac1ffd841b753a72bbb3540a842fa7622ae010c55d6fee005d631e6bd4d15b36108517a22a0935465ed564a629cf
+  metadata.gz: c29328a148dc9e690452fdb09acbb5f63a6612a85f1e5c5cfa7a14b72ed5517b99d0fca4077ca3001d9d4cfbe0b25afa9f3475d65d21ee01369cb623af8462a4
+  data.tar.gz: 79f5f2dcfb469ab62250543620473f34c9dce69204eef8bb27cfeb1b636041716effb1f1486cd50ebb1c72e2770b627be5361112e2e64a6b97fd4d93fa9768d4

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+
+## 0.1.2
+
+- Fix possible failure when a breakpoint is hit but can't be resolved
+- Fix possible failure when frame arguments can't be evaluated
+- Exit on disconnect when started by 'launch'
+- Expose `Server#wait_for_client` instead of passing a block
+- Expose `Interface#stop!` to allow the debugee to stop
+- Support specifying a start sequence with `--on-start CODE`
+- Support for child processes
+
+## 0.1.1
+
+- Improve error handling in `Byebug::DAP::Controller`
+
+## 0.1.0
+
+- Initial release

data/README.md

@@ -2,3 +2,11 @@
 
 This gem adds [Debug Adapter
 Protocol](https://microsoft.github.io/debug-adapter-protocol) support to Byebug.
+
+## TODO
+
+- Multi-process support
+- Stdout/stderr
+  - In STDIO mode, spawn with extra FDs and use those instead of 0/1?
+- Many DAP features are already supported by Byebug and just need to be
+  implemented in DAP mode

data/bin/byebug-dap

@@ -26,6 +26,7 @@ OptionParser.new do |opts|
   opts.on("-f", "--[no-]force", "When listening on a unix socket, delete the socket if it exists") { |v| options[:force] = v }
   opts.on("--debug-protocol", "Debug DAP") { |v| Byebug::DAP::Debug.protocol = true if v }
   opts.on("--debug-evaluate", "Debug variable evaluation") { |v| Byebug::DAP::Debug.evaluate = true if v }
+  opts.on("--on-start CODE", "Code to print once the debugger is available") { |v| options[:start_code] = v }
 end.parse!
 
 program = next_arg
@@ -59,16 +60,22 @@ else
 end
 
 begin
-  STDERR.puts "Starting DAP"
+  STDERR.print "Starting DAP... " unless options[:start_code]
+
+  server = Byebug.start_dap(host, port)
+
+  STDERR.puts options[:start_code] if options[:start_code]
   STDERR.flush
 
   if options[:wait]
-    Byebug.start_dap(host, port) { require File.realpath(program) }
-  else
-    Byebug.start_dap(host, port)
-    require File.realpath(program)
+    STDERR.print "waiting for debugger... " unless options[:start_code]
+    server.wait_for_client
   end
 
+  STDERR.puts "ok" unless options[:start_code]
+
+  require File.realpath(program)
+
 ensure
   File.delete(port) if File.exist?(port) if host == :unix
 end

data/lib/byebug/dap.rb

@@ -4,6 +4,7 @@ require 'byebug/core'
 require 'byebug/remote'
 
 require_relative 'dap/channel'
+require_relative 'dap/child_spawned_event_body'
 require_relative 'dap/handles'
 require_relative 'dap/invalid_request_argument_error'
 require_relative 'dap/safe_helpers'

data/lib/byebug/dap/child_spawned_event_body.rb

@@ -0,0 +1,11 @@
+module Byebug
+  module DAP
+    class ChildSpawnedEventBody < ::DAP::Base
+      ::DAP::Event.bodies[:childSpawned] = self
+
+      property :name
+      property :pid
+      property :socket
+    end
+  end
+end

data/lib/byebug/dap/command_processor.rb

@@ -103,12 +103,10 @@ module Byebug
       def stopped!
         case context.stop_reason
         when :breakpoint
-          number = Byebug.breakpoints.index(@at_breakpoint) + 1
-
           args = {
             reason: 'breakpoint',
             description: 'Hit breakpoint',
-            text: "Stopped by breakpoint #{number} at #{context.frame.file}:#{context.frame.line}",
+            text: "Stopped by breakpoint at #{context.frame.file}:#{context.frame.line}",
           }
 
         when :catchpoint

data/lib/byebug/dap/controller.rb

@@ -1,11 +1,9 @@
 module Byebug
   module DAP
     class Controller
-      class DisconnectError < StandardError; end
-
-      def initialize(interface, signal_start = nil)
+      def initialize(interface, &block)
         @interface = interface
-        @signal_start = signal_start
+        @on_configured = block
 
         @trace = TracePoint.new(:thread_begin, :thread_end) { |t| process_trace t }
       end
@@ -13,16 +11,17 @@ module Byebug
       def run
         loop do
           @request = @interface.receive
-          process_command @request
+          result = process_command @request
+          return if result == :stop
         end
 
-      rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED, DisconnectError
+      rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED
         STDERR.puts "\nClient disconnected"
 
       ensure
-        Byebug.mode = :off
-        Byebug.stop
-        @interface.socket.close
+        exit if @exit_on_disconnect
+
+        @interface.stop!
         @trace.disable
       end
 
@@ -45,6 +44,19 @@ module Byebug
       end
 
       def process_command(request)
+        case request.command
+        when 'attach', 'launch'
+          if Byebug.started?
+            respond! success: false, message: "Cannot #{request.command} - debugger is already running"
+            return
+          end
+        when 'pause', 'next', 'stepIn', 'stepOut', 'continue', 'evaluate', 'variables', 'scopes', 'threads', 'stackTrace'
+          unless Byebug.started?
+            respond! success: false, message: "Cannot #{request.command} - debugger is not running"
+            return
+          end
+        end
+
         case request.command
         when 'initialize'
           # "The ‘initialize’ request is sent as the first request from the client to the debug adapter
@@ -67,7 +79,7 @@ module Byebug
           # "This behavior can be controlled with the ‘terminateDebuggee’ argument (if supported by the debug adapter).
 
           respond!
-          raise DisconnectError
+          return :stop
 
         when 'attach'
           # "The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running.
@@ -76,8 +88,6 @@ module Byebug
           Byebug.start
           @trace.enable
 
-          @signal_start.call(:attach) if @signal_start
-
           respond!
           return
 
@@ -90,7 +100,7 @@ module Byebug
             @trace.enable
           end
 
-          @signal_start.call(:launch) if @signal_start
+          @exit_on_disconnect = true
 
           respond!
           return
@@ -98,16 +108,11 @@ module Byebug
         when 'configurationDone'
           # "This optional request indicates that the client has finished initialization of the debug adapter.
 
-          respond!
-          return
-        end
 
-        unless Byebug.started?
-          respond! success: false, message: "Debugger is not running"
+          @on_configured&.call
+          respond!
           return
-        end
 
-        case request.command
         when 'pause', 'next', 'stepIn', 'stepOut', 'continue'
           ctx = @interface.find_thread(request.arguments.threadId)
           ctx.interrupt if request.command == 'pause'

data/lib/byebug/dap/interface.rb

@@ -3,26 +3,58 @@ module Byebug
     class Interface
       include SafeHelpers
 
+      @@children = []
+
+      def self.child_spawned(name, pid, socket)
+        child = ChildSpawnedEventBody.new(name: name, pid: pid, socket: socket)
+        @@children << child
+
+        interface = Context.interface
+        interface.event! child if interface.is_a?(Byebug::DAP::Interface)
+
+        return true
+
+      rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED
+        return false
+      end
+
       attr_reader :socket
 
       def initialize(socket)
         @socket = socket
+
+        begin
+          @@children.each { |c| event! c }
+        rescue IOError, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNABORTED
+        end
+      end
+
+      def stop!
+        Byebug.mode = :off
+        Byebug.stop
+        socket.close
       end
 
       def <<(message)
-        STDERR.puts "> #{message.to_wire}" if Debug.protocol
+        STDERR.puts "#{Process.pid} > #{message.to_wire}" if Debug.protocol
         message.validate!
         socket.write ::DAP::Encoding.encode(message)
       end
 
       def event!(event, **values)
-        body = ::DAP.const_get("#{event[0].upcase}#{event[1..]}EventBody").new(values) unless values.empty?
+        if (cls = event.class.name.split('::').last) && cls.end_with?('EventBody')
+          body, event = event, cls[0].downcase + cls[1...-9]
+
+        elsif event.is_a?(String) && !values.empty?
+          body = ::DAP.const_get("#{event[0].upcase}#{event[1..]}EventBody").new(values)
+        end
+
         self << ::DAP::Event.new(event: event, body: body)
       end
 
       def receive
         m = ::DAP::Encoding.decode(socket)
-        STDERR.puts "< #{m.to_wire}" if Debug.protocol
+        STDERR.puts "#{Process.pid} < #{m.to_wire}" if Debug.protocol
         m
       end
 
@@ -78,7 +110,7 @@ module Byebug
           frame = ::Byebug::Frame.new(ctx, i)
           ::DAP::StackFrame.new(
             id: frame_ids << [ctx.thnum, i],
-            name: frame.deco_call,
+            name: frame_name(frame),
             source: ::DAP::Source.new(
               name: File.basename(frame.file),
               path: File.expand_path(frame.file)),
@@ -194,6 +226,12 @@ module Byebug
 
       private
 
+      def frame_name(frame)
+        frame.deco_call
+      rescue
+        frame.deco_block + frame.deco_class + frame.deco_method + "(?)"
+      end
+
       def describe_thread(context)
         if context.thread.name
           "##{context.thnum} (#{context.thread.name})"

data/lib/byebug/dap/server.rb

@@ -20,13 +20,11 @@ module Byebug
         public :<<, :bytes, :chars, :close_read, :close_write, :codepoints, :each, :each_byte, :each_char, :each_codepoint, :each_line, :getbyte, :getc, :gets, :lines, :pread, :print, :printf, :putc, :puts, :pwrite, :read, :read_nonblock, :readbyte, :readchar, :readline, :readlines, :readpartial, :sysread, :syswrite, :ungetbyte, :ungetc, :write, :write_nonblock
       end
 
-      def initialize(&block)
+      def initialize
         @started = false
-        if block_given?
-          @on_start = block
-          @mu = Mutex.new
-          @cond = ConditionVariable.new
-        end
+        @mu = Mutex.new
+        @cond = ConditionVariable.new
+        @configured = false
       end
 
       def start(host, port = 0)
@@ -61,6 +59,16 @@ module Byebug
         launch STDIO.new
       end
 
+      def wait_for_client
+        @mu.synchronize do
+          loop do
+            return if @configured
+
+            @cond.wait(@mu)
+          end
+        end
+      end
+
       private
 
       def launch(server)
@@ -74,19 +82,19 @@ module Byebug
           end
         end
 
-        return unless defined?(@on_start)
-
-        @mu.synchronize { @cond.wait(@mu) }
-
-        @on_start.call
+        self
       end
 
       def debug(session)
         Context.interface = Byebug::DAP::Interface.new(session)
         Context.processor = Byebug::DAP::CommandProcessor
 
-        signal_start = ->(_) { @mu.synchronize { @cond.signal } } if defined?(@on_start)
-        Byebug::DAP::Controller.new(Context.interface, signal_start).run
+        Byebug::DAP::Controller.new(Context.interface) do
+          @mu.synchronize do
+            @configured = true
+            @cond.broadcast
+          end
+        end.run
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: byebug-dap
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ethan Reesor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
 description: Implements a Debug Adapter Protocol interface for Byebug
 email: ethan.reesor@gmail.com
 executables:
@@ -46,11 +46,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - AUTHORS
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/byebug-dap
 - lib/byebug/dap.rb
 - lib/byebug/dap/channel.rb
+- lib/byebug/dap/child_spawned_event_body.rb
 - lib/byebug/dap/command_processor.rb
 - lib/byebug/dap/controller.rb
 - lib/byebug/dap/handles.rb