rookout 0.1.0 → 0.1.5

data/lib/rookout/logger.rb

@@ -11,6 +11,14 @@ module Rookout
     LOG_LEVELS = [:DEBUG, :INFO, :WARNING, :ERROR].freeze
 
     def initialize
+      # Detect unit tests
+      if ($PROGRAM_NAME.end_with?("minitest_runner.rb") ||
+          $PROGRAM_NAME.end_with?("tunit_or_minitest_in_folder_runner.rb")) &&
+         Dir.pwd.end_with?("ruby-sdk")
+        Config.logger_log_level = :DEBUG
+        Config.logger_log_to_stderr = true
+      end
+
       @verbosity = LOG_LEVELS.index(Config.logger_log_level) || LOG_LEVELS.index(:INFO)
 
       @output = nil
@@ -43,7 +51,6 @@ module Rookout
     end
 
     def exception message, exc
-      # TODO: REVIEW HOW TO REPORT EXCEPTIONS
       error message, exc
     end
 
@@ -54,7 +61,14 @@ module Rookout
         @level = level
         @time = Time.new
         @message = message
-        @formatted_message = message % arguments
+        @formatted_message = @message % arguments
+
+        arguments.each do |argument|
+          if argument.is_a? Exception
+            @formatted_message += "\n" + argument.message + "\n" + argument.backtrace.join("\n\t")
+          end
+        end
+
         @arguments = arguments
         set_caller
       end

data/lib/rookout/processor/namespace_serializer.rb

@@ -17,7 +17,7 @@ module Rookout
           Logger.instance.exception message, e
 
           error = RookError.new e, message
-          variant = error.dumps
+          variant.error_value = error.dumps
         end
         variant
       end

data/lib/rookout/processor/namespaces/frame_namespace.rb

@@ -12,6 +12,7 @@ module Rookout
         end
 
         def read_attribute name
+          return RubyObjectNamespace.new @binding.receiver if name == "self"
           raise Exceptions::RookAttributeNotFound, name unless @binding.local_variable_defined? name
           RubyObjectNamespace.new @binding.local_variable_get name
         end

data/lib/rookout/processor/namespaces/namespace.rb

@@ -4,7 +4,7 @@ module Rookout
       class Namespace
         require_relative "../../exceptions"
         def call_method name, _args
-          raise Exceptions::RookMethodNotFound, self.class.to_s, name
+          raise Exceptions::RookMethodNotFound.new(self.class.to_s, name)
         end
 
         def read_attribute name
@@ -12,7 +12,7 @@ module Rookout
         end
 
         def write_attribute name, _value
-          raise Exceptions::RookWriteAttributeNotSupported, self.class.to_s, name
+          raise Exceptions::RookWriteAttributeNotSupported.new(self.class.to_s, name)
         end
 
         def read_key key

data/lib/rookout/processor/namespaces/noop_namespace.rb

@@ -6,7 +6,7 @@ module Rookout
 
       require_relative "../../protobuf/variant_pb"
 
-      class RubyUtilsNamespace < Namespace
+      class NoopNamespace < Namespace
         def initialize
           super
         end

data/lib/rookout/processor/namespaces/ruby_object_serializer.rb

@@ -17,7 +17,7 @@ module Rookout
             Logger.instance.exception message, e
 
             error = RookError.new e, message
-            variant = error.dumps
+            variant.error_value = error.dumps
           end
           variant
         end
@@ -29,7 +29,7 @@ module Rookout
 
           if obj.nil?
             dump_nil variant
-          elsif obj.is_a?(Numeric) || obj == true || obj == false
+          elsif obj.is_a?(Numeric) || obj.is_a?(TrueClass) || obj.is_a?(FalseClass)
             dump_numeric obj, variant
           elsif obj.is_a?(String) || obj.is_a?(Symbol)
             dump_string obj, variant, config
@@ -104,7 +104,7 @@ module Rookout
             variant.complex_value = Com::Rookout::Variant::Complex.new real: obj.real.to_f,
                                                                        imaginary: obj.imaginary.to_f
           else
-            raise Exceptions.RookClassCannotBeSerialized, obj.class, "Unknown Numeric Type"
+            raise Exceptions::RookClassCannotBeSerialized.new(obj.class, "Unknown Numeric Type")
           end
           # TODO: ADD SUPPORT FOR RATIONALS
         end
@@ -123,6 +123,7 @@ module Rookout
         end
 
         def dump_string obj, variant, config
+          obj = obj.to_s
           if obj.length > config.max_string
             final_obj = obj[0...config.max_string]
           else

data/lib/rookout/processor/operations/set_operation.rb

@@ -3,6 +3,8 @@ module Rookout
     module Operations
       require_relative "operation"
 
