bullet 4.9.0 → 4.10.0

data/lib/bullet/active_record4.rb

@@ -42,7 +42,6 @@ module Bullet
           associations = (eager_load_values + includes_values).uniq
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
-            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
@@ -50,13 +49,32 @@ module Bullet
       end
 
       ::ActiveRecord::Associations::JoinDependency.class_eval do
+        alias_method :origin_instantiate, :instantiate
         alias_method :origin_construct_association, :construct_association
+
+        def instantiate(rows)
+          @bullet_eager_loadings = {}
+          records = origin_instantiate(rows)
+
+          @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
+          records
+        end
+
         # call join associations
         def construct_association(record, join, row)
+          result = origin_construct_association(record, join, row)
+
           associations = join.reflection.name
           Bullet::Detector::Association.add_object_associations(record, associations)
           Bullet::Detector::NPlusOneQuery.call_association(record, associations)
-          origin_construct_association(record, join, row)
+          @bullet_eager_loadings[record.class] ||= {}
+          @bullet_eager_loadings[record.class][record] ||= Set.new
+          @bullet_eager_loadings[record.class][record] << associations
+
+          result
         end
       end
 

data/lib/bullet/active_record41.rb

@@ -43,7 +43,6 @@ module Bullet
           associations = (eager_load_values + includes_values).uniq
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
-            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
@@ -51,13 +50,32 @@ module Bullet
       end
 
       ::ActiveRecord::Associations::JoinDependency.class_eval do
+        alias_method :origin_instantiate, :instantiate
         alias_method :origin_construct_model, :construct_model
+
+        def instantiate(result_set, aliases)
+          @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)
+          end
+          records
+        end
+
         # call join associations
         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)
-          origin_construct_model(record, node, row, model_cache, id, aliases)
+          @bullet_eager_loadings[record.class] ||= {}
+          @bullet_eager_loadings[record.class][record] ||= Set.new
+          @bullet_eager_loadings[record.class][record] << associations
+
+          result
         end
       end
 

data/lib/bullet/detector/association.rb

@@ -2,31 +2,20 @@ module Bullet
   module Detector
     class Association < Base
       class <<self
-        def start_request
-          @@checked = false
-        end
-
-        def clear
-          # Note that under ruby class variables are shared among the class
-          # that declares them and all classes derived from that class.
-          # The following variables are accessible by all classes that
-          # derive from Bullet::Detector::Association - changing the variable
-          # in one subclass will make the change visible to all subclasses!
-          @@object_associations = nil
-          @@possible_objects = nil
-          @@impossible_objects = nil
-          @@call_object_associations = nil
-          @@eager_loadings = nil
-        end
-
         def add_object_associations(object, associations)
+          return unless Bullet.start?
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
-          object_associations.add(object.bullet_ar_key, associations) if object.id
+
+          Bullet.debug("Detector::Association#add_object_associations", "object: #{object.bullet_ar_key}, associations: #{associations}")
+          object_associations.add(object.bullet_ar_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?
-          call_object_associations.add(object.bullet_ar_key, associations) if object.id
+
+          Bullet.debug("Detector::Association#add_call_object_associations", "object: #{object.bullet_ar_key}, associations: #{associations}")
+          call_object_associations.add(object.bullet_ar_key, associations)
         end
 
         private
@@ -36,22 +25,22 @@ module Bullet
           # the object_associations keep all associations that may be or may no be
           # unpreload associations or unused preload associations.
           def object_associations
-            @@object_associations ||= Bullet::Registry::Base.new
+            Thread.current[:bullet_object_associations]
           end
 
-          # call_object_assciations keep the object relationships
+          # 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
-            @@call_object_associations ||= Bullet::Registry::Base.new
+            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
-            @@possible_objects ||= Bullet::Registry::Object.new
+            Thread.current[:bullet_possible_objects]
           end
 
           # impossible_objects keep the class to objects relationships
@@ -61,14 +50,14 @@ module Bullet
           # 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
-            @@impossible_objects ||= Bullet::Registry::Object.new
+            Thread.current[:bullet_impossible_objects]
           end
 
           # 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
-            @@eager_loadings ||= Bullet::Registry::Association.new
+            Thread.current[:bullet_eager_loadings]
           end
       end
     end

data/lib/bullet/detector/base.rb

@@ -1,12 +1,6 @@
 module Bullet
   module Detector
     class Base
-      def self.start_request
-      end
-
-      def self.end_request
-        clear
-      end
     end
   end
 end

data/lib/bullet/detector/counter_cache.rb

@@ -2,32 +2,30 @@ module Bullet
   module Detector
     class CounterCache < Base
       class <<self
-        def clear
-          @@possible_objects = nil
-          @@impossible_objects = nil
-        end
-
         def add_counter_cache(object, associations)
+          return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
+          Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_ar_key}, associations: #{associations}")
           if conditions_met?(object.bullet_ar_key, associations)
             create_notification object.class.to_s, associations
           end
         end
 
         def add_possible_objects(object_or_objects)
