n_one 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d037a52ad1770b38646937c04fdf274fac7dfdbf5d8351eb5208e0899d4d8927
-  data.tar.gz: eafb63f23fca359806b398c41480bad4225a46a1806dcbf05d50d88ca8fec197
+  metadata.gz: 6ed8520fefb3a0e04185dc4a7f234ec3f9d65d110223dfd52b568d9f1f8d9080
+  data.tar.gz: 1164c40f76713cab191569ff896d4309c8938194737ed31cd21897bcc10027d9
 SHA512:
-  metadata.gz: 1e18c871f74065f1fac610a11a70717a6bd91caf447062627d91b847602300ac76abae5b7a5200d57dd65ad223f2da6fe6554ff7f0ae97df07710c609d9591e8
-  data.tar.gz: 4b933072d3e7e62f6abfac60ea794d64049457c756497614ce2f84eb77687d008786e901bdfb1139f5b47a5b49ed9acddafd7cf036e80a6e9620d977bee45a95
+  metadata.gz: 98c9dedda0ec0540d55443c678c399dd1bb5bf5b3ee007769b85b6d276aa13bcf14096aa0a8ab310ddedb824df7cd0289a88f0bd952e3f6dd4e707ca0da0ce97
+  data.tar.gz: 19da0020d67ef61418399ecfe266c063822d63fcb3912832bc57c135b5df6739aea5d4583927f90e89ecbc557d352cc1bfa99777efdc1cd4ecf6d9983c6a4715

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    n_one (1.0.1)
+    n_one (1.0.2)
       pg_query
 
 GEM
@@ -23,8 +23,8 @@ GEM
     concurrent-ruby (1.1.8)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    google-protobuf (3.19.1)
-    google-protobuf (3.19.1-x86_64-linux)
+    google-protobuf (3.19.4)
+    google-protobuf (3.19.4-x86_64-linux)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
@@ -32,8 +32,8 @@ GEM
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
-    pg_query (2.1.2)
-      google-protobuf (>= 3.17.1)
+    pg_query (2.1.3)
+      google-protobuf (>= 3.19.2)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -74,9 +74,9 @@ end
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-  NOne.scan!(whitelist: ['myapp/lib/known_n_plus_ones/']) do
-    example.run
-  end
+NOne.scan!(whitelist: ['myapp/lib/known_n_plus_ones/']) do
+  example.run
+end
 ```
 
 ## Ignore names
@@ -84,13 +84,42 @@ Ignore notifications for call stacks containing one or more substrings:
 Ignore queries with names:
 
 ```ruby
-  NOne.scan!(ignore_names: ['SCHEMA']) do
-    example.run
-  end
+NOne.scan!(ignore_names: ['SCHEMA']) do
+  example.run
+end
 ```
 
 It will skip schema queries(e.g. for column names of a given table)
 
+## Stack trace sanitizing
+
+Sanitize the call stack trace that is used to calculate the query fingerprint:
+
+```ruby
+sanitizer = lambda do |stacktrace|
+  stacktrace.reject { |s| s.include?('/active_record/relation/delegation.rb') }
+end
+
+NOne.scan!(stacktrace_sanitizer: sanitizer) do
+  example.run
+end
+```
+
+Consider the following example:
+
+```ruby
+class Foo < ActiveRecord::Base
+  def self.bar
+    first(5)
+  end
+end
+
+2.times { Foo.all.bar }
+```
+
+The subsequent `Foo.all.bar` call here will not be recognized as an N+1 query since it will have a different call stack trace (see the reason [here](https://github.com/rails/rails/blob/9a400d808bdbebd5ea50cebc79bde591d2669017/activerecord/lib/active_record/relation/delegation.rb#L82-L85)).
+This can be fixed with the `stacktrace_sanitizer` option as described above.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/prikha/n_one.

data/lib/n_one/runner.rb

@@ -6,10 +6,13 @@ module NOne
     #
     # @param whitelist [<String>] frame substrings to be ignored
     # @param ignore_names [<String>] query names to be ignored
+    # @param stacktrace_sanitizer [Proc<Array<String>>] if given, used to filter the stack trace
+    #   that is used to calculate the location key
     #
-    def initialize(whitelist: [], ignore_names: [])
+    def initialize(whitelist: [], ignore_names: [], stacktrace_sanitizer: nil)
       @whitelist = ['active_record/validations/uniqueness'] + whitelist
       @ignore_names = ignore_names
+      @stacktrace_sanitizer = stacktrace_sanitizer
     end
 
     def scan(&block)
@@ -51,7 +54,7 @@ module NOne
       end.compact
     end
 
-    def record_sql(&block) # rubocop:disable  Metrics/AbcSize, Metrics/MethodLength
+    def record_sql(&block) # rubocop:disable  Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
       subscriber = ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
         sql = data[:sql]
         cached = data[:cached]
@@ -62,7 +65,9 @@ module NOne
         sql_fingerprint = Query.fingerprint(sql)
         next unless sql_fingerprint
 
-        location_key = Digest::SHA1.hexdigest(caller.join)
+        stacktrace = caller
+        stacktrace = @stacktrace_sanitizer.call(stacktrace) if @stacktrace_sanitizer
+        location_key = Digest::SHA1.hexdigest(stacktrace.join)
 
         store["#{sql_fingerprint}_#{location_key}"] ||= {
           count: 0,
@@ -73,7 +78,7 @@ module NOne
         store["#{sql_fingerprint}_#{location_key}"][:count] += 1
         store["#{sql_fingerprint}_#{location_key}"][:sql] << sql
         store["#{sql_fingerprint}_#{location_key}"][:sql].uniq!
-        store["#{sql_fingerprint}_#{location_key}"][:caller] ||= caller.dup
+        store["#{sql_fingerprint}_#{location_key}"][:caller] ||= stacktrace
       end
 
       block.call

data/lib/n_one/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NOne
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_one
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sergey Prikhodko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query