rookout 0.1.0

data/lib/rookout/protobuf/variant_pb.rb

@@ -0,0 +1,139 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: variant.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("variant.proto", :syntax => :proto3) do
+    add_message "com.rookout.Error" do
+      optional :message, :string, 1
+      optional :type, :string, 2
+      optional :parameters, :message, 3, "com.rookout.Variant"
+      optional :exc, :message, 4, "com.rookout.Variant"
+      optional :traceback, :message, 5, "com.rookout.Variant"
+    end
+    add_message "com.rookout.Variant" do
+      optional :variant_type, :enum, 1, "com.rookout.Variant.Type"
+      optional :original_type, :string, 2
+      repeated :attributes, :message, 3, "com.rookout.Variant.NamedValue"
+      optional :max_depth, :bool, 4
+      oneof :value do
+        optional :int_value, :int32, 11
+        optional :long_value, :int64, 12
+        optional :double_value, :double, 13
+        optional :binary_value, :message, 14, "com.rookout.Variant.Binary"
+        optional :string_value, :message, 15, "com.rookout.Variant.String"
+        optional :list_value, :message, 16, "com.rookout.Variant.List"
+        optional :map_value, :message, 17, "com.rookout.Variant.Map"
+        optional :namespace_value, :message, 19, "com.rookout.Variant.Namespace"
+        optional :error_value, :message, 20, "com.rookout.Error"
+        optional :message_value, :message, 23, "com.rookout.Variant.FormattedMessage"
+        optional :time_value, :message, 24, "google.protobuf.Timestamp"
+        optional :code_value, :message, 26, "com.rookout.Variant.CodeObject"
+        optional :large_int_value, :message, 27, "com.rookout.Variant.LargeInt"
+        optional :complex_value, :message, 28, "com.rookout.Variant.Complex"
+        optional :enum_value, :message, 31, "com.rookout.Variant.Enumeration"
+        optional :traceback, :message, 32, "com.rookout.Variant.Traceback"
+      end
+    end
+    add_message "com.rookout.Variant.NamedValue" do
+      optional :name, :string, 1
+      optional :value, :message, 2, "com.rookout.Variant"
+    end
+    add_message "com.rookout.Variant.Binary" do
+      optional :original_size, :int32, 1
+      optional :value, :bytes, 2
+    end
+    add_message "com.rookout.Variant.String" do
+      optional :original_size, :int32, 1
+      optional :value, :string, 2
+    end
+    add_message "com.rookout.Variant.List" do
+      optional :type, :string, 1
+      optional :original_size, :int32, 2
+      repeated :values, :message, 3, "com.rookout.Variant"
+    end
+    add_message "com.rookout.Variant.Pair" do
+      optional :first, :message, 1, "com.rookout.Variant"
+      optional :second, :message, 2, "com.rookout.Variant"
+    end
+    add_message "com.rookout.Variant.Map" do
+      optional :original_size, :int32, 1
+      repeated :pairs, :message, 2, "com.rookout.Variant.Pair"
+    end
+    add_message "com.rookout.Variant.Namespace" do
+      repeated :attributes, :message, 1, "com.rookout.Variant.NamedValue"
+    end
+    add_message "com.rookout.Variant.FormattedMessage" do
+      optional :message, :string, 1
+    end
+    add_message "com.rookout.Variant.CodeObject" do
+      optional :name, :string, 1
+      optional :module, :string, 2
+      optional :filename, :string, 3
+      optional :lineno, :uint32, 4
+    end
+    add_message "com.rookout.Variant.LargeInt" do
+      optional :value, :string, 1
+    end
+    add_message "com.rookout.Variant.Complex" do
+      optional :real, :double, 1
+      optional :imaginary, :double, 2
+    end
+    add_message "com.rookout.Variant.Enumeration" do
+      optional :string_value, :string, 1
+      optional :ordinal_value, :int32, 2
+      optional :type_name, :string, 3
+    end
+    add_message "com.rookout.Variant.Traceback" do
+      repeated :locations, :message, 1, "com.rookout.Variant.CodeObject"
+    end
+    add_enum "com.rookout.Variant.Type" do
+      value :VARIANT_NONE, 0
+      value :VARIANT_INT, 1
+      value :VARIANT_LONG, 2
+      value :VARIANT_DOUBLE, 3
+      value :VARIANT_BINARY, 4
+      value :VARIANT_STRING, 5
+      value :VARIANT_LIST, 6
+      value :VARIANT_MAP, 7
+      value :VARIANT_OBJECT, 8
+      value :VARIANT_NAMESPACE, 9
+      value :VARIANT_ERROR, 10
+      value :VARIANT_NOT_SUPPORTED, 11
+      value :VARIANT_MAX_DEPTH, 12
+      value :VARIANT_FORMATTED_MESSAGE, 13
+      value :VARIANT_TIME, 14
+      value :VARIANT_UKNOWN_OBJECT, 15
+      value :VARIANT_CODE_OBJECT, 16
+      value :VARIANT_LARGE_INT, 17
+      value :VARIANT_COMPLEX, 18
+      value :VARIANT_UNDEFINED, 19
+      value :VARIANT_DYNAMIC, 20
+      value :VARIANT_ENUM, 21
+      value :VARIANT_TRACEBACK, 22
+    end
+  end
+end
+
+module Com
+  module Rookout
+    Error = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Error").msgclass
+    Variant = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant").msgclass
+    Variant::NamedValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.NamedValue").msgclass
+    Variant::Binary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Binary").msgclass
+    Variant::String = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.String").msgclass
+    Variant::List = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.List").msgclass
+    Variant::Pair = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Pair").msgclass
+    Variant::Map = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Map").msgclass
+    Variant::Namespace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Namespace").msgclass
+    Variant::FormattedMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.FormattedMessage").msgclass
+    Variant::CodeObject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.CodeObject").msgclass
+    Variant::LargeInt = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.LargeInt").msgclass
+    Variant::Complex = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Complex").msgclass
+    Variant::Enumeration = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Enumeration").msgclass
+    Variant::Traceback = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Traceback").msgclass
+    Variant::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.rookout.Variant.Type").enummodule
+  end
+end

data/lib/rookout/rookout_singleton.rb

@@ -0,0 +1,73 @@
+module Rookout
+  require_relative "logger"
+  require_relative "trigger_services"
+  require_relative "exceptions"
+
+  require_relative "augs/augs_manager"
+
+  require_relative "com_ws/agent_com_ws"
+  require_relative "com_ws/output"
+  require_relative "com_ws/command_handler"
+
+  class RookoutSingleton
+    require "singleton"
+    include Singleton
+
+    def initialize
+      check_version_supported
+
+      @output = ComWs::Output.new
+
+      @services_started = false
+      @services = TriggerServices.new
+
+      @aug_manager = Augs::AugsManager.new @services, @output
+
+      @agent_com = nil
+    end
+
+    def start_trigger_services
+      return if @services_started
+
+      @services.start
+      @services_started = true
+    end
+
+    def stop_trigger_services
+      return unless @services_started
+
+      @services.close
+      @services_started = false
+    end
+
+    def connect token, host, port, proxy, labels, async_start, _fork
+      raise Exceptions::RookInterfaceException, "Multiple connection attempts not supported!" unless @agent_com.nil?
+
+      start_trigger_services
+
+      Logger.instance.debug "Initiating AgentCom-\t#{host}:#{port}"
+
+      @agent_com = ComWs::AgentComWs.new @output, host, port, proxy, token, labels
+      @command_handler = ComWs::CommandHandler.new @agent_com, @aug_manager
+
+      @agent_com.connect
+      return if async_start
+
+      @agent_com.wait_for_ready
+    end
+
+    def flush
+      @output.flush_messages if !@output.nil && !@agent_com.nil?
+    end
+
+    attr_reader :services
+
+    private
+
+    def check_version_supported
+      raise Exceptions:: RookVersionNotSupported, "platform", RUBY_ENGINE unless RUBY_ENGINE == "ruby"
+      raise Exceptions::RookVersionNotSupported, "version", RUBY_VERSION unless
+          RUBY_VERSION.start_with?("2.7") || RUBY_VERSION.start_with?("2.6")
+    end
+  end
+end

data/lib/rookout/services/position.rb

@@ -0,0 +1,163 @@
+module Rookout
+  module Services
+    require_relative "../logger"
+    require_relative "../exceptions"
+
+    class PositionMarker
+      def initialize lineno, method
+        @lineno = lineno
+        @method = method
+      end
+
+      attr_reader :lineno, :method
+    end
+
+    class PositionResolver
+      def initialize tracer
+        @tracer = tracer
+        @augs = {}
+        @trace_point = TracePoint.new :script_compiled do |tp|
+          begin
+            begin
+              evaluate_script tp.instruction_sequence
+            rescue Exception => e
+              Logger.instance.exception "Exception while evaluating script", e
+            end
+          rescue
+          end
+        end
+
+        @trace_point.enable
+      end
+
+      def add_aug location, aug
+        positions = resolve_positions location, aug
+        if positions.empty?
+          @augs[aug.id] = [location, aug]
+        else
+          @tracer.add_breakpoint_aug positions, aug
+        end
+      end
+
+      def remove_aug aug_id
+        pair = @augs[aug_id]
+        return if pair.nil?
+
+        @augs.delete [aug_id]
+        aug = pair[1]
+        aug.notify_removed
+      end
+
+      def clear_augs
+        @augs.values.each do |aug_id|
+          remove_aug aug_id
+        end
+
+        @augs = {}
+      end
+
+      def close
+        clear_augs
+        @trace_point.disable
+      end
+
+      private
+
+      #########################################################################################
+      # Dynamic Loading Section
+      def evaluate_script iseq
+        filename = iseq.absolute_path
+        return if filename.nil?
+
+        @augs.each do |pair|
+          location = pair[0]
+
+          if exact_match? location, filename
+            # TODO: CHECK FILE AND LINE HASH COMPARED TO AUG
+            position = PositionMarker.new iseq.absolute_path, location.lineno, iseq
+            @tracer.add_breakpoint_aug [position], pair[1]
+          elsif suggested_match? location, filename
+            warning = Exceptions::RookSourceFilePathSuggestion.new location.filename, filename
+            pair[1].notify_warning warning
+          end
+        end
+      end
+
+      #########################################################################################
+      # Enumerating Section
+      def resolve_positions location, aug
+        # TODO: ADD HASHES AND SUGGESTIONS TO THIS FLOW
+        positions = []
+
+        ObjectSpace.each_object Module do |mod|
+          positions += scan_module_or_class mod, location, aug
+        end
+
+        ObjectSpace.each_object Class do |klass|
+          positions += scan_module_or_class klass, location, aug
+        end
+
+        positions
+      end
+
+      def scan_module_or_class mod, location, aug
+        positions = []
+
+        mod.instance_methods(false).each do |method_name|
+          method = mod.instance_method method_name
+          next unless method_match? method, location, aug
+
+          position = PositionMarker.new location.lineno, method
+          positions.push position
+        end
+
+        mod.private_instance_methods(false).each do |method_name|
+          method = mod.instance_method method_name
+          next unless method_match? method, location, aug
+
+          position = PositionMarker.new location.lineno, method
+          positions.push position
+        end
+
+        positions
+      end
+
+      def method_match? method, location, aug
+        return false unless method.source_location
+        filename = method.source_location[0]
+
+        if exact_match? location, filename
+          disasm_header = "== disasm: #<ISeq:#{method.name}@#{location.filename}:"
+          line_in_disasm = "(#{location.lineno.to_s.rjust 4})"
+          text = RubyVM::InstructionSequence.disasm method
+          return false if text.nil?
+
+          text.start_with?(disasm_header) && text.include?(line_in_disasm)
+        else
+          if suggested_match? location, filename
+            warning = Exceptions::RookSourceFilePathSuggestion.new location.filename, filename
+            aug.notify_warning warning
+          end
+          false
+        end
+      end
+
+      #########################################################################################
+      # Utils
+      def exact_match? location, filename
+        filename.end_with? location.filename
+      end
+
+      def suggested_match? location, filename
+        return unless File.basename(location.filename) == File.basename(filename)
+        location.file_hash == get_hash(filename)
+      end
+
+      def get_hash filename
+        content = File.read filename
+        content.gsub!(/(?:\r\n|\r|\n)/, "\n")
+        Digest::SHA2.new(256).hexdigest content
+      end
+    end
+  end
+end

data/lib/rookout/services/tracer.rb

@@ -0,0 +1,83 @@
+module Rookout
+  module Services
+    require "binding_of_caller"
+    include BindingOfCaller::BindingExtensions
+
+    class Tracer
+      def initialize
+        @trace_points = {}
+        @augs = {}
+      end
+
+      def add_breakpoint_aug positions, aug
+        return if @augs.include? aug.id
+
+        aug_trace_points = []
+        positions.each do |position|
+          trace_point = create_trace_point aug
+
+          begin
+            trace_point.enable target: position.method, target_line: position.lineno
+          rescue ArgumentError => e
+            raise Exceptions::RookSetTracepointFailed, position.lineno, e
+          end
+
+          # We add and remove a dummy trace point to re-align the tracing mechanism as a result of some bug in adding
+          # a breakpoint
+          dummy_trace_point = TracePoint.new(:line) {}
+          dummy_trace_point.enable target: position.method, target_line: position.lineno
+          dummy_trace_point.disable
+
+          aug_trace_points.push trace_point
+        end
+
+        @trace_points[aug.id] = aug_trace_points
+        @augs[aug.id] = aug
+        aug.notify_active
+      end
+
+      def remove_aug aug_id
+        aug = @augs[aug_id]
+        return if aug.nil?
+
+        aug_trace_points = @trace_points[aug_id]
+        unless aug_trace_points.nil?
+          aug_trace_points.each(&:disable)
+        end
+
+        @augs.delete aug_id
+        @trace_points.delete aug_id
+        aug.notify_removed
+      end
+
+      def clear_augs
+        @augs.values.each do |aug_id|
+          remove_aug aug_id
+        end
+
+        @trace_points = {}
+        @augs = {}
+      end
+
+      def close
+        clear_augs
+      end
+
+      private
+
+      def create_trace_point aug
+        TracePoint.new :line do
+          begin
+            begin
+              aug.execute BindingOfCaller::BindingExtensions.callers, nil
+            rescue Exception => e
+              Logger.instance.exception "Exception while evaluating script", e
+            end
+          rescue
+            # Don't leak any exception from here
+          end
+        end
+      end
+    end
+  end
+end