add prosopite

Author: compwron

Gemfile

@@ -64,6 +64,7 @@ gem "wicked" # Multi-step form wizard for Rails
 group :development, :test do
   gem "brakeman" # Security inspection
   gem "bullet" # Detect and fix N+1 queries
+  gem "prosopite" # N+1 query detection via SQL pattern analysis
   gem "byebug", platforms: %i[mri mingw x64_mingw] # Debugger console
   gem "dotenv-rails" # Environment variable management
   gem "erb_lint", require: false # ERB linter

Gemfile.lock

@@ -424,6 +424,7 @@ GEM
       actionpack (>= 7.1)
     prettyprint (0.2.0)
     prism (1.9.0)
+    prosopite (2.1.2)
     pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -757,6 +758,7 @@ DEPENDENCIES
   pg_query
   pghero
   pretender
+  prosopite
   pry
   pry-byebug
   puma (~> 7.0)

config/environments/development.rb

@@ -75,6 +75,10 @@
     Bullet.bullet_logger = true
   end
 
+  # Prosopite N+1 query detection
+  config.prosopite_enabled = true
+  config.prosopite_min_n_queries = 5  # More lenient for development
+
   # Annotate rendered view with file names.
   config.action_view.annotate_rendered_view_with_filenames = true
 

config/environments/production.rb

@@ -108,4 +108,8 @@
   # ]
   # Skip DNS rebinding protection for the default health check endpoint.
   # config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
+
+  # Prosopite N+1 query detection (disabled by default in production)
+  config.prosopite_enabled = ENV.fetch("PROSOPITE_ENABLED", "false") == "true"
+  config.prosopite_min_n_queries = ENV.fetch("PROSOPITE_MIN_N_QUERIES", "10").to_i
 end

config/environments/test.rb

@@ -71,6 +71,10 @@
     # Bullet.raise = true # TODO https://github.com/rubyforgood/casa/issues/2441
   end
 
+  # Prosopite N+1 query detection
+  config.prosopite_enabled = true
+  config.prosopite_min_n_queries = 2  # Stricter for tests
+
   # Annotate rendered view with file names.
   # config.action_view.annotate_rendered_view_with_filenames = true
 

config/initializers/prosopite.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Only enable Rack middleware if Prosopite is configured on
+if Rails.configuration.respond_to?(:prosopite_enabled) && Rails.configuration.prosopite_enabled
+  require "prosopite/middleware/rack"
+  Rails.configuration.middleware.use(Prosopite::Middleware::Rack)
+end
+
+Rails.application.config.after_initialize do
+  # Core settings
+  Prosopite.enabled = Rails.configuration.respond_to?(:prosopite_enabled) &&
+                      Rails.configuration.prosopite_enabled
+
+  # Minimum repeated queries to trigger detection (default: 2)
+  Prosopite.min_n_queries = Rails.configuration.respond_to?(:prosopite_min_n_queries) ?
+                            Rails.configuration.prosopite_min_n_queries : 2
+
+  # Logging options
+  Prosopite.rails_logger = true                    # Log to Rails.logger
+  Prosopite.prosopite_logger = Rails.env.development?  # Log to log/prosopite.log
+end

spec/.prosopite_ignore

@@ -0,0 +1,7 @@
+# Directories to exclude from Prosopite N+1 scanning
+# Remove paths as you fix N+1s in each area
+#
+# Example entries:
+# spec/features
+# spec/system
+# spec/requests/legacy

spec/support/prosopite.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+return unless defined?(Prosopite)
+
+# Test configuration
+Prosopite.enabled = true
+Prosopite.raise = true  # Fail specs on N+1 detection
+Prosopite.rails_logger = true
+Prosopite.prosopite_logger = true
+
+# Allowlist for known acceptable N+1 patterns (e.g., test matchers)
+Prosopite.allow_stack_paths = [
+  "shoulda/matchers/active_record/validate_uniqueness_of_matcher.rb",
+  "shoulda/matchers/active_model/validate_presence_of_matcher.rb",
+  "shoulda/matchers/active_model/validate_inclusion_of_matcher.rb",
+  "shoulda/matchers/active_model/allow_value_matcher.rb"
+]
+
+# Optional: Load ignore list from file for gradual rollout
+PROSOPITE_IGNORE = if File.exist?("spec/.prosopite_ignore")
+  File.read("spec/.prosopite_ignore").lines.map(&:chomp).reject(&:empty?)
+else
+  []
+end
+
+# Monkey-patch FactoryBot to pause during factory creation
+# Prevents false positives from factory callbacks
+if defined?(FactoryBot)
+  module FactoryBot
+    module Strategy
+      class Create
+        alias_method :original_result, :result
+
+        def result(evaluation)
+          if defined?(Prosopite) && Prosopite.enabled?
+            Prosopite.pause { original_result(evaluation) }
+          else
+            original_result(evaluation)
+          end
+        end
+      end
+    end
+  end
+end
+
+# RSpec integration
+RSpec.configure do |config|
+  config.around do |example|
+    if use_prosopite?(example)
+      Prosopite.scan { example.run }
+    else
+      original_enabled = Prosopite.enabled?
+      Prosopite.enabled = false
+      example.run
+      Prosopite.enabled = original_enabled
+    end
+  end
+end
+
+def use_prosopite?(example)
+  # Explicit metadata takes precedence
+  return false if example.metadata[:disable_prosopite]
+  return true if example.metadata[:enable_prosopite]
+
+  # Check against ignore list
+  PROSOPITE_IGNORE.none? do |path|
+    File.fnmatch?("./#{path}/*", example.metadata[:rerun_file_path].to_s)
+  end
+end