readapt 0.8.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a783dd879a972485872f13d31e299c02b223a3bea89c3be764f9b21448a5fd7
-  data.tar.gz: 52776a0cfc2befe9215b2da2f828c9d82f7c8858fcad29ff4c052aef4fc70cc5
+  metadata.gz: 901cb61ade9e11ed52cdfdd77c8a33ab45e8147633104172bb421e48bc4cf8ab
+  data.tar.gz: 46f354915b3c929de58ad7d675793f154ce871eea70536eba5629dd9d639cafe
 SHA512:
-  metadata.gz: be0687dddd12bcee0d2529262f3bae3f859da3c3d17fe3fdebd1b3631f47cd51ad2b09493ea1f6172af74dae41c0eae4ee91918d5eb89da7314620271ada51b5
-  data.tar.gz: 5152ece20452deea044bd6864e7f8092d2cb0c9d39bc8d89e15c3f5c9782cf67d35db9c5ca3f5cd81496724c839dd3d2dc98a2efde32258ca094c9a59c57de21
+  metadata.gz: 8cbb171010dee79d13a39c11f620ce98b3a53fe1ba7ae70b37ceebdace363d7e52a2bb73c405e9835a92741d23478667901ddefa6e7a142c5df97cd5613256d2
+  data.tar.gz: c1c394e97e64a67bdd196babc0b67caa9f18e29cac03aca88cca6955ba27f6048db48f32645cf9b6ded3807d0169f2ecbe5684fa1ce23538a1760ca2ff1bd962

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 matrix:
   include:
     - rvm: 2.6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.0.0 - February 9, 2020
+- Refactor server and target process communication
+- STDIO server support
+- Fix zombie process bugs
+- Sort variables alphabetically
+
 # 0.8.1 - November 14, 2019
 - Header name conflict in MacOS (#4)
 

data/lib/readapt.rb

@@ -11,8 +11,10 @@ require 'readapt/finder'
 require 'readapt/debugger'
 require 'readapt/message'
 require 'readapt/variable'
+require 'readapt/data_reader'
+require 'readapt/server'
 require 'readapt/adapter'
+require 'readapt/input'
+require 'readapt/output'
+require 'readapt/error'
 require 'readapt/shell'
-
-module Readapt
-end

data/lib/readapt/adapter.rb

@@ -12,6 +12,22 @@ module Readapt
       @@debugger = debugger
     end
 
+    def self.procid= pid
+      @@procid = pid
+    end
+
+    def procid
+      @@procid
+    end
+
+    def open_message
+      @@open_message ||= "<readapt-#{procid}>"
+    end
+
+    def close_message
+      @@close_message ||= "</readapt-#{procid}>"
+    end
+
     def format result
       write_line result.to_protocol.to_json
     end
@@ -39,8 +55,9 @@ module Readapt
       }
       obj[:body] = data unless data.nil?
       json = obj.to_json
-      envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+      envelope = "#{open_message}Content-Length: #{json.bytesize}\r\n\r\n#{json}#{close_message}"
       write envelope
+      write "#{open_message}__TERMINATE__#{close_message}" if event == 'terminated'
     end
 
     private
@@ -48,7 +65,6 @@ module Readapt
     # @param data [Hash]
     # @return [void]
     def process data
-      # @todo Better solution than nil frames
       message = Message.process(data, @@debugger)
       if data['seq']
         json = {
@@ -59,80 +75,24 @@ module Readapt
           body: message.body
         }.to_json
         envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-        write envelope
-        close if data['command'] == 'disconnect'
+        write "#{open_message}#{envelope}#{close_message}"
+        if data['command'] == 'disconnect'
+          @@debugger.disconnect
+          # @todo It does not appear necessary to close the adapter after
+          #   disconnecting the debugger.
+          # close
+        end
         return unless data['command'] == 'initialize'
         json = {
           type: 'event',
           event: 'initialized'
         }.to_json
         envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-        write envelope
+        write "#{open_message}#{envelope}#{close_message}"
       end
     rescue RuntimeError => e
       STDERR.puts "[#{e.class}] #{e.message}"
       STDERR.puts e.backtrace.join
     end
   end
