bullet 5.7.5 → 6.0.0

data/lib/bullet/active_record60.rb

@@ -0,0 +1,245 @@
+# 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.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)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+            end
+          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)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, reflection.name)
+            end
+          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)
+            end
+            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
+          end
+          records
+        end
+      end)
+
+      ::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
+
+        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
+              end
+            end
+          end
+
+          super
+        end
+
+        # 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)
+
+      ::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
+
+              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) 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
+
+        def empty?
+          if Bullet.start? && !reflection.has_cached_counter?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          end
+          super
+        end
+
+        def include?(object)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          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
+              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)
+
+      ::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

@@ -0,0 +1,58 @@
+(function() {
+  var oldOpen = window.XMLHttpRequest.prototype.open;
+  var oldSend = window.XMLHttpRequest.prototype.send;
+  function newOpen(method, url, async, user, password) {
+    this._storedUrl = url;
+    return oldOpen.apply(this, arguments);
+  }
+  function newSend(data) {
+    if (this.onload) {
+      this._storedOnload = this.onload;
+    }
+    this.onload = newOnload;
+    return oldSend.apply(this, arguments);
+  }
+  function newOnload() {
+    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 = newOpen;
+  window.XMLHttpRequest.prototype.send = newSend;
+})();

data/lib/bullet/dependency.rb

@@ -10,10 +10,6 @@ module Bullet
       @active_record ||= defined? ::ActiveRecord
     end
 
-    def rails?
-      @rails ||= defined? ::Rails
-    end
-
     def active_record_version
       @active_record_version ||= begin
                                    if active_record40?
@@ -28,8 +24,10 @@ module Bullet
                                      'active_record5'
                                    elsif active_record52?
                                      'active_record52'
+                                   elsif active_record60?
+                                     'active_record60'
                                    else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION} yet"
+                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
                                    end
                                  end
     end
@@ -42,6 +40,8 @@ module Bullet
                                'mongoid5x'
                              elsif mongoid6x?
                                'mongoid6x'
+                             elsif mongoid7x?
+                               'mongoid7x'
                              else
                                raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
                              end
@@ -56,6 +56,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 +84,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 +99,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

@@ -7,18 +7,18 @@ module Bullet
         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'.freeze, "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'.freeze, "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
 

data/lib/bullet/detector/counter_cache.rb

@@ -7,7 +7,7 @@ module Bullet
         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)
@@ -18,8 +18,9 @@ module Bullet
         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?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug('Detector::CounterCache#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
@@ -28,7 +29,7 @@ module Bullet
         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

@@ -14,11 +14,12 @@ 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'.freeze, "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
@@ -28,28 +29,29 @@ module Bullet
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           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'.freeze, "objects: #{objects.map(&:bullet_key).join(', '.freeze)}")
+          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'.freeze, "object: #{object.bullet_key}")
+          Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
         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'.freeze, "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
 
@@ -69,14 +71,12 @@ module Bullet
         # check if object => associations already exists in object_associations.
         def association?(object, associations)
           value = object_associations[object.bullet_key]
-          if value
-            value.each do |v|
+          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
-              return true if result
-            end
+            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
+            return true if result
           end
 
           false

data/lib/bullet/detector/unused_eager_loading.rb

@@ -27,7 +27,7 @@ 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_keys = objects.map(&:bullet_key)
@@ -75,6 +75,7 @@ module Bullet
           eager_loadings.similarly_associated(bullet_key, associations).each do |related_bullet_key|
             coa = call_object_associations[related_bullet_key]
             next if coa.nil?
+
             all.merge coa
           end
           all.to_a

data/lib/bullet/ext/object.rb

@@ -2,12 +2,14 @@
 
 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(','.freeze)
+      self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
       send self.class.primary_key
     else

data/lib/bullet/ext/string.rb

@@ -2,6 +2,6 @@
 
 class String
   def bullet_class_name
-    sub(/:[^:]*?$/, ''.freeze)
+    sub(/:[^:]*?$/, '')
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -24,6 +24,7 @@ module Bullet
 
         def each(&block)
           return to_enum unless block_given?
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1

data/lib/bullet/mongoid5x.rb

@@ -24,6 +24,7 @@ module Bullet
 
         def each(&block)
           return to_enum unless block_given?
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1

data/lib/bullet/mongoid6x.rb

@@ -10,20 +10,21 @@ module Bullet
         alias_method :origin_each, :each
         alias_method :origin_eager_load, :eager_load
 
-        def first
-          result = origin_first
+        def first(opt = {})
+          result = origin_first(opt)
           Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
           result
         end
 
-        def last
-          result = origin_last
+        def last(opt = {})
+          result = origin_last(opt)
           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

data/lib/bullet/mongoid7x.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+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(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
+        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

@@ -73,7 +73,7 @@ module Bullet
       protected
 
       def klazz_associations_str
-        "  #{@base_class} => [#{@associations.map(&:inspect).join(', '.freeze)}]"
+        "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
       end
 
       def associations_str