bullet 8.0.8 → 8.2.0

data/lib/bullet/dependency.rb

@@ -13,22 +13,8 @@ module Bullet
     def active_record_version
       @active_record_version ||=
         begin
-          if active_record40?
-            'active_record4'
-          elsif active_record41?
-            'active_record41'
-          elsif active_record42?
-            'active_record42'
-          elsif active_record50?
-            'active_record5'
-          elsif active_record51?
-            'active_record5'
-          elsif active_record52?
-            'active_record52'
-          elsif active_record60?
-            'active_record60'
-          elsif active_record61?
-            'active_record61'
+          if active_record6_or_older?
+            raise "Bullet no longer supports active_record #{::ActiveRecord::VERSION::STRING}"
           elsif active_record70?
             'active_record70'
           elsif active_record71?
@@ -37,6 +23,8 @@ module Bullet
             'active_record72'
           elsif active_record80?
             'active_record80'
+          elsif active_record81?
+            'active_record81'
           else
             raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
           end
@@ -64,16 +52,8 @@ module Bullet
         end
     end
 
-    def active_record4?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 4
-    end
-
-    def active_record5?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 5
-    end
-
-    def active_record6?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    def active_record6_or_older?
+      active_record? && ::ActiveRecord::VERSION::MAJOR < 7
     end
 
     def active_record7?
@@ -84,38 +64,6 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 8
     end
 
-    def active_record40?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record41?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
-    def active_record42?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 2
-    end
-
-    def active_record50?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record51?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
-    def active_record52?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 2
-    end
-
-    def active_record60?
-      active_record6? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record61?
-      active_record6? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
     def active_record70?
       active_record7? && ::ActiveRecord::VERSION::MINOR == 0
     end
@@ -132,6 +80,10 @@ module Bullet
       active_record8? && ::ActiveRecord::VERSION::MINOR == 0
     end
 
+    def active_record81?
+      active_record8? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end

data/lib/bullet/detector/association.rb

@@ -8,7 +8,7 @@ module Bullet
       class << self
         def add_object_associations(object, associations)
           return unless Bullet.start?
-          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
           Bullet.debug(
@@ -21,7 +21,7 @@ module Bullet
 
         def add_call_object_associations(object, associations)
           return unless Bullet.start?
-          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
           Bullet.debug(

data/lib/bullet/detector/n_plus_one_query.rb

@@ -13,13 +13,19 @@ module Bullet
         # first, it keeps this method call for object.association.
         # then, it checks if this associations call is unpreload.
         #   if it is, keeps this unpreload associations and caller.
-        def call_association(object, associations)
+        def call_association(object, associations, caller_stack = nil, inversed: false)
           return unless Bullet.start?
-          return unless Bullet.n_plus_one_query_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
-          return if inversed_objects.include?(object.bullet_key, associations)
 
+          # Record before early-returns so legitimate reads that bypass SQL
+          # (inversed, nil-polymorphic) aren't flagged as unused preloads.
           add_call_object_associations(object, associations)
+          call_stacks.add(object.bullet_key, caller_stack) if caller_stack
+
+          return if inversed
+          return if inversed_objects.include?(object.bullet_key, associations)
+          return if optional_polymorphic_belongs_to_with_nil_type?(object, associations)
 
           Bullet.debug(
             'Detector::NPlusOneQuery#call_association',
@@ -115,6 +121,19 @@ module Bullet
 
         private
 
+        def optional_polymorphic_belongs_to_with_nil_type?(object, associations)
+          return false unless associations.is_a?(Symbol) || associations.is_a?(String)
+          return false unless object.class.respond_to?(:reflect_on_association)
+
+          reflection = object.class.reflect_on_association(associations.to_sym)
+          return false unless reflection
+          return false unless reflection.respond_to?(:polymorphic?) && reflection.polymorphic?
+          return false unless reflection.respond_to?(:foreign_type)
+
+          foreign_type = reflection.foreign_type
+          foreign_type && object.respond_to?(:[]) && object[foreign_type].nil?
+        end
+
         def create_notification(callers, klazz, associations)
           notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:n_plus_one_query, klazz)
 

data/lib/bullet/detector/unused_eager_loading.rb

@@ -50,7 +50,7 @@ module Bullet
             if key_objects_overlap == k
               to_add << [k, associations]
             else
-              to_merge << [key_objects_overlap, (eager_loadings[k].dup << associations)]
+              to_merge << [key_objects_overlap, eager_loadings[k].dup.merge(Array.wrap(associations))]
 
               keys_without_objects = k - key_objects_overlap
               to_merge << [keys_without_objects, eager_loadings[k]]

data/lib/bullet/mongoid4x.rb

@@ -46,6 +46,8 @@ module Bullet
       ::Mongoid::Relations::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
           Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/

data/lib/bullet/mongoid5x.rb

@@ -46,6 +46,8 @@ module Bullet
       ::Mongoid::Relations::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
           Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/

data/lib/bullet/mongoid6x.rb

@@ -46,6 +46,8 @@ module Bullet
       ::Mongoid::Relations::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
           Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/

data/lib/bullet/mongoid7x.rb

@@ -61,6 +61,8 @@ module Bullet
       ::Mongoid::Association::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, association, object, reload = false)
           result = origin_get_relation(name, association, object, reload)
           Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?

data/lib/bullet/mongoid8x.rb

@@ -46,6 +46,8 @@ module Bullet
       ::Mongoid::Association::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, association, object, reload = false)
           result = origin_get_relation(name, association, object, reload)
           unless association.embedded?

data/lib/bullet/mongoid9x.rb

@@ -61,6 +61,8 @@ module Bullet
       ::Mongoid::Association::Accessors.class_eval do
         alias_method :origin_get_relation, :get_relation
 
+        private
+
         def get_relation(name, association, object, reload = false)
           result = origin_get_relation(name, association, object, reload)
           Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?

data/lib/bullet/rack.rb

@@ -76,8 +76,9 @@ module Bullet
 
     # Make footer styles work with ContentSecurityPolicy style-src as self
     def footer_style(nonce = nil)
+      position_css = footer_position_css
       css = <<~CSS
-        details#bullet-footer {cursor: pointer; position: fixed; left: 0px; bottom: 0px; z-index: 9999; background: #fdf2f2; color: #9b1c1c; font-size: 12px; border-radius: 0px 8px 0px 0px; border: 1px solid #9b1c1c;}
+        details#bullet-footer {cursor: pointer; position: fixed; #{position_css}; z-index: 9999; background: #fdf2f2; color: #9b1c1c; font-size: 12px; #{footer_border_radius}; border: 1px solid #9b1c1c;}
         details#bullet-footer summary {font-weight: 600; padding: 2px 8px;}
         details#bullet-footer div {padding: 8px; border-top: 1px solid #9b1c1c;}
       CSS
@@ -88,6 +89,38 @@ module Bullet
       end
     end
 
+    private
+
+    def footer_position_css
+      case Bullet.footer_position
+      when 'bottom_left'
+        'left: 0px; bottom: 0px'
+      when 'bottom_right'
+        'right: 0px; bottom: 0px'
+      when 'top_left'
+        'left: 0px; top: 0px'
+      when 'top_right'
+        'right: 0px; top: 0px'
+      else
+        'left: 0px; bottom: 0px'
+      end
+    end
+
+    def footer_border_radius
+      case Bullet.footer_position
+      when 'bottom_left'
+        'border-radius: 0px 8px 0px 0px'
+      when 'bottom_right'
+        'border-radius: 8px 0px 0px 0px'
+      when 'top_left'
+        'border-radius: 0px 0px 8px 0px'
+      when 'top_right'
+        'border-radius: 0px 0px 0px 8px'
+      else
+        'border-radius: 0px 8px 0px 0px'
+      end
+    end
+
     def set_header(headers, header_name, header_array)
       # Many proxy applications such as Nginx and AWS ELB limit
       # the size a header to 8KB, so truncate the list of reports to
@@ -123,7 +156,7 @@ module Bullet
     end
 
     def html_request?(headers, response)
-      headers['Content-Type']&.include?('text/html')
+      headers['Content-Type']&.include?('text/html') || false
     end
 
     def response_body(response)

data/lib/bullet/registry/call_stack.rb

@@ -4,8 +4,13 @@ module Bullet
   module Registry
     class CallStack < Base
       # remembers found association backtrace
-      def add(key)
-        @registry[key] ||= Thread.current.backtrace
+      # if backtrace is provided, it will be used and override any existing value
+      def add(key, backtrace = nil)
+        if backtrace
+          @registry[key] = backtrace
+        else
+          @registry[key] ||= Thread.current.backtrace
+        end
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '8.0.8'
+  VERSION = '8.2.0'
 end

data/lib/bullet.rb

@@ -42,6 +42,7 @@ module Bullet
                 :skip_html_injection
     attr_reader :safelist
     attr_accessor :add_footer,
+                  :footer_position,
                   :orm_patches_applied,
                   :skip_http_headers,
                   :always_append_html_body,
@@ -123,7 +124,7 @@ module Bullet
     end
 
     def get_safelist_associations(type, class_name)
-      Array.wrap(@safelist[type][class_name])
+      Array.wrap(@safelist[type][class_name]).flat_map { |a| [a, a.to_s] }
     end
 
     def reset_safelist
@@ -188,6 +189,26 @@ module Bullet
       enable? && Thread.current.thread_variable_get(:bullet_start)
     end
 
+    def pause
+      Thread.current.thread_variable_set(:bullet_start, false)
+    end
+
+    def resume
+      Thread.current.thread_variable_set(:bullet_start, true)
+    end
+
+    def paused?
+      enable? && !Thread.current.thread_variable_get(:bullet_start)
+    end
+
+    def skip
+      bullet_was_started = start?
+      pause if bullet_was_started
+      yield
+    ensure
+      resume if bullet_was_started
+    end
+
     def notification_collector
       Thread.current.thread_variable_get(:bullet_notification_collector)
     end
@@ -259,6 +280,10 @@ module Bullet
       UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
     end
 
+    def footer_position
+      @footer_position || 'bottom_left'
+    end
+
     def inject_into_page?
       return false if defined?(@skip_html_injection) && @skip_html_injection
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 8.0.8
+  version: 8.2.0
 platform: ruby
 authors:
 - Richard Huang
@@ -37,6 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: help to kill N+1 queries and unused eager loading.
 email:
 - flyerhzm@gmail.com
@@ -49,17 +77,11 @@ files:
 - README.md
 - lib/bullet.rb
 - lib/bullet/active_job.rb
-- lib/bullet/active_record4.rb
-- lib/bullet/active_record41.rb
-- lib/bullet/active_record42.rb
-- lib/bullet/active_record5.rb
-- lib/bullet/active_record52.rb
-- lib/bullet/active_record60.rb
-- lib/bullet/active_record61.rb
 - lib/bullet/active_record70.rb
 - lib/bullet/active_record71.rb
 - lib/bullet/active_record72.rb
 - lib/bullet/active_record80.rb
+- lib/bullet/active_record81.rb
 - lib/bullet/bullet_xhr.js
 - lib/bullet/dependency.rb
 - lib/bullet/detector.rb
@@ -112,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.
 test_files: []

data/lib/bullet/active_record4.rb

@@ -1,199 +0,0 @@
-# frozen_string_literal: true
-
-module Bullet
-  module ActiveRecord
-    def self.enable
-      require 'active_record'
-      ::ActiveRecord::Base.class_eval do
-        class << self
-          alias_method :origin_find_by_sql, :find_by_sql
-          def find_by_sql(sql, binds = [])
-            result = origin_find_by_sql(sql, binds)
-            if Bullet.start?
-              if result.is_a? Array
-                if result.size > 1
-                  Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-                  Bullet::Detector::CounterCache.add_possible_objects(result)
-                elsif result.size == 1
-                  Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
-                  Bullet::Detector::CounterCache.add_impossible_object(result.first)
-                end
-              elsif result.is_a? ::ActiveRecord::Base
-                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
-                Bullet::Detector::CounterCache.add_impossible_object(result)
-              end
-            end
-            result
-          end
-        end
-      end
-
-      ::ActiveRecord::Relation.class_eval do
-        alias_method :origin_to_a, :to_a
-        # if select a collection of objects, then these objects have possible to cause N+1 query.
-        # if select only one object, then the only one object has impossible to cause N+1 query.
-        def to_a
-          records = origin_to_a
-          if Bullet.start?
-            if records.size > 1
-              Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
-              Bullet::Detector::CounterCache.add_possible_objects(records)
-            elsif records.size == 1
-              Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
-              Bullet::Detector::CounterCache.add_impossible_object(records.first)
-            end
-          end
-          records
-        end
-      end
-
-      ::ActiveRecord::Persistence.class_eval do
-        def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap do
-            Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
-          end
-        end
-        alias_method_chain :_create_record, :bullet
-      end
-
-      ::ActiveRecord::Associations::Preloader.class_eval do
-        # include query for one to many associations.
-        # keep this eager loadings.
-        alias_method :origin_initialize, :initialize
-        def initialize(records, associations, preload_scope = nil)
-          origin_initialize(records, associations, preload_scope)
-
-          if Bullet.start?
-            records = [records].flatten.compact.uniq
-            return if records.empty?
-
-            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
-          end
-        end
-      end
-
-      ::ActiveRecord::FinderMethods.class_eval do
-        # add includes in scope
-        alias_method :origin_find_with_associations, :find_with_associations
-        def find_with_associations
-          records = origin_find_with_associations
-          if Bullet.start?
-            associations = (eager_load_values + includes_values).uniq
-            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
-          end
-          records
-        end
-      end
-
-      ::ActiveRecord::Associations::JoinDependency.class_eval do
-        alias_method :origin_instantiate, :instantiate
-        alias_method :origin_construct_association, :construct_association
-
-        def instantiate(rows)
-          @bullet_eager_loadings = {}
-          records = origin_instantiate(rows)
-
-          if Bullet.start?
-            @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
-              objects = eager_loadings_hash.keys
-              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(objects, eager_loadings_hash[objects.first].to_a)
-            end
-          end
-          records
-        end
-
-        # call join associations
-        def construct_association(record, join, row)
-          result = origin_construct_association(record, join, row)
-
-          if Bullet.start?
-            associations = [join.reflection.name]
-            if join.reflection.nested?
-              associations << join.reflection.through_reflection.name
-            end
-            associations.each do |association|
-              Bullet::Detector::Association.add_object_associations(record, association)
-              Bullet::Detector::NPlusOneQuery.call_association(record, association)
-              @bullet_eager_loadings[record.class] ||= {}
-              @bullet_eager_loadings[record.class][record] ||= Set.new
-              @bullet_eager_loadings[record.class][record] << association
-            end
-          end
-
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::CollectionAssociation.class_eval do
-        # call one to many associations
-        alias_method :origin_load_target, :load_target
-        def load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
-          origin_load_target
-        end
-
-        alias_method :origin_include?, :include?
-        def include?(object)
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
-          origin_include?(object)
-        end
-      end
-
-      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_empty?, :empty?
-        def empty?
-          if Bullet.start? && !loaded? && !has_cached_counter?(@reflection)
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
-          origin_empty?
-        end
-      end
-
-      ::ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
-        alias_method :origin_empty?, :empty?
-        def empty?
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start? && !loaded?
-          origin_empty?
-        end
-      end
-
-      ::ActiveRecord::Associations::SingularAssociation.class_eval do
-        # call has_one and belongs_to associations
-        alias_method :origin_reader, :reader
-        def reader(force_reload = false)
-          result = origin_reader(force_reload)
-          if Bullet.start?
-            unless @inversed
-              Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-              Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-            end
-          end
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_has_cached_counter?, :has_cached_counter?
-
-        def has_cached_counter?(reflection = reflection())
-          result = origin_has_cached_counter?(reflection)
-          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) if Bullet.start? && !result
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::CollectionProxy.class_eval do
-        def count(column_name = nil, options = {})
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(proxy_association.owner, proxy_association.reflection.name)
-            Bullet::Detector::NPlusOneQuery.call_association(proxy_association.owner, proxy_association.reflection.name)
-          end
-          super(column_name, options)
-        end
-      end
-    end
-  end
-end