mongoid 7.0.2 → 8.1.1

data/lib/mongoid/query_cache.rb

@@ -1,23 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # A cache of database queries on a per-request basis.
-  #
-  # @since 4.0.0
   module QueryCache
-    class << self
 
-      # Get the cached queries.
-      #
-      # @example Get the cached queries from the current thread.
-      #   QueryCache.cache_table
-      #
-      # @return [ Hash ] The hash of cached queries.
-      #
-      # @since 4.0.0
-      def cache_table
-        Thread.current["[mongoid]:query_cache"] ||= {}
-      end
+    class << self
 
       # Clear the query cache.
       #
@@ -25,10 +13,9 @@ module Mongoid
       #   QueryCache.clear_cache
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 4.0.0
       def clear_cache
-        Thread.current["[mongoid]:query_cache"] = nil
+        Mongoid::Warnings.warn_mongoid_query_cache_clear
+        Mongo::QueryCache.clear
       end
 
       # Set whether the cache is enabled.
@@ -36,11 +23,10 @@ module Mongoid
       # @example Set if the cache is enabled.
       #   QueryCache.enabled = true
       #
-      # @param [ true, false ] value The enabled value.
-      #
-      # @since 4.0.0
+      # @param [ true | false ] value The enabled value.
       def enabled=(value)
-        Thread.current["[mongoid]:query_cache:enabled"] = value
+        Mongoid::Warnings.warn_mongoid_query_cache
+        Mongo::QueryCache.enabled = value
       end
 
       # Is the query cache enabled on the current thread?
@@ -48,11 +34,10 @@ module Mongoid
       # @example Is the query cache enabled?
       #   QueryCache.enabled?
       #
-      # @return [ true, false ] If the cache is enabled.
-      #
-      # @since 4.0.0
+      # @return [ true | false ] If the cache is enabled.
       def enabled?
-        !!Thread.current["[mongoid]:query_cache:enabled"]
+        Mongoid::Warnings.warn_mongoid_query_cache
+        Mongo::QueryCache.enabled?
       end
 
       # Execute the block while using the query cache.
@@ -61,14 +46,9 @@ module Mongoid
       #   QueryCache.cache { collection.find }
       #
       # @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)
+        Mongoid::Warnings.warn_mongoid_query_cache
+        Mongo::QueryCache.cache(&block)
       end
 
       # Execute the block with the query cache disabled.
@@ -77,208 +57,12 @@ 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)
+        Mongoid::Warnings.warn_mongoid_query_cache
+        Mongo::QueryCache.uncached(&block)
       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.
-      #
-      # @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
-      end
-    end
-
-    # A Cursor that attempts to load documents from memory first before hitting
-    # the database if the same query has already been executed.
-    #
-    # @since 5.0.0
-    class CachedCursor < Mongo::Cursor
-
-      # We iterate over the cached documents if they exist already in the
-      # cursor otherwise proceed as normal.
-      #
-      # @example Iterate over the documents.
-      #   cursor.each do |doc|
-      #     # ...
-      #   end
-      #
-      # @since 5.0.0
-      def each
-        if @cached_documents
-          @cached_documents.each{ |doc| yield doc }
-        else
-          super
-        end
-      end
-
-      # Get a human-readable string representation of +Cursor+.
-      #
-      # @example Inspect the cursor.
-      #   cursor.inspect
-      #
-      # @return [ String ] A string representation of a +Cursor+ instance.
-      #
-      # @since 2.0.0
-      def inspect
-        "#<Mongoid::QueryCache::CachedCursor:0x#{object_id} @view=#{@view.inspect}>"
-      end
-
-      private
-
-      def process(result)
-        @remaining -= result.returned_count if limited?
-        @cursor_id = result.cursor_id
-        @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
-        documents = result.documents
-        (@cached_documents ||= []).concat(documents)
-        documents
-      end
-    end
-
-    # Included to add behaviour for clearing out the query cache on certain
-    # operations.
-    #
-    # @since 4.0.0
-    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
-
-          alias_method "#{method_name}_without_clear_cache", method_name
-          alias_method method_name, "#{method_name}_with_clear_cache"
-        end
-      end
-    end
-
-    # Contains enhancements to the Mongo::Collection::View in order to get a
-    # cached cursor or a regular cursor on iteration.
-    #
-    # @since 5.0.0
-    module View
-      extend ActiveSupport::Concern
-
-      included do
-        extend QueryCache::Base
-        alias_query_cache_clear :delete_one,
-                                :delete_many,
-                                :update_one,
-                                :update_many,
-                                :replace_one,
-                                :find_one_and_delete,
-                                :find_one_and_replace,
-                                :find_one_and_update
-      end
-
-      # Override the default enumeration to handle if the cursor can be cached
-      # or not.
-      #
-      # @example Iterate over the view.
-      #   view.each do |doc|
-      #     # ...
-      #   end
-      #
-      # @since 5.0.0
-      def each
-        if system_collection? || !QueryCache.enabled?
-          super
-        else
-          unless cursor = cached_cursor
-            read_with_retry do
-              server = server_selector.select_server(cluster)
-              cursor = CachedCursor.new(view, send_initial_query(server), server)
-              QueryCache.cache_table[cache_key] = cursor
-            end
-          end
-          cursor.each do |doc|
-            yield doc
-          end if block_given?
-          cursor
-        end
-      end
-
-      private
-
-      def cached_cursor
-        if limit
-          key = [ collection.namespace, selector, nil, skip, sort, projection, collation  ]
-          cursor = QueryCache.cache_table[key]
-          if cursor
-            limited_docs = cursor.to_a[0...limit.abs]
-            cursor.instance_variable_set(:@cached_documents, limited_docs)
-          end
-        end
-        cursor || QueryCache.cache_table[cache_key]
-      end
-
-      def cache_key
-        [ collection.namespace, selector, limit, skip, sort, projection, collation ]
-      end
-
-      def system_collection?
-        collection.namespace =~ /^system./
-      end
-    end
-
-    # Adds behaviour to the query cache for collections.
-    #
-    # @since 5.0.0
-    module Collection
-      extend ActiveSupport::Concern
-
-      included do
-        extend QueryCache::Base
-        alias_query_cache_clear :insert_one, :insert_many
-      end
-    end
-
-    # Bypass the query cache when reloading a document.
-    module Document
-      def reload
-        QueryCache.uncached { super }
-      end
-    end
+    Middleware = Mongo::QueryCache::Middleware
   end
 end
