mongoid 9.0.11 → 9.1.1

data/lib/mongoid/config/introspection.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # This module provides a way to inspect not only the defined configuration
     # settings and their defaults (which are available via
     # `Mongoid::Config.settings`), but also the documentation about them. It
@@ -69,7 +67,7 @@ module Mongoid
         #
         # @return [ String ] the reformatted comment
         def indented_comment(indent: 2, indent_first_line: false)
-          comment.gsub(/^/, " " * indent).tap do |result|
+          comment.gsub(/^/, ' ' * indent).tap do |result|
             result.strip! unless indent_first_line
           end
         end
@@ -79,17 +77,17 @@ module Mongoid
         #
         # @return [ true | false ] whether the option is deprecated or not.
         def deprecated?
-          comment.include?("(Deprecated)")
+          comment.include?('(Deprecated)')
         end
 
         # Compare self with the given option.
         #
         # @return [ true | false ] If name, default, and comment are all the
         #   same, return true. Otherwise, false.
-        def ==(option)
-          name == option.name &&
-            default == option.default &&
-            comment == option.comment
+        def ==(other)
+          name == other.name &&
+            default == other.default &&
+            comment == other.comment
         end
 
         private
@@ -101,7 +99,7 @@ module Mongoid
         #
         # @return [ String ] the unindented text.
         def unindent(text)
-          text.strip.gsub(/^\s+/, "")
+          text.strip.gsub(/^\s+/, '')
         end
       end
 
@@ -117,7 +115,7 @@ module Mongoid
       #   1: the (potentially multiline) comment
       #   2: the option's name
       #   3: the option's default value
-      OPTION_PATTERN = %r{
+      OPTION_PATTERN = /
         (
           ((?:^\s*\#.*\n)+)  # match one or more lines of comments
           ^\s+option\s+      # followed immediately by a line declaring an option
@@ -125,11 +123,12 @@ module Mongoid
           default:\s+(.*?)   # match the default value for the option
           (?:,.*?)?          # skip any other configuration
         \n)                  # end with a newline
-      }x
+      /x
 
       # The full path to the source file of the Mongoid::Config module.
       CONFIG_RB_PATH = File.absolute_path(File.join(
-        File.dirname(__FILE__), "../config.rb"))
+                                            File.dirname(__FILE__), '../config.rb'
+                                          ))
 
       # Extracts the available configuration options from the Mongoid::Config
       # source file, and returns them as an array of hashes.
@@ -142,11 +141,10 @@ module Mongoid
       def options(include_deprecated: false)
         src = File.read(CONFIG_RB_PATH)
         src.scan(OPTION_PATTERN)
-          .map { |opt| Option.from_captures(opt) }
-          .reject { |opt| !include_deprecated && opt.deprecated? }
-          .sort_by { |opt| opt.name }
+           .map { |opt| Option.from_captures(opt) }
+           .reject { |opt| !include_deprecated && opt.deprecated? }
+           .sort_by { |opt| opt.name }
       end
     end
-
   end
 end

data/lib/mongoid/config/options.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # Encapsulates logic for setting options.
     module Options
-
       # Get the defaults or initialize a new empty hash.
       #
       # @example Get the defaults.
@@ -40,8 +37,17 @@ module Mongoid
           end
 
           define_method("#{name}=") do |value|
+            old_value = settings[name]
             settings[name] = value
-            options[:on_change]&.call(value)
+
+            begin
+              options[:on_change]&.call(value)
+            rescue StandardError
+              # If the on_change callback raises an error, we need to roll
+              # the change back.
+              settings[name] = old_value
+              raise
+            end
           end
 
           define_method("#{name}?") do
@@ -81,13 +87,13 @@ module Mongoid
       #
       # @return [ Integer ] The log level.
       def log_level
-        if level = settings[:log_level]
-          unless level.is_a?(Integer)
-            # JRuby String#constantize does not work here.
-            level = Logger.const_get(level.upcase.to_s)
-          end
-          level
+        return unless level = settings[:log_level]
+
+        unless level.is_a?(Integer)
+          # JRuby String#constantize does not work here.
+          level = Logger.const_get(level.upcase.to_s)
         end
+        level
       end
     end
   end

data/lib/mongoid/config/validators/async_query_executor.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validates the async query executor options in the Mongoid
       # configuration. Used during application bootstrapping.
       #
@@ -22,10 +20,9 @@ module Mongoid
         #
         # @api private
         def validate(options)
