RubyGems - bullet - Versions diffs - 5.9.0 → 7.0.4 - Mend

bullet 5.9.0 → 7.0.4

Files changed (71) hide show

checksums.yaml +5 -5
data/.github/workflows/main.yml +82 -0
data/CHANGELOG.md +72 -0
data/Gemfile.rails-4.0 +1 -1
data/Gemfile.rails-4.1 +1 -1
data/Gemfile.rails-4.2 +1 -1
data/Gemfile.rails-5.0 +1 -1
data/Gemfile.rails-5.1 +1 -1
data/Gemfile.rails-5.2 +1 -1
data/Gemfile.rails-6.0 +15 -0
data/Gemfile.rails-6.1 +15 -0
data/Gemfile.rails-7.0 +10 -0
data/MIT-LICENSE +1 -1
data/README.md +59 -33
data/lib/bullet/active_job.rb +13 -0
data/lib/bullet/active_record4.rb +9 -32
data/lib/bullet/active_record41.rb +8 -27
data/lib/bullet/active_record42.rb +9 -24
data/lib/bullet/active_record5.rb +190 -179
data/lib/bullet/active_record52.rb +184 -169
data/lib/bullet/active_record60.rb +274 -0
data/lib/bullet/active_record61.rb +274 -0
data/lib/bullet/active_record70.rb +277 -0
data/lib/bullet/bullet_xhr.js +64 -0
data/lib/bullet/dependency.rb +60 -36
data/lib/bullet/detector/association.rb +26 -20
data/lib/bullet/detector/counter_cache.rb +15 -11
data/lib/bullet/detector/n_plus_one_query.rb +24 -14
data/lib/bullet/detector/unused_eager_loading.rb +8 -5
data/lib/bullet/ext/object.rb +4 -2
data/lib/bullet/mongoid4x.rb +3 -7
data/lib/bullet/mongoid5x.rb +3 -7
data/lib/bullet/mongoid6x.rb +3 -7
data/lib/bullet/mongoid7x.rb +34 -23
data/lib/bullet/notification/base.rb +14 -18
data/lib/bullet/notification/n_plus_one_query.rb +2 -4
data/lib/bullet/notification/unused_eager_loading.rb +2 -4
data/lib/bullet/notification.rb +2 -1
data/lib/bullet/rack.rb +55 -27
data/lib/bullet/stack_trace_filter.rb +11 -19
data/lib/bullet/version.rb +1 -1
data/lib/bullet.rb +68 -42
data/lib/generators/bullet/install_generator.rb +22 -23
data/perf/benchmark.rb +11 -14
data/spec/bullet/detector/counter_cache_spec.rb +6 -6
data/spec/bullet/detector/n_plus_one_query_spec.rb +8 -4
data/spec/bullet/detector/unused_eager_loading_spec.rb +25 -8
data/spec/bullet/ext/object_spec.rb +10 -5
data/spec/bullet/notification/base_spec.rb +5 -7
data/spec/bullet/notification/n_plus_one_query_spec.rb +16 -3
data/spec/bullet/notification/unused_eager_loading_spec.rb +5 -1
data/spec/bullet/rack_spec.rb +161 -11
data/spec/bullet/registry/association_spec.rb +2 -2
data/spec/bullet/registry/base_spec.rb +1 -1
data/spec/bullet_spec.rb +25 -44
data/spec/integration/active_record/association_spec.rb +115 -144
data/spec/integration/counter_cache_spec.rb +14 -34
data/spec/integration/mongoid/association_spec.rb +19 -33
data/spec/models/attachment.rb +5 -0
data/spec/models/deal.rb +5 -0
data/spec/models/post.rb +2 -0
data/spec/models/role.rb +7 -0
data/spec/models/submission.rb +1 -0
data/spec/models/user.rb +2 -0
data/spec/spec_helper.rb +4 -10
data/spec/support/bullet_ext.rb +8 -9
data/spec/support/mongo_seed.rb +3 -16
data/spec/support/sqlite_seed.rb +38 -0
data/test.sh +3 -0
metadata +21 -8
data/.travis.yml +0 -12

data/spec/bullet/rack_spec.rb CHANGED Viewed

@@ -31,12 +31,6 @@ module Bullet
         response = double(body: '<html><head></head><body></body></html>')
         expect(middleware).not_to be_html_request(headers, response)
       end
-      it "should be false if response body doesn't contain html tag" do
-        headers = { 'Content-Type' => 'text/html' }
-        response = double(body: '<div>Partial</div>')
-        expect(middleware).not_to be_html_request(headers, response)
-      end
     end
     context 'empty?' do
@@ -45,15 +39,20 @@ 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
         response = double(body: '')
         expect(middleware).to be_empty(response)
       end
+      it 'should be true if no response body' do
+        response = double()
+        expect(middleware).to be_empty(response)
+      end
     end
     context '#call' do
@@ -67,11 +66,12 @@ module Bullet
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).and_return(true)
+          expect(Bullet).to receive(:console_enabled?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
-          status, headers, response = middleware.call('Content-Type' => 'text/html')
+          _, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq('56')
-          expect(response).to eq(['<html><head></head><body><bullet></bullet></body></html>'])
+          expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
         end
         it 'should set the right Content-Length if response body contains accents' do
@@ -79,10 +79,138 @@ module Bullet
           response.body = '<html><head></head><body>é</body></html>'
           app.response = response
           expect(Bullet).to receive(:notification?).and_return(true)
+          allow(Bullet).to receive(:console_enabled?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
-          status, headers, response = middleware.call('Content-Type' => 'text/html')
+          _, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq('58')
         end
+        context 'with injection notifiers' do
+          before do
+            expect(Bullet).to receive(:notification?).and_return(true)
+            allow(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
+            allow(middleware).to receive(:xhr_script).and_return('<script></script>')
+            allow(middleware).to receive(:footer_note).and_return('footer')
+            expect(Bullet).to receive(:perform_out_of_channel_notifications)
+          end
+          it 'should change response body if add_footer is true' do
+            expect(Bullet).to receive(:add_footer).exactly(3).times.and_return(true)
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq((73 + middleware.send(:footer_note).length).to_s)
+            expect(response).to eq(%w[<html><head></head><body>footer<bullet></bullet><script></script></body></html>])
+          end
+          it 'should change response body for html safe string if add_footer is true' do
+            expect(Bullet).to receive(:add_footer).exactly(3).times.and_return(true)
+            app.response =
+              Support::ResponseDouble.new.tap do |response|
+                response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+              end
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq((73 + middleware.send(:footer_note).length).to_s)
+            expect(response).to eq(%w[<html><head></head><body>footer<bullet></bullet><script></script></body></html>])
+          end
+          it 'should add the footer-text header for non-html requests when add_footer is true' do
+            allow(Bullet).to receive(:add_footer).at_least(:once).and_return(true)
+            allow(Bullet).to receive(:footer_info).and_return(['footer text'])
+            app.headers = { 'Content-Type' => 'application/json' }
+            _, headers, _response = middleware.call({})
+            expect(headers).to include('X-bullet-footer-text' => '["footer text"]')
+          end
+          it 'should change response body if console_enabled is true' do
+            expect(Bullet).to receive(:console_enabled?).and_return(true)
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq('56')
+            expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
+          end
+          it 'should change response body for html safe string if console_enabled is true' do
+            expect(Bullet).to receive(:console_enabled?).and_return(true)
+            app.response =
+              Support::ResponseDouble.new.tap do |response|
+                response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+              end
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq('56')
+            expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
+          end
+          it 'should add headers for non-html requests when console_enabled is true' do
+            allow(Bullet).to receive(:console_enabled?).at_least(:once).and_return(true)
+            allow(Bullet).to receive(:text_notifications).and_return(['text notifications'])
+            app.headers = { 'Content-Type' => 'application/json' }
+            _, headers, _response = middleware.call({})
+            expect(headers).to include('X-bullet-console-text' => '["text notifications"]')
+          end
+          it "shouldn't change response body unnecessarily" do
+            expected_response = Support::ResponseDouble.new 'Actual body'
+            app.response = expected_response
+            _, _, response = middleware.call({})
+            expect(response).to eq(expected_response)
+          end
+          it "shouldn't add headers unnecessarily" do
+            app.headers = { 'Content-Type' => 'application/json' }
+            _, headers, _response = middleware.call({})
+            expect(headers).not_to include('X-bullet-footer-text')
+            expect(headers).not_to include('X-bullet-console-text')
+          end
+          context 'when skip_http_headers is enabled' do
+            before do
+              allow(Bullet).to receive(:skip_http_headers).and_return(true)
+            end
+            it 'should include the footer but not the xhr script tag if add_footer is true' do
+              expect(Bullet).to receive(:add_footer).at_least(:once).and_return(true)
+              _, headers, response = middleware.call({})
+              expect(headers['Content-Length']).to eq((56 + middleware.send(:footer_note).length).to_s)
+              expect(response).to eq(%w[<html><head></head><body>footer<bullet></bullet></body></html>])
+            end
+            it 'should not include the xhr script tag if console_enabled is true' do
+              expect(Bullet).to receive(:console_enabled?).and_return(true)
+              _, headers, response = middleware.call({})
+              expect(headers['Content-Length']).to eq('56')
+              expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
+            end
+            it 'should not add the footer-text header for non-html requests when add_footer is true' do
+              allow(Bullet).to receive(:add_footer).at_least(:once).and_return(true)
+              app.headers = { 'Content-Type' => 'application/json' }
+              _, headers, _response = middleware.call({})
+              expect(headers).not_to include('X-bullet-footer-text')
+            end
+            it 'should not add headers for non-html requests when console_enabled is true' do
+              allow(Bullet).to receive(:console_enabled?).at_least(:once).and_return(true)
+              app.headers = { 'Content-Type' => 'application/json' }
+              _, headers, _response = middleware.call({})
+              expect(headers).not_to include('X-bullet-console-text')
+            end
+          end
+        end
+        context 'when skip_html_injection is enabled' do
+          it 'should not try to inject html' do
+            expected_response = Support::ResponseDouble.new 'Actual body'
+            app.response = expected_response
+            allow(Bullet).to receive(:notification?).and_return(true)
+            allow(Bullet).to receive(:skip_html_injection?).and_return(true)
+            expect(Bullet).to receive(:gather_inline_notifications).never
+            expect(middleware).to receive(:xhr_script).never
+            expect(Bullet).to receive(:perform_out_of_channel_notifications)
+            _, _, response = middleware.call('Content-Type' => 'text/html')
+            expect(response).to eq(expected_response)
+          end
+        end
       end
       context 'when Bullet is disabled' do
@@ -95,6 +223,14 @@ module Bullet
       end
     end
+    context '#set_header' do
+      it 'should truncate headers to under 8kb' do
+        long_header = ['a' * 1_024] * 10
+        expected_res = (['a' * 1_024] * 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>' }
@@ -124,6 +260,20 @@ module Bullet
           expect(middleware.response_body(response)).to eq body_string
         end
       end
+      begin
+        require 'rack/files'
+        context 'when `response` is a Rack::Files::Iterator' do
+          let(:response) { instance_double(::Rack::Files::Iterator) }
+          before { allow(response).to receive(:is_a?).with(::Rack::Files::Iterator) { true } }
+          it 'should return nil' do
+            expect(middleware.response_body(response)).to be_nil
+          end
+        end
+      rescue LoadError
+      end
     end
   end
 end

data/spec/bullet/registry/association_spec.rb CHANGED Viewed

@@ -16,11 +16,11 @@ module Bullet
       context '#similarly_associated' do
         it 'should return similarly associated keys' do
-          expect(subject.similarly_associated('key1', Set.new(['value']))).to eq(%w[key1 key2])
+          expect(subject.similarly_associated('key1', Set.new(%w[value]))).to eq(%w[key1 key2])
         end
         it 'should return empty if key does not exist' do
-          expect(subject.similarly_associated('key3', Set.new(['value']))).to be_empty
+          expect(subject.similarly_associated('key3', Set.new(%w[value]))).to be_empty
         end
       end
     end

data/spec/bullet/registry/base_spec.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module Bullet
       context '#[]' do
         it 'should get value by key' do
-          expect(subject['key']).to eq(Set.new(['value']))
+          expect(subject['key']).to eq(Set.new(%w[value]))
         end
       end

data/spec/bullet_spec.rb CHANGED Viewed

@@ -17,9 +17,7 @@ describe Bullet, focused: true do
       end
       context 'disable Bullet' do
-        before do
-          Bullet.enable = false
-        end
+        before { Bullet.enable = false }
         it 'should be disabled' do
           expect(subject).to_not be_enable
@@ -27,8 +25,8 @@ describe Bullet, focused: true do
         context 'enable Bullet again without patching again the orms' do
           before do
-            expect(Bullet::Mongoid).not_to receive(:enable) if defined? Bullet::Mongoid
-            expect(Bullet::ActiveRecord).not_to receive(:enable) if defined? Bullet::ActiveRecord
+            expect(Bullet::Mongoid).not_to receive(:enable) if defined?(Bullet::Mongoid)
+            expect(Bullet::ActiveRecord).not_to receive(:enable) if defined?(Bullet::ActiveRecord)
             Bullet.enable = true
           end
@@ -42,9 +40,7 @@ describe Bullet, focused: true do
   describe '#start?' do
     context 'when bullet is disabled' do
-      before(:each) do
-        Bullet.enable = false
-      end
+      before(:each) { Bullet.enable = false }
       it 'should not be started' do
         expect(Bullet).not_to be_start
@@ -53,28 +49,19 @@ describe Bullet, focused: true do
   end
   describe '#debug' do
-    before(:each) do
-      $stdout = StringIO.new
-    end
+    before(:each) { $stdout = StringIO.new }
-    after(:each) do
-      $stdout = STDOUT
-    end
+    after(:each) { $stdout = STDOUT }
     context 'when debug is enabled' do
-      before(:each) do
-        ENV['BULLET_DEBUG'] = 'true'
-      end
+      before(:each) { ENV['BULLET_DEBUG'] = 'true' }
-      after(:each) do
-        ENV['BULLET_DEBUG'] = 'false'
-      end
+      after(:each) { ENV['BULLET_DEBUG'] = 'false' }
       it 'should output debug information' do
         Bullet.debug('debug_message', 'this is helpful information')
-        expect($stdout.string)
-          .to eq("[Bullet][debug_message] this is helpful information\n")
+        expect($stdout.string).to eq("[Bullet][debug_message] this is helpful information\n")
       end
     end
@@ -87,31 +74,31 @@ describe Bullet, focused: true do
     end
   end
-  describe '#add_whitelist' do
+  describe '#add_safelist' do
     context "for 'special' class names" do
-      it 'is added to the whitelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to include :department
+      it 'is added to the safelist successfully' do
+        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to include :department
       end
     end
   end
-  describe '#delete_whitelist' do
+  describe '#delete_safelist' do
     context "for 'special' class names" do
-      it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        expect(Bullet.whitelist[:n_plus_one_query]).to eq({})
+      it 'is deleted from the safelist successfully' do
+        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        Bullet.delete_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        expect(Bullet.safelist[:n_plus_one_query]).to eq({})
       end
     end
     context 'when exists multiple definitions' do
-      it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
-        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
-        expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to include :department
-        expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to_not include :team
+      it 'is deleted from the safelist successfully' do
+        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
+        Bullet.delete_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
+        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to include :department
+        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to_not include :team
       end
     end
   end
@@ -125,13 +112,7 @@ describe Bullet, focused: true do
     end
     context 'when called with Rack environment hash' do
-      let(:env) {
-        {
-          'REQUEST_METHOD' => 'GET',
-          'PATH_INFO' => '/path',
-          'QUERY_STRING' => 'foo=bar'
-        }
-      }
+      let(:env) { { 'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/path', 'QUERY_STRING' => 'foo=bar' } }
       context "when env['REQUEST_URI'] is nil" do
         before { env['REQUEST_URI'] = nil }