mongoid 7.0.12 → 7.3.3

data/lib/mongoid/query_cache.rb

@@ -1,12 +1,20 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # A cache of database queries on a per-request basis.
   #
   # @since 4.0.0
   module QueryCache
-    class << self
+    # @api private
+    LEGACY_WARNING = <<~DOC
+      You are using the legacy Mongoid query cache which has known issues.
+      Please upgrade the `mongo' gem to at least 2.14.0 to use the improved driver query cache.
+      Refer to: https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/#the-improved-driver-query-cache
+    DOC
 
+    class << self
       # Get the cached queries.
       #
       # @example Get the cached queries from the current thread.
@@ -15,8 +23,13 @@ module Mongoid
       # @return [ Hash ] The hash of cached queries.
       #
       # @since 4.0.0
+      # @api private
       def cache_table
-        Thread.current["[mongoid]:query_cache"] ||= {}
+        if defined?(Mongo::QueryCache)
+          raise NotImplementedError, "Mongoid does not expose driver's query cache table"
+        else
+          Thread.current["[mongoid]:query_cache"] ||= {}
+        end
       end
 
       # Clear the query cache.
@@ -28,7 +41,11 @@ module Mongoid
       #
       # @since 4.0.0
       def clear_cache
-        Thread.current["[mongoid]:query_cache"] = nil
+        if defined?(Mongo::QueryCache)
+          Mongo::QueryCache.clear
+        else
+          Thread.current["[mongoid]:query_cache"] = nil
+        end
       end
 
       # Set whether the cache is enabled.
@@ -40,7 +57,11 @@ module Mongoid
       #
       # @since 4.0.0
       def enabled=(value)
-        Thread.current["[mongoid]:query_cache:enabled"] = value
+        if defined?(Mongo::QueryCache)
+          Mongo::QueryCache.enabled = value
+        else
+          Thread.current["[mongoid]:query_cache:enabled"] = value
+        end
       end
 
       # Is the query cache enabled on the current thread?
@@ -52,7 +73,11 @@ module Mongoid
       #
       # @since 4.0.0
       def enabled?
-        !!Thread.current["[mongoid]:query_cache:enabled"]
+        if defined?(Mongo::QueryCache)
+          Mongo::QueryCache.enabled?
+        else
+          !!Thread.current["[mongoid]:query_cache:enabled"]
+        end
       end
 
       # Execute the block while using the query cache.
@@ -63,12 +88,22 @@ module Mongoid
       # @return [ Object ] The result of the block.
       #
       # @since 4.0.0
-      def cache
-        enabled = QueryCache.enabled?
-        QueryCache.enabled = true
-        yield
-      ensure
-        QueryCache.enabled = enabled
+      def cache(&block)
+        if defined?(Mongo::QueryCache)
+          Mongo::QueryCache.cache(&block)
+        else
+          @legacy_query_cache_warned ||= begin
+            Mongoid.logger.warn(LEGACY_WARNING)
+            true
+          end
+          enabled = QueryCache.enabled?
+          QueryCache.enabled = true
+          begin
+            yield
+          ensure
+            QueryCache.enabled = enabled
+          end
+        end
       end
 
       # Execute the block with the query cache disabled.
@@ -77,47 +112,59 @@ module Mongoid
       #   QueryCache.uncached { collection.find }
       #
       # @return [ Object ] The result of the block.
-      def uncached
-        enabled = QueryCache.enabled?
-        QueryCache.enabled = false
-        yield
-      ensure
-        QueryCache.enabled = enabled
+      def uncached(&block)
+        if defined?(Mongo::QueryCache)
+          Mongo::QueryCache.uncached(&block)
+        else
+          enabled = QueryCache.enabled?
+          QueryCache.enabled = false
+          begin
+            yield
+          ensure
+            QueryCache.enabled = enabled
+          end
+        end
       end
     end
 
-    # The middleware to be added to a rack application in order to activate the
-    # query cache.
-    #
-    # @since 4.0.0
-    class Middleware
-
-      # Instantiate the middleware.
-      #
-      # @example Create the new middleware.
-      #   Middleware.new(app)
-      #
-      # @param [ Object ] app The rack applciation stack.
+    if defined?(Mongo::QueryCache::Middleware)
+      Middleware = Mongo::QueryCache::Middleware
+    else
+      # The middleware to be added to a rack application in order to activate the
+      # query cache.
       #
       # @since 4.0.0
-      def initialize(app)
-        @app = app
-      end
+      class Middleware
+
+        # Instantiate the middleware.
+        #
+        # @example Create the new middleware.
+        #   Middleware.new(app)
+        #
+        # @param [ Object ] app The rack application stack.
+        #
+        # @since 4.0.0
+        def initialize(app)
+          @app = app
+        end
 
-      # Execute the request, wrapping in a query cache.
-      #
-      # @example Execute the request.
-      #   middleware.call(env)
-      #
-      # @param [ Object ] env The environment.
-      #
-      # @return [ Object ] The result of the call.
-      #
-      # @since 4.0.0
-      def call(env)
-        QueryCache.cache { @app.call(env) }
-      ensure
-        QueryCache.clear_cache
+        # Execute the request, wrapping in a query cache.
+        #
+        # @example Execute the request.
+        #   middleware.call(env)
+        #
+        # @param [ Object ] env The environment.
+        #
+        # @return [ Object ] The result of the call.
+        #
+        # @since 4.0.0
+        def call(env)
+          QueryCache.cache do
+            @app.call(env)
+          end
+        ensure
+          QueryCache.clear_cache
+        end
       end
     end
 
@@ -125,6 +172,7 @@ module Mongoid
     # the database if the same query has already been executed.
     #
     # @since 5.0.0
+    # @deprecated This class is only used with driver versions 2.13 and lower.
     class CachedCursor < Mongo::Cursor
 
       # We iterate over the cached documents if they exist already in the
@@ -162,31 +210,28 @@ module Mongoid
 
       def process(result)
         documents = super
-
         if @cursor_id.zero? && !@after_first_batch
           @cached_documents ||= []
           @cached_documents.concat(documents)
         end
-
         @after_first_batch = true
         documents
       end
     end
 
-    # Included to add behaviour for clearing out the query cache on certain
+    # Included to add behavior for clearing out the query cache on certain
     # operations.
     #
     # @since 4.0.0
+    # @deprecated This module is only used with driver versions 2.13 and lower.
     module Base
 
       def alias_query_cache_clear(*method_names)
         method_names.each do |method_name|
-          class_eval <<-CODE, __FILE__, __LINE__ + 1
-              def #{method_name}_with_clear_cache(*args)
-                QueryCache.clear_cache
-                #{method_name}_without_clear_cache(*args)
-              end
-            CODE
+          define_method("#{method_name}_with_clear_cache") do |*args|
+            QueryCache.clear_cache
+            send("#{method_name}_without_clear_cache", *args)
+          end
 
           alias_method "#{method_name}_without_clear_cache", method_name
           alias_method method_name, "#{method_name}_with_clear_cache"
@@ -198,6 +243,7 @@ module Mongoid
     # cached cursor or a regular cursor on iteration.
     #
     # @since 5.0.0
+    # @deprecated This module is only used with driver versions 2.13 and lower.
     module View
       extend ActiveSupport::Concern
 
@@ -228,24 +274,19 @@ module Mongoid
         else
           @cursor = nil
           unless @cursor = cached_cursor
-
-            if driver_supports_cursor_sessions?
-              session = client.send(:get_session, @options)
-              read_with_retry(session, server_selector) do |server|
-                result = send_initial_query(server, session)
-                @cursor = get_cursor(result, server, session)
-              end
-            else
-              read_with_retry do
-                server = server_selector.select_server(cluster)
-                result = send_initial_query(server)
-                @cursor = get_cursor(result, server)
+            session = client.send(:get_session, @options)
+            read_with_retry(session, server_selector) do |server|
+              result = send_initial_query(server, session)
+              if result.cursor_id == 0 || result.cursor_id.nil?
+                @cursor = CachedCursor.new(view, result, server, session: session)
+                QueryCache.cache_table[cache_key] = @cursor
+              else
+                @cursor = Mongo::Cursor.new(view, result, server, session: session)
               end
             end
           end
-
           if block_given?
-            if limit && limit != -1
+            if limit
               @cursor.to_a[0...limit].each do |doc|
                 yield doc
               end
@@ -270,44 +311,19 @@ module Mongoid
         cursor || QueryCache.cache_table[cache_key]
       end
 
-      def get_cursor(result, server, session = nil)
-        if result.cursor_id == 0 || result.cursor_id.nil?
-          cursor = if session
-            CachedCursor.new(view, result, server, session: session)
-          else
-            CachedCursor.new(view, result, server)
-          end
-
-          QueryCache.cache_table[cache_key] = cursor
-        else
-          cursor = if session
-            Mongo::Cursor.new(view, result, server, session: session)
-          else
-            Mongo::Cursor.new(view, result, server)
-          end
-        end
-
-        cursor
-      end
-
       def cache_key
         [ collection.namespace, selector, limit, skip, sort, projection, collation ]
       end
 
       def system_collection?
-        collection.namespace =~ /\Asystem./
-      end
-
-      def driver_supports_cursor_sessions?
-        # Driver versions 2.9 and newer support passing in a session to the
-        # cursor object.
-        (Mongo::VERSION.split('.').map(&:to_i) <=> [2, 9, 0]) > 0
+        collection.name.start_with?('system.')
       end
     end
 
-    # Adds behaviour to the query cache for collections.
+    # Adds behavior to the query cache for collections.
     #
     # @since 5.0.0
+    # @deprecated This module is only used with driver versions 2.13 and lower.
     module Collection
       extend ActiveSupport::Concern
 
@@ -326,6 +342,8 @@ module Mongoid
   end
 end
 
-Mongo::Collection.__send__(:include, Mongoid::QueryCache::Collection)
-Mongo::Collection::View.__send__(:include, Mongoid::QueryCache::View)
-Mongoid::Document.__send__(:include, Mongoid::QueryCache::Document)
+unless defined?(Mongo::QueryCache)
+  Mongo::Collection.__send__(:include, Mongoid::QueryCache::Collection)
+  Mongo::Collection::View.__send__(:include, Mongoid::QueryCache::View)
+  Mongoid::Document.__send__(:include, Mongoid::QueryCache::Document)
+end

data/lib/mongoid/railtie.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "rails"
 require "rails/mongoid"
 
@@ -40,7 +42,7 @@ module Rails
       # @example Set up configuration in the Rails app.
       #   module MyApplication
       #     class Application < Rails::Application
-      #       config.mongoid.logger = Logger.new($stdout, :warn)
+      #       config.mongoid.logger = Logger.new(STDERR, :warn)
       #     end
       #   end
       #

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Railties
     module ControllerRuntime
@@ -83,4 +86,4 @@ module Mongoid
 
     end
   end
-end
+end

data/lib/mongoid/railties/database.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 load 'mongoid/tasks/database.rake'
 
 namespace :db do
@@ -58,13 +60,20 @@ namespace :db do
   end
 
   unless Rake::Task.task_defined?("db:create_indexes")
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => "mongoid:create_indexes"
   end
 
   unless Rake::Task.task_defined?("db:remove_indexes")
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => "mongoid:remove_indexes"
   end
 
+  unless Rake::Task.task_defined?("db:shard_collections")
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => "mongoid:shard_collections"
+  end
+
   namespace :mongoid do
     task :load_models do
       ::Rails.application.eager_load! if defined?(::Rails)

data/lib/mongoid/reloadable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module handles reloading behaviour of documents.
+  # This module handles reloading behavior of documents.
   #
   # @since 4.0.0
   module Reloadable
@@ -19,6 +21,11 @@ module Mongoid
     #
     # @since 1.0.0
     def reload
+      if @atomic_selector
+        # Clear atomic_selector cache for sharded clusters. MONGOID-5076
+        remove_instance_variable('@atomic_selector')
+      end
+
       reloaded = _reload
       if Mongoid.raise_not_found_error && reloaded.empty?
         raise Errors::DocumentNotFound.new(self.class, _id, _id)
@@ -37,7 +44,7 @@ module Mongoid
     private
 
     # Reload the document, determining if it's embedded or not and what
-    # behaviour to use.
+    # behavior to use.
     #
     # @example Reload the document.
     #   document._reload
@@ -58,7 +65,7 @@ module Mongoid
     #
     # @since 2.3.2
     def reload_root_document
-      {}.merge(collection.find({ _id: _id }, session: _session).read(mode: :primary).first || {})
+      {}.merge(collection.find(atomic_selector, session: _session).read(mode: :primary).first || {})
     end
 
     # Reload the embedded document.
@@ -71,7 +78,7 @@ module Mongoid
     # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        collection(_root).find(_id: _root._id).read(mode: :primary).first
+        collection(_root).find(_root.atomic_selector).read(mode: :primary).first
       ))
     end
 

data/lib/mongoid/scopable.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
 
 module Mongoid
 
-  # This module contains behaviour for all Mongoid scoping - named scopes,
+  # This module contains behavior for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
   #
   # @since 4.0.0

data/lib/mongoid/selectable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Provides behaviour for generating the selector for a specific document.
+  # Provides behavior for generating the selector for a specific document.
   #
   # @since 4.0.0
   module Selectable
@@ -19,7 +21,7 @@ module Mongoid
     # @since 1.0.0
     def atomic_selector
       @atomic_selector ||=
-        (embedded? ? embedded_atomic_selector : root_atomic_selector)
+        (embedded? ? embedded_atomic_selector : root_atomic_selector_in_db)
     end
 
     private
@@ -42,18 +44,16 @@ module Mongoid
       end
     end
 
-    # Get the atomic selector for a root document.
+    # Get the atomic selector that would match the existing version of the
+    # root document.
     #
     # @api private
     #
-    # @example Get the root atomic selector.
-    #   document.root_atomic_selector
-    #
     # @return [ Hash ] The root document selector.
     #
     # @since 4.0.0
-    def root_atomic_selector
-      { "_id" => _id }.merge!(shard_key_selector)
+    def root_atomic_selector_in_db
+      { "_id" => _id }.merge!(shard_key_selector_in_db)
     end
   end
 end

data/lib/mongoid/serializable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module provides the extra behaviour for including relations in JSON
+  # This module provides the extra behavior for including associations in JSON
   # and XML serialization.
   #
   # @since 4.0.0
@@ -11,8 +13,16 @@ module Mongoid
     # We need to redefine where the JSON configuration is getting defined,
     # similar to +ActiveRecord+.
     included do
-      undef_method :include_root_in_json
-      delegate :include_root_in_json, to: ::Mongoid
+
+      class << self
+        # Note that this intentionally only delegates :include_root_in_json
+        # and not :include_root_in_json? - delegating the latter produces
+        # wrong behavior.
+        # Also note that this intentionally uses the ActiveSupport delegation
+        # functionality and not the Ruby standard library one.
+        # See https://jira.mongodb.org/browse/MONGOID-4849.
+        delegate :include_root_in_json, to: ::Mongoid
+      end
     end
 
     # Gets the document as a serializable hash, used by ActiveModel's JSON
@@ -26,7 +36,7 @@ module Mongoid
     #
     # @param [ Hash ] options The options to pass.
     #
-    # @option options [ Symbol ] :include What relations to include.
+    # @option options [ Symbol ] :include What associations to include.
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
     # @option options [ Symbol ] :methods What methods to include.
@@ -70,7 +80,7 @@ module Mongoid
 
       only = Array.wrap(options[:only]).map(&:to_s)
       except = Array.wrap(options[:except]).map(&:to_s)
-      except |= ['_type'] unless Mongoid.include_type_for_serialization
+      except |= [self.class.discriminator_key] unless Mongoid.include_type_for_serialization
 
       if !only.empty?
         names &= only
@@ -80,7 +90,7 @@ module Mongoid
       names
     end
 
-    # Serialize a single attribute. Handles relations, fields, and dynamic
+    # Serialize a single attribute. Handles associations, fields, and dynamic
     # attributes.
     #
     # @api private
@@ -107,16 +117,16 @@ module Mongoid
       end
     end
 
-    # For each of the provided include options, get the relation needed and
+    # For each of the provided include options, get the association needed and
     # provide it in the hash.
     #
-    # @example Serialize the included relations.
+    # @example Serialize the included associations.
     #   document.serialize_relations({}, :include => :addresses)
     #
     # @param [ Hash ] attributes The attributes to serialize.
     # @param [ Hash ] options The serialization options.
     #
-    # @option options [ Symbol ] :include What relations to include
+    # @option options [ Symbol ] :include What associations to include
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
     #
@@ -135,12 +145,12 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the names.
     #
-    # @example Get the relation names.
+    # @example Get the association names.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     #
-    # @return [ Array<Symbol> ] The names of the included relations.
+    # @return [ Array<Symbol> ] The names of the included associations.
     #
     # @since 2.0.0.rc.6
     def relation_names(inclusions)
@@ -150,14 +160,14 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the options.
     #
-    # @example Get the relation options.
+    # @example Get the association options.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     # @param [ Hash ] options The options.
-    # @param [ Symbol ] name The name of the relation.
+    # @param [ Symbol ] name The name of the association.
     #
-    # @return [ Hash ] The options for the relation.
+    # @return [ Hash ] The options for the association.
     #
     # @since 2.0.0.rc.6
     def relation_options(inclusions, options, name)