-
-  class DataReader
-    def initialize
-      @in_header = true
-      @content_length = 0
-      @buffer = String.new
-    end
-
-    # Declare a block to be executed for each message received from the
-    # client.
-    #
-    # @yieldparam [Hash] The message received from the client
-    def set_message_handler &block
-      @message_handler = block
-    end
-
-    # Process raw data received from the client. The data will be parsed
-    # into messages based on the JSON-RPC protocol. Each message will be
-    # passed to the block declared via set_message_handler. Incomplete data
-    # will be buffered and subsequent data will be appended to the buffer.
-    #
-    # @param data [String]
-    def receive data
-      data.each_char do |char|
-        @buffer.concat char
-        if @in_header
-          prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
-        else
-          parse_message_from_buffer if @buffer.bytesize == @content_length
-        end
-      end
-    end
-
-    private
-
-    def prepare_to_parse_message
-      @in_header = false
-      @buffer.each_line do |line|
-        parts = line.split(':').map(&:strip)
-        if parts[0] == 'Content-Length'
-          @content_length = parts[1].to_i
-          break
-        end
-      end
-      @buffer.clear
-    end
-
-    def parse_message_from_buffer
-      begin
-        msg = JSON.parse(@buffer)
-        @message_handler.call msg unless @message_handler.nil?
-      rescue JSON::ParserError => e
-        Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
-        Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
-      ensure
-        @buffer.clear
-        @in_header = true
-        @content_length = 0
-      end
-    end
-  end
 end

data/lib/readapt/data_reader.rb

@@ -0,0 +1,62 @@
+module Readapt
+  class DataReader
+    def initialize
+      @in_header = true
+      @content_length = 0
+      @buffer = String.new
+    end
+
+    # Declare a block to be executed for each message received from the
+    # client.
+    #
+    # @yieldparam [Hash] The message received from the client
+    def set_message_handler &block
+      @message_handler = block
+    end
+
+    # Process raw data received from the client. The data will be parsed
+    # into messages based on the JSON-RPC protocol. Each message will be
+    # passed to the block declared via set_message_handler. Incomplete data
+    # will be buffered and subsequent data will be appended to the buffer.
+    #
+    # @param data [String]
+    def receive data
+      data.each_char do |char|
+        @buffer.concat char
+        if @in_header
+          prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+        else
+          parse_message_from_buffer if @buffer.bytesize == @content_length
+        end
+      end
+    end
+
+    private
+
+    def prepare_to_parse_message
+      @in_header = false
+      @buffer.each_line do |line|
+        parts = line.split(':').map(&:strip)
+        if parts[0] == 'Content-Length'
+          @content_length = parts[1].to_i
+          break
+        end
+      end
+      @buffer.clear
+    end
+
+    def parse_message_from_buffer
+      begin
+        msg = JSON.parse(@buffer)
+        @message_handler.call msg unless @message_handler.nil?
+      rescue JSON::ParserError => e
+        Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
+        Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
+      ensure
+        @buffer.clear
+        @in_header = true
+        @content_length = 0
+      end
+    end
+  end
+end

data/lib/readapt/debugger.rb

@@ -13,7 +13,7 @@ module Readapt
 
     attr_reader :file
 
-    def initialize machine = Machine.new
+    def initialize
       @stack = []
       @frames = {}
       @running = false
@@ -22,7 +22,6 @@ module Readapt
       @config = {}
       @original_argv = ARGV.clone
       @original_prog = $0
-      @machine = machine
       @breakpoints = {}
     end
 
@@ -57,13 +56,14 @@ module Readapt
 
     def start
       ::Thread.new do
+        set_program_args
         run { load @file }
+        set_original_args
       end
     end
 
     def run
       # raise RuntimeError, 'Debugger is already running' if @running
