tapping_device 0.5.0 → 0.5.5

data/lib/tapping_device/trackers/method_call_tracker.rb

@@ -0,0 +1,9 @@
+class TappingDevice
+  module Trackers
+    class MethodCallTracker < TappingDevice
+      def filter_condition_satisfied?(tp)
+        is_from_target?(tp)
+      end
+    end
+  end
+end

data/lib/tapping_device/trackers/mutation_tracker.rb

@@ -0,0 +1,112 @@
+class TappingDevice
+  module Trackers
+    class MutationTracker < TappingDevice
+      def initialize(options, &block)
+        options[:hijack_attr_methods] = true
+        super
+        @snapshot_stack = []
+      end
+
+      def track(object)
+        super
+        insert_snapshot_taking_trace_point
+        self
+      end
+
+      def stop!
+        super
+        @ivar_snapshot_trace_point.disable
+      end
+
+      private
+
+      # we need to snapshot instance variables at the beginning of every method call
+      # so we can get a correct state for the later comparison
+      def insert_snapshot_taking_trace_point
+        @ivar_snapshot_trace_point = build_minimum_trace_point(event_type: :call) do
+          snapshot_instance_variables
+        end
+
+        @ivar_snapshot_trace_point.enable unless TappingDevice.suspend_new
+      end
+
+      def filter_condition_satisfied?(tp)
+        return false unless is_from_target?(tp)
+
+        if snapshot_capturing_event?(tp)
+          true
+        else
+          @latest_instance_variables = target_instance_variables
+          @instance_variables_snapshot = @snapshot_stack.pop
+
+          @latest_instance_variables != @instance_variables_snapshot
+        end
+      end
+
+      def build_payload(tp:, filepath:, line_number:)
+        payload = super
+
+        if change_capturing_event?(tp)
+          payload[:ivar_changes] = capture_ivar_changes
+        end
+
+        payload
+      end
+
+      def capture_ivar_changes
+        changes = {}
+
+        additional_keys = @latest_instance_variables.keys - @instance_variables_snapshot.keys
+        additional_keys.each do |key|
+          changes[key] = {before: Output::Payload::UNDEFINED, after: @latest_instance_variables[key]}
+        end
+
+        removed_keys = @instance_variables_snapshot.keys - @latest_instance_variables.keys
+        removed_keys.each do |key|
+          changes[key] = {before: @instance_variables_snapshot[key], after: Output::Payload::UNDEFINED}
+        end
+
+        remained_keys = @latest_instance_variables.keys - additional_keys
+        remained_keys.each do |key|
+          next if @latest_instance_variables[key] == @instance_variables_snapshot[key]
+          changes[key] = {before: @instance_variables_snapshot[key], after: @latest_instance_variables[key]}
+        end
+
+        changes
+      end
+
+      def snapshot_instance_variables
+        @snapshot_stack.push(target_instance_variables)
+      end
+
+      def target_instance_variables
+        target.instance_variables.each_with_object({}) do |ivar, hash|
+          hash[ivar] = target.instance_variable_get(ivar)
+        end
+      end
+
+      def snapshot_capturing_event?(tp)
+        tp.event == :call
+      end
+
+      def change_capturing_event?(tp)
+        !snapshot_capturing_event?(tp)
+      end
+
+      # belows are debugging helpers
+      # I'll leave them for a while in case there's a bug in the tracker
+      def print_snapshot_stack(tp)
+        puts("===== STACK - #{tp.callee_id} (#{tp.event}) =====")
+        puts(@snapshot_stack)
+        puts("================ END STACK =================")
+      end
+
+      def print_state_comparison
+        puts("###############")
+        puts(@latest_instance_variables)
+        puts(@instance_variables_snapshot)
+        puts("###############")
+      end
+    end
+  end
+end

data/lib/tapping_device/trackers/passed_tracker.rb

@@ -0,0 +1,16 @@
+class TappingDevice
+  module Trackers
+    # PassedTracker tracks calls that use the target object as an argument
+    class PassedTracker < TappingDevice
+      def filter_condition_satisfied?(tp)
+        collect_arguments(tp).values.any? do |value|
+          # during comparison, Ruby might perform data type conversion like calling `to_sym` on the value
+          # but not every value supports every conversion methods
+          target == value rescue false
+        end
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.5.0"
+  VERSION = "0.5.5"
 end

data/tapping_device.gemspec

@@ -32,10 +32,12 @@ Gem::Specification.new do |spec|
     spec.add_dependency "activerecord", ">= 5.2"
   end
 
+  spec.add_dependency "pry" # for using Method#source in MutationTracker
+  spec.add_dependency "activesupport"
+
   spec.add_development_dependency "sqlite3", ">= 1.3.6"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "0.17.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.5
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,27 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -147,14 +162,25 @@ files:
 - bin/setup
 - images/print_calls - single entry.png
 - images/print_calls.png
