prosopite 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c01f842ae2f77f85afad80b9333d9e08532763b0a2f4da8b947fd224bd8ad5e
-  data.tar.gz: b7355dba60a61af1936fabc438838cd6c5e68c2bf99ad4f89250f0fbb56da6f7
+  metadata.gz: 77276ce50263c0d9e2e4a9e0c525924ac5810367f036d783197222819f8fb312
+  data.tar.gz: b43868ebc87b40d97997db1c7a77fb3ee34cb032a76a0b290adb174c8d04c6d3
 SHA512:
-  metadata.gz: d667f984caa2c358dd1268a515d4784bad98d86c39f42535cc97c7161c5f9131dbdf8dd57786aebc6fc20b55d1fcc660f4700260db08e47df3400797e4f7e3da
-  data.tar.gz: 1b31e428871d38f29fb3f46f1c637cc822addbc5c826366da5b98ebe149bc1af63912f69a8a50cec277ed8e2c34c185bdc11e3f58d302a43fedd97c5b20622cc
+  metadata.gz: 5fc318b3becb5095f93244d8e23699c27e604c43ba7a3dc489ee3939d19b23e26a47eb4957d6355f28fdaa18fb6ecaa2caf27721a03fcadadefa73a5cbcfec7e
+  data.tar.gz: e5954aa6aec45c26722f807dcb2fde6aae4c1090d097cc7172a306cdde9639b734d226826fa1d6dcab59a9d22857dc7901978eb4297287ac49b81a63b23ae0e1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prosopite (1.0.1)
+    prosopite (1.0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -127,11 +127,12 @@ Prosopite auto-detection can be enabled on all controllers:
 ```ruby
 class ApplicationController < ActionController::Base
   unless Rails.env.production?
-    before_action do
+    around_action :n_plus_one_detection
+    
+    def n_plus_one_detection
       Prosopite.scan
-    end
-
-    after_action do
+      yield
+    ensure
       Prosopite.finish
     end
   end
@@ -181,7 +182,13 @@ WARNING: scan/finish should run before/after **each** test and NOT before/after
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-Prosopite.allow_list = ['substring_in_call_stack']
+Prosopite.allow_stack_paths = ['substring_in_call_stack']
+```
+
+Ignore notifications matching a specific SQL query:
+
+```ruby
+Prosopite.ignore_queries = [/regex_match/, "SELECT * from EXACT_STRING_MATCH"]
 ```
 
 ## Scanning code outside controllers or tests
@@ -202,6 +209,23 @@ Prosopite.scan do
 end
 ```
 
+## Pausing and resuming scans
+
+Scans can be paused:
+
+```ruby
+Prosopite.scan
+# <code to scan>
+Prosopite.pause
+# <code that has n+1s>
+Prosopite.resume
+# <code to scan>
+Prosopite.finish
+```
+
+An example of when you might use this is if you are [testing Active Jobs inline](https://guides.rubyonrails.org/testing.html#testing-jobs),
+and don't want to run Prosopite on background job code, just foreground app code. In that case you could write an [Active Job callback](https://edgeguides.rubyonrails.org/active_job_basics.html#callbacks) that pauses the scan while the job is running.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/charkost/prosopite.

data/lib/prosopite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosopite
-  VERSION = "1.0.2"
+  VERSION = "1.0.6"
 end

data/lib/prosopite.rb

@@ -1,12 +1,21 @@
 
 module Prosopite
+  DEFAULT_ALLOW_LIST = %w(active_record/associations/preloader active_record/validations/uniqueness)
+
   class NPlusOneQueriesError < StandardError; end
   class << self
     attr_writer :raise,
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
-                :allow_list
+                :allow_stack_paths,
+                :ignore_queries
+
+    def allow_list=(value)
+      puts "Prosopite.allow_list= is deprecated. Use Prosopite.allow_stack_paths= instead."
+
+      self.allow_stack_paths = value
+    end
 
     def scan
       tc[:prosopite_scan] ||= false
@@ -18,7 +27,7 @@ module Prosopite
       tc[:prosopite_query_holder] = Hash.new { |h, k| h[k] = [] }
       tc[:prosopite_query_caller] = {}
 
-      @allow_list ||= []
+      @allow_stack_paths ||= []
 
       tc[:prosopite_scan] = true
 
@@ -36,6 +45,14 @@ module Prosopite
       Thread.current
     end
 
+    def pause
+      tc[:prosopite_scan] = false
+    end
+
+    def resume
+      tc[:prosopite_scan] = true
+    end
+
     def scan?
       tc[:prosopite_scan]
     end
@@ -62,14 +79,15 @@ module Prosopite
             end
           end
 
+          next unless fingerprints.uniq.size == 1
+
           kaller = tc[:prosopite_query_caller][location_key]
+          allow_list = (@allow_stack_paths + DEFAULT_ALLOW_LIST)
+          is_allowed = kaller.any? { |f| allow_list.any? { |s| f.include?(s) } }
 
-          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @allow_list.any? { |s| f.include?(s) } }
+          unless is_allowed
             queries = tc[:prosopite_query_holder][location_key]
-
-            unless kaller.any? { |f| f.include?('active_record/validations/uniqueness') }
-              tc[:prosopite_notifications][queries] = kaller
-            end
+            tc[:prosopite_notifications][queries] = kaller
           end
         end
       end
@@ -170,6 +188,11 @@ module Prosopite
       str.split("\n").map { |line| "\e[91m#{line}\e[0m" }.join("\n")
     end
 
+    def ignore_query?(sql)
+      @ignore_queries ||= []
+      @ignore_queries.any? { |q| q === sql }
+    end
+
     def subscribe
       @subscribed ||= false
       return if @subscribed
@@ -177,7 +200,7 @@ module Prosopite
       ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
         sql, name = data[:sql], data[:name]
 
-        if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil?
+        if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil? && !ignore_query?(sql)
           location_key = Digest::SHA1.hexdigest(caller.join)
 
           tc[:prosopite_query_counter][location_key] += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry