bullet 5.9.0 → 7.0.4

data/lib/bullet/active_record70.rb

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+module Bullet
+  module SaveWithBulletSupport
+    def _create_record(*)
+      super do
+        Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+        yield(self) if block_given?
+      end
+    end
+  end
+
+  module ActiveRecord
+    def self.enable
+      require 'active_record'
+      ::ActiveRecord::Base.extend(
+        Module.new do
+          def find_by_sql(sql, binds = [], preparable: nil, &block)
+            result = super
+            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
+      )
+
+      ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
+
+      ::ActiveRecord::Relation.prepend(
+        Module.new do
+          # 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 records
+            result = super
+            if Bullet.start?
+              if result.first.class.name !~ /^HABTM_/
+                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
+              end
+            end
+            result
+          end
+        end
+      )
+
+      ::ActiveRecord::Associations::Preloader::Batch.prepend(
+        Module.new do
+          def call
+            if Bullet.start?
+              @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
+      )
+
+      ::ActiveRecord::Associations::Preloader::Branch.prepend(
+        Module.new do
+          def preloaders_for_reflection(reflection, reflection_records)
+            if Bullet.start?
+              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
+          end
+        end
+      )
+
+      ::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|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            end
+            super
+          end
+        end
+      )
+
+      ::ActiveRecord::Associations::JoinDependency.prepend(
+        Module.new do
+          def instantiate(result_set, strict_loading_value, &block)
+            @bullet_eager_loadings = {}
+            records = super
+
+            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
+
+          def construct(ar_parent, parent, row, seen, model_cache, strict_loading_value)
+            if Bullet.start?
+              unless ar_parent.nil?
+                parent.children.each do |node|
+                  key = aliases.column_alias(node, node.primary_key)
+                  id = row[key]
+                  next unless id.nil?
+
+                  associations = node.reflection.name
+                  Bullet::Detector::Association.add_object_associations(ar_parent, associations)
+                  Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
+                  @bullet_eager_loadings[ar_parent.class] ||= {}
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
+                end
+              end
+            end
+
+            super
+          end
+
+          # call join associations
+          def construct_model(record, node, row, model_cache, id, strict_loading_value)
+            result = super
+
+            if Bullet.start?
+              associations = node.reflection.name
+              Bullet::Detector::Association.add_object_associations(record, associations)
+              Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+              @bullet_eager_loadings[record.class] ||= {}
+              @bullet_eager_loadings[record.class][record] ||= Set.new
+              @bullet_eager_loadings[record.class][record] << associations
+            end
+
+            result
+          end
+        end
+      )
+
+      ::ActiveRecord::Associations::Association.prepend(
+        Module.new do
+          def inversed_from(record)
+            if Bullet.start?
+              Bullet::Detector::NPlusOneQuery.add_inversed_object(owner, reflection.name)
+            end
+            super
+          end
+        end
+      )
+
+      ::ActiveRecord::Associations::CollectionAssociation.prepend(
+        Module.new do
+          def load_target
+            records = super
+
+            if Bullet.start?
+              if is_a? ::ActiveRecord::Associations::ThroughAssociation
+                association = owner.association(reflection.through_reflection.name)
+                if association.loaded?
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
+                  Array.wrap(association.target).each do |through_record|
+                    Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
+                  end
+                end
+
+                if reflection.through_reflection != through_reflection
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+                end
+              end
+              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)
+                  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
+            end
+            records
+          end
+
+          def empty?
+            if Bullet.start? && !reflection.has_cached_counter?
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+            end
+            super
+          end
+
+          def include?(object)
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            super
+          end
+        end
+      )
+
+      ::ActiveRecord::Associations::SingularAssociation.prepend(
+        Module.new do
+          # call has_one and belongs_to associations
+          def reader
+            result = super
+
+            if Bullet.start?
+              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)
+                  Array.wrap(association.target).each do |through_record|
+                    Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
+                  end
+
+                  if reflection.through_reflection != through_reflection
+                    Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+                  end
+                end
+                Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+
+                if Bullet::Detector::NPlusOneQuery.impossible?(owner)
+                  Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+                else
+                  Bullet::Detector::NPlusOneQuery.add_possible_objects(result) if result
+                end
+              end
+            end
+            result
+          end
+        end
+      )
+
+      ::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)
+            end
+            result
+          end
+
+          def count_records
+            result = reflection.has_cached_counter?
+            if Bullet.start? && !result && !is_a?(::ActiveRecord::Associations::ThroughAssociation)
+              Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+            end
+            super
+          end
+        end
+      )
+    end
+  end
+end

