bullet 8.0.1 → 8.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb8c8d2264141849784cb8a103b9521a8fad5ba11eba1daa9a5a576f02c2bcc6
-  data.tar.gz: e9b5a2a2f123ad3e84007407123103535844dcde3c7e9f3da304eb019d55f96d
+  metadata.gz: a61908a92c8bc22bba69f9ea56946f1b6b2abd320e392e7539a3a6024b939b0c
+  data.tar.gz: 1fc844bc72f0e9e4c046590ef3f981180ce0beb5e32fab2217592d21e3456705
 SHA512:
-  metadata.gz: bc9c11edab1b705ba7f51f63bf0315c94d5c3f4178684c42da4042adeef52da7570939a91556301dcb076a08a9dc816b89cd38c8a5399c7a8fe81baf2562ca01
-  data.tar.gz: aa0cc8a93443e8fa17582ac89dca1eba8714080ebab2d0199b0a298f77ccf3f0a019b457615e18e6dd8827f3573e0fe657d9ada3c36d6e8cd588e2b2c4a4090f
+  metadata.gz: 456c8c81a574243cda8ad3a3bb728b0ae97f169434e1608158a72967b8f9a6e7153939fcb2ce7c9d9e363921e918871e6a8b3ed7c374a45bc910170a4cb3e779
+  data.tar.gz: 3ebfc6724a13326f9d2286506727edb5d47b66b01253fbc48a2407d9e7f1c6c3f8ac700d7405024fcc86766a9fd65d170d0eea0678ffd1af3c60dd90b0c82b06

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## Next Release
 
+## 8.0.4 (04/18/2024)
+
+* Insert bullet middleware before `ContentSecurityPolicy`
+* Support url query `skip_html_injection=true`
+* Mark object as impossible after updating inversed
+
+## 8.0.3 (04/04/2025)
+
+* Update non persisted `inversed_objects`
+
+## 8.0.2 (04/02/2025)
+
+* Do not cache `bullet_key` if object is not persisted
+
 ## 8.0.1 (02/10/2025)
 
 * Update benchmark to use sqlite

data/README.md

@@ -121,8 +121,6 @@ Bullet.unused_eager_loading_enable = false
 Bullet.counter_cache_enable        = false
 ```
 
-Note: When calling `Bullet.enable`, all other detectors are reset to their defaults (`true`) and need reconfiguring.
-
 ## Safe list
 
 Sometimes Bullet may notify you of query problems you don't care to fix, or
@@ -194,6 +192,11 @@ see [https://github.com/flyerhzm/uniform_notifier](https://github.com/flyerhzm/u
 
 Growl support is dropped from uniform_notifier 1.16.0, if you still want it, please use uniform_notifier 1.15.0.
 
+## URL query control
+
+You can add the URL query parameter `skip_html_injection` to make the current HTML request behave as if `Bullet.skip_html_injection` is enabled,
+e.g. `http://localhost:3000/posts?skip_html_injection=true`
+
 ## Important
 
 If you find Bullet does not work for you, *please disable your browser's cache*.
@@ -240,7 +243,7 @@ If your application generates a Content-Security-Policy via a separate middlewar
 
 ### Run in tests
 
-First you need to enable Bullet in test environment.
+First you need to enable Bullet in the test environment.
 
 ```ruby
 # config/environments/test.rb
@@ -251,11 +254,13 @@ config.after_initialize do
 end
 ```
 
-Then wrap each test in Bullet api.
+Then wrap each test in the Bullet api.
+
+With RSpec:
 
 ```ruby
 # spec/rails_helper.rb
-if Bullet.enable?
+RSpec.configure do |config|
   config.before(:each) do
     Bullet.start_request
   end
@@ -267,6 +272,26 @@ if Bullet.enable?
 end
 ```
 
+With Minitest:
+
+```ruby
+# test/test_helper.rb
+module ActiveSupport
+  class TestCase
+    def before_setup
+      Bullet.start_request
+      super
+    end
+
+    def after_teardown
+      super
+      Bullet.perform_out_of_channel_notifications if Bullet.notification?
+      Bullet.end_request
+    end
+  end
+end
+```
+
 ## Debug Mode
 
 Bullet outputs some details info, to enable debug mode, set

data/lib/bullet/active_record4.rb

@@ -49,7 +49,10 @@ module Bullet
 
       ::ActiveRecord::Persistence.class_eval do
         def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap { Bullet::Detector::NPlusOneQuery.add_impossible_object(self) }
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+          end
         end
         alias_method_chain :_create_record, :bullet
       end

data/lib/bullet/active_record41.rb

@@ -52,7 +52,10 @@ module Bullet
 
       ::ActiveRecord::Persistence.class_eval do
         def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap { Bullet::Detector::NPlusOneQuery.add_impossible_object(self) }
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+          end
         end
         alias_method_chain :_create_record, :bullet
       end

data/lib/bullet/active_record42.rb

@@ -45,7 +45,10 @@ module Bullet
 
       ::ActiveRecord::Persistence.class_eval do
         def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap { Bullet::Detector::NPlusOneQuery.add_impossible_object(self) }
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+          end
         end
         alias_method_chain :_create_record, :bullet
       end

data/lib/bullet/active_record5.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record52.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record60.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record61.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record70.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record71.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record72.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/active_record80.rb

@@ -4,6 +4,7 @@ module Bullet
   module SaveWithBulletSupport
     def _create_record(*)
       super do
+        Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
         Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
         yield(self) if block_given?
       end

data/lib/bullet/dependency.rb

@@ -56,6 +56,8 @@ module Bullet
             'mongoid7x'
           elsif mongoid8x?
             'mongoid8x'
+          elsif mongoid9x?
+            'mongoid9x'
           else
             raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
           end
@@ -149,5 +151,9 @@ module Bullet
     def mongoid8x?
       mongoid? && ::Mongoid::VERSION =~ /\A8/
     end
+
+    def mongoid9x?
+      mongoid? && ::Mongoid::VERSION =~ /\A9/
+    end
   end
 end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -67,13 +67,23 @@ module Bullet
         def add_inversed_object(object, association)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.bullet_primary_key_value
 
+          object_key = object.bullet_primary_key_value ? object.bullet_key : object.object_id
           Bullet.debug(
             'Detector::NPlusOneQuery#add_inversed_object',
-            "object: #{object.bullet_key}, association: #{association}"
+            "object: #{object_key}, association: #{association}"
           )
-          inversed_objects.add object.bullet_key, association
+          inversed_objects.add object_key, association
+        end
+
+        def update_inversed_object(object)
+          if inversed_objects&.key?(object.object_id)
+            Bullet.debug(
+              'Detector::NPlusOneQuery#update_inversed_object',
+              "object from #{object.object_id} to #{object.bullet_key}"
+            )
+            inversed_objects.add(object.bullet_key, inversed_objects[object.object_id].to_a)
+          end
         end
 
         # decide whether the object.associations is unpreloaded or not.

data/lib/bullet/ext/object.rb

@@ -7,17 +7,20 @@ module Bullet
         attr_writer :bullet_key, :bullet_primary_key_value
 
         def bullet_key
+          return "#{self.class}:" if respond_to?(:persisted?) && !persisted?
+
           @bullet_key ||= "#{self.class}:#{bullet_primary_key_value}"
         end
 
         def bullet_primary_key_value
-          @bullet_primary_key_value ||= begin
-            return if respond_to?(:persisted?) && !persisted?
+          return if respond_to?(:persisted?) && !persisted?
 
-            primary_key = self.class.try(:primary_keys) || self.class.try(:primary_key) || :id
+          @bullet_primary_key_value ||=
+            begin
+              primary_key = self.class.try(:primary_keys) || self.class.try(:primary_key) || :id
 
-            bullet_join_potential_composite_primary_key(primary_key)
-          end
+              bullet_join_potential_composite_primary_key(primary_key)
+            end
         end
 
         private

data/lib/bullet/mongoid9x.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      require 'rubygems'
+      ::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
+
+        %i[first last].each do |context|
+          default = Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new('7.5') ? nil : {}
+          define_method(context) do |opts = default|
+            result = send(:"origin_#{context}", opts)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+            result
+          end
+        end
+
+        def each(&_block)
+          return to_enum unless block_given?
+
+          first_document = nil
+          document_count = 0
+
+          origin_each do |document|
+            document_count += 1
+
+            if document_count == 1
+              first_document = document
+            elsif document_count == 2
+              Bullet::Detector::NPlusOneQuery.add_possible_objects([first_document, document])
+              yield(first_document)
+              first_document = nil
+              yield(document)
+            else
+              Bullet::Detector::NPlusOneQuery.add_possible_objects(document)
+              yield(document)
+            end
+          end
+
+          if document_count == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(first_document)
+            yield(first_document)
+          end
+
+          self
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Association::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, association, object, reload = false)
+          result = origin_get_relation(name, association, object, reload)
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/rack.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'rack/request'
+require 'json'
+
 module Bullet
   class Rack
     include Dependency
@@ -19,7 +22,8 @@ module Bullet
       response_body = nil
 
       if Bullet.notification? || Bullet.always_append_html_body
-        if Bullet.inject_into_page? && !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
+        request = ::Rack::Request.new(env)
+        if Bullet.inject_into_page? && !skip_html_injection?(request) && !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
           if html_request?(headers, response)
             response_body = response_body(response)
 
@@ -73,8 +77,23 @@ module Bullet
       # 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
+      header_array.pop while JSON.generate(header_array).length > 8 * 1024
+      headers[header_name] = JSON.generate(header_array)
+    end
+
+    def skip_html_injection?(request)
+      query_string = request.env['QUERY_STRING']
+      return false if query_string.nil? || query_string.empty?
+
+      if defined?(Rack::QueryParser)
+        parser = Rack::QueryParser.new
+        params = parser.parse_nested_query(query_string)
+      else
+        # compatible with rack 1.x,
+        # remove it after dropping rails 4.2 suppport
+        params = Rack::Utils.parse_nested_query(query_string)
+      end
+      params['skip_html_injection'] == 'true'
     end
 
     def file?(headers)

data/lib/bullet/registry/base.rb

@@ -35,7 +35,11 @@ module Bullet
       end
 
       def include?(key, value)
-        !@registry[key].nil? && @registry[key].include?(value)
+        key?(key) && @registry[key].include?(value)
+      end
+
+      def key?(key)
+        @registry.key?(key)
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '8.0.1'
+  VERSION = '8.0.4'
 end

data/lib/bullet.rb

@@ -24,7 +24,7 @@ module Bullet
   if defined?(Rails::Railtie)
     class BulletRailtie < Rails::Railtie
       initializer 'bullet.configure_rails_initialization' do |app|
-        if defined?(ActionDispatch::ContentSecurityPolicy::Middleware) && Rails.application.config.content_security_policy
+        if defined?(ActionDispatch::ContentSecurityPolicy::Middleware)
           app.middleware.insert_before ActionDispatch::ContentSecurityPolicy::Middleware, Bullet::Rack
         else
           app.middleware.use Bullet::Rack
@@ -64,7 +64,7 @@ module Bullet
     ].freeze
 
     def enable=(enable)
-      @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
+      @enable = enable
 
       if enable?
         reset_safelist
@@ -90,15 +90,15 @@ module Bullet
     end
 
     def n_plus_one_query_enable?
-      enable? && !!@n_plus_one_query_enable
+      enable? && (@n_plus_one_query_enable.nil? ? true : @n_plus_one_query_enable)
     end
 
     def unused_eager_loading_enable?
-      enable? && !!@unused_eager_loading_enable
+      enable? && (@unused_eager_loading_enable.nil? ? true : @unused_eager_loading_enable)
     end
 
     def counter_cache_enable?
-      enable? && !!@counter_cache_enable
+      enable? && (@counter_cache_enable.nil? ? true : @counter_cache_enable)
     end
 
     def stacktrace_includes

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.0.4
 platform: ruby
 authors:
 - Richard Huang
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,7 @@ files:
 - lib/bullet/mongoid6x.rb
 - lib/bullet/mongoid7x.rb
 - lib/bullet/mongoid8x.rb
+- lib/bullet/mongoid9x.rb
 - lib/bullet/notification.rb
 - lib/bullet/notification/base.rb
 - lib/bullet/notification/counter_cache.rb