active_record_query_trace 1.5.4 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 45e5fb5ece85b56cde741aab63f6d4ef1cdd4674
-  data.tar.gz: 75090841d4650bd2ebde1517fc040fec661a25a1
+SHA256:
+  metadata.gz: 06d7497a2165d922974efd1ffc10bf6b6725d1c4705f9b5d5464affca6db069e
+  data.tar.gz: 1d5bf04f35d74b69cddc657d9f91795c315ce4b50422cc79aa06843a0299d3e9
 SHA512:
-  metadata.gz: 0a1ff57686ca621ef4cd4ed12dadcb0bd6b4f9b2f425492bf3d814e74ff4e4e362ad24985b17f0ccc4ea6f83c8e5f631834ba3cedb9401204cd6dfbb9b3eb377
-  data.tar.gz: 676166a2fa21b3975290260fba1d8bc83db77a25a765a33bd800a5eb9f8266f823b1da0d3c6e8d181ad37ee92e98ccbfe0bb05e73fc8a54175c2a381133b13b2
+  metadata.gz: '09cd3daa1e090acc6e8bafd776c28c3df40f190baccd3799e5b93629a416f890ce4b4514993842830159840fe8d688ef71ba45f54893c62cf053b045c8dd978f'
+  data.tar.gz: d53226b99e6eae63ea2b79abf5db75f4f04c546773dc61fda88962d9de2b4c465f84c3af6481b3778d0410e3c4ed07433b29ba29eba5d4481c04efe9d836118c

data/lib/active_record_query_trace.rb

@@ -1,7 +1,29 @@
-# encoding: UTF-8
-require 'active_support/log_subscriber'
+# frozen_string_literal: true
+
+require 'active_record/log_subscriber'
 
 module ActiveRecordQueryTrace
+  INDENTATION = ' ' * 6
+  BACKTRACE_PREFIX = "Query Trace:\n#{INDENTATION}"
+  COLORS = {
+    true => '38',
+    blue: '34',
+    light_red: '1;31',
+    black: '30',
+    purple: '35',
+    light_green: '1;32',
+    red: '31',
+    cyan: '36',
+    yellow: '1;33',
+    green: '32',
+    gray: '37',
+    light_blue: '1;34',
+    brown: '33',
+    dark_gray: '1;30',
+    light_purple: '1;35',
+    white: '1;37',
+    light_cyan: '1;36'
+  }.freeze
 
   class << self
     attr_accessor :enabled
@@ -9,89 +31,220 @@ module ActiveRecordQueryTrace
     attr_accessor :lines
     attr_accessor :ignore_cached_queries
     attr_accessor :colorize
+    attr_accessor :query_type
+    attr_accessor :suppress_logging_of_db_reads
+    attr_reader :backtrace_cleaner
+
+    def backtrace_cleaner=(cleaner)
+      @backtrace_cleaner =
+        if cleaner.is_a?(Proc)
+          cleaner
+        else
+          proc { |trace| cleaner.clean(trace) }
+        end
+    end
   end
 
-  module ActiveRecord
-    class LogSubscriber < ActiveSupport::LogSubscriber
+  class CustomLogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Metrics/ClassLength
+    def initialize
+      super
+      ActiveRecordQueryTrace.enabled = false
+      ActiveRecordQueryTrace.level = :app
+      ActiveRecordQueryTrace.lines = 5
+      ActiveRecordQueryTrace.ignore_cached_queries = false
+      ActiveRecordQueryTrace.colorize = false
+      ActiveRecordQueryTrace.query_type = :all
+      ActiveRecordQueryTrace.suppress_logging_of_db_reads = false
+    end
 
-      def initialize
-        super
-        ActiveRecordQueryTrace.enabled = false
-        ActiveRecordQueryTrace.level = :app
-        ActiveRecordQueryTrace.lines = 5
-        ActiveRecordQueryTrace.ignore_cached_queries = false
-        ActiveRecordQueryTrace.colorize = false
+    def sql(event)
+      payload = event.payload
+      return unless display_backtrace?(payload)
 
-        if ActiveRecordQueryTrace.level != :app
-          # Rails by default silences all backtraces that match Rails::BacktraceCleaner::APP_DIRS_PATTERN
-          Rails.backtrace_cleaner.remove_silencers!
-        end
+      setup_backtrace_cleaner unless ActiveRecordQueryTrace.backtrace_cleaner
+
+      trace = fully_formatted_trace # Memoize
+      debug(trace) unless trace.blank?
+    end
+
+    attach_to :active_record
+
+    private
+
+    def cached_query?(payload)
+      return false unless ActiveRecordQueryTrace.ignore_cached_queries
+      payload[:cached] || payload[:name] == 'CACHE'
+    end
+
+    # TODO: refactor and remove rubocop:disable comments.
+    def display_backtrace?(payload)
+      ActiveRecordQueryTrace.enabled \
+        && !transaction_begin_or_commit_query?(payload) \
+        && !schema_query?(payload) \
+        && !cached_query?(payload) \
+        && !(ActiveRecordQueryTrace.suppress_logging_of_db_reads && db_read_query?(payload)) \
+        && display_backtrace_for_query_type?(payload)
+    end
+
+    def display_backtrace_for_query_type?(payload)
+      case ActiveRecordQueryTrace.query_type
+      when :all then true
+      when :read then db_read_query?(payload)
+      when :write then !db_read_query?(payload)
+      else
+        raise 'Invalid ActiveRecordQueryTrace.query_type value ' \
+          "#{ActiveRecordQueryTrace.level}. Should be :all, :read, or :write."
       end