-
-Mongo::Collection.__send__(:include, Mongoid::QueryCache::Collection)
-Mongo::Collection::View.__send__(:include, Mongoid::QueryCache::View)
-Mongoid::Document.__send__(:include, Mongoid::QueryCache::Document)

data/lib/mongoid/railtie.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails"
 require "rails/mongoid"
 
@@ -6,8 +7,6 @@ module Rails
   module Mongoid
 
     # Hooks Mongoid into Rails 3 and higher.
-    #
-    # @since 2.0.0
     class Railtie < Rails::Railtie
 
       # Mapping of rescued exceptions to HTTP responses
@@ -16,8 +15,6 @@ module Rails
       #   railtie.rescue_responses
       #
       # @ return [Hash] rescued responses
-      #
-      # @since 2.4.3
       def self.rescue_responses
         {
           "Mongoid::Errors::DocumentNotFound" => :not_found,
@@ -40,17 +37,13 @@ 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
-      #
-      # @since 2.0.0
       config.mongoid = ::Mongoid::Config
 
       # Initialize Mongoid. This will look for a mongoid.yml in the config
       # directory and configure mongoid appropriately.
-      #
-      # @since 2.0.0
       initializer "mongoid.load-config" do
         config_file = Rails.root.join("config", "mongoid.yml")
         if config_file.file?
@@ -70,8 +63,6 @@ module Rails
 
       # Set the proper error types for Rails. DocumentNotFound errors should be
       # 404s and not 500s, validation errors are 422s.
-      #
-      # @since 2.0.0
       config.after_initialize do
         unless config.action_dispatch.rescue_responses
           ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
@@ -84,8 +75,6 @@ module Rails
       #
       # This will happen for every request in development, once in other
       # environments.
-      #
-      # @since 2.0.0
       initializer "mongoid.preload-models" do |app|
         config.to_prepare do
           ::Rails::Mongoid.preload_models(app)
@@ -96,12 +85,27 @@ module Rails
       # code, so we have no way in the intitializer to know if we are
       # generating a mongoid.yml. So instead of failing, we catch all the
       # errors and print them out.
-      #
-      # @since 3.0.0
       def handle_configuration_error(e)
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message
       end
+
+      # Include Controller extension that measures Mongoid runtime
+      # during request processing. The value then appears in Rails'
+      # instrumentation event `process_action.action_controller`.
+      #
+      # The measurement is made via internal Mongo monitoring subscription
+      initializer "mongoid.runtime-metric" do
+        require "mongoid/railties/controller_runtime"
+
+        ActiveSupport.on_load :action_controller do
+          include ::Mongoid::Railties::ControllerRuntime::ControllerExtension
+        end
+
+        Mongo::Monitoring::Global.subscribe Mongo::Monitoring::COMMAND,
+            ::Mongoid::Railties::ControllerRuntime::Collector.new
+      end
+
     end
   end
 end

data/lib/mongoid/railties/controller_runtime.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Railties
+    module ControllerRuntime
+
+      # This extension mimics the Rails' internal method to
+      # measure ActiveRecord runtime during request processing.
+      # It appends MongoDB runtime value (`mongoid_runtime`) into payload
+      # of instrumentation event `process_action.action_controller`.
+      module ControllerExtension
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :mongoid_runtime
+
+        # Reset the runtime before each action.
+        def process_action(action, *args)
+          Collector.reset_runtime
+          super
+        end
+
+        # Override to collect the measurements.
+        def cleanup_view_runtime
+          mongo_rt_before_render = Collector.reset_runtime
+          runtime = super
+          mongo_rt_after_render = Collector.reset_runtime
+          self.mongoid_runtime = mongo_rt_before_render + mongo_rt_after_render
+          runtime - mongo_rt_after_render
+        end
+
+        # Add the measurement to the instrumentation event payload.
+        def append_info_to_payload(payload)
+          super
+          payload[:mongoid_runtime] = (mongoid_runtime || 0) + Collector.reset_runtime
+        end
+
+        module ClassMethods
+
+          # Append MongoDB runtime information to ActionController runtime
+          # log message.
+          def log_process_action(payload)
+            messages = super
+            mongoid_runtime = payload[:mongoid_runtime]
+            messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
+            messages
+          end
+
+        end
+
+      end
+
+      # The Collector of MongoDB runtime metric, that subscribes to Mongo
+      # driver command monitoring. Stores the value within a thread-local
+      # variable to provide correct accounting when an application issues
+      # MongoDB operations from background threads.
+      class Collector
+
+        VARIABLE_NAME = "Mongoid.controller_runtime".freeze
+
+        def started _; end
+
+        def _completed e
+          Collector.runtime += e.duration * 1000
+        end
+        alias :succeeded :_completed
+        alias :failed :_completed
+
+        def self.runtime
+          Thread.current[VARIABLE_NAME] ||= 0
+        end
+
+        def self.runtime= value
+          Thread.current[VARIABLE_NAME] = value
+        end
+
+        def self.reset_runtime
+          to_now = runtime
+          self.runtime = 0
+          to_now
+        end
+
+      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
@@ -23,7 +25,7 @@ namespace :db do
 
   unless Rake::Task.task_defined?("db:setup")
     desc "Create the database, and initialize with the seed data"
-    task :setup => [ "db:create", "mongoid:create_indexes", "db:seed" ]
+    task :setup => [ "db:create", "mongoid:create_collections", "mongoid:create_indexes", "db:seed" ]
   end
 
   unless Rake::Task.task_defined?("db:reset")
@@ -53,18 +55,30 @@ namespace :db do
 
   unless Rake::Task.task_defined?("db:test:prepare")
     namespace :test do
-      task :prepare => "mongoid:create_indexes"
+      task :prepare => ["mongoid:create_collections", "mongoid:create_indexes"]
     end
   end
 
+  unless Rake::Task.task_defined?("db:create_collections")
+    desc "Create collections specified in Mongoid models"
+    task :create_collections => "mongoid:create_collections"
+  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,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module handles reloading behaviour of documents.
-  #
-  # @since 4.0.0
+  # This module handles reloading behavior of documents.
   module Reloadable
 
     # Reloads the +Document+ attributes from the database. If the document has
@@ -16,16 +15,21 @@ module Mongoid
     # @raise [ Errors::DocumentNotFound ] If the document was deleted.
     #
     # @return [ Document ] The document, reloaded.
-    #
-    # @since 1.0.0
     def reload
       reloaded = _reload
-      if Mongoid.raise_not_found_error && reloaded.empty?
-        raise Errors::DocumentNotFound.new(self.class, _id, _id)
+      if Mongoid.raise_not_found_error && (reloaded.nil? || reloaded.empty?)
+        shard_keys = atomic_selector.with_indifferent_access.slice(*shard_key_fields, :_id)
+        raise Errors::DocumentNotFound.new(self.class, _id, shard_keys)
       end
+
+      reset_atomic_updates!
+
       @attributes = reloaded
-      @attributes_before_type_cast = {}
-      changed_attributes.clear
+      @attributes_before_type_cast = @attributes.dup
+      @changed_attributes = {}
+      @previous_changes = {}
+      @previous_attributes = {}
+      @previously_new_record = false
       reset_readonly
       apply_defaults
       reload_relations
@@ -37,14 +41,12 @@ 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
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @since 2.3.2
     def _reload
       embedded? ? reload_embedded_document : reload_root_document
     end
@@ -55,10 +57,8 @@ module Mongoid
     #   document.reload_root_document
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @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.
@@ -67,11 +67,9 @@ module Mongoid
     #   document.reload_embedded_document
     #
     # @return [ Hash ] The reloaded attributes.
-    #
-    # @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, session: _session).read(mode: :primary).first
       ))
     end
 
@@ -82,9 +80,8 @@ module Mongoid
     #
     # @param [ Hash ] attributes The document in the db.
     #
-    # @return [ Hash ] The document's extracted attributes.
-    #
-    # @since 2.3.2
+    # @return [ Hash | nil ] The document's extracted attributes or nil if the
+    #   document doesn't exist.
     def extract_embedded_attributes(attributes)
       atomic_position.split(".").inject(attributes) do |attrs, part|
         attrs = attrs[part =~ /\d/ ? part.to_i : part]