bullet 4.13.1 → 5.0.0

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 !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
           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"
@@ -73,25 +97,10 @@ module Bullet
             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
+          def excluded_stacktrace_path?
+            Bullet.stacktrace_excludes.any? do |excluded_path|
+              caller_in_project.any? { |c| c.include?(excluded_path) }
             end
-
-            return false
           end
       end
     end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -47,8 +47,8 @@ module Bullet
             end
           end
 
-          eager_loadings.add *to_add if to_add
-          to_merge.each { |k,val| eager_loadings.merge k, val }
+          eager_loadings.add(*to_add) if to_add
+          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

@@ -1,10 +1,12 @@
 class Object
   def bullet_key
-    [self.class, self.primary_key_value].join(':')
+    "#{self.class}:#{self.primary_key_value}"
   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/base.rb

@@ -18,6 +18,10 @@ module Bullet
         raise NoMethodError.new("no method body defined")
       end
 
+      def call_stack_messages
+        ""
+      end
+
       def whoami
         @user ||= ENV['USER'].presence || (`whoami`.chomp rescue "")
         if @user.present?
@@ -28,15 +32,7 @@ module Bullet
       end
 
       def body_with_caller
-        body
-      end
-
-      def standard_notice
-        @standard_notifice ||= title + "\n" + body
-      end
-
-      def full_notice
-        [whoami.presence, url, title, body_with_caller].compact.join("\n")
+        "#{body}\n#{call_stack_messages}\n"
       end
 
       def notify_inline
@@ -48,7 +44,7 @@ module Bullet
       end
 
       def short_notice
-        [whoami.presence, url, title, body].compact.join("\n")
+        [whoami.presence, url, title, body].compact.join("  ")
       end
 
       def notification_data
@@ -74,7 +70,7 @@ module Bullet
         end
 
         def associations_str
-          ":include => #{@associations.map{ |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
+          ":includes => #{@associations.map{ |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
         end
     end
   end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -7,10 +7,6 @@ module Bullet
         @callers = callers
       end
 
-      def body_with_caller
-        "#{body}\n#{call_stack_messages}"
-      end
-
       def body
         "#{klazz_associations_str}\n  Add to your finder: #{associations_str}"
       end
@@ -19,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,17 +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)
-          response_body = response_body(response) << Bullet.gather_inline_notifications
-          add_footer_note(response_body) if Bullet.add_footer
+        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]
@@ -42,16 +41,25 @@ module Bullet
       end
     end
 
-    def add_footer_note(response_body)
-      response_body << "<div #{footer_div_style}>" + Bullet.footer_info.uniq.join("<br>") + "</div>"
+    def append_to_html_body(response_body, content)
+      if response_body.include?('</body>')
+        position = response_body.rindex('</body>')
+        response_body.insert(position, content)
+      else
+        response_body << content
+      end
+    end
+
+    def footer_note
+      "<div #{footer_div_attributes}>" + Bullet.footer_info.uniq.join("<br>") + "</div>"
     end
 
     def file?(headers)
       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)
@@ -67,9 +75,9 @@ module Bullet
     end
 
     private
-    def footer_div_style
+    def footer_div_attributes
 <<EOF
-style="position: fixed; bottom: 0pt; left: 0pt; cursor: pointer; border-style: solid; border-color: rgb(153, 153, 153);
+data-is-bullet-footer ondblclick="this.parentNode.removeChild(this);" style="position: fixed; bottom: 0pt; left: 0pt; cursor: pointer; border-style: solid; border-color: rgb(153, 153, 153);
  -moz-border-top-colors: none; -moz-border-right-colors: none; -moz-border-bottom-colors: none;
  -moz-border-left-colors: none; -moz-border-image: none; border-width: 2pt 2pt 0px 0px;
  padding: 5px; border-radius: 0pt 10pt 0pt 0px; background: none repeat scroll 0% 0% rgba(200, 200, 200, 0.8);
@@ -78,4 +86,3 @@ EOF
     end
   end
 end
-

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "4.13.1"
+  VERSION = "5.0.0"
 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|
@@ -25,11 +28,13 @@ module Bullet
   end
 
   class << self
-    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes
+    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
     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)
@@ -71,7 +76,12 @@ module Bullet
       @stacktrace_includes || []
     end
 
+    def stacktrace_excludes
+      @stacktrace_excludes || []
+    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 +91,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 +110,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 +144,7 @@ module Bullet
     end
 
     def start?
-      Thread.current[:bullet_start]
+      enable? && Thread.current[:bullet_start]
     end
 
     def notification_collector
@@ -153,14 +167,14 @@ module Bullet
 
     def perform_out_of_channel_notifications(env = {})
       for_each_active_notifier_with_notification do |notification|
-        notification.url = [env['HTTP_HOST'], env['REQUEST_URI']].compact.join
+        notification.url = env['REQUEST_URI']
         notification.notify_out_of_channel
       end
     end
 
     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 +190,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

data/spec/bullet/detector/counter_cache_spec.rb

@@ -10,13 +10,13 @@ module Bullet
 
       context ".add_counter_cache" do
         it "should create notification if conditions met" do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1.bullet_key, [:comments]).and_return(true)
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(true)
           expect(CounterCache).to receive(:create_notification).with("Post", [:comments])
           CounterCache.add_counter_cache(@post1, [:comments])
         end
 
         it "should not create notification if conditions not met" do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1.bullet_key, [:comments]).and_return(false)
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(false)
           expect(CounterCache).to receive(:create_notification).never
           CounterCache.add_counter_cache(@post1, [:comments])
         end
@@ -25,30 +25,30 @@ module Bullet
       context ".add_possible_objects" do
         it "should add possible objects" do
           CounterCache.add_possible_objects([@post1, @post2])
-          expect(CounterCache.send(:possible_objects)).to be_include(@post1.bullet_key)
-          expect(CounterCache.send(:possible_objects)).to be_include(@post2.bullet_key)
+          expect(CounterCache.possible_objects).to be_include(@post1.bullet_key)
+          expect(CounterCache.possible_objects).to be_include(@post2.bullet_key)
         end
 
         it "should add impossible object" do
           CounterCache.add_impossible_object(@post1)
-          expect(CounterCache.send(:impossible_objects)).to be_include(@post1.bullet_key)
+          expect(CounterCache.impossible_objects).to be_include(@post1.bullet_key)
         end
       end
 
       context ".conditions_met?" do
         it "should be true when object is possible, not impossible" do
           CounterCache.add_possible_objects(@post1)
-          expect(CounterCache.send(:conditions_met?, @post1.bullet_key, :associations)).to eq true
+          expect(CounterCache.conditions_met?(@post1, :associations)).to eq true
         end
 
         it "should be false when object is not possible" do
-          expect(CounterCache.send(:conditions_met?, @post1.bullet_key, :associations)).to eq false
+          expect(CounterCache.conditions_met?(@post1, :associations)).to eq false
         end
 
         it "should be true when object is possible, and impossible" do
           CounterCache.add_possible_objects(@post1)
           CounterCache.add_impossible_object(@post1)
-          expect(CounterCache.send(:conditions_met?, @post1.bullet_key, :associations)).to eq false
+          expect(CounterCache.conditions_met?(@post1, :associations)).to eq false
         end
       end
     end