bullet 5.7.5 → 6.0.0

data/lib/bullet/rack.rb

@@ -10,17 +10,23 @@ module Bullet
 
     def call(env)
       return @app.call(env) unless Bullet.enable?
+
       Bullet.start_request
       status, headers, response = @app.call(env)
 
       response_body = nil
       if Bullet.notification?
-        if !file?(headers) && !sse?(headers) && !empty?(response) &&
-           status == 200 && html_request?(headers, response)
-          response_body = response_body(response)
-          response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
-          response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
-          headers['Content-Length'] = response_body.bytesize.to_s
+        if !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
+          if html_request?(headers, response)
+            response_body = response_body(response)
+            response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
+            response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
+            response_body = append_to_html_body(response_body, xhr_script)
+            headers['Content-Length'] = response_body.bytesize.to_s
+          else
+            set_header(headers, 'X-bullet-footer-text', Bullet.footer_info.uniq) if Bullet.add_footer
+            set_header(headers, 'X-bullet-console-text', Bullet.text_notifications) if Bullet.console_enabled?
+          end
         end
         Bullet.perform_out_of_channel_notifications(env)
       end
@@ -31,16 +37,10 @@ module Bullet
 
     # fix issue if response's body is a Proc
     def empty?(response)
-      # response may be ["Not Found"], ["Move Permanently"], etc.
-      if rails?
-        (response.is_a?(Array) && response.size <= 1) ||
-          !response.respond_to?(:body) ||
-          !response_body(response).respond_to?(:empty?) ||
-          response_body(response).empty?
-      else
-        body = response_body(response)
-        body.nil? || body.empty?
-      end
+      # response may be ["Not Found"], ["Move Permanently"], etc, but
+      # those should not happen if the status is 200
+      body = response_body(response)
+      body.nil? || body.empty?
     end
 
     def append_to_html_body(response_body, content)
@@ -54,7 +54,15 @@ module Bullet
     end
 
     def footer_note
-      "<div #{footer_div_attributes}>" + footer_close_button + Bullet.footer_info.uniq.join('<br>') + '</div>'
+      "<div #{footer_div_attributes}>" + footer_header + '<br>' + Bullet.footer_info.uniq.join('<br>') + '</div>'
+    end
+
+    def set_header(headers, header_name, header_array)
+      # Many proxy applications such as Nginx and AWS ELB limit
+      # the size a header to 8KB, so truncate the list of reports to
+      # be under that limit
+      header_array.pop while header_array.to_json.length > 8 * 1024
+      headers[header_name] = header_array.to_json
     end
 
     def file?(headers)
@@ -66,7 +74,7 @@ module Bullet
     end
 
     def html_request?(headers, response)
-      headers['Content-Type'] && headers['Content-Type'].include?('text/html') && response_body(response).include?('<html')
+      headers['Content-Type']&.include?('text/html') && response_body(response).include?('<html')
     end
 
     def response_body(response)
@@ -80,17 +88,27 @@ module Bullet
     private
 
     def footer_div_attributes
-      <<EOF
-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: 3px 5px; border-radius: 0pt 10pt 0pt 0px; background: none repeat scroll 0% 0% rgba(200, 200, 200, 0.8);
- color: rgb(119, 119, 119); font-size: 16px; font-family: 'Arial', sans-serif; z-index:9999;"
-EOF
+      <<~EOF
+        id="bullet-footer" 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: 3px 5px; border-radius: 0pt 10pt 0pt 0px; background: none repeat scroll 0% 0% rgba(200, 200, 200, 0.8);
+         color: rgb(119, 119, 119); font-size: 16px; font-family: 'Arial', sans-serif; z-index:9999;"
+      EOF
+    end
+
+    def footer_header
+      cancel_button = "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+      if Bullet.console_enabled?
+        "<span>See 'Uniform Notifier' in JS Console for Stacktrace</span>#{cancel_button}"
+      else
+        cancel_button
+      end
     end
 
-    def footer_close_button
-      "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+    # Make footer work for XHR requests by appending data to the footer
+    def xhr_script
+      "<script type='text/javascript'>#{File.read("#{__dir__}/bullet_xhr.js")}</script>"
     end
   end
 end

data/lib/bullet/stack_trace_filter.rb

