bullet 6.0.0 → 6.1.0

data/lib/bullet/active_record60.rb

@@ -13,233 +13,255 @@ module Bullet
   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)
+      ::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
-            elsif result.is_a? ::ActiveRecord::Base
-              Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
-              Bullet::Detector::CounterCache.add_impossible_object(result)
             end
+            result
           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)
+      ::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
-          result
         end
-      end)
-
-      ::ActiveRecord::Associations::Preloader.prepend(Module.new do
-        def preloaders_for_one(association, records, scope, polymorphic_parent)
-          if Bullet.start?
-            records.compact!
-            if records.first.class.name !~ /^HABTM_/
-              records.each do |record|
-                Bullet::Detector::Association.add_object_associations(record, association)
+      )
+
+      ::ActiveRecord::Associations::Preloader.prepend(
+        Module.new do
+          def preloaders_for_one(association, records, scope, polymorphic_parent)
+            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)
               end
-              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
             end
+            super
           end
-          super
-        end
 
-        def preloaders_for_reflection(reflection, records, scope)
-          if Bullet.start?
-            records.compact!
-            if records.first.class.name !~ /^HABTM_/
-              records.each do |record|
-                Bullet::Detector::Association.add_object_associations(record, reflection.name)
+          def preloaders_for_reflection(reflection, records, scope)
+            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)
               end
-              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, reflection.name)
             end
+            super
           end
-          super
         end
-      end)
-
-      ::ActiveRecord::FinderMethods.prepend(Module.new do
-        # add includes in scope
-        def find_with_associations
-          return super { |r| yield r } if block_given?
+      )
 
-          records = super
-          if Bullet.start?
-            associations = (eager_load_values + includes_values).uniq
-            records.each do |record|
-              Bullet::Detector::Association.add_object_associations(record, associations)
+      ::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
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
+            super
           end
-          records
         end
-      end)
+      )
 
-      ::ActiveRecord::Associations::JoinDependency.prepend(Module.new do
-        def instantiate(result_set, &block)
-          @bullet_eager_loadings = {}
-          records = super
+      ::ActiveRecord::FinderMethods.prepend(
+        Module.new do
+          # add includes in scope
+          def find_with_associations
+            return super { |r| yield r } if block_given?
 
-          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)
+            records = super
+            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
-          records
         end
+      )
 
-        def construct(ar_parent, parent, row, seen, model_cache)
-          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
+      ::ActiveRecord::Associations::JoinDependency.prepend(
+        Module.new do
+          def instantiate(result_set, &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
 
-          super
-        end
+          def construct(ar_parent, parent, row, seen, model_cache)
+            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?
 
-        # call join associations
-        def construct_model(record, node, row, model_cache, id)
-          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
+                  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
 
-          result
+          # call join associations
+          def construct_model(record, node, row, model_cache, id)
+            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
-      end)
-
-      ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new do
-        def load_target
-          records = super
-
-          if Bullet.start?
-            if is_a? ::ActiveRecord::Associations::ThroughAssociation
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
-              association = owner.association reflection.through_reflection.name
-              Array(association.target).each do |through_record|
-                Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
-              end
+      )
+
+      ::ActiveRecord::Associations::CollectionAssociation.prepend(
+        Module.new do
+          def load_target
+            records = super
 
-              if reflection.through_reflection != through_reflection
-                Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+            if Bullet.start?
+              if is_a? ::ActiveRecord::Associations::ThroughAssociation
+                Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
+                association = owner.association(reflection.through_reflection.name)
+                Array(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
-            end
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
-            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)
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
+              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
-          records
-        end
 
-        def empty?
-          if Bullet.start? && !reflection.has_cached_counter?
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          def empty?
+            if Bullet.start? && !reflection.has_cached_counter?
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+            end
+            super
           end
-          super
-        end
 
-        def include?(object)
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          def include?(object)
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
+            super
           end
-          super
         end
-      end)
-
-      ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new do
-        # call has_one and belongs_to associations
-        def target
-          result = super()
-          if Bullet.start?
-            if owner.class.name !~ /^HABTM_/ && !@inversed
-              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
+      )
+
+      ::ActiveRecord::Associations::SingularAssociation.prepend(
+        Module.new do
+          # call has_one and belongs_to associations
+          def target
+            result = super()
+
+            if Bullet.start?
+              if owner.class.name !~ /^HABTM_/ && !@inversed
+                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
-          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)
+      ::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
-          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)
+          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
-          super
-        end
-      end)
-
-      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
-        def writer(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          super
         end
-      end)
+      )
     end
   end
 end

data/lib/bullet/bullet_xhr.js

@@ -1,37 +1,42 @@
 (function() {
   var oldOpen = window.XMLHttpRequest.prototype.open;
   var oldSend = window.XMLHttpRequest.prototype.send;
-  function newOpen(method, url, async, user, password) {
+
+  /**
+   * 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 oldOpen.apply(this, arguments);
   }
-  function newSend(data) {
+  function bulletXHRSend() {
     if (this.onload) {
       this._storedOnload = this.onload;
     }
-    this.onload = newOnload;
+    this.addEventListener('load', bulletXHROnload);
     return oldSend.apply(this, arguments);
   }
-  function newOnload() {
+  function bulletXHROnload() {
     if (
-      this._storedUrl.startsWith(
-        window.location.protocol + '//' + window.location.host,
-      ) ||
+      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(() => {
-          var oldHtml = document
-            .getElementById('bullet-footer')
-            .innerHTML.split('<br>');
+          var oldHtml = document.getElementById('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.getElementById(
-            'bullet-footer',
-          ).innerHTML = `${header}<br>${newHtml.join('<br>')}`;
+          document.getElementById('bullet-footer').innerHTML = `${header}<br>${newHtml.join('<br>')}`;
         }, 0);
       }
       var bulletConsoleText = this.getResponseHeader('X-bullet-console-text');
@@ -53,6 +58,6 @@
       return this._storedOnload.apply(this, arguments);
     }
   }
-  window.XMLHttpRequest.prototype.open = newOpen;
-  window.XMLHttpRequest.prototype.send = newSend;
+  window.XMLHttpRequest.prototype.open = bulletXHROpen;
+  window.XMLHttpRequest.prototype.send = bulletXHRSend;
 })();