+          return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
-          if object_or_objects.is_a? Array
-            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
-          else
-            possible_objects.add object_or_objects.bullet_ar_key
-          end
+          objects = Array(object_or_objects)
+          Bullet.debug("Detector::CounterCache#add_possible_objects", "objects: #{objects.map(&:bullet_ar_key).join(', ')}")
+          objects.each { |object| possible_objects.add object.bullet_ar_key }
         end
 
         def add_impossible_object(object)
+          return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
+          Bullet.debug("Detector::CounterCache#add_impossible_object", "object: #{object.bullet_ar_key}")
           impossible_objects.add object.bullet_ar_key
         end
 
@@ -42,11 +40,11 @@ module Bullet
           end
 
           def possible_objects
-            @@possible_objects ||= Bullet::Registry::Object.new
+            Thread.current[:bullet_counter_possible_objects]
           end
 
           def impossible_objects
-            @@impossible_objects ||= Bullet::Registry::Object.new
+            Thread.current[:bullet_counter_impossible_objects]
           end
 
           def conditions_met?(bullet_ar_key, associations)

data/lib/bullet/detector/n_plus_one_query.rb

@@ -9,27 +9,31 @@ module Bullet
         # then, it checks if this associations call is unpreload.
         #   if it is, keeps this unpreload associations and caller.
         def call_association(object, associations)
-          @@checked = true
+          return unless Bullet.start?
           add_call_object_associations(object, associations)
 
+          Bullet.debug("Detector::NPlusOneQuery#call_association", "object: #{object.bullet_ar_key}, associations: #{associations}")
           if conditions_met?(object.bullet_ar_key, associations)