-      set_program_args
       @running = true
       send_event('process', {
         name: @file
@@ -75,14 +75,11 @@ module Readapt
     rescue StandardError => e
       STDERR.puts "[#{e.class}] #{e.message}"
       STDERR.puts e.backtrace.join("\n")
-    rescue SystemExit
-      # Ignore
     ensure
       Monitor.stop
       @running = false
-      set_original_args
-      STDOUT.flush
-      STDERR.flush
+      STDOUT.flush #unless STDOUT.closed?
+      STDERR.flush #unless STDERR.closed?
       changed
       send_event 'terminated', nil
     end
@@ -103,7 +100,7 @@ module Readapt
     end
 
     def clear_breakpoints source
-      @breakpoints.delete_if { |key, value|
+      @breakpoints.delete_if { |_key, value|
         value.source == source
       }
     end
@@ -211,7 +208,6 @@ module Readapt
     end
 
     def shutdown
-      @machine.stop
       exit
     end
 

data/lib/readapt/error.rb

@@ -0,0 +1,63 @@
+require 'securerandom'
+
+module Readapt
+  module Error
+    class << self
+      attr_accessor :adapter
+    end
+
+    def opening
+      @buffer = ''
+    end
+
+    def receiving data
+      output = ''
+      data.each_char do |char|
+        @buffer += char
+        if open_message.start_with?(@buffer) || @buffer.start_with?(open_message)
+          if @buffer.end_with?(close_message)
+            msg = @buffer[open_message.length..-(close_message.length+1)]
+            exit if msg == '__TERMINATE__'
+            Error.adapter.write msg
+            @buffer.clear
+          end
+        else
+          output += @buffer
+          @buffer.clear
+        end
+      end
+      return if output.empty?
+      send_event('output', {
+        output: output,
+        category: 'stderr'
+      })
+    end
+
+    def send_event event, data
+      obj = {
+        type: 'event',
+        event: event
+      }
+      obj[:body] = data unless data.nil?
+      json = obj.to_json
+      envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+      Error.adapter.write envelope
+    end
+
+    def self.procid= pid
+      @@procid = pid
+    end
+
+    def procid
+      @@procid
+    end
+
+    def open_message
+      @@open_message ||= "<readapt-#{procid}>"
+    end
+
+    def close_message
+      @@close_message ||= "</readapt-#{procid}>"
+    end
+  end
+end

data/lib/readapt/frame.rb

@@ -22,7 +22,7 @@ module Readapt
     def locals
       return [] if frame_binding.nil?
       result = []
-      frame_binding.local_variables.each do |sym|
+      frame_binding.local_variables.sort.each do |sym|
         var = frame_binding.local_variable_get(sym)
         result.push Variable.new(sym, var)
       end

data/lib/readapt/input.rb

@@ -0,0 +1,7 @@
+module Readapt
+  module Input
+    def receiving data
+      print data
+    end
+  end
+end

data/lib/readapt/message/disconnect.rb

@@ -4,10 +4,9 @@ module Readapt
   module Message
     class Disconnect < Base
       def run
-        # HACK: Wait a moment to make sure the output is flushed
-        # @todo Find a better way
-        sleep 1
-        debugger.disconnect
+        # The message only sets an empty body to acknowledge that the request
+        # was received. The adapter handles the actual disconnection process.
+        set_body({})
       end
     end
   end

data/lib/readapt/message/variables.rb

@@ -27,10 +27,10 @@ module Readapt
                 result.push Variable.new("[#{idx}]", itm)
               end
             else
-              obj.instance_variables.each do |iv|
+              obj.instance_variables.sort.each do |iv|
                 result.push Variable.new(iv, obj.instance_variable_get(iv))
               end
-              obj.class.class_variables.each do |cv|
+              obj.class.class_variables.sort.each do |cv|
                 result.push Variable.new(cv, obj.class.class_variable_get(cv))
               end
             end

data/lib/readapt/output.rb

@@ -0,0 +1,25 @@
+module Readapt
+  module Output
+    class << self
+      attr_accessor :adapter
+    end
+
+    def receiving data
+      send_event('output', {
+        output: data,
+        category: 'stdout'
+      })
+    end
+
+    def send_event event, data
+      obj = {
+        type: 'event',
+        event: event
+      }
+      obj[:body] = data unless data.nil?
+      json = obj.to_json
+      envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+      Output.adapter.write envelope
+    end
+  end
+end

data/lib/readapt/server.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+require 'stringio'
+
+module Readapt
+  module Server
+    class << self
+      attr_accessor :target_in
+      attr_accessor :target_pid
+    end
+
+    def opening
+      Error.adapter = self
+      Output.adapter = self
+    end
+
+    def receiving data
+      Server.target_in.syswrite data
+    rescue Errno::EPIPE, IOError
+      close
+    end
+  end
+end

data/lib/readapt/shell.rb

@@ -1,5 +1,8 @@
 require 'thor'
 require 'backport'
+require 'open3'
+require 'securerandom'
+require 'socket'
 
 module Readapt
   class Shell < Thor
@@ -10,31 +13,91 @@ module Readapt
       puts Readapt::VERSION
     end
 
-    desc 'serve', 'Run a DAP server'
+    desc 'socket', 'Run a DAP server over TCP'
     option :host, type: :string, aliases: :h, description: 'The server host', default: '127.0.0.1'
     option :port, type: :numeric, aliases: :p, description: 'The server port', default: 1234
-    def serve
+    def socket
+      machine = Backport::Machine.new
+      machine.run do
+        prepare_machine machine
+        server = Backport::Server::Tcpip.new(host: options[:host], port: options[:port], adapter: Readapt::Server)
+        machine.prepare server
+        STDERR.puts "Readapt Debugger #{Readapt::VERSION} is listening HOST=#{options[:host]} PORT=#{options[:port]} PID=#{Process.pid}"
+      end
+    end
+    map serve: :socket
+
+    desc 'stdio', 'Run a DAP server over STDIO'
+    def stdio
+      machine = Backport::Machine.new
+      machine.run do
+        prepare_machine machine
+        server = Backport::Server::Stdio.new(adapter: Readapt::Server)
+        machine.prepare server
+      end
+    end
+
+    desc 'target [PROCID]', 'Run a target process'
+    def target procid = nil
+      STDIN.binmode
+      STDOUT.binmode
+      STDERR.binmode
       STDOUT.sync = true
       STDERR.sync = true
+      Readapt::Adapter.procid = procid
       machine = Backport::Machine.new
+      Signal.trap("INT") do
+        graceful_shutdown machine
+      end
+      Signal.trap("TERM") do
+        graceful_shutdown machine
+      end
       machine.run do
-        Signal.trap("INT") do
-          graceful_shutdown
-        end
-        Signal.trap("TERM") do
-          graceful_shutdown
-        end
-        debugger = Readapt::Debugger.new(machine)
+        debugger = Readapt::Debugger.new
         Readapt::Adapter.host debugger
-        machine.prepare Backport::Server::Tcpip.new(host: options[:host], port: options[:port], adapter: Readapt::Adapter)
-        STDERR.puts "Readapt Debugger #{Readapt::VERSION} is listening HOST=#{options[:host]} PORT=#{options[:port]} PID=#{Process.pid}"
+        machine.prepare Backport::Server::Stdio.new(input: STDIN, output: STDERR, adapter: Readapt::Adapter)
       end
     end
 
     private
 
-    def graceful_shutdown
-      Backport.stop
+    # @param machine [Backport::Machine]
+    # @return [void]
+    def prepare_machine machine
+      STDOUT.sync = true
+      STDERR.sync = true
+      Signal.trap("INT") do
+        graceful_shutdown machine
+      end
+      Signal.trap("TERM") do
+        graceful_shutdown machine
+      end
+      procid = SecureRandom.hex(8)
+      Readapt::Error.procid = procid
+      stdin, stdout, stderr, thr = Open3.popen3('ruby', $0, 'target', procid)
+      stdin.sync = true
+      stdout.sync = true
+      stderr.sync = true
+      stdin.binmode
+      Readapt::Server.target_in = stdin
+      Readapt::Server.target_pid = thr[:pid]
+      output = Backport::Server::Stdio.new(input: stdout, output: stdin, adapter: Readapt::Output)
+      error = Backport::Server::Stdio.new(input: stderr, output: stdin, adapter: Readapt::Error)
+      machine.prepare output
+      machine.prepare error
+      at_exit do
+        begin
+          Process.kill 'KILL', thr[:pid]
+        rescue Errno::ESRCH
+          # Ignore
+        end
+      end
+    end
+
+    # @param machine [Backport::Machine]
+    # @return [void]
+    def graceful_shutdown machine
+      machine.stop
       exit
     end
   end

data/lib/readapt/thread.rb

@@ -17,12 +17,7 @@ module Readapt
     end
 
     def object
-      STDERR.puts "Getting #{id}"
       ObjectSpace._id2ref(id)
     end
-
-    # def frames
-    #   @frames ||= []
-    # end
   end
 end

data/lib/readapt/version.rb

@@ -1,3 +1,3 @@
 module Readapt
-  VERSION = "0.8.1"
+  VERSION = "1.0.0"
 end

data/readapt.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2'
 
   spec.add_dependency 'backport', '~> 1.1'
-  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'thor', '~> 1.0'
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rake-compiler", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readapt
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,9 +137,12 @@ files:
 - lib/readapt.rb
 - lib/readapt/adapter.rb
 - lib/readapt/breakpoint.rb
+- lib/readapt/data_reader.rb
 - lib/readapt/debugger.rb
+- lib/readapt/error.rb
 - lib/readapt/finder.rb
 - lib/readapt/frame.rb
+- lib/readapt/input.rb
 - lib/readapt/message.rb
 - lib/readapt/message/attach.rb
 - lib/readapt/message/base.rb
@@ -160,6 +163,8 @@ files:
 - lib/readapt/message/threads.rb
 - lib/readapt/message/variables.rb
 - lib/readapt/monitor.rb
+- lib/readapt/output.rb
+- lib/readapt/server.rb
 - lib/readapt/shell.rb
 - lib/readapt/snapshot.rb
 - lib/readapt/thread.rb