+      require_relative "../namespaces/ruby_object_namespace"
+
       require_relative "../rook_error"
       require_relative "../../logger"
       require_relative "../../user_warnings"
@@ -29,7 +31,8 @@ module Rookout
           @paths.each do |dest_path, source_path|
             begin
               value = source_path.read_from namespace
-              if value.is_a?(RubyObjectNamespace) && value.dump_config == Namespaces::OBJECT_DUMP_CONFIG_DEFAULT
+              if value.is_a?(Namespaces::RubyObjectNamespace) &&
+                 value.dump_config == Namespaces::OBJECT_DUMP_CONFIG_DEFAULT
                 value.tailor_limits!
               end
 

data/lib/rookout/processor/paths/arithmetic_path.rb

@@ -71,7 +71,7 @@ module Rookout
 
           if result.is_a? Canopy::ToolExceptionMarker
             raise result.obj if result.obj.is_a? Exceptions::ToolException
-            raise Exceptions::RookInvalidArithmeticPath, @raw_path, result.obj
+            raise Exceptions::RookInvalidArithmeticPath.new(@raw_path, result.obj)
           end
 
           res = result.obj

data/lib/rookout/processor/paths/canopy/markers.rb

@@ -4,6 +4,9 @@ module Rookout
       module Canopy
         require_relative "consts"
 
+        require_relative "../../../exceptions"
+        require_relative "../../namespaces/container_namespace"
+
         class Marker; end
 
         class Operation < Marker
@@ -12,7 +15,7 @@ module Rookout
           end
 
           def write _namespace, _value
-            raise Exception.RookOperationReadOnly, self.class.to_s
+            raise Exception::RookOperationReadOnly, self.class.to_s
           end
         end
 
@@ -36,7 +39,7 @@ module Rookout
             namespace.read_attribute @name
           rescue Exceptions::RookAttributeNotFound
             raise unless create
-            namespace.write_attribute name, ContainerNamespace.new
+            namespace.write_attribute @name, Namespaces::ContainerNamespace.new
           end
 
           def write namespace, value

data/lib/rookout/rookout_singleton.rb

@@ -40,7 +40,7 @@ module Rookout
       @services_started = false
     end
 
-    def connect token, host, port, proxy, labels, async_start, _fork
+    def connect token: nil, host: nil, port: nil, proxy: nil, labels: [], async_start: false, **_
       raise Exceptions::RookInterfaceException, "Multiple connection attempts not supported!" unless @agent_com.nil?
 
       start_trigger_services
@@ -48,6 +48,7 @@ module Rookout
       Logger.instance.debug "Initiating AgentCom-\t#{host}:#{port}"
 
       @agent_com = ComWs::AgentComWs.new @output, host, port, proxy, token, labels
+      @output.agent_com = @agent_com
       @command_handler = ComWs::CommandHandler.new @agent_com, @aug_manager
 
       @agent_com.connect
@@ -65,8 +66,8 @@ module Rookout
     private
 
     def check_version_supported
-      raise Exceptions:: RookVersionNotSupported, "platform", RUBY_ENGINE unless RUBY_ENGINE == "ruby"
-      raise Exceptions::RookVersionNotSupported, "version", RUBY_VERSION unless
+      raise Exceptions:: RookVersionNotSupported.new("platform", RUBY_ENGINE) unless RUBY_ENGINE == "ruby"
+      raise Exceptions::RookVersionNotSupported.new("version", RUBY_VERSION) unless
           RUBY_VERSION.start_with?("2.7") || RUBY_VERSION.start_with?("2.6")
     end
   end

data/lib/rookout/services/position.rb

@@ -1,5 +1,7 @@
 module Rookout
   module Services
+    require "zlib"
+
     require_relative "../logger"
     require_relative "../exceptions"
 
@@ -16,10 +18,16 @@ module Rookout
       def initialize tracer
         @tracer = tracer
         @augs = {}
+        @iseqs = []
         @trace_point = TracePoint.new :script_compiled do |tp|
           begin
             begin
-              evaluate_script tp.instruction_sequence
+              iseq = tp.instruction_sequence
+              # Ignore script without sources
+              if iseq.absolute_path
+                @iseqs << iseq
+                evaluate_script iseq
+              end
             rescue Exception => e
               Logger.instance.exception "Exception while evaluating script", e
             end
@@ -30,22 +38,18 @@ module Rookout
         @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
+      def add_aug location
+        positions = evaluate_all_scripts_to_location location
+        @tracer.add_breakpoint_aug positions, location unless positions.empty?
+        @augs[location.id] = location
       end
 
       def remove_aug aug_id