@@ -2,52 +2,70 @@
 
 module Bullet
   module StackTraceFilter
-    VENDOR_PATH = '/vendor'.freeze
+    VENDOR_PATH = '/vendor'
 
     def caller_in_project
-      app_root = rails? ? Rails.root.to_s : Dir.pwd
-      vendor_root = app_root + VENDOR_PATH
+      vendor_root = Bullet.app_root + VENDOR_PATH
       bundler_path = Bundler.bundle_path.to_s
-      select_caller_locations do |caller_path|
-        caller_path.include?(app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
-          Bullet.stacktrace_includes.any? do |include_pattern|
-            case include_pattern
-            when String
-              caller_path.include?(include_pattern)
-            when Regexp
-              caller_path =~ include_pattern
-            end
-          end
+      select_caller_locations do |location|
+        caller_path = location_as_path(location)
+        caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
+          Bullet.stacktrace_includes.any? { |include_pattern| pattern_matches?(location, include_pattern) }
       end
     end
 
     def excluded_stacktrace_path?
       Bullet.stacktrace_excludes.any? do |exclude_pattern|
-        caller_in_project.any? do |location|
-          caller_path = location.absolute_path.to_s
-          case exclude_pattern
-          when String
-            caller_path.include?(exclude_pattern)
-          when Regexp
-            caller_path =~ exclude_pattern
-          end
-        end
+        caller_in_project.any? { |location| pattern_matches?(location, exclude_pattern) }
       end
     end
 
     private
 
+    def pattern_matches?(location, pattern)
+      path = location_as_path(location)
+      case pattern
+      when Array
+        pattern_path = pattern.first
+        filter = pattern.last
+        return false unless pattern_matches?(location, pattern_path)
+
+        case filter
+        when Range
+          filter.include?(location.lineno)
+        when Integer
+          filter == location.lineno
+        when String
+          filter == location.base_label
+        end
+      when String
+        path.include?(pattern)
+      when Regexp
+        path =~ pattern
+      end
+    end
+
+    def location_as_path(location)
+      ruby_19? ? location : location.absolute_path.to_s
+    end
+
     def select_caller_locations
-      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+      if ruby_19?
         caller.select do |caller_path|
           yield caller_path
         end
       else
         caller_locations.select do |location|
-          caller_path = location.absolute_path.to_s
-          yield caller_path
+          yield location
         end
       end
     end
+
+    def ruby_19?
+      if @ruby_19.nil?
+        @ruby_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+      end
+      @ruby_19
+    end
   end
 end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '5.7.5'.freeze
+  VERSION = '6.0.0'
 end

data/lib/bullet.rb

@@ -19,8 +19,8 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
-  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
-  TRUE = 'true'.freeze
+  BULLET_DEBUG = 'BULLET_DEBUG'
+  TRUE = 'true'
 
   if defined? Rails::Railtie
     class BulletRailtie < Rails::Railtie
@@ -63,6 +63,10 @@ module Bullet
       !!@enable
     end
 
+    def app_root
+      (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
+    end
+
     def n_plus_one_query_enable?
       enable? && !!@n_plus_one_query_enable
     end
@@ -111,9 +115,8 @@ module Bullet
     def bullet_logger=(active)
       if active
         require 'fileutils'
-        root_path = (rails? ? Rails.root.to_s : Dir.pwd).to_s
-        FileUtils.mkdir_p(root_path + '/log')
-        bullet_log_file = File.open("#{root_path}/log/bullet.log", 'a+')
+        FileUtils.mkdir_p(app_root + '/log')
+        bullet_log_file = File.open("#{app_root}/log/bullet.log", 'a+')
         bullet_log_file.sync = true
         UniformNotifier.customized_logger = bullet_log_file
       end
@@ -163,6 +166,7 @@ module Bullet
 
     def notification?
       return unless start?
+
       Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
       notification_collector.notifications_present?
     end
@@ -191,6 +195,14 @@ module Bullet
       info
     end
 
+    def text_notifications
+      info = []
+      notification_collector.collection.each do |notification|
+        info << notification.notification_data.values.compact.join("\n")
+      end
+      info
+    end
+
     def warnings
       notification_collector.collection.each_with_object({}) do |notification, warnings|
         warning_type = notification.class.to_s.split(':').last.tableize
@@ -218,6 +230,10 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
     private
 
     def for_each_active_notifier_with_notification

data/lib/generators/bullet/install_generator.rb

@@ -3,9 +3,9 @@
 module Bullet
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      desc <<-DESC
-Description:
-    Enable bullet in development/test for your application.
+      desc <<~DESC
+        Description:
+            Enable bullet in development/test for your application.
       DESC
 
       def enable_in_development

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -101,6 +101,29 @@ module Bullet
             expect(NPlusOneQuery).to_not receive(:create_notification)
             NPlusOneQuery.call_association(@post, :association)
           end
+
+          # just a sanity spec to make sure the following spec works correctly
+          it "should create notification when stacktrace contains methods that aren't in the exclude list" do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).at_least(1).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to receive(:conditions_met?).and_return(true)
+            expect(NPlusOneQuery).to receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
+
+          it 'should not create notification when stacktrace contains methods that are in the exclude list' do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            Bullet.stacktrace_excludes = [method]
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to_not receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
         end
       end
 

data/spec/bullet/ext/object_spec.rb

@@ -17,23 +17,28 @@ describe Object do
     end
   end
 
-  context 'primary_key_value' do
+  context 'bullet_primary_key_value' do
     it 'should return id' do
       post = Post.first
-      expect(post.primary_key_value).to eq(post.id)
+      expect(post.bullet_primary_key_value).to eq(post.id)
     end
 
     it 'should return primary key value' do
       post = Post.first
       Post.primary_key = 'name'
-      expect(post.primary_key_value).to eq(post.name)
+      expect(post.bullet_primary_key_value).to eq(post.name)
       Post.primary_key = 'id'
     end
 
     it 'should return value for multiple primary keys' do
       post = Post.first
       allow(Post).to receive(:primary_keys).and_return(%i[category_id writer_id])
-      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+      expect(post.bullet_primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+    end
+
+    it 'it should return nil for unpersisted records' do
+      post = Post.new(id: 123)
+      expect(post.bullet_primary_key_value).to be_nil
     end
   end
 end

data/spec/bullet/rack_spec.rb

@@ -45,9 +45,9 @@ module Bullet
         expect(middleware).not_to be_empty(response)
       end
 
-      it 'should be true if response is not found' do
+      it 'should be false if response is not found' do
         response = ['Not Found']
-        expect(middleware).to be_empty(response)
+        expect(middleware).not_to be_empty(response)
       end
 
       it 'should be true if response body is empty' do
@@ -68,6 +68,7 @@ module Bullet
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
+          expect(middleware).to receive(:xhr_script).and_return('')
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
           status, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq('56')
@@ -81,7 +82,7 @@ module Bullet
           expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
           status, headers, response = middleware.call('Content-Type' => 'text/html')
-          expect(headers['Content-Length']).to eq('58')
+          expect(headers['Content-Length']).to eq((58 + middleware.send(:xhr_script).length).to_s)
         end
       end
 
@@ -95,6 +96,14 @@ module Bullet
       end
     end
 
+    context '#set_header' do
+      it 'should truncate headers to under 8kb' do
+        long_header = ['a' * 1024] * 10
+        expected_res = (['a' * 1024] * 7).to_json
+        expect(middleware.set_header({}, 'Dummy-Header', long_header)).to eq(expected_res)
+      end
+    end
+
     describe '#response_body' do
       let(:response) { double }
       let(:body_string) { '<html><body>My Body</body></html>' }

data/spec/integration/active_record/association_spec.rb

@@ -226,7 +226,7 @@ if active_record?
     context 'post => comment' do
       it 'should detect unused preload with post => comments' do
         Post.includes(:comments).each do |post|
-          post.comments.first.name if post.comments.first
+          post.comments.first&.name
         end
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_unused_preload_associations_for(Post, :comments)
@@ -246,7 +246,7 @@ if active_record?
         category = Category.first
         category.draft_post.destroy!
         post = category.draft_post
-        post.update_attributes!(link: true)
+        post.update!(link: true)
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
 
@@ -331,7 +331,7 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
 
-      it 'should dtect preload with comment => post' do
+      it 'should detect preload with comment => post' do
         Comment.includes(:post).each do |comment|
           comment.post.name
         end
@@ -356,6 +356,17 @@ if active_record?
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
+
+      it 'should not detect newly assigned object in an after_save' do
+        new_post = Post.new(category: Category.first)
+
+        new_post.trigger_after_save = true
+        new_post.save!
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
     end
 
     context 'comment => post => category' do
@@ -528,6 +539,44 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
     end
+
+    context 'firm => clients => groups' do
+      it 'should detect non preload associations' do
+        Firm.all.each do |firm|
+          firm.groups.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Firm, :groups)
+      end
+
+      it 'should detect preload associations' do
+        Firm.includes(:groups).each do |firm|
+          firm.groups.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+
+      it 'should not detect preload associations' do
+        Firm.all.map(&:name)
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+
+      it 'should detect unused preload associations' do
+        Firm.includes(:groups).map(&:name)
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).to be_unused_preload_associations_for(Firm, :groups)
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+    end
   end
 
   describe Bullet::Detector::Association, 'has_one' do

