query_owl 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1269c2c24be94cd4ebf8ef07d12fa3e5da1aa2c1573256779f641d3f0a089c6e
-  data.tar.gz: 891f6323d6a6ffd95b6e73e131ddbf2f556e90703f5aa67819d92a3bdf0b4ccb
+  metadata.gz: 9d6d1c90011594e84ad366b86242261eb507c646bbbd99567ee68e764f79fed3
+  data.tar.gz: 6b3d04a4eeba7e6cd61f77ac1c86d9267490cb68bc4bee375bf3fca39db21c48
 SHA512:
-  metadata.gz: 6fe7f83cbb596f8616ffdd11ccea40c4c2c485fa16b303f783a0b6b3a551eef4b8313e353585c8990061832227926738931fa582f9d2de8860b819afad301b96
-  data.tar.gz: 87244c9aba6eff9996e97d1f5a3727b8fbf283d6b10647c05fb903d4d7833bc464fdd0c26db84895f8ed7dbc7e290bc6c22f5f225f01360649d03859b9e2dfb7
+  metadata.gz: 48dd728246c8226b5fc04bf819e85712e8eaf5453d1fe77ca1ce3ba012f7399a52af50cffacb652c5958f2ab086c35270930fed9c093971b3e446bc3846f1756
+  data.tar.gz: 1f26cb6d3c28dccf5708446b4c9e17ce2f334af66ae8b0ed6c6d92eb36440818b4c1feff3cf4ef124f455e54e050641eadc8952aa0a8d59c5b2a4ed50672a8cf

data/lib/generators/query_owl/install/templates/initializer.rb

@@ -34,6 +34,26 @@ QueryOwl.configure do |config|
   # Disabled by default (nil). Useful for persistence across restarts.
   # config.log_file = Rails.root.join("log/query_owl.log").to_s
 
+  # Paths to skip entirely — accepts strings (prefix match) or regexes.
+  # Useful for health check endpoints and other high-frequency low-value paths.
+  # config.ignore_paths = ["/up", "/healthz", %r{^/assets/}]
+
+  # Controllers to skip — matched against the Rails controller name (e.g. "rails/health").
+  # config.ignore_controllers = ["rails/health", "admin/metrics"]
+
+  # Test helper — opt-in RSpec matchers and Minitest assertions.
+  # Add to spec/rails_helper.rb (or test/test_helper.rb for Minitest):
+  #
+  #   require "query_owl/test_helper"
+  #   RSpec.configure { |c| c.include QueryOwl::TestHelper }
+  #   # or: class ActiveSupport::TestCase; include QueryOwl::TestHelper; end
+  #
+  # Then use: expect { }.not_to trigger_n_plus_one
+  #           expect { }.not_to trigger_slow_query
+  #           expect { }.not_to trigger_unused_eager_load
+  #           assert_no_n_plus_one { }
+  #           assert_no_slow_query { }
+
   # Notifiers receive each detected event via #call(event).
   # Defaults to [QueryOwl::Notifiers::Logger] which writes to Rails.logger.
   # Use Console for TTY-aware colorized output (yellow: N+1, red: slow query).

data/lib/query_owl/configuration.rb

@@ -5,7 +5,8 @@ module QueryOwl
 
     attr_reader :log_level, :backtrace_filter
     attr_accessor :enabled, :slow_query_threshold_ms, :n_plus_one_threshold, :backtrace_lines,
-                  :raise_on_n_plus_one, :event_store_size, :dashboard_enabled, :log_file
+                  :raise_on_n_plus_one, :event_store_size, :dashboard_enabled, :log_file,
+                  :ignore_paths, :ignore_controllers
 
     def notifiers
       @notifiers ||= [Notifiers::Logger.new]
@@ -31,6 +32,8 @@ module QueryOwl
       @event_store_size        = 100
       @dashboard_enabled       = Rails.env.development?
       @log_file                = nil
+      @ignore_paths            = []
+      @ignore_controllers      = []
     end
 
     def log_level=(level)

data/lib/query_owl/middleware.rb

@@ -4,41 +4,63 @@ module QueryOwl
       @app = app
     end
 
-    def raise_on_n_plus_one!(events)
-      event = events.find { |e| e[:type] == :n_plus_one }
-      return unless event
-
-      raise NPlusOneError, "N+1 detected: #{event[:sql]} (#{event[:count]} times) #{event[:backtrace].first}"
-    end
-
     def call(env)
+      tracking = false
       return @app.call(env) unless QueryOwl.config.enabled
+      return @app.call(env) if ignored_path?(env["PATH_INFO"])
 
+      tracking = true
       QueryTracker.start!
       EagerLoadTracker.start!
       @app.call(env)
     ensure