-        pair = @augs[aug_id]
-        return if pair.nil?
+        location = @augs[aug_id]
+        return if location.nil?
 
         @augs.delete [aug_id]
-        aug = pair[1]
-        aug.notify_removed
+        location.notify_removed
       end
 
       def clear_augs
@@ -64,88 +68,47 @@ module Rookout
       private
 
       #########################################################################################
-      # Dynamic Loading Section
+      # ISEQ comparison Section
       def evaluate_script iseq
         filename = iseq.absolute_path
         return if filename.nil?
 
-        @augs.each do |pair|
-          location = pair[0]
+        @augs.each_value do |location|
+          position = evaluate_script_to_location iseq, filename, location
+          next if position.nil?
 
-          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
+          @tracer.add_breakpoint_aug [position], location
         end
       end
 
-      #########################################################################################
-      # Enumerating Section
-      def resolve_positions location, aug
-        # TODO: ADD HASHES AND SUGGESTIONS TO THIS FLOW
+      def evaluate_all_scripts_to_location location
         positions = []
+        @iseqs.each do |iseq|
+          position = evaluate_script_to_location iseq, iseq.absolute_path, location
+          next if position.nil?
 
-        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
+          positions << position
         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
+      def evaluate_script_to_location iseq, filename, location
+        if exact_match? location.filename, filename
+          lineno = find_updated_line filename, location
+          return if lineno == -1
 
-          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
+          PositionMarker.new lineno, iseq
+        elsif suggested_match? location, filename
+          warning = Exceptions::RookSourceFilePathSuggestion.new location.filename, filename
+          location.notify_warning warning
         end
       end
 
       #########################################################################################
       # Utils
-      def exact_match? location, filename
-        filename.end_with? location.filename
+      def exact_match? location_filename, script_filename
+        script_filename.end_with? location_filename
       end
 
       def suggested_match? location, filename
@@ -158,6 +121,43 @@ module Rookout
         content.gsub!(/(?:\r\n|\r|\n)/, "\n")
         Digest::SHA2.new(256).hexdigest content
       end
+
+      def find_updated_line filename, location
+        return location.lineno if location.line_crc.nil?
+
+        lines = File.readlines filename, chomp: true
+        line_crc32 = lines.length >= location.lineno ? crc_line(lines[location.lineno - 1]) : nil
+        return location.lineno if location.line_crc == line_crc32
+
+        if location.line_unique
+          first_line = nil
+          second_found = false
+
+          lines.each_with_index do |line, index|
+            if crc_line(line) == location.line_crc
+              if first_line.nil?
+                first_line = index
+              else
+                second_found = true
+                break
+              end
+            end
+          end
+
+          if first_line && !second_found
+            updated_line = first_line + 1
+            location.notify_warning Exceptions::RookLineMoved.new(filename, location.lineno, updated_line)
+            return updated_line
+          end
+        end
+
+        location.notify_error Exceptions::RookCrcMismatchException.new(filename, location.line_crc, line_crc32)
+        -1
+      end
+
+      def crc_line line
+        (Zlib.crc32(line) & 0xffffffff).to_s 16
+      end
     end
   end
 end

data/lib/rookout/services/tracer.rb

@@ -1,9 +1,11 @@
 module Rookout
   module Services
-    require "binding_of_caller"
-    include BindingOfCaller::BindingExtensions
+    require_relative "../logger"
 
     class Tracer
+      require "binding_of_caller"
+      include BindingOfCaller::BindingExtensions
+
       def initialize
         @trace_points = {}
         @augs = {}
@@ -19,7 +21,7 @@ module Rookout
           begin
             trace_point.enable target: position.method, target_line: position.lineno
           rescue ArgumentError => e
-            raise Exceptions::RookSetTracepointFailed, position.lineno, e
+            raise Exceptions::RookSetTracepointFailed.new(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
@@ -69,9 +71,10 @@ module Rookout
         TracePoint.new :line do
           begin
             begin
-              aug.execute BindingOfCaller::BindingExtensions.callers, nil
+              # TODO: consider delaying callers (get bindings) until we actually need them in Aug.rb
+              aug.execute callers, nil
             rescue Exception => e
-              Logger.instance.exception "Exception while evaluating script", e
+              Logger.instance.exception "Exception calling aug", e
             end
           rescue
             # Don't leak any exception from here

data/lib/rookout/trigger_services.rb

@@ -17,8 +17,8 @@ module Rookout
       @services.each_value { |service| service.remove_aug aug_id }
     end
 
-    def clear_augs aug_id
-      @services.each_value { |service| service.clear_augs aug_id }
+    def clear_augs
+      @services.each_value(&:clear_augs)
     end
 
     def start