+- images/print_mutations.png
 - images/print_traces.png
 - lib/tapping_device.rb
+- lib/tapping_device/configurable.rb
 - lib/tapping_device/exceptions.rb
 - lib/tapping_device/manageable.rb
-- lib/tapping_device/output_payload.rb
+- lib/tapping_device/method_hijacker.rb
+- lib/tapping_device/output.rb
+- lib/tapping_device/output/file_writer.rb
+- lib/tapping_device/output/payload.rb
+- lib/tapping_device/output/stdout_writer.rb
+- lib/tapping_device/output/writer.rb
 - lib/tapping_device/payload.rb
-- lib/tapping_device/sql_tapping_methods.rb
 - lib/tapping_device/trackable.rb
+- lib/tapping_device/trackers/association_call_tracker.rb
+- lib/tapping_device/trackers/initialization_tracker.rb
+- lib/tapping_device/trackers/method_call_tracker.rb
+- lib/tapping_device/trackers/mutation_tracker.rb
+- lib/tapping_device/trackers/passed_tracker.rb
 - lib/tapping_device/version.rb
 - tapping_device.gemspec
 homepage: https://github.com/st0012/tapping_device

data/lib/tapping_device/output_payload.rb

@@ -1,145 +0,0 @@
-class TappingDevice
-  class OutputPayload < Payload
-    alias :raw_arguments :arguments
-    alias :raw_return_value :return_value
-
-    def method_name(options = {})
-      ":#{super(options)}"
-    end
-
-    def arguments(options = {})
-      generate_string_result(raw_arguments, options[:inspect])
-    end
-
-    def return_value(options = {})
-      generate_string_result(raw_return_value, options[:inspect])
-    end
-
-    def self.full_color_code(code)
-    end
-
-    COLOR_CODES = {
-      green: 10,
-      yellow: 11,
-      blue: 12,
-      megenta: 13,
-      cyan: 14,
-      orange: 214
-    }
-
-    COLORS = COLOR_CODES.each_with_object({}) do |(name, code), hash|
-      hash[name] = "\u001b[38;5;#{code}m"
-    end.merge(
-      reset: "\u001b[0m",
-      nocolor: ""
-    )
-
-    PAYLOAD_ATTRIBUTES = {
-      method_name: {symbol: "", color: COLORS[:blue]},
-      location: {symbol: "from:", color: COLORS[:green]},
-      sql: {symbol: "QUERIES", color: COLORS[:nocolor]},
-      return_value: {symbol: "=>", color: COLORS[:megenta]},
-      arguments: {symbol: "<=", color: COLORS[:orange]},
-      defined_class: {symbol: "#", color: COLORS[:yellow]}
-    }
-
-    PAYLOAD_ATTRIBUTES.each do |attribute, attribute_options|
-      color = attribute_options[:color]
-
-      alias_method "original_#{attribute}".to_sym, attribute
-
-      # regenerate attributes with `colorize: true` support
-      define_method attribute do |options = {}|
-        call_result = send("original_#{attribute}", options)
-
-        if options[:colorize]
-          "#{color}#{call_result}#{COLORS[:reset]}"
-        else
-          call_result
-        end
-      end
-
-      define_method "#{attribute}_with_color" do |options = {}|
-        send(attribute, options.merge(colorize: true))
-      end
-
-      PAYLOAD_ATTRIBUTES.each do |and_attribute, and_attribute_options|
-        next if and_attribute == attribute
-
-        define_method "#{attribute}_and_#{and_attribute}" do |options = {}|
-          "#{send(attribute, options)} #{and_attribute_options[:symbol]} #{send(and_attribute, options)}"
-        end
-
-        define_method "#{attribute}_and_#{and_attribute}_with_color" do |options = {}|
-          send("#{attribute}_and_#{and_attribute}", options.merge(colorize: true))
-        end
-      end
-    end
-
-    def passed_at(options = {})
-      with_method_head = options.fetch(:with_method_head, false)
-      arg_name = raw_arguments.keys.detect { |k| raw_arguments[k] == target }
-
-      return unless arg_name
-
-      arg_name = ":#{arg_name}"
-      arg_name = value_with_color(arg_name, :orange) if options[:colorize]
-      msg = "Passed as #{arg_name} in '#{defined_class(options)}##{method_name(options)}' at #{location(options)}"
-      msg += "\n  > #{method_head.strip}" if with_method_head
-      msg
-    end
-
-    def detail_call_info(options = {})
-      <<~MSG
-      #{method_name_and_defined_class(options)}
-          from: #{location(options)}
-          <= #{arguments(options)}
-          => #{return_value(options)}
-
-      MSG
-    end
-
-    private
-
-    def value_with_color(value, color)
-      "#{COLORS[color]}#{value}#{COLORS[:reset]}"
-    end
-
-    def generate_string_result(obj, inspect)
-      case obj
-      when Array
-        array_to_string(obj, inspect)
-      when Hash
-        hash_to_string(obj, inspect)
-      when String
-        "\"#{obj}\""
-      else
-        inspect ? obj.inspect : obj.to_s
-      end
-    end
-
-    def array_to_string(array, inspect)
-      elements_string = array.map do |elem|
-        generate_string_result(elem, inspect)
-      end.join(", ")
-      "[#{elements_string}]"
-    end
-
-    def hash_to_string(hash, inspect)
-      elements_string = hash.map do |key, value|
-        "#{key.to_s}: #{generate_string_result(value, inspect)}"
-      end.join(", ")
-      "{#{elements_string}}"
-    end
-
-    def obj_to_string(element, inspect)
-      to_string_method = inspect ? :inspect : :to_s
-
-      if !inspect && element.is_a?(String)
-        "\"#{element}\""
-      else
-        element.send(to_string_method)
-      end
-    end
-  end
-end

