bullet 8.0.8 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2296e419c6f32f6ed2e2dbe92a344884d1197b8287bb6c67783a1587c31c72
-  data.tar.gz: 523f4b66265e7ca8b4d67b19ecd13a547f7ad55acbdbd8190ec1e48a1cb4993e
+  metadata.gz: fff8caa10888c5cc1aee062b08ac4c4df6e5911e9b4c592b3e0c89c3faedf089
+  data.tar.gz: aebe5eb8c7b8624fc2bbe05f42c4c6e8ba5ef8122f519e4e2f984f83d1ac8762
 SHA512:
-  metadata.gz: 463b978de4299a651821f4bf66ce219ba3def30f32d8fbb790086d10b869526578c2f5b441a1c0c5d368c03906e833a86b5ed88cda1a2f983e5769c04bf7efb2
-  data.tar.gz: 5ab230e714c07790210516fbb760007fbbb49875a4021950b8e5d2c8ab77e132240f632ee50a62ee25dc58f629663f6d9802bee626d870d456284e3d4130ed3e
+  metadata.gz: 6d60f48c25171229b660274b31ae90689f402d0ea1f46fdf2c63467a550765520b46afb70ff683a8beca75da7ddb86629ba5f58e276667a784d37653f3a94688
+  data.tar.gz: '06973354f3d5158e1ade0f2898577d772b6669d622b176010b6176dbb8b02e5f67c611fbb55668bfee9c93ea873c1183cd28ba30e778a5a6692d0e050a9a3794'

data/CHANGELOG.md

@@ -1,4 +1,34 @@
-## Next Release
+## Unreleased
+
+## 8.2.0 (08/29/2026)
+
+* Add thread-safe `Bullet.pause`, `Bullet.resume`, `Bullet.paused?`, and `Bullet.skip` APIs
+* Add configurable footer positioning
+* Fix unused eager loading false positives when N+1 detection is disabled
+* Fix unused eager loading false positives for conditional `has_many :through` associations
+* Fix Ruby 4.0 compatibility issues
+* Drop support for ActiveRecord versions older than 7 and Mongoid versions older than 8
+
+## 8.1.3 (06/02/2026)
+
+* Handle inversed polymorphic belongs_to false positives
+
+## 8.1.2 (05/25/2026)
+
+* Skip N+1 detection for optional polymorphic `belongs_to` whose `*_type` column is nil. ActiveRecord short-circuits the reader to nil without issuing SQL, so the access cannot represent an N+1 query and preloading would be a no-op.
+* Fix `Set#<<` corruption in `UnusedEagerLoading#add_eager_loadings` split branch
+
+## 8.1.1 (04/23/2026)
+
+* Fix ActiveRecord 8.1 patch-level method signature compatibility; test against Rails 8.1.3.
+* Handle string associations in safelist for Action Text
+* Enhance N+1 query detection by including caller stack in association calls
+* Update external links in README.md
+
+## 8.1.0 (10/23/2025)
+
+* Make `get_relation` private
+* Support Rails 8.1
 
 ## 8.0.8 (05/30/2025)
 

data/README.md

@@ -17,10 +17,9 @@ If you use activerecord 3.x, please use bullet < 5.5.0
 
 ## External Introduction
 