+            Bullet.debug("detect n + 1 query", "object: #{object.bullet_ar_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
           end
         end
 
         def add_possible_objects(object_or_objects)
+          return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return if object_or_objects.blank?
-          if object_or_objects.is_a? Array
-            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
-          else
-            possible_objects.add object_or_objects.bullet_ar_key if object_or_objects.id
-          end
+
+          objects = Array(object_or_objects)
+          Bullet.debug("Detector::NPlusOneQuery#add_possible_objects", "objects: #{objects.map(&:bullet_ar_key).join(', ')}")
+          objects.each { |object| possible_objects.add object.bullet_ar_key }
         end
 
         def add_impossible_object(object)
+          return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          impossible_objects.add object.bullet_ar_key if object.id
+
+          Bullet.debug("Detector::NPlusOneQuery#add_impossible_object", "object: #{object.bullet_ar_key}")
+          impossible_objects.add object.bullet_ar_key
         end
 
         private

data/lib/bullet/detector/unused_eager_loading.rb

@@ -7,19 +7,23 @@ module Bullet
         #   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
         def check_unused_preload_associations
+          return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
 
-          @@checked = true
           object_associations.each do |bullet_ar_key, associations|
             object_association_diff = diff_object_associations bullet_ar_key, associations
             next if object_association_diff.empty?
 
+            Bullet.debug("detect unused preload", "object: #{bullet_ar_key}, associations: #{object_association_diff}")
             create_notification bullet_ar_key.bullet_class_name, object_association_diff
           end
         end
 
         def add_eager_loadings(objects, associations)
+          return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
+
+          Bullet.debug("Detector::UnusedEagerLoading#add_eager_loadings", "objects: #{objects.map(&:bullet_ar_key).join(', ')}, associations: #{associations}")
           bullet_ar_keys = objects.map(&:bullet_ar_key)
 
           to_add = nil

data/lib/bullet/mongoid3x.rb

@@ -41,13 +41,14 @@ module Bullet
       end
 
       ::Mongoid::Relations::Accessors.class_eval do
-        alias_method :origin_set_relation, :set_relation
+        alias_method :origin_get_relation, :get_relation
 
-        def set_relation(name, relation)
-          if relation && relation.metadata.macro !~ /embed/
+        def get_relation(name, metadata, reload = false)
+          result = origin_get_relation(name, metadata, reload)
+          if metadata.macro !~ /embed/
             Bullet::Detector::NPlusOneQuery.call_association(self, name)
           end
-          origin_set_relation(name, relation)
+          result
         end
       end
     end

data/lib/bullet/mongoid4x.rb

@@ -41,13 +41,14 @@ module Bullet
       end
 
       ::Mongoid::Relations::Accessors.class_eval do
-        alias_method :origin_set_relation, :set_relation
+        alias_method :origin_get_relation, :get_relation
 
-        def set_relation(name, relation)
-          if relation && relation.relation_metadata.macro !~ /embed/
+        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
-          origin_set_relation(name, relation)
+          result
         end
       end
     end

data/lib/bullet/version.rb

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

data/spec/bullet/detector/association_spec.rb

@@ -7,25 +7,6 @@ module Bullet
         @post1 = Post.first
         @post2 = Post.last
       end
-      before(:each) { Association.clear }
-
-      context ".start_request" do
-        it "should set @@checked to false" do
-          Association.start_request
-          expect(Association.class_variable_get(:@@checked)).to eq false
-        end
-      end
-
-      context ".clear" do
-        it "should clear all class variables" do
-          Association.clear
-          expect(Association.class_variable_get(:@@object_associations)).to be_nil
-          expect(Association.class_variable_get(:@@possible_objects)).to be_nil
-          expect(Association.class_variable_get(:@@impossible_objects)).to be_nil
-          expect(Association.class_variable_get(:@@call_object_associations)).to be_nil
-          expect(Association.class_variable_get(:@@eager_loadings)).to be_nil
-        end
-      end
 
       context ".add_object_association" do
         it "should add object, associations pair" do

data/spec/bullet/detector/base_spec.rb

@@ -3,12 +3,6 @@ require 'spec_helper'
 module Bullet
   module Detector
     describe Base do
-      context ".end_request" do
-        it "should call clear" do
-          expect(Base).to receive(:clear)
-          Base.end_request
-        end
-      end
     end
   end
 end

data/spec/bullet/detector/counter_cache_spec.rb

@@ -7,14 +7,6 @@ module Bullet
         @post1 = Post.first
         @post2 = Post.last
       end
-      before(:each) { CounterCache.clear }
-
-      context ".clear" do
-        it "should clear all class variables" do
-          expect(CounterCache.class_variable_get(:@@possible_objects)).to be_nil
-          expect(CounterCache.class_variable_get(:@@impossible_objects)).to be_nil
-        end
-      end
 
       context ".add_counter_cache" do
         it "should create notification if conditions met" do

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -7,14 +7,8 @@ module Bullet
         @post = Post.first
         @post2 = Post.last
       end
-      before(:each) { NPlusOneQuery.clear }
 
       context ".call_association" do
-        it "should set @@checked to true" do
-          NPlusOneQuery.call_association(@post, :associations)
-          expect(NPlusOneQuery.class_variable_get(:@@checked)).to eq true
-        end
-
         it "should add call_object_associations" do
           expect(NPlusOneQuery).to receive(:add_call_object_associations).with(@post, :associations)
           NPlusOneQuery.call_association(@post, :associations)

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -7,7 +7,6 @@ module Bullet
         @post = Post.first
         @post2 = Post.last
       end
-      before(:each) { UnusedEagerLoading.clear }
 
       context ".call_associations" do
         it "should get empty array if eager_loadings" do
@@ -39,11 +38,6 @@ module Bullet
       end
 
       context ".check_unused_preload_associations" do
-        it "should set @@checked to true" do
-          UnusedEagerLoading.check_unused_preload_associations
-          expect(UnusedEagerLoading.class_variable_get(:@@checked)).to eq true
-        end
-
         it "should create notification if object_association_diff is not empty" do
           UnusedEagerLoading.add_object_associations(@post, :association)
           expect(UnusedEagerLoading).to receive(:create_notification).with("Post", [:association])
@@ -51,7 +45,6 @@ module Bullet
         end
 
         it "should not create notification if object_association_diff is empty" do
-          UnusedEagerLoading.clear
           UnusedEagerLoading.add_object_associations(@post, :association)
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)