data/lib/tapping_device/sql_tapping_methods.rb

@@ -1,89 +0,0 @@
-class TappingDevice
-  module SqlTappingMethods
-    CALL_STACK_SKIPPABLE_METHODS = [:transaction, :tap]
-
-    # SQLListener acts like an interface for us to intercept activerecord query instrumentations
-    # this means we only need to register one subscriber no matter how many objects we want to tap on
-    class SQLListener
-      def call(name, start, finish, message_id, values);end
-    end
-    @@sql_listener = SQLListener.new
-
-    ActiveSupport::Notifications.subscribe("sql.active_record", @@sql_listener)
-
-    def tap_sql!(object)
-      @call_stack = []
-      @target ||= object
-      @trace_point = with_trace_point_on_target(object, event: [:call, :c_call]) do |start_tp|
-        ########## Check if the call is worth recording ##########
-        filepath, line_number = get_call_location(start_tp, padding: 1) # we need extra padding because of `with_trace_point_on_target`
-        method = start_tp.callee_id
-        next if already_recording?(method)
-
-        ########## Start the recording ##########
-        # 1. Mark recording state by pushing method into @call_stack
-        # 2. Subscribe sql instrumentations generated by activerecord
-        # 3. Record those sqls and run device callbacks
-        # 4. Start waiting for current call's return callback
-        @call_stack.push(method)
-        payload = build_payload(tp: start_tp, filepath: filepath, line_number: line_number)
-        device = tap_on_sql_instrumentation!(payload)
-
-        with_trace_point_on_target(object, event: :return) do |return_tp|
-          next unless return_tp.callee_id == method
-
-          ########## End recording ##########
-          # 1. Close itself
-          # 2. Stop our subscription on SQLListener
-          # 3. Remove current method from @call_stack
-          # 4. Stop the device if stop condition is fulfilled
-          return_tp.disable
-          device.stop!
-          @call_stack.pop
-          stop_if_condition_fulfilled(payload)
-
-          ########## Track descendant objects ##########
-          # if the method creates another Relation object
-          if return_tp.defined_class == ActiveRecord::QueryMethods
-            create_child_device.tap_sql!(return_tp.return_value)
-          end
-        end.enable
-      end
-
-      @trace_point.enable unless self.class.suspend_new
-
-      self
-    end
-  end
-
-  private
-
-  def tap_on_sql_instrumentation!(payload)
-    device = TappingDevice.new do |sql_listener_payload|
-      values = sql_listener_payload.arguments[:values]
-
-      next if should_be_skipped_by_paths?(payload.filepath) ||
-        ["SCHEMA", "TRANSACTION"].include?(values[:name]) ||
-        values[:sql].match?(/SAVEPOINT/)
-
-      payload[:sql] = values[:sql]
-      record_call!(payload)
-    end
-    device.tap_on!(@@sql_listener)
-  end
-
-  # usually, AR's query methods (like `first`) will end up calling `find_by_sql`
-  # then to TappingDevice, both `first` and `find_by_sql` generates the sql
-  # but the results are duplicated, we should only consider the `first` call
-  def already_recording?(method)
-    !@call_stack.empty? || CALL_STACK_SKIPPABLE_METHODS.include?(method)
-  end
-
-  def with_trace_point_on_target(object, event:)
-    TracePoint.new(*event) do |tp|
-      if is_from_target?(object, tp)
-        yield(tp)
-      end
-    end
-  end
-end