-          if options.key?(:async_query_executor)
-            if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
-              raise Errors::InvalidGlobalExecutorConcurrency
-            end
+          return unless options.key?(:async_query_executor)
+          if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
+            raise Errors::InvalidGlobalExecutorConcurrency
           end
         end
       end

data/lib/mongoid/config/validators/client.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for client specific configuration.
       module Client
         extend self
 
         # Standard configuration options.
-        STANDARD = [ :database, :hosts, :username, :password ].freeze
+        STANDARD = %i[database hosts username password].freeze
 
         # Validate the client configuration.
         #
@@ -19,9 +17,8 @@ module Mongoid
         #
         # @param [ Hash ] clients The clients config.
         def validate(clients)
-          unless clients.has_key?(:default)
-            raise Errors::NoDefaultClient.new(clients.keys)
-          end
+          raise Errors::NoDefaultClient.new(clients.keys) unless clients.has_key?(:default)
+
           clients.each_pair do |name, config|
             validate_client_database(name, config)
             validate_client_hosts(name, config)
@@ -41,9 +38,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_database(name, config)
-          if no_database_or_uri?(config)
-            raise Errors::NoClientDatabase.new(name, config)
-          end
+          return unless no_database_or_uri?(config)
+
+          raise Errors::NoClientDatabase.new(name, config)
         end
 
         # Validate that the client config has hosts.
@@ -56,9 +53,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_hosts(name, config)
-          if no_hosts_or_uri?(config)
-            raise Errors::NoClientHosts.new(name, config)
-          end
+          return unless no_hosts_or_uri?(config)
+
+          raise Errors::NoClientHosts.new(name, config)
         end
 
         # Validate that not both a uri and standard options are provided for a
@@ -72,9 +69,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_uri(name, config)
-          if both_uri_and_standard?(config)
-            raise Errors::MixedClientConfiguration.new(name, config)
-          end
+          return unless both_uri_and_standard?(config)
+
+          raise Errors::MixedClientConfiguration.new(name, config)
         end
 
         # Return true if the configuration has no database or uri option

data/lib/mongoid/config/validators/option.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for configuration options.
       module Option
         extend self
@@ -15,9 +13,9 @@ module Mongoid
         #
         # @param [ String ] option The name of the option.
         def validate(option)
-          unless Config.settings.keys.include?(option.to_sym)
-            raise Errors::InvalidConfigOption.new(option)
-          end
+          return if Config.settings.keys.include?(option.to_sym)
+
+          raise Errors::InvalidConfigOption.new(option)
         end
       end
     end

data/lib/mongoid/config/validators.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/config/validators/async_query_executor"
-require "mongoid/config/validators/option"
-require "mongoid/config/validators/client"
+require 'mongoid/config/validators/async_query_executor'
+require 'mongoid/config/validators/option'
+require 'mongoid/config/validators/client'

data/lib/mongoid/config.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/config/defaults"
-require "mongoid/config/environment"
-require "mongoid/config/options"
-require "mongoid/config/validators"
-require "mongoid/config/introspection"
-require "mongoid/config/encryption"
+require 'mongoid/config/defaults'
+require 'mongoid/config/environment'
+require 'mongoid/config/options'
+require 'mongoid/config/validators'
+require 'mongoid/config/introspection'
+require 'mongoid/config/encryption'
 
 module Mongoid
-
   # This module defines all the configuration options for Mongoid, including
   # the database connections.
   module Config
@@ -39,7 +37,7 @@ module Mongoid
     option :belongs_to_required_by_default, default: true
 
     # Set the global discriminator key.
-    option :discriminator_key, default: "_type"
+    option :discriminator_key, default: '_type'
 
     # Raise an exception when a field is redefined.
     option :duplicate_fields_exception, default: false
@@ -81,23 +79,23 @@ module Mongoid
     option :map_big_decimal_to_decimal128, default: true
 
     # Allow BSON::Decimal128 to be parsed and returned directly in
-    # field values. When BSON 5 is present and the this option is set to false
+    # field values. When BSON 5 is present and this option is set to false
     # (the default), BSON::Decimal128 values in the database will be returned
     # as BigDecimal.
     #
     # @note this option only has effect when BSON 5+ is present. Otherwise,
     #   the setting is ignored.
-    option :allow_bson5_decimal128, default: false, on_change: -> (allow) do
-        if BSON::VERSION >= '5.0.0'
-          if allow
-            BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BSON::Decimal128)
-          else
-            BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BigDecimal)
-          end
+    option :allow_bson5_decimal128, default: false, on_change: lambda { |allow|
+      if BSON::VERSION >= '5.0.0'
+        if allow
+          BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BSON::Decimal128)
+        else
+          BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BigDecimal)
         end
       end
+    }
 
-    # Sets the async_query_executor for the application. By default the thread pool executor
+    # Sets the async_query_executor for the application. By default, the thread pool executor
     #   is set to `:immediate. Options are:
     #
     #   - :immediate - Initializes a single +Concurrent::ImmediateExecutor+
@@ -110,30 +108,100 @@ module Mongoid
     # to `:global_thread_pool`.
     option :global_executor_concurrency, default: nil
 
-    # When this flag is true, it will be possible to change the parent of a
-    # record in a "has_many" association by passing the child record's id in the
-    # nested attributes for another parent record.
+    VALID_ISOLATION_LEVELS = %i[ rails thread fiber ].freeze
+
+    # Defines the isolation level that Mongoid uses to store its internal
+    # state.
     #
-    # When this flag is false, attempting to change the parent of a record in a
-    # "has-many" association via nested attributes will raise an error.
+    # Valid values are:
+    # - `:rails` - Uses the isolation level that Rails currently has
+    #  configured. (This is the default.)
+    # - `:thread` - Uses thread-local storage.
+    # - `:fiber` - Uses fiber-local storage (only supported in Ruby 3.2+).
+    #
+    # If set to `:fiber`, Mongoid will use fiber-local storage instead. This
+    # may be necessary if you are using libraries like Falcon, which use
+    # fibers to manage concurrency.
+    #
+    # Note that the `:fiber` isolation level is only supported in Ruby 3.2
+    # and later, due to semantic differences in how fiber storage is handled
+    # in earlier Ruby versions.
+    option :isolation_level, default: :rails, on_change: lambda { |level|
+      validate_isolation_level!(level)
+    }
+
+    # When this flag is true, it will be possible to add a record to a
+    # "has_many" or "has_and_belongs_to_many" association by passing that
+    # record's id in the nested attributes for another parent record, even
+    # when the record does not already belong to that association. For a
+    # "has_many" association this moves the record to the new parent.
     #
-    # The default is `true`. Note that allowing reparenting via nested attributes
+    # When this flag is false, an id in nested attributes is only resolved
+    # within the association itself, and anything else raises an error.
+    #
+    # The default is `false`. Note that allowing reparenting via nested attributes
     # is a potential security risk, since it could allow a malicious user to move
     # records that they do not own to a parent record that they do own.
     #
-    # This option will default to `false` in Mongoid 9.1, and will be removed
-    # in Mongoid 10.
-    option :allow_reparenting_via_nested_attributes, default: true
+    # This option will be removed in Mongoid 10, and the only behavior will be
+    # as if this option were set to false.
+    option :allow_reparenting_via_nested_attributes, default: false
+
+    # When this flag is true, Mongoid will skip sending queries to the database
+    # for criteria that are guaranteed to return no results, such as those with
+    # an empty $in array (e.g. Band.in(name: [])). The default is false.
+    option :allow_short_circuit_queries, default: false
 
     # When this flag is true, any documents in associations with `autosave: true`
     # will be saved even if they have not been changed. When this flag is false,
     # only autosaved documents that have been changed will be saved. The default
-    # is `true`.
+    # is false.
+    #
+    # This option will be removed in Mongoid 10, with the only behavior at that
+    # point being as if this option were set to false.
+    option :autosave_saves_unchanged_documents, default: false
+
+    # Returns the (potentially-dereferenced) isolation level that Mongoid
+    # will use to store its internal state. If `isolation_level` is set to
+    # `:rails`, this will return the isolation level that Rails is current
+    # configured to use (`ActiveSupport::IsolatedExecutionState.isolation_level`).
+    #
+    # If using an older version of Rails that does not support
+    # ActiveSupport::IsolatedExecutionState, this will return `:thread`
+    # instead.
     #
-    # This option will default to `false` in Mongoid 9.1, and will be removed
-    # in Mongoid 10, with the only behavior at that point being as if this
-    # option were set to `false`.
-    option :autosave_saves_unchanged_documents, default: true
+    # @api private
+    def real_isolation_level
+      return isolation_level unless isolation_level == :rails
+
+      if defined?(ActiveSupport::IsolatedExecutionState)
+        ActiveSupport::IsolatedExecutionState.isolation_level.tap do |level|
+          # We can't guarantee that Rails will always support the same
+          # isolation levels as Mongoid, so we check here to make sure
+          # it's something we can work with.
+          validate_isolation_level!(level)
+        end
+      else
+        # The default, if Rails does not support IsolatedExecutionState,
+        :thread
+      end
+    end
+
+    # Checks to see if the provided isolation level is something that Mongoid
+    # supports. Raises Errors::UnsupportedIsolationLevel if it is not.
+    #
+    # This will also raise an error if the isolation level is set to `:fiber`
+    # and the Ruby version is less than 3.2, since fiber-local storage
+    # is not supported in earlier Ruby versions.
+    #
+    # @api private
+    def validate_isolation_level!(level)
+      raise Errors::UnsupportedIsolationLevel.new(level) unless VALID_ISOLATION_LEVELS.include?(level)
+
+      return unless level == :fiber && RUBY_VERSION < '3.2'
+
+      raise Errors::UnsupportedIsolationLevel.new(level)
+    end
 
     # When this flag is false, a document will become read-only only once the
     # #readonly! method is called, and an error will be raised on attempting
@@ -191,7 +259,7 @@ module Mongoid
     #
     # Setting this flag to true restores the pre-9.0 behavior, where callbacks
     # for embedded documents are called. This may lead to stack overflow errors
-    # if there are more than cicrca 1000 embedded documents in the root
+    # if there are more than circa 1000 embedded documents in the root
     # document's dependencies graph.
     # See https://jira.mongodb.org/browse/MONGOID-5658 for more details.
     option :around_callbacks_for_embeds, default: false
@@ -205,6 +273,74 @@ module Mongoid
     # See https://jira.mongodb.org/browse/MONGOID-5785 for more details.
     option :allow_scopes_to_unset_default_scope, default: false
 
+    # When this flag is false, indexes are (roughly) validated on the client
+    # to prevent duplicate indexes being declared. This validation is
+    # incomplete, however, and can result in some indexes being silently
+    # ignored.
+    #
+    # Setting this to true will allow duplicate indexes to be declared and sent
+    # to the server. The server will then validate the indexes and raise an
+    # exception if duplicates are detected.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5827 for an example of the
+    # consequences of duplicate index checking.
+    option :allow_duplicate_index_declarations, default: false
+
+    # When this flag is true, performing a serializable_hash(only: []) will
+    # result in all fields being included. This is the traditional (and default)
+    # behavior in Mongoid 9 and earlier.
+    #
+    # Setting this flag to false will change the behavior to suppress all fields
+    # in the serialized hash. This will be the default in Mongoid 10.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5892 for more details.
+    option :serializable_hash_with_legacy_only, default: true
+
+    # When false (default), query operators are restricted when building a
+    # selector, so that user-supplied input reaching the query builder cannot
+    # make MongoDB execute arbitrary JavaScript. Two rules are enforced:
+    #
+    # - An operator at the top level of an expression must appear in
+    #   +Criteria::Queryable::Selectable::ALLOWED_QUERY_OPERATORS+.
+    # - +$where+, +$function+, and +$accumulator+ are rejected at any depth,
+    #   including inside +$expr+ and the logical operators.
+    #
+    # This applies to every query method that accepts an expression, including
+    # +where+, +find_by+, +and+, +or+, +nor+, +not+, +any_of+, and +none_of+.
+    # It also governs the string form of +where+, e.g.
+    # +where("this.name == 'admin'")+, which the server evaluates as +$where+.
+    # Applications relying on that form must set this option to true.
+    #
+    # The APIs that request JavaScript explicitly, +Criteria#for_js+ and
+    # +js_query+, are unaffected: there the developer has asked for it.
+    #
+    # Set to true to restore the unrestricted pass-through behavior.
+    #
+    # Note that this option is deliberately not tied to +load_defaults+: an
+    # application that has opted into older defaults still gets the guard, and
+    # must set this option explicitly to turn it off.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5939,
+    # https://jira.mongodb.org/browse/MONGOID-5993,
+    # https://jira.mongodb.org/browse/MONGOID-5994 for details.
+    option :allow_unsafe_query_operators, default: false
+
+    # The maximum number of seconds that evaluating a single query in memory
+    # may spend executing regular expressions. Queries against an embedded
+    # association are evaluated in the calling thread, so a pattern built from
+    # user input runs locally and can otherwise consume unbounded CPU. The
+    # limit is cumulative over the whole query, since cost grows with the
+    # number of documents and conditions as well as with the pattern.
+    #
+    # Set to nil to remove the limit. On Ruby 3.2 and later the remaining
+    # budget is compiled into the pattern, so the limit counts only the time
+    # spent matching. Earlier Rubies have no per-Regexp timeout, so the query
+    # is bounded with Timeout instead and the limit is wall clock over the
+    # whole in-memory evaluation.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5981 for details.
+    option :in_memory_regexp_time_limit, default: 5.0
+
     # Returns the Config singleton, for use in the configure DSL.
     #
     # @return [ self ] The Config singleton.
@@ -231,11 +367,11 @@ module Mongoid
     #   config.connect_to("mongoid_test")
     #
     # @param [ String ] name The database name.
-    def connect_to(name, options = { read: { mode: :primary }})
+    def connect_to(name, options = { read: { mode: :primary } })
       self.clients = {
         default: {
           database: name,
-          hosts: [ "localhost:27017" ],
+          hosts: [ 'localhost:27017' ],
           options: options
         }
       }
@@ -375,12 +511,12 @@ module Mongoid
     #
     # @param [ Hash ] options The configuration options.
     def options=(options)
-      if options
-        Validators::AsyncQueryExecutor.validate(options)
-        options.each_pair do |option, value|
-          Validators::Option.validate(option)
-          send("#{option}=", value)
-        end
+      return unless options
+
+      Validators::AsyncQueryExecutor.validate(options)
+      options.each_pair do |option, value|
+        Validators::Option.validate(option)
+        send("#{option}=", value)
       end
     end
 
@@ -401,7 +537,7 @@ module Mongoid
     #
     # @return [ String ] The time zone.
     def time_zone
-      use_utc? ? "UTC" : ::Time.zone
+      use_utc? ? 'UTC' : ::Time.zone
     end
 
     # Is the application running under passenger?
@@ -427,6 +563,7 @@ module Mongoid
 
     def clients=(clients)
       raise Errors::NoClientsConfig.new unless clients
+
       c = clients.with_indifferent_access
       Validators::Client.validate(c)
       @clients = c
@@ -437,11 +574,11 @@ module Mongoid
     #
     # @return [Mongo::Client] Client according to global overrides.
     def global_client
-      client =  if Threaded.client_override
-                  Clients.with_name(Threaded.client_override)
-                else
-                  Clients.default
-                end
+      client = if Threaded.client_override
+                 Clients.with_name(Threaded.client_override)
+               else
+                 Clients.default
+               end
       if Threaded.database_override
         client.use(Threaded.database_override)
       else
@@ -449,6 +586,10 @@ module Mongoid
       end
     end
 
+    # Wraps configuration options that have been deprecated so that assigning
+    # them emits a deprecation warning. OPTIONS is intentionally empty when no
+    # options are currently deprecated; it is populated as options are retired,
+    # at which point this module rewrites their setters to warn.
     module DeprecatedOptions
       OPTIONS = %i[]
 

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
+
+require 'mongoid/field_readable'
 
 module Mongoid
   module Contextual
     module Aggregable
       # Contains behavior for aggregating values in memory.
       module Memory
+        include FieldReadable
 
         # Get all the aggregate values for the provided field.
         # Provided for interface consistency with Aggregable::Mongo.
@@ -16,7 +18,7 @@ module Mongoid
         #   If no documents are present, then returned Hash will have
         #   count, sum of 0 and max, min, avg of nil.
         def aggregates(field)
-          %w(count sum avg min max).each_with_object({}) do |method, hash|
+          %w[count sum avg min max].each_with_object({}) do |method, hash|
             hash[method] = send(method, field)
           end
         end
@@ -30,7 +32,7 @@ module Mongoid
         #
         # @return [ Numeric ] The average.
         def avg(field)
-          total = count { |doc| !doc.send(field).nil? }
+          total = count { |doc| !read_field_value(doc, field).nil? }
           return nil unless total > 0
 
           total = total.to_f if total.is_a?(Integer)
@@ -90,7 +92,7 @@ module Mongoid
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol | Numeric ] field The field to sum, or the intial
+        # @param [ Symbol | Numeric ] field The field to sum, or the initial
         #   value of the sum when a block is given.
         #
         # @return [ Numeric ] The sum value.
@@ -116,7 +118,7 @@ module Mongoid
         def aggregate_by(field, method)
           return nil unless any?
 
-          map { |doc| doc.public_send(field) }.compact.public_send(method)
+          map { |doc| read_field_value(doc, field) }.compact.public_send(method)
         end
       end
     end