n_plus_one_control 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b20b8f4269aac76f3da642b271b93ddee2adf508539bba6852e02225695de155
-  data.tar.gz: e739f342b4d46cc451229f3a065cb0e2b83ee28c301d99045d0f094e74bc137b
+  metadata.gz: 394ec848692af46dd43c3a03a3315349c2aea19d174ff05ededa1ef825839ee0
+  data.tar.gz: 7e2a271fe8ae173b117d1fc514e33b6f08aa7c528e4ea476f5360591a28da6f8
 SHA512:
-  metadata.gz: 74805b4ea497ff96bb882557ed8a14e04d32cf5ea5c62e9c65167647c880275aec9d0f8a405a298554e9cfecbb20049d99f630b977475a75122d847c7b27e1a9
-  data.tar.gz: 19063ec1fb2a84edcfd0e38075a3858e239a438803ffb40e03916bc8eb5d49dda9e8b03a30a60788e4e00f9c5484811740448fe3241e64658a78ccf884619321
+  metadata.gz: 1f411b0c1539f517e0c4036570e274fe62327817722065551fce09307e15402c31185566343ddb9fd388324a71c5c8d7730fc938767397f5bbba60f103ffdccb
+  data.tar.gz: 21a4445b6dd7efa9dad9bbfe2ccf8708ae813e2e60ea424b60f7b00cf58bef1971d58b1392893f34e817a3834792b461536890ed38619a20e0f9bd770ab7ddfd

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## master (unreleased)
 
