bullet 4.14.3 → 4.14.10

data/lib/bullet/active_record42.rb

@@ -2,19 +2,50 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find, :find
+          def find(*args)
+            result = origin_find(*args)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              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
+      end
+
+      ::ActiveRecord::Persistence.class_eval do
+        def save_with_bullet(*args, &proc)
+          was_new_record = new_record?
+          save_without_bullet(*args, &proc).tap do |result|
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+          end
+        end
+        alias_method_chain :save, :bullet
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # 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 to_a
           records = origin_to_a
-          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)
+          if Bullet.start?
+            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
@@ -25,12 +56,14 @@ module Bullet
         alias_method :origin_preloaders_on, :preloaders_on
 
         def preloaders_on(association, records, scope)
-          records.compact!
-          if records.first.class.name !~ /^HABTM_/
-            records.each do |record|
-              Bullet::Detector::Association.add_object_associations(record, association)
+          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
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
           end
           origin_preloaders_on(association, records, scope)
         end
@@ -40,12 +73,15 @@ module Bullet
         # add includes in scope
         alias_method :origin_find_with_associations, :find_with_associations
         def find_with_associations
+          return origin_find_with_associations { |r| yield r } if block_given?
           records = origin_find_with_associations
-          associations = (eager_load_values + includes_values).uniq
-          records.each do |record|
-            Bullet::Detector::Association.add_object_associations(record, associations)
+          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
-          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
         end
       end
@@ -58,9 +94,11 @@ module Bullet
           @bullet_eager_loadings = {}
           records = origin_instantiate(result_set, aliases)
 
-          @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)
+          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
@@ -69,12 +107,14 @@ module Bullet
         def construct_model(record, node, row, model_cache, id, aliases)
           result = origin_construct_model(record, node, row, model_cache, id, aliases)
 
-          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
+          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
@@ -84,16 +124,18 @@ module Bullet
         # call one to many associations
         alias_method :origin_load_target, :load_target
         def load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
           records = origin_load_target
 
-          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)
+          if Bullet.start?
+            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
@@ -101,13 +143,17 @@ module Bullet
 
         alias_method :origin_empty?, :empty?
         def empty?
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
           origin_empty?
         end
 
         alias_method :origin_include?, :include?
         def include?(object)
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
           origin_include?(object)
         end
       end
@@ -117,12 +163,15 @@ module Bullet
         alias_method :origin_reader, :reader
         def reader(force_reload = false)
           result = origin_reader(force_reload)
-          if @owner.class.name !~ /^HABTM_/ && !@inversed
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-            Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-          end
-          if ::ActiveRecord::Reflection::HasOneReflection === @reflection && result
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+          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
@@ -134,14 +183,27 @@ module Bullet
           Thread.current[:bullet_collection_empty] = true
           result = origin_many_empty?
           Thread.current[:bullet_collection_empty] = nil
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
           result
         end
 
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          if !result && !Thread.current[:bullet_collection_empty]
+          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+          end
+          result
+        end
+      end
+
+      ::ActiveRecord::Associations::HasManyThroughAssociation.class_eval do
+        alias_method :origin_hmt_has_cached_counter?, :has_cached_counter?
+        def has_cached_counter?(reflection = reflection())
+          result = origin_hmt_has_cached_counter?(reflection)
+          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
             Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
           result

data/lib/bullet/dependency.rb

@@ -36,6 +36,8 @@ module Bullet
                                'mongoid3x'
                              elsif mongoid4x?
                                'mongoid4x'
+                             elsif mongoid5x?
+                               'mongoid5x'
                              end
                            end
     end
@@ -83,5 +85,9 @@ module Bullet
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
+
+    def mongoid5x?
+      mongoid? && ::Mongoid::VERSION =~ /\A5/
+    end
   end
 end

data/lib/bullet/detector/association.rb

@@ -20,6 +20,22 @@ module Bullet
           call_object_associations.add(object.bullet_key, associations)
         end
 
+        # possible_objects keep the class to object relationships
+        # that the objects may cause N+1 query.
+        # e.g. { Post => ["Post:1", "Post:2"] }
+        def possible_objects
+          Thread.current[:bullet_possible_objects]
+        end
+
+        # impossible_objects keep the class to objects relationships
+        # that the objects may not cause N+1 query.
+        # e.g. { Post => ["Post:1", "Post:2"] }
+        # if find collection returns only one object, then the object is impossible object,
+        # impossible_objects are used to avoid treating 1+1 query to N+1 query.
+        def impossible_objects
+          Thread.current[:bullet_impossible_objects]
+        end
+
         private
           # object_associations keep the object relationships
           # that the object has many associations.
@@ -38,22 +54,6 @@ module Bullet
             Thread.current[:bullet_call_object_associations]
           end
 
-          # possible_objects keep the class to object relationships
-          # that the objects may cause N+1 query.
-          # e.g. { Post => ["Post:1", "Post:2"] }
-          def possible_objects
-            Thread.current[:bullet_possible_objects]
-          end
-
-          # impossible_objects keep the class to objects relationships
-          # that the objects may not cause N+1 query.
-          # e.g. { Post => ["Post:1", "Post:2"] }
-          # if find collection returns only one object, then the object is impossible object,
-          # impossible_objects are used to avoid treating 1+1 query to N+1 query.
-          def impossible_objects
-            Thread.current[:bullet_impossible_objects]
-          end
-
           # inversed_objects keeps object relationships
           # that association is inversed.
           # e.g. { "Comment:1" => ["post"] }

data/lib/bullet/detector/counter_cache.rb

@@ -8,7 +8,7 @@ module Bullet
           return unless object.primary_key_value
 
           Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object.bullet_key, associations)
+          if conditions_met?(object, associations)
             create_notification object.class.to_s, associations
           end
         end
@@ -32,6 +32,18 @@ module Bullet
           impossible_objects.add object.bullet_key
         end
 
+        def conditions_met?(object, associations)
+          possible_objects.include?(object.bullet_key) && !impossible_objects.include?(object.bullet_key)
+        end
+
+        def possible_objects
+          Thread.current[:bullet_counter_possible_objects]
+        end
+
+        def impossible_objects
+          Thread.current[:bullet_counter_impossible_objects]
+        end
+
         private
           def create_notification(klazz, associations)
             notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
@@ -41,18 +53,6 @@ module Bullet
               Bullet.notification_collector.add notice
             end
           end
-
-          def possible_objects
-            Thread.current[:bullet_counter_possible_objects]
-          end
-
-          def impossible_objects
-            Thread.current[:bullet_counter_impossible_objects]
-          end
-
-          def conditions_met?(bullet_key, associations)
-            possible_objects.include?(bullet_key) && !impossible_objects.include?(bullet_key)
-          end
       end
     end
   end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -15,7 +15,7 @@ module Bullet
           add_call_object_associations(object, associations)
 
           Bullet.debug("Detector::NPlusOneQuery#call_association", "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object.bullet_key, associations)
+          if 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
           end
@@ -49,6 +49,35 @@ module Bullet
           inversed_objects.add object.bullet_key, association
         end
 
+        # decide whether the object.associations is unpreloaded or not.
+        def conditions_met?(object, associations)
+          possible?(object) && !impossible?(object) && !association?(object, associations)
+        end
+
+        def possible?(object)
+          possible_objects.include? object.bullet_key
+        end
+
+        def impossible?(object)
+          impossible_objects.include? object.bullet_key
+        end
+
+        # 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|
+              # associations == v comparision 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
+          end
+
+          false
+        end
+
         private
           def create_notification(callers, klazz, associations)
             notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
@@ -59,11 +88,6 @@ module Bullet
             end
           end
 
-          # decide whether the object.associations is unpreloaded or not.
-          def conditions_met?(bullet_key, associations)
-            possible?(bullet_key) && !impossible?(bullet_key) && !association?(bullet_key, associations)
-          end
-
           def caller_in_project
             app_root = rails? ? Rails.root.to_s : Dir.pwd
             vendor_root = app_root + "/vendor"
@@ -72,27 +96,6 @@ module Bullet
               Bullet.stacktrace_includes.any? { |include| c.include?(include) }
             end
           end
-
-          def possible?(bullet_key)
-            possible_objects.include? bullet_key
-          end
-
-          def impossible?(bullet_key)
-            impossible_objects.include? bullet_key
-          end
-
-          # check if object => associations already exists in object_associations.
-          def association?(bullet_key, associations)
-            value = object_associations[bullet_key]
-            if value
-              value.each do |v|
-                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
-                return true if result
-              end
-            end
-
-            return false
-          end
       end
     end
   end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -48,7 +48,7 @@ module Bullet
           end
 
           eager_loadings.add(*to_add) if to_add
-          to_merge.each { |k,val| eager_loadings.merge k, val }
+          to_merge.each { |k, val| eager_loadings.merge k, val }
           to_delete.each { |k| eager_loadings.delete k }
 
           eager_loadings.add bullet_keys, associations unless bullet_keys.empty?

data/lib/bullet/ext/object.rb

@@ -4,7 +4,9 @@ class Object
   end
 
   def primary_key_value
-    if self.class.respond_to?(:primary_key) && self.class.primary_key
+    if self.class.respond_to?(:primary_keys) && self.class.primary_keys
+      self.class.primary_keys.map { |primary_key| self.send primary_key }.join(',')
+    elsif self.class.respond_to?(:primary_key) && self.class.primary_key
       self.send self.class.primary_key
     else
       self.id

data/lib/bullet/mongoid5x.rb

@@ -0,0 +1,56 @@
+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
+          result = origin_first
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last
+          result = origin_last
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          records = view.map{ |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          origin_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::Relations::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        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
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -15,6 +15,12 @@ module Bullet
         "N+1 Query #{@path ? "in #{@path}" : 'detected'}"
       end
 
+      def notification_data
+        super.merge(
+          :backtrace => @callers
+        )
+      end
+
       protected
         def call_stack_messages
           (['N+1 Query method call stack'] + @callers).join( "\n  " )

data/lib/bullet/rack.rb

@@ -10,18 +10,16 @@ module Bullet
       return @app.call(env) unless Bullet.enable?
       Bullet.start_request
       status, headers, response = @app.call(env)
-      return [status, headers, response] if file?(headers) || sse?(response) || empty?(response)
 
       response_body = nil
       if Bullet.notification?
-        if status == 200 && !response_body(response).frozen? && html_request?(headers, response)
+        if !file?(headers) && !sse?(headers) && !empty?(response) &&
+            status == 200 && !response_body(response).frozen? && html_request?(headers, response)
           response_body = response_body(response)
           append_to_html_body(response_body, footer_note) if Bullet.add_footer
           append_to_html_body(response_body, Bullet.gather_inline_notifications)
           headers['Content-Length'] = response_body.bytesize.to_s
         end
-      end
-      if Bullet.enable? && Bullet.notification?
         Bullet.perform_out_of_channel_notifications(env)
       end
       [status, headers, response_body ? [response_body] : response]
@@ -60,8 +58,8 @@ module Bullet
       headers["Content-Transfer-Encoding"] == "binary"
     end
 
-    def sse?(response)
-      response.respond_to?(:stream) && response.stream.is_a?(ActionController::Live::Buffer)
+    def sse?(headers)
+      headers["Content-Type"] == "text/event-stream"
     end
 
     def html_request?(headers, response)

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "4.14.3"
+  VERSION = "4.14.10"
 end

data/lib/bullet.rb

@@ -16,6 +16,9 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
+  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
+  TRUE = 'true'.freeze
+
   if defined? Rails::Railtie
     class BulletRailtie < Rails::Railtie
       initializer "bullet.configure_rails_initialization" do |app|
@@ -29,7 +32,9 @@ module Bullet
     attr_reader :notification_collector, :whitelist
     attr_accessor :add_footer, :orm_pathches_applied
 
-    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :bugsnag=, :to => UniformNotifier
+    available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.map { |notifier| "#{notifier}=" }
+    available_notifiers << { :to => UniformNotifier }
+    delegate *available_notifiers
 
     def raise=(should_raise)
       UniformNotifier.raise=(should_raise ? Notification::UnoptimizedQueryError : false)
@@ -72,6 +77,7 @@ module Bullet
     end
 
     def add_whitelist(options)
+      reset_whitelist
       @whitelist[options[:type]][options[:class_name].classify] ||= []
       @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_sym
     end
@@ -81,7 +87,11 @@ module Bullet
     end
 
     def reset_whitelist
-      @whitelist = {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+      @whitelist ||= {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+    end
+
+    def clear_whitelist
+      @whitelist = nil
     end
 
     def bullet_logger=(active)
@@ -96,7 +106,7 @@ module Bullet
     end
 
     def debug(title, message)
-      puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
+      puts "[Bullet][#{title}] #{message}" if ENV[BULLET_DEBUG] == TRUE
     end
 
     def start_request
@@ -130,7 +140,7 @@ module Bullet
     end
 
     def start?
-      Thread.current[:bullet_start]
+      enable? && Thread.current[:bullet_start]
     end
 
     def notification_collector
@@ -160,7 +170,7 @@ module Bullet
 
     def footer_info
       info = []
-      for_each_active_notifier_with_notification do |notification|
+      notification_collector.collection.each do |notification|
         info << notification.short_notice
       end
       info
@@ -176,14 +186,17 @@ module Bullet
     end
 
     def profile
-      Bullet.start_request if Bullet.enable?
+      if Bullet.enable?
+        begin
+          Bullet.start_request
 
-      yield
+          yield
 
-      if Bullet.enable? && Bullet.notification?
-        Bullet.perform_out_of_channel_notifications
+          Bullet.perform_out_of_channel_notifications if Bullet.notification?
+        ensure
+          Bullet.end_request
+        end
       end
-      Bullet.end_request if Bullet.enable?
     end
 
     private