data/lib/bullet/bullet_xhr.js

@@ -0,0 +1,64 @@
+(function () {
+  var oldOpen = window.XMLHttpRequest.prototype.open;
+  var oldSend = window.XMLHttpRequest.prototype.send;
+
+  /**
+   * Return early if we've already extended prototype. This prevents
+   * "maximum call stack exceeded" errors when used with Turbolinks.
+   * See https://github.com/flyerhzm/bullet/issues/454
+   */
+  if (isBulletInitiated()) return;
+
+  function isBulletInitiated() {
+    return oldOpen.name == "bulletXHROpen" && oldSend.name == "bulletXHRSend";
+  }
+  function bulletXHROpen(_, url) {
+    this._storedUrl = url;
+    return Reflect.apply(oldOpen, this, arguments);
+  }
+  function bulletXHRSend() {
+    if (this.onload) {
+      this._storedOnload = this.onload;
+    }
+    this.onload = null;
+    this.addEventListener("load", bulletXHROnload);
+    return Reflect.apply(oldSend, this, arguments);
+  }
+  function bulletXHROnload() {
+    if (
+      this._storedUrl.startsWith(window.location.protocol + "//" + window.location.host) ||
+      !this._storedUrl.startsWith("http") // For relative paths
+    ) {
+      var bulletFooterText = this.getResponseHeader("X-bullet-footer-text");
+      if (bulletFooterText) {
+        setTimeout(function () {
+          var oldHtml = document.querySelector("#bullet-footer").innerHTML.split("<br>");
+          var header = oldHtml[0];
+          oldHtml = oldHtml.slice(1, oldHtml.length);
+          var newHtml = oldHtml.concat(JSON.parse(bulletFooterText));
+          newHtml = newHtml.slice(newHtml.length - 10, newHtml.length); // rotate through 10 most recent
+          document.querySelector("#bullet-footer").innerHTML = `${header}<br>${newHtml.join("<br>")}`;
+        }, 0);
+      }
+      var bulletConsoleText = this.getResponseHeader("X-bullet-console-text");
+      if (bulletConsoleText && typeof console !== "undefined" && console.log) {
+        setTimeout(function () {
+          JSON.parse(bulletConsoleText).forEach((message) => {
+            if (console.groupCollapsed && console.groupEnd) {
+              console.groupCollapsed("Uniform Notifier");
+              console.log(message);
+              console.groupEnd();
+            } else {
+              console.log(message);
+            }
+          });
+        }, 0);
+      }
+    }
+    if (this._storedOnload) {
+      return Reflect.apply(this._storedOnload, this, arguments);
+    }
+  }
+  window.XMLHttpRequest.prototype.open = bulletXHROpen;
+  window.XMLHttpRequest.prototype.send = bulletXHRSend;
+})();

data/lib/bullet/dependency.rb

@@ -3,51 +3,55 @@
 module Bullet
   module Dependency
     def mongoid?
-      @mongoid ||= defined? ::Mongoid
+      @mongoid ||= defined?(::Mongoid)
     end
 
     def active_record?
-      @active_record ||= defined? ::ActiveRecord
-    end
-
-    def rails?
-      @rails ||= defined? ::Rails
+      @active_record ||= defined?(::ActiveRecord)
     end
 
     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'
-                                   else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
-                                   end
-                                 end
+      @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'
+          elsif active_record70?
+            'active_record70'
+          else
+            raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
+          end
+        end
     end
 
     def mongoid_version
-      @mongoid_version ||= begin
-                             if mongoid4x?
-                               'mongoid4x'
-                             elsif mongoid5x?
-                               'mongoid5x'
-                             elsif mongoid6x?
-                               'mongoid6x'
-                             elsif mongoid7x?
-                               'mongoid7x'
-                             else
-                               raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
-                             end
-                           end
+      @mongoid_version ||=
+        begin
+          if mongoid4x?
+            'mongoid4x'
+          elsif mongoid5x?
+            'mongoid5x'
+          elsif mongoid6x?
+            'mongoid6x'
+          elsif mongoid7x?
+            'mongoid7x'
+          else
+            raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
+          end
+        end
     end
 
     def active_record4?
@@ -58,6 +62,14 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 5
     end
 
+    def active_record6?
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    end
+
+    def active_record7?
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 7
+    end
+
     def active_record40?
       active_record4? && ::ActiveRecord::VERSION::MINOR == 0
     end
@@ -82,6 +94,18 @@ module Bullet
       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
+
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end

data/lib/bullet/detector/association.rb

@@ -3,22 +3,28 @@
 module Bullet
   module Detector
     class Association < Base
-      class <<self
+      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 object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::Association#add_object_associations',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           object_associations.add(object.bullet_key, associations)
         end
 
         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 object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_call_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::Association#add_call_object_associations',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           call_object_associations.add(object.bullet_key, associations)
         end
 
@@ -40,33 +46,33 @@ module Bullet
 
         private
 
-          # object_associations keep the object relationships
-          # that the object has many associations.
-          # e.g. { "Post:1" => [:comments] }
-          # the object_associations keep all associations that may be or may no be
-          # unpreload associations or unused preload associations.
+        # object_associations keep the object relationships
+        # that the object has many associations.
+        # e.g. { "Post:1" => [:comments] }
+        # the object_associations keep all associations that may be or may no be
+        # unpreload associations or unused preload associations.
         def object_associations
           Thread.current[:bullet_object_associations]
         end
 
-          # call_object_associations keep the object relationships
-          # that object.associations is called.
-          # e.g. { "Post:1" => [:comments] }
-          # they are used to detect unused preload associations.
+        # call_object_associations keep the object relationships
+        # that object.associations is called.
+        # e.g. { "Post:1" => [:comments] }
+        # they are used to detect unused preload associations.
         def call_object_associations
           Thread.current[:bullet_call_object_associations]
         end
 
-          # inversed_objects keeps object relationships
-          # that association is inversed.
-          # e.g. { "Comment:1" => ["post"] }
+        # inversed_objects keeps object relationships
+        # that association is inversed.
+        # e.g. { "Comment:1" => ["post"] }
         def inversed_objects
           Thread.current[:bullet_inversed_objects]
         end
 
-          # eager_loadings keep the object relationships
-          # that the associations are preloaded by find :include.
-          # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
+        # eager_loadings keep the object relationships
+        # that the associations are preloaded by find :include.
+        # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
         def eager_loadings
           Thread.current[:bullet_eager_loadings]
         end

data/lib/bullet/detector/counter_cache.rb

@@ -3,33 +3,37 @@
 module Bullet
   module Detector
     class CounterCache < Base
-      class <<self
+      class << self
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::CounterCache#add_counter_cache', "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object, associations)
-            create_notification object.class.to_s, associations
-          end
+          Bullet.debug(
+            'Detector::CounterCache#add_counter_cache',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
+          create_notification object.class.to_s, associations if conditions_met?(object, associations)
         end
 
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
-          objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          objects = Array.wrap(object_or_objects)
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::CounterCache#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug(
+            'Detector::CounterCache#add_possible_objects',
+            "objects: #{objects.map(&:bullet_key).join(', ')}"
+          )
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::CounterCache#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
@@ -50,7 +54,7 @@ module Bullet
         private
 
         def create_notification(klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:counter_cache, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::CounterCache.new klazz, notify_associations