-* [http://railscasts.com/episodes/372-bullet](http://railscasts.com/episodes/372-bullet)
-* [http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009](http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009)
-* [http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1](http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1)
 * [https://rubyonrails.org/2009/10/22/community-highlights](https://rubyonrails.org/2009/10/22/community-highlights)
+* [https://www.shakacode.com/blog/eliminate-N-1-queries-with-bullet/](https://www.shakacode.com/blog/eliminate-N-1-queries-with-bullet/)
+* [https://reinteractive.com/articles/ruby-on-rails-community/elevating-your-code-quality-bullet-gem-and-query-prevention-in-testing](https://reinteractive.com/articles/ruby-on-rails-community/elevating-your-code-quality-bullet-gem-and-query-prevention-in-testing)
 
 ## Install
 
@@ -70,11 +69,16 @@ config.after_initialize do
   Bullet.airbrake = true
   Bullet.rollbar = true
   Bullet.add_footer = true
+  Bullet.footer_position = 'bottom_left'  # or 'bottom_right', 'top_left', 'top_right'
   Bullet.skip_html_injection = false
+  Bullet.skip_http_headers = false
   Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
   Bullet.stacktrace_excludes = [ 'their_gem', 'their_middleware', ['my_file.rb', 'my_method'], ['my_file.rb', 16..20] ]
   Bullet.slack = { webhook_url: 'http://some.slack.url', channel: '#default', username: 'notifier' }
   Bullet.opentelemetry = true
+  Bullet.raise = false
+  Bullet.always_append_html_body = false
+  Bullet.skip_user_in_notification = false
 end
 ```
 
@@ -82,6 +86,7 @@ The notifier of Bullet is a wrap of [uniform_notifier](https://github.com/flyerh
 
 The code above will enable all of the Bullet notification systems:
 * `Bullet.enable`: enable Bullet gem, otherwise do nothing
+* `Bullet.sentry`: add notifications to sentry
 * `Bullet.alert`: pop up a JavaScript alert in the browser
 * `Bullet.bullet_logger`: log to the Bullet log file (Rails.root/log/bullet.log)
 * `Bullet.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
@@ -89,11 +94,11 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.rails_logger`: add warnings directly to the Rails log
 * `Bullet.honeybadger`: add notifications to Honeybadger
 * `Bullet.bugsnag`: add notifications to bugsnag
-* `Bullet.airbrake`: add notifications to airbrake
 * `Bullet.appsignal`: add notifications to AppSignal
+* `Bullet.airbrake`: add notifications to airbrake
 * `Bullet.rollbar`: add notifications to rollbar
-* `Bullet.sentry`: add notifications to sentry
 * `Bullet.add_footer`: adds the details in the bottom left corner of the page. Double click the footer or use close button to hide footer.
+* `Bullet.footer_position`: position of the footer on the page. Valid values are 'bottom_left' (default), 'bottom_right', 'top_left', or 'top_right'. This is useful when the default position clashes with browser UI elements like Chrome's URL preview.
 * `Bullet.skip_html_injection`: prevents Bullet from injecting code into the returned HTML. This must be false for receiving alerts, showing the footer or console logging.
 * `Bullet.skip_http_headers`: don't add headers to API requests, and remove the javascript that relies on them. Note that this prevents bullet from logging warnings to the browser console or updating the footer.
 * `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
@@ -134,23 +139,34 @@ Bullet.add_safelist :type => :unused_eager_loading, :class_name => "Post", :asso
 Bullet.add_safelist :type => :counter_cache, :class_name => "Country", :association => :cities
 ```
 
+## Skip Bullet in specific actions
+
 If you want to skip bullet in some specific controller actions, you can
-do like
+use `Bullet.skip`, which is thread-safe and works correctly in multi-threaded
+environments like Puma.
 
 ```ruby
 class ApplicationController < ActionController::Base
   around_action :skip_bullet, if: -> { defined?(Bullet) }
 
   def skip_bullet
-    previous_value = Bullet.enable?
-    Bullet.enable = false
-    yield
-  ensure
-    Bullet.enable = previous_value
+    Bullet.skip { yield }
   end
 end
 ```
 
+For more granular control, you can also use `Bullet.pause` and `Bullet.resume`:
+
+```ruby
+Bullet.pause   # Temporarily disable detection for current thread
+Bullet.resume  # Re-enable detection for current thread
+Bullet.paused? # Check if detection is paused for current thread
+```
+
+**Note**: Do not toggle `Bullet.enable` at runtime, as it modifies a global
+flag that is not thread-safe. Use `Bullet.skip`, `Bullet.pause`, or
+`Bullet.start_request`/`Bullet.end_request` instead.
+
 ## Log
 
 The Bullet log `log/bullet.log` will look something like this:
@@ -256,6 +272,8 @@ config.after_initialize do
 end
 ```
 
+**Note:** Controller and integration tests work automatically because Bullet's Rack middleware wraps each HTTP request with `Bullet.start_request` and `Bullet.end_request`. However, model tests and other tests that don't go through the Rack middleware (like direct model method calls) require manual wrapping with the test helper code below.
+
 Then wrap each test in the Bullet api.
 
 With RSpec:

data/lib/bullet/active_record70.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 
@@ -232,13 +246,13 @@ module Bullet
 
           def empty?
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
             super
           end
 
           def include?(object)
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations) if Bullet.start?
             super
           end
         end
@@ -280,11 +294,10 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.prepend(
         Module.new do
           def empty?
-            result = super
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
-            result
+            super
           end
 
           def count_records
@@ -307,7 +320,8 @@ module Bullet
               )
               Bullet::Detector::NPlusOneQuery.call_association(
                 proxy_association.owner,
-                proxy_association.reflection.name
+                proxy_association.reflection.name,
+                caller_locations
               )
             end
             super(column_name)

data/lib/bullet/active_record71.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 
@@ -232,13 +246,13 @@ module Bullet
 
           def empty?
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
             super
           end
 
           def include?(object)
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations) if Bullet.start?
             super
           end
         end
@@ -280,11 +294,10 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.prepend(
         Module.new do
           def empty?
-            result = super
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
-            result
+            super
           end
 
           def count_records
@@ -307,7 +320,8 @@ module Bullet
               )
               Bullet::Detector::NPlusOneQuery.call_association(
                 proxy_association.owner,
-                proxy_association.reflection.name
+                proxy_association.reflection.name,
+                caller_locations
               )
             end
             super(column_name)

data/lib/bullet/active_record72.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 
@@ -232,13 +246,13 @@ module Bullet
 
           def empty?
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
             super
           end
 
           def include?(object)
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations) if Bullet.start?
             super
           end
         end
@@ -280,11 +294,10 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.prepend(
         Module.new do
           def empty?
-            result = super
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
-            result
+            super
           end
 
           def count_records
@@ -307,7 +320,8 @@ module Bullet
               )
               Bullet::Detector::NPlusOneQuery.call_association(
                 proxy_association.owner,
-                proxy_association.reflection.name
+                proxy_association.reflection.name,
+                caller_locations
               )
             end
             super(column_name)

data/lib/bullet/active_record80.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 
@@ -232,13 +246,13 @@ module Bullet
 
           def empty?
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
             super
           end
 
           def include?(object)
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations) if Bullet.start?
             super
           end
         end
