power_trace 0.2.2 → 0.3.0

data/lib/power_trace.rb

@@ -8,8 +8,7 @@ module PowerTrace
   cattr_accessor :replace_backtrace, instance_accessor: false
   self.replace_backtrace = false
 
-  cattr_accessor :power_rspec_trace, instance_accessor: false
-  self.power_rspec_trace = false
+  cattr_accessor :integrations, instance_accessor: false
 
   cattr_accessor :trace_limit, instance_accessor: false
   self.trace_limit = 50
@@ -19,6 +18,29 @@ module PowerTrace
   end
 
   class << self
+    AVAILABLE_INTEGRATIONS = [:rails, :rspec, :minitest].freeze
+
+    def integrations=(integrations)
+      integrations = Array(integrations).uniq.map(&:to_sym)
+
+      integrations.each do |integration|
+        unless AVAILABLE_INTEGRATIONS.include?(integration)
+          raise "#{integration} is not a supported integration, only #{AVAILABLE_INTEGRATIONS} is allowed."
+        end
+
+        case integration
+        when :rails
+          require "power_trace/integrations/rails"
+        when :rspec
+          require "power_trace/integrations/rspec"
+        when :minitest
+          require "power_trace/integrations/minitest"
+        end
+      end
+
+      @@integrations = integrations
+    end
+
     def print_power_trace_error(exception)
       puts(exception)
       puts(exception.backtrace)
@@ -31,8 +53,3 @@ include PowerTrace
 
 require "power_trace/exception_patch"
 
-require "rspec" rescue LoadError
-
-if defined?(RSpec)
-  require "power_trace/rspec_patch"
-end

data/lib/power_trace/entry.rb

@@ -5,14 +5,21 @@ module PowerTrace
   class Entry
     include ColorizeHelper
     UNDEFINED = "[undefined]"
+    EMPTY_STRING = ""
+    EMPTY_ARRAY = [].freeze
+    EMPTY_HASH = {}.freeze
+    SET_IVAR_INSTRUCTION_REGEX = /setinstancevariable/
+    SPACE = "\s"
+    DEFAULT_LINE_LIMIT = 100
 
-    attr_reader :frame, :filepath, :line_number, :receiver, :locals, :arguments
+    attr_reader :frame, :filepath, :line_number, :receiver, :locals, :arguments, :ivars
 
     def initialize(frame)
       @frame = frame
       @filepath, @line_number = frame.source_location
       @receiver = frame.receiver
-      @locals, @arguments = colloct_locals_and_arguments
+      @locals, @arguments = collect_locals_and_arguments
+      @ivars = collect_ivars
     end
 
     def name(options = {})
@@ -37,6 +44,13 @@ module PowerTrace
       STR
     end
 
+    def ivars_string(options = {})
+      <<~STR.chomp
+        #{options[:indentation]}(Instance Variables)
+        #{hash_to_string(ivars, false, options)}
+      STR
+    end
+
     def call_trace(options = {})
       "#{location(options)}:in `#{name(options)}'"
     end
@@ -45,7 +59,8 @@ module PowerTrace
       name: :blue,
       location: :green,
       arguments_string: :orange,
-      locals_string: :megenta
+      locals_string: :megenta,
+      ivars_string: :cyan
     }
 
     ATTRIBUTE_COLORS.each do |attribute, color|
@@ -78,7 +93,7 @@ module PowerTrace
     def assemble_string(options)
       strings = [call_trace(options)]
 
-      indentation = "\s" * options[:extra_info_indent]
+      indentation = SPACE * (options[:extra_info_indent] || 0)
       options[:indentation] = indentation
 
       if arguments.present?
@@ -89,12 +104,16 @@ module PowerTrace
         strings << locals_string(options)
       end
 
+      if ivars.present?
+        strings << ivars_string(options)
+      end
+
       strings.join("\n")
     end
 
     def hash_to_string(hash, inspect, options)
-      truncation = options[:line_limit]
-      indentation = options[:indentation] + "\s" * 2
+      truncation = options[:line_limit] || DEFAULT_LINE_LIMIT
+      indentation = (options[:indentation] || EMPTY_STRING) + SPACE * 2
 
       elements_string = hash.map do |key, value|
         value_string = value_to_string(value, truncation)
@@ -108,15 +127,61 @@ module PowerTrace
       when Array
         value.to_s.truncate(truncation, omission: "...]")
       when Hash
-        value.to_s.truncate(truncation, omission: "...}")
+        elements_string = value.map do |key, val|
+          value_string = value_to_string(val, truncation)
+          "#{key.to_s}: #{value_string}"
+        end.join(", ")
+
+        "{#{elements_string}}".truncate(truncation, omission: "...}")
       when nil
         "nil"
+      when Symbol
+        ":#{value}"
+      when String
+        "\"#{value.truncate(truncation)}\""
       else
-        value.to_s.truncate(truncation)
+        if defined?(ActiveRecord::Base)
+          case value
+          when ActiveRecord::Base
+            value.inspect.truncate(truncation, omission: "...>")
+          when ActiveRecord::Relation
+            "#{value}, SQL - (#{value.to_sql})"
+          else
+            value.to_s.truncate(truncation)
+          end
+        else
+          value.to_s.truncate(truncation)
+        end
+      end
+    end
+
+    # we need to make sure
+    # 1. the frame is iseq (vm instructions)
+    # 2. and the instructions contain `setinstancevariable` instructions
+    #
+    # and only then we can start capturing instance variables from the frame
+    # this is to make sure we only capture the instance variables set inside the current method call
+    # otherwise, it'll create a lot noise
+    def collect_ivars
+      iseq = frame.instance_variable_get(:@iseq)
+
+      return EMPTY_HASH unless iseq
+
+      set_ivar_instructios = iseq.disasm.split("\n").select { |i| i.match?(SET_IVAR_INSTRUCTION_REGEX) }
+
+      return EMPTY_HASH unless set_ivar_instructios.present?
+
+      new_ivars = set_ivar_instructios.map do |i|
+        i.match(/:(@\w+),/)[1]
+      end
+
+      new_ivars.inject({}) do |hash, ivar_name|
+        hash[ivar_name] = receiver.instance_variable_get(ivar_name.to_sym)
+        hash
       end
     end
 
-    def colloct_locals_and_arguments
+    def collect_locals_and_arguments
       locals = {}
       arguments = {}
 
@@ -147,7 +212,7 @@ module PowerTrace
       if method
         method.parameters.map { |parameter| parameter[1] }
       else
-        []
+        EMPTY_ARRAY
       end
     end
   end

data/lib/power_trace/exception_patch.rb

@@ -18,7 +18,7 @@ TracePoint.trace(:raise) do |tp|
     # these errors are commonly used as flow control so working with them can be error-prone and slow
     # we can revisit them once the gem gets more stable
     next if e.is_a?(LoadError)
-    next if e.is_a?(NameError)
+    next if e.is_a?(NameError) && !e.is_a?(NoMethodError)
     next if e.is_a?(SystemCallError)
 
     if defined?(Bootsnap)

data/lib/power_trace/integrations/minitest.rb

@@ -0,0 +1,14 @@
+module Minitest
+  class UnexpectedError
+    alias :original_backtrace :backtrace
+
+    def backtrace
+      begin
+        error.stored_power_trace.to_backtrace(extra_info_indent: 8)
+      rescue => e
+        PowerTrace.print_power_trace_error(e)
+        original_backtrace
+      end
+    end
+  end
+end

data/lib/power_trace/integrations/rails.rb

@@ -0,0 +1,2 @@
+require "power_trace/rails/action_dispatch/debug_exceptions"
+require "power_trace/rails/action_dispatch/exception_wrapper"

data/lib/power_trace/integrations/rspec.rb

@@ -0,0 +1,11 @@
+RSpec::Core::Formatters::ExceptionPresenter.class_eval do
+  alias :original_formatted_backtrace :formatted_backtrace
+
+  def formatted_backtrace(exception=@exception)
+    backtrace = exception.stored_power_trace.to_backtrace(extra_info_indent: 8)
+    backtrace_formatter.format_backtrace(backtrace, example.metadata) + formatted_cause(exception)
+  rescue => e
+    PowerTrace.print_power_trace_error(e)
+    original_formatted_backtrace
+  end
+end

data/lib/power_trace/rails/action_dispatch/debug_exceptions.rb

@@ -0,0 +1,28 @@
+module ActionDispatch
+  class DebugExceptions
+    private
+
+    def log_error(request, wrapper)
+      logger = logger(request)
+
+      return unless logger
+
+      exception = wrapper.exception
+
+      trace = wrapper.application_power_trace
+      trace = wrapper.framework_power_trace if trace.empty?
+
+      ActiveSupport::Deprecation.silence do
+        message = []
+        message << "  "
+        message << "#{exception.class} (#{exception.message}):"
+        message.concat(exception.annotated_source_code) if exception.respond_to?(:annotated_source_code)
+        message << "  "
+        message.concat(trace)
+
+        log_array(logger, message)
+      end
+    end
+  end
+end
+

data/lib/power_trace/rails/action_dispatch/exception_wrapper.rb

@@ -0,0 +1,28 @@
+module ActionDispatch
+  class ExceptionWrapper
+    def application_power_trace
+      clean_power_trace(:silent)
+    end
+
+    def framework_power_trace
+      clean_power_trace(:noise)
+    end
+
+    def full_power_trace
+      clean_power_trace(:all)
+    end
+
+    private
+      def stored_power_trace
+        Array(@exception.stored_power_trace.map { |t| t.to_s(extra_info_indent: 4) })
+      end
+
+      def clean_power_trace(*args)
+        if backtrace_cleaner
+          backtrace_cleaner.clean(stored_power_trace, *args)
+        else
+          stored_power_trace
+        end
+      end
+  end
+end

data/lib/power_trace/version.rb

@@ -1,3 +1,3 @@
 module PowerTrace
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/power_trace.gemspec

@@ -32,4 +32,5 @@ So I hope to solve this problem by adding some additional runtime info to the ba
   spec.add_dependency "binding_of_caller", "~> 0.8.0"
 
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rails"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_trace
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Backtrace (Stack traces) are essential information for debugging our applications. However, they only tell us what the program did, but don't tell us what it had (the arguments, local variables...etc.). So it's very often that we'd need to visit each call site, rerun the program, and try to print out the variables. To me, It's like the Google map's navigation only tells us the name of the roads, but not showing us the map along with them.
 
@@ -78,9 +92,122 @@ files:
 - benchmarks/raise_with_power_trace.rb
 - bin/console
 - bin/setup
+- examples/rails-6/.browserslistrc
+- examples/rails-6/.gitignore
+- examples/rails-6/.ruby-version
+- examples/rails-6/Gemfile
+- examples/rails-6/Gemfile.lock
+- examples/rails-6/README.md
+- examples/rails-6/Rakefile
+- examples/rails-6/app/assets/config/manifest.js
+- examples/rails-6/app/assets/images/.keep
+- examples/rails-6/app/assets/stylesheets/application.css
+- examples/rails-6/app/assets/stylesheets/posts.scss
+- examples/rails-6/app/assets/stylesheets/scaffolds.scss
+- examples/rails-6/app/channels/application_cable/channel.rb
+- examples/rails-6/app/channels/application_cable/connection.rb
+- examples/rails-6/app/controllers/application_controller.rb
+- examples/rails-6/app/controllers/concerns/.keep
+- examples/rails-6/app/controllers/posts_controller.rb
+- examples/rails-6/app/helpers/application_helper.rb
+- examples/rails-6/app/helpers/posts_helper.rb
+- examples/rails-6/app/javascript/channels/consumer.js
+- examples/rails-6/app/javascript/channels/index.js
+- examples/rails-6/app/javascript/packs/application.js
+- examples/rails-6/app/jobs/application_job.rb
+- examples/rails-6/app/mailers/application_mailer.rb
+- examples/rails-6/app/models/application_record.rb
+- examples/rails-6/app/models/concerns/.keep
+- examples/rails-6/app/models/post.rb
+- examples/rails-6/app/views/layouts/application.html.erb
+- examples/rails-6/app/views/layouts/mailer.html.erb
+- examples/rails-6/app/views/layouts/mailer.text.erb
+- examples/rails-6/app/views/posts/_form.html.erb
+- examples/rails-6/app/views/posts/_post.json.jbuilder
+- examples/rails-6/app/views/posts/edit.html.erb
+- examples/rails-6/app/views/posts/index.html.erb
+- examples/rails-6/app/views/posts/index.json.jbuilder
+- examples/rails-6/app/views/posts/new.html.erb
+- examples/rails-6/app/views/posts/show.html.erb
+- examples/rails-6/app/views/posts/show.json.jbuilder
+- examples/rails-6/babel.config.js
+- examples/rails-6/bin/bundle
+- examples/rails-6/bin/rails
+- examples/rails-6/bin/rake
+- examples/rails-6/bin/setup
+- examples/rails-6/bin/webpack
+- examples/rails-6/bin/webpack-dev-server
+- examples/rails-6/bin/yarn
+- examples/rails-6/config.ru
+- examples/rails-6/config/application.rb
+- examples/rails-6/config/boot.rb
+- examples/rails-6/config/cable.yml
+- examples/rails-6/config/credentials.yml.enc
+- examples/rails-6/config/database.yml
+- examples/rails-6/config/environment.rb
+- examples/rails-6/config/environments/development.rb
+- examples/rails-6/config/environments/production.rb
+- examples/rails-6/config/environments/test.rb
+- examples/rails-6/config/initializers/application_controller_renderer.rb
+- examples/rails-6/config/initializers/assets.rb
+- examples/rails-6/config/initializers/backtrace_silencers.rb
+- examples/rails-6/config/initializers/content_security_policy.rb
+- examples/rails-6/config/initializers/cookies_serializer.rb
+- examples/rails-6/config/initializers/filter_parameter_logging.rb
+- examples/rails-6/config/initializers/inflections.rb
+- examples/rails-6/config/initializers/mime_types.rb
+- examples/rails-6/config/initializers/power_trace.rb
+- examples/rails-6/config/initializers/wrap_parameters.rb
+- examples/rails-6/config/locales/en.yml
+- examples/rails-6/config/puma.rb
+- examples/rails-6/config/routes.rb
+- examples/rails-6/config/storage.yml
+- examples/rails-6/config/webpack/development.js
+- examples/rails-6/config/webpack/environment.js
+- examples/rails-6/config/webpack/production.js
+- examples/rails-6/config/webpack/test.js
+- examples/rails-6/config/webpacker.yml
+- examples/rails-6/db/migrate/20200829063653_create_posts.rb
+- examples/rails-6/db/seeds.rb
+- examples/rails-6/lib/assets/.keep
+- examples/rails-6/lib/tasks/.keep
+- examples/rails-6/log/.keep
+- examples/rails-6/package.json
+- examples/rails-6/postcss.config.js
+- examples/rails-6/public/404.html
+- examples/rails-6/public/422.html
+- examples/rails-6/public/500.html
+- examples/rails-6/public/apple-touch-icon-precomposed.png
+- examples/rails-6/public/apple-touch-icon.png
+- examples/rails-6/public/favicon.ico
+- examples/rails-6/public/robots.txt
+- examples/rails-6/storage/.keep
+- examples/rails-6/test/application_system_test_case.rb
+- examples/rails-6/test/channels/application_cable/connection_test.rb
+- examples/rails-6/test/controllers/.keep
+- examples/rails-6/test/controllers/posts_controller_test.rb
+- examples/rails-6/test/fixtures/.keep
+- examples/rails-6/test/fixtures/files/.keep
+- examples/rails-6/test/fixtures/posts.yml
+- examples/rails-6/test/helpers/.keep
+- examples/rails-6/test/integration/.keep
+- examples/rails-6/test/mailers/.keep
+- examples/rails-6/test/models/.keep
+- examples/rails-6/test/models/post_test.rb
+- examples/rails-6/test/system/.keep
+- examples/rails-6/test/system/posts_test.rb
+- examples/rails-6/test/test_helper.rb
+- examples/rails-6/tmp/.keep
+- examples/rails-6/tmp/pids/.keep
+- examples/rails-6/vendor/.keep
+- examples/rails-6/yarn.lock
 - images/entries.png
 - images/normal_backtrace.png
+- images/normal_minitest_error.png
+- images/normal_rails_error.png
 - images/normal_rspec_error.png
+- images/power_minitest_error.png
+- images/power_rails_error.png
 - images/power_trace_backtrace.png
 - images/power_trace_rspec_error.png
 - images/print_directly.png
@@ -88,7 +215,11 @@ files:
 - lib/power_trace/entry.rb
 - lib/power_trace/exception_patch.rb
 - lib/power_trace/helpers/colorize_helper.rb
-- lib/power_trace/rspec_patch.rb
+- lib/power_trace/integrations/minitest.rb
+- lib/power_trace/integrations/rails.rb
+- lib/power_trace/integrations/rspec.rb
+- lib/power_trace/rails/action_dispatch/debug_exceptions.rb
+- lib/power_trace/rails/action_dispatch/exception_wrapper.rb
 - lib/power_trace/stack.rb
 - lib/power_trace/version.rb
 - power_trace.gemspec