haplo 2.5.0-java → 2.5.4-java

data/lib/debuggers.rb

@@ -0,0 +1,263 @@
+# Haplo Plugin Tool             http://docs.haplo.org/dev/tool/plugin
+# (c) Haplo Services Ltd 2006 - 2016    http://www.haplo-services.com
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+module PluginTool
+
+  @@profile_output = nil
+
+  def self.request_profile(options)
+    output_file = $stdout
+    close_output_file = false
+    if options.profile_file
+      output_file = File.open(options.profile_file, "a")
+      close_output_file = true
+    end
+
+    formatter = nil
+    case options.profile_format || 'tree'
+    when 'tree'
+      @@profile_output = ProfilerFormatterTree.new(output_file)
+    when 'raw'
+      @@profile_output = ProfilerFormatterRaw.new(output_file)
+    else
+      puts "Unknown profiler format: #{options.profile_format}"
+      exit 1
+    end
+
+    if 'OK' == PluginTool.post("/api/development-plugin-loader/debugger-profile-start", {:min => options.profile})
+      puts "JavaScript profiler started."
+    else
+      puts "Error starting JavaScript profiler."
+      exit 1
+    end
+    at_exit do
+      puts
+      puts "Disabling JavaScript profiler..."
+      PluginTool.post("/api/development-plugin-loader/debugger-profile-stop")
+      puts "JavaScript profiler disabled."
+      output_file.close if close_output_file
+    end
+  end
+
+  class ProfilerFormatter
+    def initialize(output_file)
+      @output_file = output_file
+    end
+    def format(report)
+      _format(report, @output_file)
+      @output_file.flush
+    end
+  end
+
+  class ProfilerFormatterRaw < ProfilerFormatter
+    def _format(report, output_file)
+      output_file.write(report)
+    end
+  end
+
+  class ProfilerFormatterTree < ProfilerFormatter
+    def _format(report, output_file)
+      report.split("\n").each do |line|
+        depth, time, percent, count, position = line.split("\t")
+        if depth == 'REPORT'
+          output_file.write("PROFILE -- #{Time.new(time)}\n")
+        elsif depth == 'OMIT'
+          output_file.write(("  "*time.to_i)+"... children omitted\n")
+        else
+          output_file.write(("  "*depth.to_i)+"#{percent} #{count} #{time.to_i / 1000000} #{position}\n")
+        end
+      end
+    end
+  end
+
+  def self.profiler_handle_report(report)
+    if @@profile_output
+      @@profile_output.format(report)
+    end
+  end
+
+  # -------------------------------------------------------------------------
+
+  def self.request_coverage(options)
+
+    format = options.coverage_format || 'raw'
+    if format != 'raw'
+      puts "Unknown coverage format: #{format}"
+      exit 1
+    end
+
+    if 'OK' == PluginTool.post("/api/development-plugin-loader/debugger-coverage-start")
+      puts "Coverage capture started."
+    else
+      puts "Error starting coverage capture."
+      exit 1
+    end
+
+    at_exit do
+      coverage = PluginTool.post("/api/development-plugin-loader/debugger-coverage-stop")
+      # TODO: Check errors
+      File.open(options.coverage_file, "w") { |f| f.write coverage }
+    end
+
+  end
+
+end
+
+# -------------------------------------------------------------------------
+
+module DebugAdapterProtocolTunnel
+
+  @@dap_plugins = nil
+  @@dap_debugger_option = nil
+  @@dap_server = nil
+  @@dap_connection = nil
+
+  def self.prepare(plugins, options)
+    @@dap_plugins = plugins
+    @@dap_debugger_option = options.debugger
+    raise "BAD DEBUGGER OPTION #{@@dap_debugger_option}" unless @@dap_debugger_option =~ /\A(\d+)\z/
+    @@dap_server = TCPServer.new("127.0.0.1", @@dap_debugger_option.to_i)
+    Thread.new do
+      while true
+        connection = @@dap_server.accept
+        if connection
+          if @@dap_connection
+            connection.close
+          else
+            @@dap_connection = DAPConnection.new(connection, @@dap_plugins)
+            Thread.new do
+              @@dap_connection.run
+              _stop_remote_debugger()
+              @@dap_connection = nil
+            end
+          end
+        end
+      end
+    rescue => e
+      # ignore
+    end
+    at_exit do
+      @@dap_server.close
+      @@dap_connection.close if @@dap_connection
+      _stop_remote_debugger()
+    end
+  end
+
+  def self._stop_remote_debugger
+    puts "DEBUGGER: Stopping remote debugger..."
+    result = PluginTool.post("/api/development-plugin-loader/debugger-dap-stop")
+    if result == 'OK'
+      puts "DEBUGGER: Remote debugger stopped."
+    else
+      puts "DEBUGGER: Error stopping remote debugger, application server may be in non-functioning state."
+    end
+  end
+
+  def self.log_message_from_server(text)
+    if @@dap_connection
+      @@dap_connection._write({
+        'type' => 'event',
+        'event' => 'output',
+        'body' => {
+          'category' => 'console',
+          'output' => text+"\n"
+        }
+      })
+    end
+  end
+
+  def self.dap_message_from_server(json)
+    if @@dap_connection
+      @@dap_connection._write(JSON.parse(json))
+    end
+  end
+
+  class DAPConnection
+    def initialize(connection, plugins)
+      @connection = connection
+      @plugins = plugins
+      @running = false
+      @next_seq = 1
+      @write_mutex = Mutex.new
+      @_dump_messages = (ENV['HAPLO_DAP_DEBUG'] == '1')
+    end
+
+    def close
+      begin
+        @connection.close
+      rescue => e
+        # ignore any errors
+      end
+    end
+
+    def run
+      begin
+        run2
+      rescue => e
+        puts "DEBUGGER: Local connection closed"
+      end
+      self.close
+    end
+
+    def run2
+      @running = true
+      have_initialized = false
+      while @running
+        header = @connection.readline
+        blank = @connection.readline
+        if header =~ /\Acontent-length:\s+(\d+)\r\n\z/i && blank == "\r\n"
+          body = @connection.read($1.to_i)
+          message = JSON.parse(body)
+          puts "DAP READ: #{JSON.pretty_generate(message)}\n" if @_dump_messages
+          unless have_initialized
+            if message['type'] == 'request' && message['command'] == 'initialize'
+              puts "DEBUGGER: Local connection from #{message['arguments']['clientName']} (#{message['arguments']['clientID']})\nDEBUGGER: Starting remote debugger..."
+              plugin_locations = {}
+              @plugins.each { |p| plugin_locations[p.name] = p.plugin_dir }
+              start_response = PluginTool.post("/api/development-plugin-loader/debugger-dap-start", {
+                :plugin_locations => JSON.generate(plugin_locations)
+              })
+              unless start_response =~ /\ATOKEN: (.+)\z/
+                raise "Remote debugger failed to start"
+              end
+              @token = $1
+              puts "DEBUGGER: Remote debugger started."
+              have_initialized = true
+            else
+              raise "Expected initialize message after DAP connection"
+            end
+          end
+          # TODO: Send messages in another thread, so that they can be batched together
+          message_response = PluginTool.post_with_json_response("/api/development-plugin-loader/debugger-dap-messages", {
+            :token => @token,
+            :messages => JSON.generate([message])
+          })
+          if message_response['error']
+            puts "DEBUGGER: Server responded with error: #{message_response['error']}"
+          else
+            message_response['messages'].each do |response|
+              _write(response) if response
+            end
+          end
+        end
+      end
+    end
+
+    def _write(message)
+      @write_mutex.synchronize do
+        m = {'seq' => @next_seq}
+        @next_seq += 1
+        m.merge!(message)
+        puts "DAP WRITE: #{JSON.pretty_generate(m)}\n" if @_dump_messages
+        msg_json = JSON.generate(m)
+        @connection.write("Content-Length: #{msg_json.bytesize}\r\n\r\n")
+        @connection.write(msg_json)
+      end
+    end
+  end
+
+end

data/lib/notifications.rb

@@ -69,6 +69,12 @@ module PluginTool
     when 'log '
       # Output from console.log()
       puts "LOG:#{data}"
+      DebugAdapterProtocolTunnel.log_message_from_server(data)
+    when 'DAP1'
+      DebugAdapterProtocolTunnel.dap_message_from_server(data)
+    when 'prof'
+      # Profiler report
+      PluginTool.profiler_handle_report(data)
     when 'audt'
       decoded = JSON.parse(data)
       kind = decoded.find { |name,value| name == 'auditEntryType' }.last

data/lib/packing.rb

@@ -50,7 +50,10 @@ module PluginTool
       end
       # Minimise file?
       unless filename =~ /\A(js|test)\//
-        data = minimiser.process(data, filename)
+        # Is this file explicitly excluded from minimisation?
+        unless plugin.exclude_files_from_minimisation.include?(filename)
+          data = minimiser.process(data, filename)
+        end
       end
       hash = Digest::SHA256.hexdigest(data)
       # Make sure output directory exists, write file

data/lib/plugin.rb

@@ -102,6 +102,17 @@ module PluginTool
       end
     end
 
+    def exclude_files_from_minimisation
+      @exclude_files_from_minimisation ||= begin
+        # developer.json file might specify files which should skip minimisation when packing
+        if developer_json['excludeFromMinimisation'].kind_of?(Array)
+          developer_json['excludeFromMinimisation']
+        else
+          []
+        end
+      end
+    end
+
     # ---------------------------------------------------------------------------------------------------------
 
     def command(cmd, errors)
@@ -180,11 +191,16 @@ module PluginTool
           hash = action
           # Minimise file before uploading?
           if @options.minimiser != nil && filename =~ /\A(static|template)\//
-            size_before = data.length
-            data = @options.minimiser.process(data, filename)
-            size_after = data.length
-            hash = Digest::SHA256.hexdigest(data)
-            puts "        minimisation: #{size_before} -> #{size_after} (#{(size_after * 100) / size_before}%)"
+            # Is this file explicitly excluded from minimisation?
+            unless exclude_files_from_minimisation.include?(filename)
+              size_before = data.length
+              data = @options.minimiser.process(data, filename)
+              size_after = data.length
+              hash = Digest::SHA256.hexdigest(data)
+              puts "        minimisation: #{size_before} -> #{size_after} (#{(size_after * 100) / size_before}%)"
+            else
+              puts "        minimisation: skipped by developer.json, unmodified file uploaded"
+            end
           end
           r = PluginTool.post_with_json_response("/api/development-plugin-loader/put-file/#{@loaded_plugin_id}", params, {:file => [filename, data]})
           if r["result"] == 'success'

data/lib/plugin_tool.rb

@@ -23,7 +23,7 @@ NO_DEPENDENCY_COMMANDS.delete('list')
 PLUGIN_SEARCH_PATH = ['.']
 
 # Options for passing to plugin objects
-options = Struct.new(:output, :minimiser, :no_dependency, :with_dependency, :exclude_with_prefix, :no_console, :show_system_audit, :args, :force, :turbo, :server_substring, :restrict_to_app_id).new
+options = Struct.new(:output, :minimiser, :no_dependency, :with_dependency, :exclude_with_prefix, :no_console, :show_system_audit, :args, :force, :turbo, :debugger, :profile, :profile_file, :profile_format, :coverage_file, :coverage_format, :server_substring, :restrict_to_app_id).new
 
 # Parse arguments
 show_help = false
@@ -37,6 +37,12 @@ opts = GetoptLong.new(
   ['--server', '-s', GetoptLong::REQUIRED_ARGUMENT],
   ['--force', GetoptLong::NO_ARGUMENT],
   ['--turbo', GetoptLong::NO_ARGUMENT],
+  ['--debugger', GetoptLong::REQUIRED_ARGUMENT],
+  ['--profile', GetoptLong::REQUIRED_ARGUMENT],
+  ['--profile-file', GetoptLong::REQUIRED_ARGUMENT],
+  ['--profile-format', GetoptLong::REQUIRED_ARGUMENT],
+  ['--coverage-file', GetoptLong::REQUIRED_ARGUMENT],
+  ['--coverage-format', GetoptLong::REQUIRED_ARGUMENT],
   ['--output', GetoptLong::REQUIRED_ARGUMENT],
   ['--pack-restrict-to-app-id', GetoptLong::REQUIRED_ARGUMENT],
   ['--no-console', '-n', GetoptLong::NO_ARGUMENT],
@@ -72,6 +78,18 @@ opts.each do |opt, argument|
     options.force = true
   when '--turbo'
     options.turbo = true
+  when '--debugger'
+    options.debugger = argument
+  when '--profile'
+    options.profile = argument.to_f
+  when '--profile-file'
+    options.profile_file = argument
+  when '--profile-format'
+    options.profile_format = argument
+  when '--coverage-file'
+    options.coverage_file = argument
+  when '--coverage-format'
+    options.coverage_format = argument
   end
 end
 # Handle rest of command line -- first arg is the command, the rest are passed on
@@ -325,6 +343,13 @@ end
 unless LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND]
   PluginTool.custom_behaviour.server_ready(plugins, PLUGIN_TOOL_COMMAND, options)
   plugins.each { |p| p.setup_for_server }
+
+  if options.profile
+    PluginTool.request_profile(options)
+  end
+  if options.coverage_file
+    PluginTool.request_coverage(options)
+  end
 end
 
 # Run the command
@@ -343,6 +368,11 @@ PluginTool.start_syntax_check
 # Notifications support (including console)
 PluginTool.start_notifications(options) unless options.no_console
 
+# If the debugger is requested, open the listening socket. Debugger initialised on connection.
+if options.debugger
+  DebugAdapterProtocolTunnel.prepare(plugins, options)
+end
+
 # Open watcher
 watcher = PluginTool.make_watcher(plugins.map { |p| p.plugin_dir })
 

data/lib/run.rb

@@ -65,6 +65,7 @@ require "#{PLUGIN_TOOL_ROOT_DIR}/lib/syntax_checking.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/notifications.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/plugin.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/new_plugin.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/debuggers.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/misc.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/watchers.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/minimise.rb"

data/lib/server.rb

@@ -50,6 +50,7 @@ module PluginTool
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_PEER
     http.cert_store = ssl_ca
+    http.read_timeout = 3600 # 1 hour, in case a test runs for a very long time
     http.start
     http
   end

data/lib/version.txt

@@ -1 +1 @@
-861823a
+ccc8c26

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haplo
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.4
 platform: java
 authors:
 - Haplo Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies: []
 description: Development tools for developing Haplo plugins, see https://haplo.org
 email: client.services@haplo-services.com
@@ -24,6 +24,7 @@ files:
 - lib/auth.rb
 - lib/check.rb
 - lib/custom.rb
+- lib/debuggers.rb
 - lib/haplo-templates.jar
 - lib/hmac.rb
 - lib/hsvt_parser_config.rb
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 2.7.9
 signing_key:
 specification_version: 4
 summary: Haplo Plugin Tool