@@ -280,11 +294,10 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.prepend(
         Module.new do
           def empty?
-            result = super
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
-            result
+            super
           end
 
           def count_records
@@ -307,7 +320,8 @@ module Bullet
               )
               Bullet::Detector::NPlusOneQuery.call_association(
                 proxy_association.owner,
-                proxy_association.reflection.name
+                proxy_association.reflection.name,
+                caller_locations
               )
             end
             super(column_name)

data/lib/bullet/{active_record60.rb → active_record81.rb}

@@ -16,8 +16,8 @@ module Bullet
       require 'active_record'
       ::ActiveRecord::Base.extend(
         Module.new do
-          def find_by_sql(sql, binds = [], preparable: nil, &block)
-            result = super
+          def find_by_sql(*args, **kwargs, &block)
+            result = super(*args, **kwargs, &block)
             if Bullet.start?
               if result.is_a? Array
                 if result.size > 1
@@ -61,25 +61,32 @@ module Bullet
         end
       )
 
-      ::ActiveRecord::Associations::Preloader.prepend(
+      ::ActiveRecord::Associations::Preloader::Batch.prepend(
         Module.new do
-          def preloaders_for_one(association, records, scope, polymorphic_parent)
+          def call
             if Bullet.start?
-              records.compact!
-              if records.first.class.name !~ /^HABTM_/
-                records.each { |record| Bullet::Detector::Association.add_object_associations(record, association) }
-                Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+              @preloaders.each do |preloader|
+                preloader.records.each { |record|
+                  Bullet::Detector::Association.add_object_associations(record, preloader.associations)
+                }
+                Bullet::Detector::UnusedEagerLoading.add_eager_loadings(preloader.records, preloader.associations)
               end
             end
             super
           end
+        end
+      )
 
-          def preloaders_for_reflection(reflection, records, scope)
+      ::ActiveRecord::Associations::Preloader::Branch.prepend(
+        Module.new do
+          def preloaders_for_reflection(reflection, reflection_records)
             if Bullet.start?
-              records.compact!
-              if records.first.class.name !~ /^HABTM_/
-                records.each { |record| Bullet::Detector::Association.add_object_associations(record, reflection.name) }
-                Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, reflection.name)
+              reflection_records.compact!
+              if reflection_records.first.class.name !~ /^HABTM_/
+                reflection_records.each { |record|
+                  Bullet::Detector::Association.add_object_associations(record, reflection.name)
+                }
+                Bullet::Detector::UnusedEagerLoading.add_eager_loadings(reflection_records, reflection.name)
               end
             end
             super
@@ -89,25 +96,41 @@ module Bullet
 
       ::ActiveRecord::Associations::Preloader::ThroughAssociation.prepend(
         Module.new do
-          def preloaded_records
-            if Bullet.start? && !defined?(@preloaded_records)
-              source_preloaders.each do |source_preloader|
-                reflection_name = source_preloader.send(:reflection).name
-                source_preloader.send(:owners).each do |owner|
+          def source_preloaders
+            if Bullet.start? && !defined?(@source_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
                 end
               end
+            else
+              super
+            end
+          end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
             end
-            super
           end
         end
       )
 
       ::ActiveRecord::Associations::JoinDependency.prepend(
         Module.new do
-          def instantiate(result_set, &block)
+          def instantiate(*args, **kwargs, &block)
             @bullet_eager_loadings = {}
-            records = super
+            records = super(*args, **kwargs, &block)
 
             if Bullet.start?
               @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
@@ -121,7 +144,8 @@ module Bullet
             records
           end
 
-          def construct(ar_parent, parent, row, seen, model_cache)
+          def construct(*args, **kwargs, &block)
+            ar_parent, parent, row = args
             if Bullet.start?
               unless ar_parent.nil?
                 parent.children.each do |node|
@@ -144,12 +168,13 @@ module Bullet
               end
             end
 
-            super
+            super(*args, **kwargs, &block)
           end
 
           # call join associations
-          def construct_model(record, node, row, model_cache, id)
-            result = super
+          def construct_model(*args, **kwargs, &block)
+            record, node = args
+            result = super(*args, **kwargs, &block)
 
             if Bullet.start?
               associations = [node.reflection.name]
@@ -178,6 +203,13 @@ module Bullet
             end
             super
           end
+
+          def inversed_from_queries(record)
+            if Bullet.start? && inversable?(record)
+              Bullet::Detector::NPlusOneQuery.add_inversed_object(owner, reflection.name)
+            end
+            super
+          end
         end
       )
 
@@ -200,7 +232,7 @@ module Bullet
                   end
                 end
               end
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
               if records.first.class.name !~ /^HABTM_/
                 if records.size > 1
                   Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
@@ -216,13 +248,13 @@ module Bullet
 
           def empty?
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
             super
           end
 
           def include?(object)
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations) if Bullet.start?
             super
           end
         end
@@ -231,11 +263,11 @@ module Bullet
       ::ActiveRecord::Associations::SingularAssociation.prepend(
         Module.new do
           # call has_one and belongs_to associations
-          def target
-            result = super()
+          def reader
+            result = super
 
             if Bullet.start?
-              if owner.class.name !~ /^HABTM_/ && !@inversed
+              if owner.class.name !~ /^HABTM_/
                 if is_a? ::ActiveRecord::Associations::ThroughAssociation
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                   association = owner.association(reflection.through_reflection.name)
@@ -264,11 +296,10 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.prepend(
         Module.new do
           def empty?
-            result = super
             if Bullet.start? && !reflection.has_cached_counter?
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name, caller_locations)
             end
-            result
+            super
           end
 
           def count_records
@@ -291,7 +322,8 @@ module Bullet
               )
               Bullet::Detector::NPlusOneQuery.call_association(
                 proxy_association.owner,
-                proxy_association.reflection.name
+                proxy_association.reflection.name,
+                caller_locations
               )
             end
             super(column_name)