bullet 5.8.1 → 6.1.0

data/lib/bullet/bullet_xhr.js

@@ -0,0 +1,63 @@
+(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 oldOpen.apply(this, arguments);
+  }
+  function bulletXHRSend() {
+    if (this.onload) {
+      this._storedOnload = this.onload;
+    }
+    this.addEventListener('load', bulletXHROnload);
+    return oldSend.apply(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(() => {
+          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>')}`;
+        }, 0);
+      }
+      var bulletConsoleText = this.getResponseHeader('X-bullet-console-text');
+      if (bulletConsoleText && typeof console !== 'undefined' && console.log) {
+        setTimeout(() => {
+          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 this._storedOnload.apply(this, arguments);
+    }
+  }
+  window.XMLHttpRequest.prototype.open = bulletXHROpen;
+  window.XMLHttpRequest.prototype.send = bulletXHRSend;
+})();

data/lib/bullet/dependency.rb

@@ -3,49 +3,51 @@
 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'
+          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'
-                             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?
@@ -56,6 +58,10 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 5
     end
 
+    def active_record6?
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    end
+
     def active_record40?
       active_record4? && ::ActiveRecord::VERSION::MINOR == 0
     end
@@ -80,6 +86,10 @@ module Bullet
       active_record5? && ::ActiveRecord::VERSION::MINOR == 2
     end
 
+    def active_record60?
+      active_record6? && ::ActiveRecord::VERSION::MINOR == 0
+    end
+
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
@@ -91,5 +101,9 @@ module Bullet
     def mongoid6x?
       mongoid? && ::Mongoid::VERSION =~ /\A6/
     end
+
+    def mongoid7x?
+      mongoid? && ::Mongoid::VERSION =~ /\A7/
+    end
   end
 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/base.rb

@@ -2,7 +2,6 @@
 
 module Bullet
   module Detector
-    class Base
-    end
+    class Base; end
   end
 end

data/lib/bullet/detector/counter_cache.rb

@@ -3,16 +3,17 @@
 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)
@@ -20,16 +21,19 @@ module Bullet
           return unless Bullet.counter_cache_enable?
 
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          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

data/lib/bullet/detector/n_plus_one_query.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # executed when object.assocations is called.
         # first, it keeps this method call for object.association.
         # then, it checks if this associations call is unpreload.
@@ -14,12 +14,15 @@ module Bullet
         def call_association(object, associations)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
           return if inversed_objects.include?(object.bullet_key, associations)
 
           add_call_object_associations(object, associations)
 
-          Bullet.debug('Detector::NPlusOneQuery#call_association', "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#call_association',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           if !excluded_stacktrace_path? && conditions_met?(object, associations)
             Bullet.debug('detect n + 1 query', "object: #{object.bullet_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
@@ -31,16 +34,19 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
 
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#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.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
@@ -49,9 +55,12 @@ module Bullet
         def add_inversed_object(object, association)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::NPlusOneQuery#add_inversed_object', "object: #{object.bullet_key}, association: #{association}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#add_inversed_object',
+            "object: #{object.bullet_key}, association: #{association}"
+          )
           inversed_objects.add object.bullet_key, association
         end
 
@@ -72,10 +81,11 @@ module Bullet
         def association?(object, associations)
           value = object_associations[object.bullet_key]
           value&.each do |v|
-              # associations == v comparison order is important here because
-              # v variable might be a squeel node where :== method is redefined,
-              # so it does not compare values at all and return unexpected results
-            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
+            # associations == v comparison order is important here because
+            # v variable might be a squeel node where :== method is redefined,
+            # so it does not compare values at all and return unexpected results
+            result =
+              v.is_a?(Hash) ? v.key?(associations) : associations == v
             return true if result
           end
 

data/lib/bullet/detector/unused_eager_loading.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # check if there are unused preload associations.
         #   get related_objects from eager_loadings associated with object and associations
         #   get call_object_association from associations of call_object_associations whose object is in related_objects
@@ -27,9 +27,12 @@ module Bullet
         def add_eager_loadings(objects, associations)
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::UnusedEagerLoading#add_eager_loadings', "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::UnusedEagerLoading#add_eager_loadings',
+            "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}"
+          )
           bullet_keys = objects.map(&:bullet_key)
 
           to_add = []

data/lib/bullet/ext/object.rb

@@ -2,10 +2,12 @@
 
 class Object
   def bullet_key
-    "#{self.class}:#{primary_key_value}"
+    "#{self.class}:#{bullet_primary_key_value}"
   end
 
-  def primary_key_value
+  def bullet_primary_key_value
+    return if respond_to?(:persisted?) && !persisted?
+
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
       self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key

data/lib/bullet/mongoid4x.rb

@@ -37,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -50,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end