n_plus_one_control 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227fb8257ab67628ffd449aff0358d729dd3ff3eafc291f9fca427aa355e0650
-  data.tar.gz: 2e65e5f09da3ad989fbb1e2418a657c8142ea8d25540a0daf729adeb9f0b0d5b
+  metadata.gz: b20b8f4269aac76f3da642b271b93ddee2adf508539bba6852e02225695de155
+  data.tar.gz: e739f342b4d46cc451229f3a065cb0e2b83ee28c301d99045d0f094e74bc137b
 SHA512:
-  metadata.gz: e79cf5bd9ec1afd8b10ca184a483edd9e8d8fbbeaca62e147d277102715ead2fa909d720eb0085fc6d2c2441abb5e61aa08f8a081a4b37079b3f552694d3e220
-  data.tar.gz: 59c76b177dc8b6ad4d58cfbad1f3c3e89204eef6e92d2d39989b5829f714939c77d0d38806e935d3624e20469447607f7b403af2b2bd633a02486e82c6cc4f6c
+  metadata.gz: 74805b4ea497ff96bb882557ed8a14e04d32cf5ea5c62e9c65167647c880275aec9d0f8a405a298554e9cfecbb20049d99f630b977475a75122d847c7b27e1a9
+  data.tar.gz: 19063ec1fb2a84edcfd0e38075a3858e239a438803ffb40e03916bc8eb5d49dda9e8b03a30a60788e4e00f9c5484811740448fe3241e64658a78ccf884619321

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## master (unreleased)
+
+## 0.4.1 (2020-09-04)
+
+- Enhance failure message by showing differences in table hits. ([@palkan][])
+
 ## 0.4.0 (2020-07-20)
 
 - Make scale factor available in tests via `#current_scale` method. ([@Earendil95][])

data/README.md

@@ -186,9 +186,9 @@ If you use caching you can face the problem when first request performs more DB
 
 context "N + 1", :n_plus_one do
   populate { |n| create_list :post, n }
-  
+
   warmup { get :index } # cache something must be cached
-  
+
   specify do
     expect { get :index }.to perform_constant_number_of_queries
   end
@@ -215,7 +215,7 @@ end
 def test_no_n_plus_one
   populate = ->(n) { create_list(:post, n) }
   warmup = -> { get :index }
-  
+
   assert_perform_constant_number_of_queries population: populate, warmup: warmup do
     get :index
   end
@@ -240,6 +240,14 @@ NPlusOneControl.default_scale_factors = [2, 3]
 # You can activate verbosity through env variable NPLUSONE_VERBOSE=1
 NPlusOneControl.verbose = false
 
+# Print table hits difference, for example:
+#
+#   Unmatched query numbers by tables:
+#     users (SELECT): 2 != 3
+#     events (INSERT): 1 != 2
+#
+self.show_table_stats = true
+
 # Ignore matching queries
 NPlusOneControl.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 

data/lib/n_plus_one_control.rb

@@ -5,17 +5,59 @@ require "n_plus_one_control/executor"
 
 # RSpec and Minitest matchers to prevent N+1 queries problem.
 module NPlusOneControl
+  # Used to extract a table name from a query
+  EXTRACT_TABLE_RXP = /(insert into|update|delete from|from) ['"](\S+)['"]/i.freeze
+
+  # Used to convert a query part extracted by the regexp above to the corresponding
+  # human-friendly type
+  QUERY_PART_TO_TYPE = {
+    "insert into" => "INSERT",
+    "update" => "UPDATE",
+    "delete from" => "DELETE",
+    "from" => "SELECT"
+  }.freeze
+
   class << self
-    attr_accessor :default_scale_factors, :verbose, :ignore, :event
+    attr_accessor :default_scale_factors, :verbose, :show_table_stats, :ignore, :event
 
-    def failure_message(queries)
+    def failure_message(queries) # rubocop:disable Metrics/MethodLength
       msg = ["Expected to make the same number of queries, but got:\n"]
       queries.each do |(scale, data)|
         msg << "  #{data.size} for N=#{scale}\n"
-        msg << data.map { |sql| "    #{sql}\n" }.join.to_s if verbose
       end
+
+      msg.concat(table_usage_stats(queries.map(&:last))) if show_table_stats
+
+      if verbose
+        queries.each do |(scale, data)|
+          msg << "  Queries for N=#{scale}\n"
+          msg << data.map { |sql| "    #{sql}\n" }.join.to_s
+        end
+      end
+
       msg.join
     end
+
+    def table_usage_stats(runs) # rubocop:disable Metrics/MethodLength
+      msg = ["\nUnmatched query numbers by tables:\n"]
+
+      before, after = runs.map do |queries|
+        queries.group_by do |query|
+          matches = query.match(EXTRACT_TABLE_RXP)
+          next unless matches
+
+          "  #{matches[2]} (#{QUERY_PART_TO_TYPE[matches[1].downcase]})"
+        end.transform_values(&:count)
+      end
+
+      before.keys.each do |k|
+        next if before[k] == after[k]
+
+        msg << "#{k}: #{before[k]} != #{after[k]}\n"
+      end
+
+      msg
+    end
   end
 
   # Scale factors to use.
@@ -25,6 +67,9 @@ module NPlusOneControl
   # Print performed queries if true
   self.verbose = ENV['NPLUSONE_VERBOSE'] == '1'
 
+  # Print table hits difference
+  self.show_table_stats = true
+
   # Ignore matching queries
   self.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 

data/lib/n_plus_one_control/minitest.rb

@@ -17,7 +17,7 @@ module NPlusOneControl
       warming_up warmup
 
       @executor = NPlusOneControl::Executor.new(
-        population: population_proc(populate),
+        population: populate || population_method,
         matching: matching || /^SELECT/i,
         scale_factors: scale_factors || NPlusOneControl.default_scale_factors
       )
@@ -39,8 +39,8 @@ module NPlusOneControl
       (warmup || methods.include?(:warmup) ? method(:warmup) : nil)&.call
     end
 
-    def population_proc(populate)
-      (populate || methods.include?(:populate) ? method(:populate) : nil)
+    def population_method
+      methods.include?(:populate) ? method(:populate) : nil
     end
   end
 end

data/lib/n_plus_one_control/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: RSpec and Minitest matchers to prevent N+1 queries problem