n_one 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b2ba1b5d986f35ed074dac942c0448f1ae64217403a5946398da54ad93e54f
-  data.tar.gz: 14cbea5e0fd6b84932f5d8b74957f8d99e97b0572eb062af824c9cf41745be0d
+  metadata.gz: 1d2ff9afa1af0f84f3291494c21e47d28c94d67c61abea2b9a10bba5482c1ed8
+  data.tar.gz: 2e50029cb362fbcd9f773d7dd5e4d86120a9cef425b0a167b13d659441de57fa
 SHA512:
-  metadata.gz: ea4606afb1b0ef8cc5417745f76b7260b628e77c645896e6ba919096340692cf6602a5d7645133fe5dbf79021d0664a738b6e870bbbea72728b6cb514bac638e
-  data.tar.gz: '08567625417d3881bc257bde3da51db8e500eb06a2ffdc2dd32d2800026d8d00df6a9ffb81cc6638d66bb96bde769f015c231a31a0444e7e8deb9b84c4efda04'
+  metadata.gz: 2b5585f38769f8e3a5228111d01a0b894217197f8597cc608e70b0d3d6fa35cf2047f79e3eb71c86a4a2a3a300eea4655a59e090868d4fe51008b9e175294d29
+  data.tar.gz: 78718a6479979500f2e6466bbbb25d60a122c0b5ea3199d86b39a212e1b80ba1ee423778b2df14ccc8eb36e270b76e48306a9bd01f7e86b0147c141681ba872e

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.5, '3.0', head]
+        ruby: [2.6, '3.0']
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    n_one (1.0.0)
+    n_one (1.0.3)
       pg_query
 
 GEM
@@ -23,6 +23,8 @@ GEM
     concurrent-ruby (1.1.8)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
+    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)
@@ -30,7 +32,8 @@ GEM
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
-    pg_query (1.3.0)
+    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,11 +74,52 @@ end
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-  NOne.scan!(whitelist: 'myapp/lib/known_n_plus_ones/') do
-    example.run
+NOne.scan!(whitelist: ['myapp/lib/known_n_plus_ones/']) do
+  example.run
+end
+```
+
+## Ignore names
+
+Ignore queries with names:
+
+```ruby
+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

@@ -2,8 +2,17 @@
 
 module NOne
   class Runner # :nodoc:
-    def initialize(whitelist: [])
+    # Instantiation
+    #
+    # @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: [], stacktrace_sanitizer: nil)
       @whitelist = ['active_record/validations/uniqueness'] + whitelist
+      @ignore_names = ignore_names
+      @stacktrace_sanitizer = stacktrace_sanitizer
     end
 
     def scan(&block)
@@ -20,7 +29,7 @@ module NOne
 
     private
 
-    attr_reader :store, :whitelist
+    attr_reader :store, :whitelist, :ignore_names
 
     def init_store
       @store = {}
@@ -45,17 +54,20 @@ 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]
 
         next if !sql.include?('SELECT') || cached
+        next if ignore_names.include?(data[:name])
 
         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,
@@ -66,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.0'
+  VERSION = '1.0.3'
 end

data/lib/n_one.rb

@@ -30,11 +30,11 @@ module NOne
 
   module_function
 
-  def scan(whitelist: [], &block)
-    Runner.new(whitelist: whitelist).scan(&block)
+  def scan(**args, &block)
+    Runner.new(**args).scan(&block)
   end
 
-  def scan!(whitelist: [], &block)
-    Runner.new(whitelist: whitelist).scan!(&block)
+  def scan!(**args, &block)
+    Runner.new(**args).scan!(&block)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_one
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Sergey Prikhodko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: N+1 auto-detection for ActiveRecord and PostgreSQL