+    end
+
+    def db_read_query?(payload)
+      payload[:sql] !~ /INSERT|UPDATE|DELETE/
+    end
+
+    def fully_formatted_trace
+      cleaned_trace = clean_trace(original_trace)
+      return if cleaned_trace.blank?
+      stringified_trace = BACKTRACE_PREFIX + lines_to_display(cleaned_trace).join("\n" + INDENTATION)
+      colorize_text(stringified_trace)
+    end
 
-      def sql(event)
-        if ActiveRecordQueryTrace.enabled
-          index = begin
-            if ActiveRecordQueryTrace.lines == 0
-              0..-1
-            else
-              0..(ActiveRecordQueryTrace.lines - 1)
-            end
-          end
-
-          payload = event.payload
-          return if payload[:name] == 'SCHEMA'
-          return if ActiveRecordQueryTrace.ignore_cached_queries && payload[:name] == 'CACHE'
-
-          cleaned_trace = clean_trace(caller)[index].join("\n     from ")
-          debug("  Query Trace > " + colorize_text(cleaned_trace)) unless cleaned_trace.blank?
+    # Must be called after the backtrace cleaner.
+    def lines_to_display(full_trace)
+      ActiveRecordQueryTrace.lines.zero? ? full_trace : full_trace.first(ActiveRecordQueryTrace.lines)
+    end
+
+    def transaction_begin_or_commit_query?(payload)
+      payload[:sql] =~ /\Abegin transaction|commit transaction|BEGIN|COMMIT\Z/
+    end
+
+    def schema_query?(payload)
+      payload[:name] == 'SCHEMA'
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def clean_trace(full_trace)
+      case ActiveRecordQueryTrace.level
+      when :full
+        trace = full_trace
+      when :app, :rails
+        trace = Rails.backtrace_cleaner.clean(full_trace)
+      when :custom
+        unless ActiveRecordQueryTrace.backtrace_cleaner
+          raise 'Configure your backtrace cleaner first via ActiveRecordQueryTrace.backtrace_cleaner = MyCleaner'
         end
+        trace = ActiveRecordQueryTrace.backtrace_cleaner.call(full_trace)
+      else
+        raise 'Invalid ActiveRecordQueryTrace.level value ' \
+          "#{ActiveRecordQueryTrace.level}. Should be :full, :rails, or :app."
       end
 
-      # Allow query to be colorized in the terminal
-      def colorize_text(text)
-        return text unless ActiveRecordQueryTrace.colorize
-        # Try to convert the choosen color from string to integer or try
-        # to use the colorize as the color code
-        colors = {
-          true => "38",       "blue" => "34",        "light red" => "1;31",
-          "black" => "30",    "purple" => "35",      "light green" => "1;32",
-          "red" => "31",      "cyan" => "36",        "yellow" => "1;33",
-          "green" => "32",    "gray" => "37",        "light blue" => "1;34",
-          "brown" => "33",    "dark gray" => "1;30", "light purple" => "1;35",
-          "white" => "1;37",  "light cyan" => "1;36"
-        }
-        color_code = colors[ActiveRecordQueryTrace.colorize] ||
-          ActiveRecordQueryTrace.colorize.to_s
-        unless /\d+(;\d+){0,1}/.match(color_code)
-          raise "Invalid color. Use one of #{ colors.keys } or a valid color code"
-        end
-        "\e[#{ color_code }m#{ text }\e[0m"
+      # We cant use a Rails::BacktraceCleaner filter to display only the relative
+      # path of application trace lines because it breaks the silencer that selects
+      # the lines to display or hide based on whether they include `Rails.root`.
+      trace.map { |line| line.sub(rails_root_prefix, '') }
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Rails by default silences all backtraces that *do not* match
+    # Rails::BacktraceCleaner::APP_DIRS_PATTERN. In other words, the default
+    # silencer filters out all framework backtrace lines, leaving only the
+    # application lines.
+    def setup_backtrace_cleaner
+      setup_backtrace_cleaner_path
+      return if ActiveRecordQueryTrace.level == :full
+
+      remove_filters_and_silencers
+
+      case ActiveRecordQueryTrace.level
+      when :app
+        Rails.backtrace_cleaner.add_silencer { |line| line !~ rails_root_regexp }
+      when :rails
+        Rails.backtrace_cleaner.add_silencer { |line| line =~ rails_root_regexp }
       end
+    end
 
-      def clean_trace(trace)
-        # Rails relies on backtrace cleaner to set the application root directory filter
-        # the problem is that the backtrace cleaner is initialized before the application
-        # this ensures that the value of `root` used by the filter is set to the application root
-        if Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
-          Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
-        end
+    # Rails relies on backtrace cleaner to set the application root directory
+    # filter. The problem is that the backtrace cleaner is initialized before
+    # this gem. This ensures that the value of `root` used by the filter
+    # is correct.
+    def setup_backtrace_cleaner_path
+      return unless Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
+      Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
+    end
 
-        case ActiveRecordQueryTrace.level
-        when :full
-          trace
-        when :rails
-          Rails.respond_to?(:backtrace_cleaner) ? Rails.backtrace_cleaner.clean(trace) : trace
-        when :app
-          Rails.backtrace_cleaner.remove_silencers!
-          Rails.backtrace_cleaner.add_silencer { |line| not line =~ /^(app|lib|engines)\// }
-          Rails.backtrace_cleaner.clean(trace)
-        else
-          raise "Invalid ActiveRecordQueryTrace.level value '#{ActiveRecordQueryTrace.level}' - should be :full, :rails, or :app"
+    def remove_filters_and_silencers
+      Rails.backtrace_cleaner.remove_filters!
+      Rails.backtrace_cleaner.remove_silencers!
+    end
+
+    # Allow query to be colorized in the terminal
+    def colorize_text(text)
+      return text unless ActiveRecordQueryTrace.colorize
+      "\e[#{color_code}m#{text}\e[0m"
+    end
+
+    # Wrapper used for testing purposes.
+    def original_trace
+      caller
+    end
+
+    def color_code
+      return @color_code if @color_code && @configured_color == ActiveRecordQueryTrace.colorize
+
+      @configured_color = ActiveRecordQueryTrace.colorize
+
+      # Backward compatibility for string color names with space as word separator.
+      @color_code =
+        case ActiveRecordQueryTrace.colorize
+        when Symbol, true then COLORS[ActiveRecordQueryTrace.colorize]
+        when String then COLORS[ActiveRecordQueryTrace.colorize.tr("\s", '_').to_sym]
         end
-      end
+    end
 
-      attach_to :active_record
+    def validate_color_code(color_code)
+      valid_color_code?(color_code) || raise(
+        'ActiveRecordQueryTrace.colorize was set to an invalid ' \
+          "color. Use one of #{COLORS.keys} or a valid color code."
+      )
+    end
+
+    def valid_color_code?(color_code)
+      /\A\d+(?:;\d+)?\Z/ =~ color_code
+    end
 
+    def rails_root_prefix
+      @rails_root_prefix ||= "#{Rails.root}/"
     end
+
+    # This cannot be set in a constant as Rails.root is not yet available when
+    # this file is loaded.
+    def rails_root_regexp
+      @rails_root_regexp ||= %r{#{Regexp.escape(Rails.root.to_s)}(?!\/vendor)}
+    end
+  end
+end
+
+# The following code is used to suppress specific entries from the log. The
+# "around alias" technique is used to allow `ActiveSupport::LogSubscriber#debug`
+# to be overwritten while preserving the original version, which can still be
+# called.
+#
+# I would prefer using Module#prepend here, but alias_method does not work if
+# called from within a prepended module.
+#
+# Note that:
+# - #debug is used to log queries but also other things, do not mess it up.
+# - Some queries include both SELECT and a write operation such as INSERT,
+# UPDATE or DELETE. That means that checking for the presence of SELECT is not
+# enough to ensure it is not a write query.
+#
+# TODO: move to a separate file.
+ActiveSupport::LogSubscriber.class_eval do
+  alias_method :original_debug, :debug
+
+  def debug(*args, &block)
+    return if ActiveRecordQueryTrace.suppress_logging_of_db_reads \
+      && args.first !~ /INSERT|UPDATE|DELETE|#{ActiveRecordQueryTrace::BACKTRACE_PREFIX}/
+    original_debug(*args, &block)
   end
 end

data/lib/active_record_query_trace/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordQueryTrace
+  VERSION = '1.8'
+end

metadata

@@ -1,25 +1,138 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: '1.8'
 platform: ruby
 authors:
 - Cody Caughlan
+- Bruno Facca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
-dependencies: []
-description: Print stack trace of all queries to the Rails log. Helpful to find where
-  queries are being executed in your application.
-email: toolbag@gmail.com
+date: 2020-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Print stack trace of all DB queries to the Rails log. Helpful to find
+  where queries are being executed in your application.
+email: bruno@facca.info
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/active_record_query_trace.rb
-- lib/version.rb
-homepage: https://github.com/ruckus/active-record-query-trace
+- lib/active_record_query_trace/version.rb
+homepage: https://github.com/brunofacca/active-record-query-trace
 licenses:
 - MIT
 metadata: {}
@@ -29,19 +142,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Print stack trace of all queries to the Rails log. Helpful to find where
+summary: Print stack trace of all DB queries to the Rails log. Helpful to find where
   queries are being executed in your application.
 test_files: []

data/lib/version.rb

@@ -1,3 +0,0 @@
-module ActiveRecordQueryTrace
-  VERSION = '1.5.4'
-end