data/spec/integration/counter_cache_spec.rb

@@ -38,7 +38,7 @@ if !mongoid? && active_record?
       expect(Bullet.collected_counter_cache_notifications).to be_empty
     end
 
-    if active_record5?
+    if active_record5? || active_record6?
       it 'should not need counter cache for has_many through' do
         Client.all.each do |client|
           client.firms.size

data/spec/models/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Client < ActiveRecord::Base
+  belongs_to :group
+
   has_many :relationships
   has_many :firms, through: :relationships
 end

data/spec/models/firm.rb

@@ -3,4 +3,5 @@
 class Firm < ActiveRecord::Base
   has_many :relationships
   has_many :clients, through: :relationships
+  has_many :groups, through: :clients
 end

data/spec/models/group.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Group < ActiveRecord::Base
+end

data/spec/models/post.rb

@@ -14,4 +14,19 @@ class Post < ActiveRecord::Base
   def link=(*)
     comments.new
   end
+
+  # see association_spec.rb 'should not detect newly assigned object in an after_save'
+  attr_accessor :trigger_after_save
+  after_save do
+    next unless trigger_after_save
+
+    temp_comment = Comment.new(post: self)
+    # this triggers self to be "possible", even though it's
+    # not saved yet
+    temp_comment.post
+
+    # category should NOT whine about not being pre-loaded, because
+    # it's obviously attached to a new object
+    category
+  end
 end

data/spec/support/sqlite_seed.rb

@@ -45,8 +45,10 @@ module Support
 
       firm1 = Firm.create(name: 'first')
       firm2 = Firm.create(name: 'second')
-      client1 = Client.create(name: 'first')
-      client2 = Client.create(name: 'second')
+      group1 = Group.create(name: 'first')
+      group2 = Group.create(name: 'second')
+      client1 = Client.create(name: 'first', group: group1)
+      client2 = Client.create(name: 'second', group: group2)
       firm1.clients = [client1, client2]
       firm2.clients = [client1, client2]
       client1.firms << firm1
@@ -125,6 +127,7 @@ module Support
 
         create_table :clients do |t|
           t.column :name, :string
+          t.column :group_id, :integer
         end
 
         create_table :comments do |t|
@@ -171,6 +174,10 @@ module Support
           t.column :name, :string
         end
 
+        create_table :groups do |t|
+          t.column :name, :string
+        end
+
         create_table :hotels do |t|
           t.column :name, :string
           t.column :location_id, :integer

data/test.sh

@@ -1,11 +1,13 @@
 #bundle update rails && bundle exec rspec spec
 #BUNDLE_GEMFILE=Gemfile.mongoid bundle update mongoid && BUNDLE_GEMFILE=Gemfile.mongoid bundle exec rspec spec
+BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-4.2 bundle && BUNDLE_GEMFILE=Gemfile.rails-4.2 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-4.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-4.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-4.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-4.0 bundle exec rspec spec
+BUNDLE_GEMFILE=Gemfile.mongoid-7.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-7.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-6.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-6.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle exec rspec spec

data/update.sh

@@ -4,6 +4,7 @@ BUNDLE_GEMFILE=Gemfile.rails-5.0 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-4.2 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-4.1 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-4.0 bundle update
+BUNDLE_GEMFILE=Gemfile.mongoid-7.0 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-6.0 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle update