rookout 0.1.52 → 0.1.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8854b65da599e09232b62dadbe87cb092dccd93e2a3153dae13e5aa703fcd4e0
-  data.tar.gz: 8fb0f255e23b6eac93f293632a4230e7b24fa80fcdd49d0288d78582ebd121e0
+  metadata.gz: fc61fe37a93f9e71f499fce1d5edfc2de6b2eb1203b9885c5b4cdbcc0b0af6f2
+  data.tar.gz: 5d48b072987c67593ecc81a68d3d96dd217aca001a3a49fd581a97ae72ae6903
 SHA512:
-  metadata.gz: a0008b3f484e1967418b7cd8bd9db5b8550658a1eb211b5f1ce6f6e731a9fca6733361fd03413f1904dd2aebea889be20418b5fcde963ffd14d116290e8421cf
-  data.tar.gz: 3d2282c21829a747f961e6063435433aa19e88be46ae3f572c8239355ef6dfda585fd12c8d12c4b401d427d7fd0f9040c744b0c27a673b2d9a87a0ac6705ca56
+  metadata.gz: 6afa9d0c7fa12fba84e4bd679ac752eecf6463bf0bc82fef67f80dbd6fa1df576f7a0095f7f246116ed5bc0d4a5418a7afc078ffcba40fe1fc8804501422e83d
+  data.tar.gz: 605af10354982b51166cce1382572be5f816d90512a2506ce23acb61ea175b155b1b9b435488cafe47269b5b119e9a7c6e4df4449a7c227b647185c97bbad65d

data/lib/rookout/augs/aug.rb

@@ -24,7 +24,7 @@ module Rookout
 
       attr_reader :id
 
-      def execute frame, extracted, output
+      def execute frame_binding, stack_trace, extracted, output
         return unless @enabled
 
         if output.user_messages_queue_full?
@@ -32,7 +32,7 @@ module Rookout
           return
         end
 
-        namespace = create_namespaces frame, extracted
+        namespace = create_namespaces frame_binding, stack_trace, extracted
         return if @condition && !@condition.evaluate(namespace)
 
         should_skip_limiters = @condition.nil? && !@executed
@@ -46,10 +46,10 @@ module Rookout
 
       private
 
-      def create_namespaces frame, extracted
+      def create_namespaces frame_binding, stack_trace, extracted
         Processor::Namespaces::ContainerNamespace.new(
-          "frame" => Processor::Namespaces::FrameNamespace.new(frame[1]),
-          "stack" => Processor::Namespaces::StackNamespace.new(frame, 1),
+          "frame" => Processor::Namespaces::FrameNamespace.new(frame_binding, stack_trace[0]),
+          "stack" => Processor::Namespaces::StackNamespace.new(stack_trace),
           "extracted" => Processor::Namespaces::ContainerNamespace.new(extracted),
           "store" => Processor::Namespaces::ContainerNamespace.new,
           "temp" => Processor::Namespaces::ContainerNamespace.new,

data/lib/rookout/augs/locations/location.rb

@@ -20,10 +20,10 @@ module Rookout
           @aug.id
         end
 
-        def execute frame, extracted
+        def execute frame_binding, stack_trace, extracted
           UserWarnings.with self do
             begin
-              @aug.execute frame, extracted, @output
+              @aug.execute frame_binding, stack_trace, extracted, @output
             rescue SystemExit
               raise
             rescue Exception => e

data/lib/rookout/commit.rb

@@ -1,3 +1,3 @@
 module Rookout
-  COMMIT = "3e5cbb5882385eff12a3113f93dfde79418d5061".freeze
+  COMMIT = "24373c28244fc83259758e74b7fd12d5a6964eb5".freeze
 end

data/lib/rookout/exceptions.rb

@@ -258,5 +258,11 @@ module Rookout
         super "Live Logger is not supported. Try using Rookout Live Debugger instead."
       end
     end
+
+    class RookLocalsUnavailable < ToolException
+      def initialize
+        super "Can't collect local variables up the stack"
+      end
+    end
   end
 end

data/lib/rookout/processor/namespace_serializer2.rb

@@ -314,12 +314,12 @@ module Rookout
 
         namespace.depth.times do |i|
           position = i + namespace.offset
-          break if position >= namespace.backtrace.length
-          frame = namespace.backtrace[position]
+          break if position >= namespace.stack_trace.length
+          frame_info = namespace.stack_trace[position]
 
-          code_object = Com::Rookout::Variant::CodeObject.new filename: frame.source_location[0],
-                                                              lineno: frame.source_location[1],
-                                                              name: frame.eval("__method__").to_s
+          code_object = Com::Rookout::Variant::CodeObject.new filename: frame_info.path,
+                                                              lineno: frame_info.lineno,
+                                                              name: frame_info.label
           variant.code_values << code_object
           # See dump_code_object
           @estimated_pending_bytes += 14 # Header + size + (header + number) * 4

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

@@ -7,33 +7,35 @@ module Rookout
       require_relative "../../exceptions"
 
       class FrameNamespace < Namespace
-        def initialize binding
+        def initialize frame_binding, top_frame_info
           super()
-          @binding = binding
+          @frame_binding = frame_binding
+          @top_frame_info = top_frame_info
         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
+          raise Exceptions::RookLocalsUnavailable if @frame_binding.nil?
+          return RubyObjectNamespace.new @frame_binding.receiver if name == "self"
+          raise Exceptions::RookAttributeNotFound, name unless @frame_binding.local_variable_defined? name
+          RubyObjectNamespace.new @frame_binding.local_variable_get name
         end
 
         def call_method name, args
           case name
           when "filename", "module"
-            RubyObjectNamespace.new @binding.source_location[0]
+            RubyObjectNamespace.new @top_frame_info.path
           when "line"
-            RubyObjectNamespace.new @binding.source_location[1]
+            RubyObjectNamespace.new @top_frame_info.lineno
           when "function"
-            RubyObjectNamespace.new @binding.eval("__method__").to_s
+            RubyObjectNamespace.new @top_frame_info.label
           when "locals"
             locals args
           when "dump"
             result = {
-              "filename" => RubyObjectNamespace.new(@binding.source_location[0]),
-              "line" => RubyObjectNamespace.new(@binding.source_location[1]),
-              "function" => RubyObjectNamespace.new(@binding.eval("__method__").to_s),
-              "module" => RubyObjectNamespace.new(@binding.source_location[0]),
+              "filename" => RubyObjectNamespace.new(@top_frame_info.path),
+              "line" => RubyObjectNamespace.new(@top_frame_info.lineno),
+              "function" => RubyObjectNamespace.new(@top_frame_info.label),
+              "module" => RubyObjectNamespace.new(@top_frame_info.path),
               "locals" => locals(args)
             }
             ContainerNamespace.new result
@@ -43,19 +45,20 @@ module Rookout
         end
 
         def locals args
+          raise Exceptions::RookLocalsUnavailable if @frame_binding.nil?
           dump_config = nil
           unless args.nil?
             dump_config = OBJECT_DUMP_TABLE[args.downcase]
           end
 
           hash = {}
-          local_variables = @binding.local_variables
+          local_variables = @frame_binding.local_variables
           local_variables.each do |var|
-            value = @binding.local_variable_get var
+            value = @frame_binding.local_variable_get var
             hash[var.to_s] = RubyObjectNamespace.new value, dump_config
           end
 
-          hash["self"] = RubyObjectNamespace.new @binding.receiver, dump_config
+          hash["self"] = RubyObjectNamespace.new @frame_binding.receiver, dump_config
 
           ContainerNamespace.new hash
         end

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

@@ -5,15 +5,16 @@ module Rookout
       require_relative "frame_namespace"
       require_relative "traceback_namespace"
 
+
       class StackNamespace < Namespace
-        def initialize backtrace, offset = 0
+        def initialize stack_trace, offset = 0
           super()
-          @backtrace = backtrace
+          @stack_trace = stack_trace
           @offset = offset
         end
 
         def read_key key
-          FrameNamespace.new @backtrace[key + @offset]
+          FrameNamespace.new nil, @stack_trace[key + @offset]
         end
 
         def call_method name, args
@@ -23,7 +24,7 @@ module Rookout
 
         def create_traceback args
           args = 1000 if args == ""
-          TracebackNamespace.new @backtrace, @offset, args.to_i
+          TracebackNamespace.new @stack_trace, @offset, args.to_i
         end
       end
     end

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

@@ -3,23 +3,22 @@ module Rookout
     module Namespaces
       require_relative "namespace"
       require_relative "frame_namespace"
-
       require_relative "../../protobuf/variant_pb"
 
       class TracebackNamespace < Namespace
-        def initialize backtrace, offset, depth
+        def initialize stack_trace, offset, depth
           super()
-          @backtrace = backtrace
+          @stack_trace = stack_trace
           @offset = offset
           @depth = depth
         end
 
-        attr_reader :backtrace
+        attr_reader :stack_trace
         attr_reader :offset
         attr_reader :depth
 
         def read_key key
-          FrameNamespace.new @backtrace[key + @offset]
+          FrameNamespace.new nil, @stack_trace[key + @offset]
         end
 
         def dump _log_object_errors
@@ -27,12 +26,12 @@ module Rookout
 
           @depth.times do |i|
             position = i + @offset
-            break if position >= @backtrace.length
-            frame = @backtrace[position]
+            break if position >= @stack_trace.length
+            frame_info = @stack_trace[position]
 
-            code_object = Com::Rookout::Variant::CodeObject.new filename: frame.source_location[0],
-                                                                lineno: frame.source_location[1],
-                                                                name: frame.eval("__method__").to_s
+            code_object = Com::Rookout::Variant::CodeObject.new filename: frame_info.path,
+                                                                lineno: frame_info.lineno,
+                                                                name: frame_info.label
 
             traceback.locations << code_object
           end

data/lib/rookout/services/tracer.rb

@@ -3,9 +3,6 @@ module Rookout
     require_relative "../logger"
 
     class Tracer
-      require "binding_of_caller"
-      include BindingOfCaller::BindingExtensions
-
       def initialize
         @trace_points = {}
         @augs = {}
@@ -17,22 +14,25 @@ module Rookout
         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 RuntimeError, ArgumentError => e
+            trace_point.disable # just to make sure if something was partially added to clear everything
             if e.message.include? "can not enable any hooks"
               raise Exceptions::RookInvalidPositionException.new(aug.filename, position.lineno)
             end
             raise Exceptions::RookSetTracepointFailed.new(position.lineno, e)
+          ensure
+            # We add and remove a dummy trace point to re-align the tracing mechanism as a result of some bug in adding
+            # a breakpoint https://bugs.ruby-lang.org/issues/17302
+            begin
+              dummy_trace_point = TracePoint.new(:line) {} # Dummy
+              dummy_trace_point.enable target: position.method, target_line: position.lineno
+              dummy_trace_point.disable
+            rescue
+              # IGNORE
+            end
           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
-          dummy_trace_point.enable target: position.method, target_line: position.lineno
-          dummy_trace_point.disable
-
           aug_trace_points.push trace_point
         end
 
@@ -71,11 +71,19 @@ module Rookout
       private
 
       def create_trace_point aug
-        TracePoint.new :line do
+        TracePoint.new :line do |tp|
           begin
             begin
-              # TODO: consider delaying callers (get bindings) until we actually need them in Aug.rb
-              aug.execute callers, nil
+              # tp.binding - Binding object of the frame in the location that triggered the TracePoint.
+              #              This allows us to collect locals.
+              # caller_locations - returns the stacktrace. Allows us to collect files, lines and function names.
+              # We used to also collect the Bindings up the stack (allowed us to also collect locals up the stack),
+              # but we don't actually need that. If we'll ever need this functionality again, we'll have to use the
+              # binding_of_caller gem:
+              # require "binding_of_caller"
+              # include BindingOfCaller::BindingExtensions
+              # callers_bindings = callers - The "callers" function retrieves the bindings up the stack
+              aug.execute tp.binding, caller_locations, nil
             rescue Exception => e
               Logger.instance.exception "Exception calling aug", e
             end

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.52".freeze
+  VERSION = "0.1.53".freeze
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rookout
 version: !ruby/object:Gem::Version
-  version: 0.1.52
+  version: 0.1.53
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: binding_of_caller
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement