bullet 6.1.0 → 7.1.6

data/lib/bullet/bullet_xhr.js

@@ -1,4 +1,4 @@
-(function() {
+(function () {
   var oldOpen = window.XMLHttpRequest.prototype.open;
   var oldSend = window.XMLHttpRequest.prototype.send;
 
@@ -10,41 +10,42 @@
   if (isBulletInitiated()) return;
 
   function isBulletInitiated() {
-    return oldOpen.name == 'bulletXHROpen' && oldSend.name == 'bulletXHRSend';
+    return oldOpen.name == "bulletXHROpen" && oldSend.name == "bulletXHRSend";
   }
   function bulletXHROpen(_, url) {
     this._storedUrl = url;
-    return oldOpen.apply(this, arguments);
+    return Reflect.apply(oldOpen, this, arguments);
   }
   function bulletXHRSend() {
     if (this.onload) {
       this._storedOnload = this.onload;
     }
-    this.addEventListener('load', bulletXHROnload);
-    return oldSend.apply(this, arguments);
+    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
+      this._storedUrl.startsWith(window.location.protocol + "//" + window.location.host) ||
+      !this._storedUrl.startsWith("http") // For relative paths
     ) {
-      var bulletFooterText = this.getResponseHeader('X-bullet-footer-text');
+      var bulletFooterText = this.getResponseHeader("X-bullet-footer-text");
       if (bulletFooterText) {
-        setTimeout(() => {
-          var oldHtml = document.getElementById('bullet-footer').innerHTML.split('<br>');
+        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.getElementById('bullet-footer').innerHTML = `${header}<br>${newHtml.join('<br>')}`;
+          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(() => {
-          JSON.parse(bulletConsoleText).forEach(message => {
+      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.groupCollapsed("Uniform Notifier");
               console.log(message);
               console.groupEnd();
             } else {
@@ -55,7 +56,7 @@
       }
     }
     if (this._storedOnload) {
-      return this._storedOnload.apply(this, arguments);
+      return Reflect.apply(this._storedOnload, this, arguments);
     }
   }
   window.XMLHttpRequest.prototype.open = bulletXHROpen;

data/lib/bullet/dependency.rb

@@ -27,6 +27,12 @@ module Bullet
             'active_record52'
           elsif active_record60?
             'active_record60'
+          elsif active_record61?
+            'active_record61'
+          elsif active_record70?
+            'active_record70'
+          elsif active_record71?
+            'active_record71'
           else
             raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
           end
@@ -44,6 +50,8 @@ module Bullet
             'mongoid6x'
           elsif mongoid7x?
             'mongoid7x'
+          elsif mongoid8x?
+            'mongoid8x'
           else
             raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
           end
@@ -62,6 +70,10 @@ module Bullet
       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
@@ -90,6 +102,18 @@ module Bullet
       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 active_record71?
+      active_record7? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
@@ -105,5 +129,9 @@ module Bullet
     def mongoid7x?
       mongoid? && ::Mongoid::VERSION =~ /\A7/
     end
+
+    def mongoid8x?
+      mongoid? && ::Mongoid::VERSION =~ /\A8/
+    end
   end
 end

data/lib/bullet/detector/association.rb

@@ -13,6 +13,7 @@ module Bullet
             'Detector::Association#add_object_associations',
             "object: #{object.bullet_key}, associations: #{associations}"
           )
+          call_stacks.add(object.bullet_key)
           object_associations.add(object.bullet_key, associations)
         end
 
@@ -25,6 +26,7 @@ module Bullet
             'Detector::Association#add_call_object_associations',
             "object: #{object.bullet_key}, associations: #{associations}"
           )
+          call_stacks.add(object.bullet_key)
           call_object_associations.add(object.bullet_key, associations)
         end
 
@@ -76,6 +78,12 @@ module Bullet
         def eager_loadings
           Thread.current[:bullet_eager_loadings]
         end
+
+        # cal_stacks keeps stacktraces where querie-objects were called from.
+        # e.g. { 'Object:111' => [SomeProject/app/controllers/...] }
+        def call_stacks
+          Thread.current[:bullet_call_stacks]
+        end
       end
     end
   end

data/lib/bullet/detector/base.rb

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

data/lib/bullet/detector/counter_cache.rb

@@ -20,7 +20,7 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
-          objects = Array(object_or_objects)
+          objects = Array.wrap(object_or_objects)
           return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug(
@@ -54,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

data/lib/bullet/detector/n_plus_one_query.rb

@@ -7,7 +7,7 @@ module Bullet
       extend StackTraceFilter
 
       class << self
-        # executed when object.assocations is called.
+        # executed when object.associations is called.
         # 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.
@@ -25,7 +25,7 @@ module Bullet
           )
           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
+            create_notification caller_in_project(object.bullet_key), object.class.to_s, associations
           end
         end
 
@@ -33,14 +33,23 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
 
-          objects = Array(object_or_objects)
-          return if objects.map(&:bullet_primary_key_value).compact.empty?
-
-          Bullet.debug(
-            'Detector::NPlusOneQuery#add_possible_objects',
-            "objects: #{objects.map(&:bullet_key).join(', ')}"
-          )
-          objects.each { |object| possible_objects.add object.bullet_key }
+          objects = Array.wrap(object_or_objects)
+          class_names_match_regex = true
+          primary_key_values_are_empty = true
+          keys_joined = ""
+          objects.each do |obj|
+            unless obj.class.name =~ /^HABTM_/
+              class_names_match_regex = false
+            end
+            unless obj.bullet_primary_key_value.nil?
+              primary_key_values_are_empty = false
+            end
+            keys_joined += "#{(keys_joined.empty? ? '' : ', ')}#{obj.bullet_key}"
+          end
+          unless class_names_match_regex || primary_key_values_are_empty
+            Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{keys_joined}")
+            objects.each { |object| possible_objects.add object.bullet_key }
+          end
         end
 
         def add_impossible_object(object)
@@ -84,8 +93,7 @@ module Bullet
             # 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
+            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
             return true if result
           end
 
@@ -95,7 +103,7 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:n_plus_one_query, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)

data/lib/bullet/detector/unused_eager_loading.rb

@@ -10,7 +10,7 @@ module Bullet
         # 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
-        #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload assocations
+        #   if association not in call_object_association, then the object => association - call_object_association is unused preload associations
         def check_unused_preload_associations
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
@@ -20,7 +20,7 @@ module Bullet
             next if object_association_diff.empty?
 
             Bullet.debug('detect unused preload', "object: #{bullet_key}, associations: #{object_association_diff}")
-            create_notification(caller_in_project, bullet_key.bullet_class_name, object_association_diff)
+            create_notification(caller_in_project(bullet_key), bullet_key.bullet_class_name, object_association_diff)
           end
         end
 
@@ -65,7 +65,10 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(
+            :unused_eager_loading,
+            klazz
+          )
 
           if notify_associations.present?
             notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)

data/lib/bullet/ext/object.rb

@@ -9,11 +9,22 @@ class Object
     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(',')
+      primary_key = self.class.primary_keys
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
-      send self.class.primary_key
+      primary_key = self.class.primary_key
     else
-      id
+      primary_key = :id
     end
+
+    bullet_join_potential_composite_primary_key(primary_key)
+  end
+
+  private
+
+  def bullet_join_potential_composite_primary_key(primary_keys)
+    return send(primary_keys) unless primary_keys.is_a?(Enumerable)
+
+    primary_keys.map { |primary_key| send primary_key }
+                .join(',')
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -23,7 +23,7 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
 
           records = []
           origin_each { |record| records << record }

data/lib/bullet/mongoid5x.rb

@@ -23,7 +23,7 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
 
           records = []
           origin_each { |record| records << record }

data/lib/bullet/mongoid6x.rb

@@ -23,7 +23,7 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
 
           records = []
           origin_each { |record| records << record }

data/lib/bullet/mongoid7x.rb

@@ -4,35 +4,50 @@ module Bullet
   module Mongoid
     def self.enable
       require 'mongoid'
+      require 'rubygems'
       ::Mongoid::Contextual::Mongo.class_eval do
         alias_method :origin_first, :first
         alias_method :origin_last, :last
         alias_method :origin_each, :each
         alias_method :origin_eager_load, :eager_load
 
-        def first(opts = {})
-          result = origin_first(opts)
-          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
-          result
-        end
-
-        def last(opts = {})
-          result = origin_last(opts)
-          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
-          result
+        %i[first last].each do |context|
+          default = Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new('7.5') ? nil : {}
+          define_method(context) do |opts = default|
+            result = send(:"origin_#{context}", opts)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+            result
+          end
         end
 
         def each(&block)
           return to_enum unless block_given?
 
-          records = []
-          origin_each { |record| records << record }
-          if records.length > 1
-            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
-          elsif records.size == 1
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          first_document = nil
+          document_count = 0
+
+          origin_each do |document|
+            document_count += 1
+
+            if document_count == 1
+              first_document = document
+            elsif document_count == 2
+              Bullet::Detector::NPlusOneQuery.add_possible_objects([first_document, document])
+              yield(first_document)
+              first_document = nil
+              yield(document)
+            else
+              Bullet::Detector::NPlusOneQuery.add_possible_objects(document)
+              yield(document)
+            end
           end
-          records.each(&block)
+
+          if document_count == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(first_document)
+            yield(first_document)
+          end
+
+          self
         end
 
         def eager_load(docs)

data/lib/bullet/mongoid8x.rb

@@ -0,0 +1,59 @@
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        def first(limit = nil)
+          result = origin_first(limit)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last(limit = nil)
+          result = origin_last(limit)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          records.each(&block)
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Association::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, association, object, reload = false)
+          result = origin_get_relation(name, association, object, reload)
+          unless association.embedded?
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/notification/base.rb

@@ -28,13 +28,13 @@ module Bullet
       def whoami
         @user ||=
           ENV['USER'].presence ||
-            (
-              begin
-                `whoami`.chomp
-              rescue StandardError
-                ''
-              end
-            )
+          (
+            begin
+              `whoami`.chomp
+            rescue StandardError
+              ''
+            end
+          )
         @user.present? ? "user: #{@user}" : ''
       end
 
@@ -51,11 +51,22 @@ module Bullet
       end
 
       def short_notice
-        [whoami.presence, url, title, body].compact.join('  ')
+        parts = []
+        parts << whoami.presence unless Bullet.skip_user_in_notification
+        parts << url
+        parts << title
+        parts << body
+
+        parts.compact.join('  ')
       end
 
       def notification_data
-        { user: whoami, url: url, title: title, body: body_with_caller }
+        hash = {}
+        hash[:user] = whoami unless Bullet.skip_user_in_notification
+        hash[:url] = url
+        hash[:title] = title
+        hash[:body] = body_with_caller
+        hash
       end
 
       def eql?(other)
@@ -73,7 +84,8 @@ module Bullet
       end
 
       def associations_str
-        ".includes(#{@associations.map { |a| a.to_s.to_sym }.inspect})"
+        ".includes(#{@associations.map { |a| a.to_s.to_sym }
+.inspect})"
       end
     end
   end

data/lib/bullet/notification/counter_cache.rb

@@ -8,7 +8,7 @@ module Bullet
       end
 
       def title
-        'Need Counter Cache'
+        'Need Counter Cache with Active Record size'
       end
     end
   end

data/lib/bullet/notification.rb

@@ -7,6 +7,7 @@ module Bullet
     autoload :NPlusOneQuery, 'bullet/notification/n_plus_one_query'
     autoload :CounterCache, 'bullet/notification/counter_cache'
 
-    class UnoptimizedQueryError < StandardError; end
+    class UnoptimizedQueryError < StandardError
+    end
   end
 end