-      params  = env["action_dispatch.request.path_parameters"] || {}
-      RequestContext.set(controller: params[:controller], action: params[:action], path: env["PATH_INFO"])
-      queries    = QueryTracker.stop!
-      eager_data = EagerLoadTracker.stop!
-      context    = RequestContext.current
-      RequestContext.clear
-      events     = (Detector.detect_n_plus_one(queries) +
+      if tracking
+        params     = env["action_dispatch.request.path_parameters"] || {}
+        RequestContext.set(controller: params[:controller], action: params[:action], path: env["PATH_INFO"])
+        queries    = QueryTracker.stop!
+        eager_data = EagerLoadTracker.stop!
+        context    = RequestContext.current
+        RequestContext.clear
+
+        unless ignored_controller?(context[:controller])
+          events = (Detector.detect_n_plus_one(queries) +
                     Detector.detect_slow_queries(queries) +
                     Detector.detect_unused_eager_loads(eager_data))
                    .map { |e| e.merge(context) }
-      events.each do |event|
-        QueryOwl.config.notifiers.each do |notifier|
-          notifier.call(event)
-        rescue => e
-          Rails.logger.error "[QueryOwl] Notifier #{notifier.class} raised: #{e.message}"
+          events.each do |event|
+            QueryOwl.config.notifiers.each do |notifier|
+              notifier.call(event)
+            rescue => e
+              Rails.logger.error "[QueryOwl] Notifier #{notifier.class} raised: #{e.message}"
+            end
+          end
+          Logger.log_summary(events)
+          events.each { |e| EventStore.push(e) }
+          FileLogger.append(events)
+          raise_on_n_plus_one!(events) if QueryOwl.config.raise_on_n_plus_one
         end
       end
-      Logger.log_summary(events)
-      events.each { |e| EventStore.push(e) }
-      FileLogger.append(events)
-      raise_on_n_plus_one!(events) if QueryOwl.config.raise_on_n_plus_one
     end
+
+    def raise_on_n_plus_one!(events)
+      event = events.find { |e| e[:type] == :n_plus_one }
+      return unless event
+
+      raise NPlusOneError, "N+1 detected: #{event[:sql]} (#{event[:count]} times) #{event[:backtrace].first}"
+    end
+
+    private
+
+      def ignored_path?(path)
+        QueryOwl.config.ignore_paths.any? do |pattern|
+          pattern.is_a?(Regexp) ? pattern.match?(path) : path.start_with?(pattern.to_s)
+        end
+      end
+
+      def ignored_controller?(controller)
+        return false unless controller
+
+        QueryOwl.config.ignore_controllers.any? { |name| name.to_s == controller }
+      end
   end
 end

data/lib/query_owl/test_helper.rb

@@ -0,0 +1,85 @@
+require "query_owl"
+
+module QueryOwl
+  module TestHelper
+    # Runs block with QueryOwl's trackers active and returns detected events.
+    # Isolated from config.enabled and config.raise_on_n_plus_one.
+    def self.capture_events
+      QueryTracker.start!
+      EagerLoadTracker.start!
+      yield
+      queries    = QueryTracker.stop!
+      eager_data = EagerLoadTracker.stop!
+      Detector.detect_n_plus_one(queries) +
+        Detector.detect_slow_queries(queries) +
+        Detector.detect_unused_eager_loads(eager_data)
+    rescue
+      QueryTracker.stop!
+      EagerLoadTracker.stop!
+      raise
+    end
+
+    # RSpec block matchers — use with expect { }.to / not_to
+
+    def trigger_n_plus_one
+      EventTypeMatcher.new(:n_plus_one)
+    end
+
+    def trigger_slow_query
+      EventTypeMatcher.new(:slow_query)
+    end
+
+    def trigger_unused_eager_load
+      EventTypeMatcher.new(:unused_eager_load)
+    end
+
+    # Minitest assertions — call assert_no_n_plus_one { } inside a test method
+
+    def assert_no_n_plus_one(msg = nil, &block)
+      events = QueryOwl::TestHelper.capture_events(&block)
+      count  = events.count { |e| e[:type] == :n_plus_one }
+      assert count.zero?, msg || "Expected no N+1 queries, but #{count} detected"
+    end
+
+    def assert_no_slow_query(msg = nil, &block)
+      events = QueryOwl::TestHelper.capture_events(&block)
+      count  = events.count { |e| e[:type] == :slow_query }
+      assert count.zero?, msg || "Expected no slow queries, but #{count} detected"
+    end
+
+    class EventTypeMatcher
+      def initialize(type)
+        @type   = type
+        @events = []
+      end
+
+      def matches?(block)
+        @events = QueryOwl::TestHelper.capture_events(&block)
+        @events.any? { |e| e[:type] == @type }
+      end
+
+      def does_not_match?(block)
+        !matches?(block)
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def failure_message
+        "expected block to trigger #{label} but none were detected"
+      end
+
+      def failure_message_when_negated
+        n = @events.count { |e| e[:type] == @type }
+        "expected block not to trigger #{label} but #{n} detected"
+      end
+
+      private
+
+        def label
+          @type.to_s.tr("_", " ")
+        end
+    end
+  end
+end

data/lib/query_owl/version.rb

@@ -1,3 +1,3 @@
 module QueryOwl
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

data/lib/tasks/query_owl_tasks.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :query_owl do
-#   # Task goes here
-# end
+namespace :query_owl do
+  desc "Clear all events from the QueryOwl in-memory event store"
+  task clear: :environment do
+    count = QueryOwl::EventStore.size
+    QueryOwl::EventStore.clear
+    puts "[QueryOwl] Event store cleared (#{count} event#{"s" if count != 1} removed)."
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_owl
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -63,6 +63,7 @@ files:
 - lib/query_owl/notifiers/stdout.rb
 - lib/query_owl/query_tracker.rb
 - lib/query_owl/request_context.rb
+- lib/query_owl/test_helper.rb
 - lib/query_owl/version.rb
 - lib/tasks/query_owl_tasks.rake
 homepage: https://github.com/eclectic-coding/query_owl