+## 0.5.0 (2020-09-07)
+
+- **Ruby 2.5+ is required**. ([@palkan][])
+
+- Add support for multiple backtrace lines in verbose output. ([@palkan][])
+
+Could be specified via `NPLUSONE_BACKTRACE` env var.
+
+- Add `NPLUSONE_TRUNCATE` env var to truncate queries in verbose mode. ([@palkan][])
+
+- Support passing default filter via `NPLUSONE_FILTER` env var. ([@palkan][])
+
+- Add location tracing to SQLs in verbose mode. ([@palkan][])
+
 ## 0.4.1 (2020-09-04)
 
 - Enhance failure message by showing differences in table hits. ([@palkan][])

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/n_plus_one_control.svg)](https://rubygems.org/gems/n_plus_one_control) [![Build Status](https://travis-ci.org/palkan/n_plus_one_control.svg?branch=master)](https://travis-ci.org/palkan/n_plus_one_control)
+[![Gem Version](https://badge.fury.io/rb/n_plus_one_control.svg)](https://rubygems.org/gems/n_plus_one_control)
+![Build](https://github.com/palkan/n_plus_one_control/workflows/Build/badge.svg)
 
 # N + 1 Control
 
@@ -31,7 +32,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :test do
-  gem 'n_plus_one_control'
+  gem "n_plus_one_control"
 end
 ```
 
@@ -47,8 +48,6 @@ First, add NPlusOneControl to your `spec_helper.rb`:
 
 ```ruby
 # spec_helper.rb
-...
-
 require "n_plus_one_control/rspec"
 ```
 
@@ -86,10 +85,10 @@ Availables modifiers:
 ```ruby
 # You can specify the RegExp to filter queries.
 # By default, it only considers SELECT queries.
-expect { ... }.to perform_constant_number_of_queries.matching(/INSERT/)
+expect { subject }.to perform_constant_number_of_queries.matching(/INSERT/)
 
 # You can also provide custom scale factors
-expect { ... }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
+expect { subject }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
 ```
 
 #### Using scale factor in spec
@@ -97,7 +96,7 @@ expect { ... }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
 Let's suppose your action accepts parameter, which can make impact on the number of returned records:
 
 ```ruby
-get :index, params: { per_page: 10 }
+get :index, params: {per_page: 10}
 ```
 
 Then it is enough to just change `per_page` parameter between executions and do not recreate records in DB. For this purpose, you can use `current_scale` method in your example:
@@ -107,7 +106,7 @@ context "N+1", :n_plus_one do
   before { create_list :post, 3 }
 
   specify do
-    expect { get :index, params: { per_page: current_scale } }.to perform_constant_number_of_queries
+    expect { get :index, params: {per_page: current_scale} }.to perform_constant_number_of_queries
   end
 end
 ```
@@ -118,8 +117,6 @@ First, add NPlusOneControl to your `test_helper.rb`:
 
 ```ruby
 # test_helper.rb
-...
-
 require "n_plus_one_control/minitest"
 ```
 
@@ -153,6 +150,12 @@ assert_perform_constant_number_of_queries(
 end
 ```
 
+It's possible to specify a filter via `NPLUSONE_FILTER` env var, e.g.:
+
+```ruby
+NPLUSONE_FILTER = users bundle exec rake test
+```
+
 You can also specify `populate` as a test class instance method:
 
 ```ruby
@@ -165,6 +168,7 @@ def test_no_n_plus_one_error
     get :index
   end
 end
+
 ```
 
 As in RSpec, you can use `current_scale` factor instead of `populate` block:
@@ -172,7 +176,7 @@ As in RSpec, you can use `current_scale` factor instead of `populate` block:
 ```ruby
 def test_no_n_plus_one_error
   assert_perform_constant_number_of_queries do
-    get :index, params: { per_page: current_scale }
+    get :index, params: {per_page: current_scale}
   end
 end
 ```
@@ -223,6 +227,7 @@ end
 ```
 
 If your `warmup` and testing procs are identical, you can use:
+
 ```ruby
 expext { get :index }.to perform_constant_number_of_queries.with_warming_up # RSpec only
 ```
@@ -254,7 +259,7 @@ NPlusOneControl.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 # ActiveSupport notifications event to track queries.
 # We track ActiveRecord event by default,
 # but can also track rom-rb events ('sql.rom') as well.
-NPlusOneControl.event = 'sql.active_record'
+NPlusOneControl.event = "sql.active_record"
 
 # configure transactional behavour for populate method
 # in case of use multiple database connections
@@ -268,6 +273,21 @@ NPlusOneControl::Executor.tap do |executor|
     connections.each(&:rollback_transaction)
   end
 end
+
+# Provide a backtrace cleaner callable object used to filter SQL caller location to display in the verbose mode
+# Set it to nil to disable tracing.
+#
+# In Rails apps, we use Rails.backtrace_cleaner by default.
+NPlusOneControl.backtrace_cleaner = ->(locations_array) { do_some_filtering(locations_array) }
+
+# You can also specify the number of backtrace lines to show.
+# MOTE: It could be specified via NPLUSONE_BACKTRACE env var
+NPlusOneControl.backtrace_length = 1
+
+# Sometime queries could be too large to provide any meaningful insight.
+# You can configure an output length limit for quries in verbose mode by setting the follwing option
+# NOTE: It could be specified via NPLUSONE_TRUNCATE env var
+NPlusOneControl.truncate_query_size = 100
 ```
 
 ## How does it work?
@@ -276,22 +296,29 @@ Take a look at our [Executor](https://github.com/palkan/n_plus_one_control/blob/
 
 ## What's next?
 
+- More matchers.
+
 It may be useful to provide more matchers/assertions, for example:
 
 ```ruby
 
 # Actually, that means that it is N+1))
-assert_linear_number_of_queries { ... }
+assert_linear_number_of_queries { some_code }
 
 # But we can tune it with `coef` and handle such cases as selecting in batches
 assert_linear_number_of_queries(coef: 0.1) do
-  Post.find_in_batches { ... }
+  Post.find_in_batches { some_code }
 end
 
 # probably, also make sense to add another curve types
-assert_logarithmic_number_of_queries { ... }
+assert_logarithmic_number_of_queries { some_code }
 ```
 
+- Support custom non-SQL events.
+
+N+1 problem is not a database specific: we can have N+1 Redis calls, N+1 HTTP external requests, etc.
+We can make `n_plus_one_control` customizable to support these scenarios (technically, we need to make it possible to handle different payload in the event subscriber).
+
 If you want to discuss or implement any of these, feel free to open an [issue](https://github.com/palkan/n_plus_one_control/issues) or propose a [pull request](https://github.com/palkan/n_plus_one_control/pulls).
 
 ## Development

data/lib/n_plus_one_control.rb

@@ -18,7 +18,10 @@ module NPlusOneControl
   }.freeze
 
   class << self
-    attr_accessor :default_scale_factors, :verbose, :show_table_stats, :ignore, :event
+    attr_accessor :default_scale_factors, :verbose, :show_table_stats, :ignore, :event,
+      :backtrace_cleaner, :backtrace_length, :truncate_query_size
+
+    attr_reader :default_matching
 
     def failure_message(queries) # rubocop:disable Metrics/MethodLength
       msg = ["Expected to make the same number of queries, but got:\n"]
@@ -30,8 +33,8 @@ module NPlusOneControl
 
       if verbose
         queries.each do |(scale, data)|
-          msg << "  Queries for N=#{scale}\n"
-          msg << data.map { |sql| "    #{sql}\n" }.join.to_s
+          msg << "Queries for N=#{scale}\n"
+          msg << data.map { |sql| "  #{truncate_query(sql)}\n" }.join.to_s
         end
       end
 
@@ -39,7 +42,7 @@ module NPlusOneControl
     end
 
     def table_usage_stats(runs) # rubocop:disable Metrics/MethodLength
-      msg = ["\nUnmatched query numbers by tables:\n"]
+      msg = ["Unmatched query numbers by tables:\n"]
 
       before, after = runs.map do |queries|
         queries.group_by do |query|
@@ -58,6 +61,38 @@ module NPlusOneControl
 
       msg
     end
+
+    def default_matching=(val)
+      unless val
+        @default_matching = nil
+        return
+      end
+
+      @default_matching =
+        if val.is_a?(Regexp)
+          val
+        else
+          Regexp.new(val, Regexp::MULTILINE | Regexp::IGNORECASE)
+        end
+    end
+
+    private
+
+    def truncate_query(sql)
+      return sql unless truncate_query_size
+
+      # Only truncate query, leave tracing (if any) as is
+      parts = sql.split(/(\s+↳)/)
+
+      parts[0] =
+        if truncate_query_size < 4
+          "..."
+        else
+          parts[0][0..(truncate_query_size - 4)] + "..."
+        end
+
+      parts.join
+    end
   end
 
   # Scale factors to use.
@@ -65,7 +100,7 @@ module NPlusOneControl
   self.default_scale_factors = [2, 3]
 
   # Print performed queries if true
-  self.verbose = ENV['NPLUSONE_VERBOSE'] == '1'
+  self.verbose = ENV["NPLUSONE_VERBOSE"] == "1"
 
   # Print table hits difference
   self.show_table_stats = true
@@ -76,5 +111,16 @@ module NPlusOneControl
   # ActiveSupport notifications event to track queries.
   # We track ActiveRecord event by default,
   # but can also track rom-rb events ('sql.rom') as well.
-  self.event = 'sql.active_record'
+  self.event = "sql.active_record"
+
+  # Default query filtering applied if none provided explicitly
+  self.default_matching = ENV["NPLUSONE_FILTER"] || /^SELECT/i
+
+  # Truncate queries in verbose mode to fit the length
+  self.truncate_query_size = ENV["NPLUSONE_TRUNCATE"]&.to_i
+
+  # Define the number of backtrace lines to show
+  self.backtrace_length = ENV.fetch("NPLUSONE_BACKTRACE", 1).to_i
 end
+
+require "n_plus_one_control/railtie" if defined?(Rails::Railtie)

data/lib/n_plus_one_control/executor.rb

@@ -19,10 +19,27 @@ module NPlusOneControl
         @queries
       end
 
-      def callback(_name, _start, _finish, _message_id, values)
+      def callback(_name, _start, _finish, _message_id, values) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/LineLength
         return if %w[CACHE SCHEMA].include? values[:name]
 
-        @queries << values[:sql] if @pattern.nil? || (values[:sql] =~ @pattern)
+        return unless @pattern.nil? || (values[:sql] =~ @pattern)
+
+        query = values[:sql]
+
+        if NPlusOneControl.backtrace_cleaner && NPlusOneControl.verbose
+          source = extract_query_source_location(caller)
+
+          query = "#{query}\n    ↳ #{source.join("\n")}" unless source.empty?
+        end
+
+        @queries << query
+      end
+
+      private
+
+      def extract_query_source_location(locations)
+        NPlusOneControl.backtrace_cleaner.call(locations.lazy)
+          .take(NPlusOneControl.backtrace_length).to_a
       end
     end
 

data/lib/n_plus_one_control/minitest.rb

@@ -18,7 +18,7 @@ module NPlusOneControl
 
       @executor = NPlusOneControl::Executor.new(
         population: populate || population_method,
-        matching: matching || /^SELECT/i,
+        matching: matching || NPlusOneControl.default_matching,
         scale_factors: scale_factors || NPlusOneControl.default_scale_factors
       )
 

data/lib/n_plus_one_control/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NPlusOneControl # :nodoc:
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer "n_plus_one_control.backtrace_cleaner" do
+      ActiveSupport.on_load(:active_record) do
+        NPlusOneControl.backtrace_cleaner = lambda do |locations|
+          ::Rails.backtrace_cleaner.clean(locations)
+        end
+      end
+    end
+  end
+end

data/lib/n_plus_one_control/rspec/matcher.rb

@@ -27,8 +27,7 @@
 
     warmup.call if warmup.present?
 
-    # by default we're looking for select queries
-    pattern = @pattern || /^SELECT/i
+    pattern = @pattern || NPlusOneControl.default_matching
 
     @matcher_execution_context.executor = NPlusOneControl::Executor.new(
       population: populate,

data/lib/n_plus_one_control/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NPlusOneControl
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,62 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.8.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.61.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.61.0
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.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
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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: "\n    RSpec and Minitest matchers to prevent N+1 queries problem.\n\n
   \   Evaluates code under consideration several times with different scale factors\n
   \   to make sure that the number of DB queries behaves as expected (i.e. O(1) instead
@@ -152,6 +96,7 @@ files:
 - lib/n_plus_one_control.rb
 - lib/n_plus_one_control/executor.rb
 - lib/n_plus_one_control/minitest.rb
+- lib/n_plus_one_control/railtie.rb
 - lib/n_plus_one_control/rspec.rb
 - lib/n_plus_one_control/rspec/context.rb
 - lib/n_plus_one_control/rspec/dsl.rb
@@ -174,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="