mongoid 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c7e1fbb3fda280fb0e0f74c312b36b7a73dad79
-  data.tar.gz: 92dcab3023e9005560efd4209e3eecd26032b259
+SHA256:
+  metadata.gz: 496715e8829978d85bd903477e9d6d7961fa4ffe8d9529d6720fbfdb2b3ec9a8
+  data.tar.gz: 907296ce5256555834c738f5fdf8d7277b57d6c09da3c733eb7cb0ba6526d0a2
 SHA512:
-  metadata.gz: 44e65ba1446fc7c42e545b38223d4122e798f85d26aeb93103b85c45e7a4abc17e3b7da9f60853a7a38a24b5d4a258338111759d0b22bb4e5f99611e002eaa0f
-  data.tar.gz: 25b84f09ac4fb6366a0d9782d0865a0a1ae214234fbdbde4ce57146d8bf740823b66f15d4871e4a45b0d3fc5f0557b9f91dd743501713ae6920a430e90bab62e
+  metadata.gz: 9d16c8cff475066981b0736ed07ebe0b463c8ee4e8c43049087f43ad8ee6789ff88a5c2e73e3fe6a31a52f7732cc6b8614de72d8c76df2dd3c54ee48a5977a41
+  data.tar.gz: d15deebe3406b501b95fa864306c03cfa7b106f810909dffeda8d7402d14de5aa1dad3d1129685b859ef9d537e656108a015b77f066ea5affd9e32785e018b0a

data/lib/config/locales/en.yml

@@ -206,6 +206,20 @@ en:
             \_\_\_\_include Mongoid::Document\n
             \_\_\_\_scope :inactive, ->{ where(active: false) }\n
             \_\_end\n\n"
+        invalid_session_use:
+          message: "A session was attempted to be used with a model whose client cannot use
+            that session."
+          summary: "Sessions are started via driver clients (Model#mongo_client) and, in most cases, driver
+            clients are shared across models. When different models have their own clients, a session cannot
+            be obtained via one model and used for operations on another model."
+          resolution: "Only execute operations on the model class or instances of the model through which
+            the session was created. Otherwise, ensure that all models on which operations are executed
+            in the session block share the same driver client. For example, a model may have a different
+            client specified in its 'store_in' options.\n\n"
+        invalid_session_nesting:
+          message: "A session was started while another session was being used."
+          summary: "Sessions cannot be nested. Only one session can be used in a thread at once."
+          resolution: "Only use one session at a time; sessions cannot be nested."
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
@@ -452,6 +466,13 @@ en:
             with the already defined method %{model_name}, or set the
             configuration option Mongoid.scope_overwrite_exception to false,
             which is its default. In this case a warning will be logged."
+        sessions_not_supported:
+          message: "Sessions are not supported by the connected server(s)."
+          summary: "A session was attempted to be used with a MongoDB server version
+            that doesn't support sessions. Sessions are supported in MongoDB
+            server versions 3.6 and higher."
+          resolution: "Verify that all servers in your deployment are at least
+            version 3.6 or don't attempt to use sessions with older server versions."
         taken:
           "is already taken"
         too_many_nested_attribute_records:

data/lib/mongoid.rb

@@ -42,7 +42,7 @@ module Mongoid
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
-  MONGODB_VERSION = "2.4.0"
+  MONGODB_VERSION = "2.6.0"
 
   # Sets the Mongoid configuration options. Best used by passing a block.
   #

data/lib/mongoid/clients.rb

@@ -3,12 +3,14 @@ require "mongoid/clients/factory"
 require "mongoid/clients/validators"
 require "mongoid/clients/storage_options"
 require "mongoid/clients/options"
+require "mongoid/clients/sessions"
 
 module Mongoid
   module Clients
     extend ActiveSupport::Concern
     include StorageOptions
     include Options
+    include Sessions
 
     class << self
 

data/lib/mongoid/clients/sessions.rb

@@ -0,0 +1,113 @@
+module Mongoid
+  module Clients
+
+    # Encapsulates behavior for getting a session from the client of a model class or instance,
+    # setting the session on the current thread, and yielding to a block.
+    # The session will be closed after the block completes or raises an error.
+    #
+    # @since 6.4.0
+    module Sessions
+
+      # Execute a block within the context of a session.
+      #
+      # @example Execute some operations in the context of a session.
+      #   band.with_session(causal_consistency: true) do
+      #     band.records << Record.create
+      #     band.name = 'FKA Twigs'
+      #     band.save
+      #     band.reload
+      #   end
+      #
+      # @param [ Hash ] options The session options. Please see the driver
+      #   documentation for the available session options.
+      #
+      # @note You cannot do any operations in the block using models or objects
+      #   that use a different client; the block will execute all operations
+      #   in the context of the implicit session and operations on any models using
+      #   another client will fail. For example, if you set a client using store_in on a
+      #   particular model and execute an operation on it in the session context block,
+      #   that operation can't use the block's session and an error will be raised.
+      #   An error will also be raised if sessions are nested.
+      #
+      # @raise [ Errors::InvalidSessionUse ] If an operation is attempted on a model using another
+      #   client from which the session was started or if sessions are nested.
+      #
+      # @return [ Object ] The result of calling the block.
+      #
+      # @yieldparam [ Mongo::Session ] The session being used for the block.
+      #
+      # @since 6.4.0
+      def with_session(options = {})
+        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+        session = persistence_context.client.start_session(options)
+        Threaded.set_session(session)
+        yield(session)
+      rescue Mongo::Error::InvalidSession => ex
+        if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+          raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
+        end
+        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
+      ensure
+        Threaded.clear_session
+      end
+
+      private
+
+      def session
+        Threaded.get_session
+      end
+
+      module ClassMethods
+
+        # Execute a block within the context of a session.
+        #
+        # @example Execute some operations in the context of a session.
+        #   Band.with_session(causal_consistency: true) do
+        #     band = Band.create
+        #     band.records << Record.new
+        #     band.save
+        #     band.reload.records
+        #   end
+        #
+        # @param [ Hash ] options The session options. Please see the driver
+        #   documentation for the available session options.
+        #
+        # @note You cannot do any operations in the block using models or objects
+        #   that use a different client; the block will execute all operations
+        #   in the context of the implicit session and operations on any models using
+        #   another client will fail. For example, if you set a client using store_in on a
+        #   particular model and execute an operation on it in the session context block,
+        #   that operation can't use the block's session and an error will be raised.
+        #   You also cannot nest sessions.
+        #
+        # @raise [ Errors::InvalidSessionUse ] If an operation is attempted on a model using another
+        #   client from which the session was started or if sessions are nested.
+        #
+        # @return [ Object ] The result of calling the block.
+        #
+        # @yieldparam [ Mongo::Session ] The session being used for the block.
+        #
+        # @since 6.4.0
+        def with_session(options = {})
+          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+          session = persistence_context.client.start_session(options)
+          Threaded.set_session(session)
+          yield(session)
+        rescue Mongo::Error::InvalidSession => ex
+          if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+            raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
+          end
+          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
+        ensure
+          Threaded.clear_session
+        end
+
+        private
+
+        def session
+          Threaded.get_session
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/clients/storage_options.rb

@@ -61,6 +61,7 @@ module Mongoid
         # @since 4.0.0
         def reset_storage_options!
           self.storage_options = storage_options_defaults.dup
+          PersistenceContext.clear(self)
         end
 
         # Get the default storage options.

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

@@ -23,7 +23,7 @@ module Mongoid
         #
         # @since 3.0.0
         def aggregates(field)
-          result = collection.find.aggregate(pipeline(field)).to_a
+          result = collection.find.aggregate(pipeline(field), session: session).to_a
           if result.empty?
             { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
           else

data/lib/mongoid/contextual/map_reduce.rb

@@ -166,12 +166,12 @@ module Mongoid
         validate_out!
         cmd = command
         opts = { read: cmd.delete(:read).options } if cmd[:read]
-        @map_reduce.database.command(cmd, opts || {}).first
+        @map_reduce.database.command(cmd, (opts || {}).merge(session: session)).first
       end
       alias :results :raw
 
       # Execute the map/reduce, returning the raw output.
-      # Useful when you don't care about map/reduce's ouptut.
+      # Useful when you don't care about map/reduce's output.
       #
       # @example Run the map reduce
       #   map_reduce.execute
@@ -249,6 +249,10 @@ module Mongoid
       def validate_out!
         raise Errors::NoMapReduceOutput.new({}) unless @map_reduce.out
       end
+
+      def session
+        criteria.send(:session)
+      end
     end
   end
 end

data/lib/mongoid/contextual/memory.rb

@@ -48,7 +48,8 @@ module Mongoid
         end
         unless removed.empty?
           collection.find(selector).update_one(
-            positionally(selector, "$pullAll" => { path => removed })
+            positionally(selector, "$pullAll" => { path => removed }),
+            session: session
           )
         end
         deleted
@@ -303,7 +304,7 @@ module Mongoid
           updates["$set"].merge!(doc.atomic_updates["$set"] || {})
           doc.move_changes
         end
-        collection.find(selector).update_one(updates) unless updates["$set"].empty?
+        collection.find(selector).update_one(updates, session: session) unless updates["$set"].empty?
       end
 
       # Get the limiting value.
@@ -444,6 +445,10 @@ module Mongoid
         doc._parent.remove_child(doc)
         doc.destroyed = true
       end
+
+      def session
+        @criteria.send(:session)
+      end
     end
   end
 end

data/lib/mongoid/contextual/mongo.rb

@@ -95,7 +95,8 @@ module Mongoid
       def destroy
         each.inject(0) do |count, doc|
           doc.destroy
-          count += 1
+          count += 1 if acknowledged_write?
+          count
         end
       end
       alias :destroy_all :destroy
@@ -340,7 +341,7 @@ module Mongoid
         @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
         @collection = @klass.collection
         criteria.send(:merge_type_selection)
-        @view = collection.find(criteria.selector)
+        @view = collection.find(criteria.selector, session: session)
         apply_options
       end
 
@@ -704,6 +705,14 @@ module Mongoid
         yield(doc)
         documents.push(doc) if cacheable?
       end
+
+      def session
+        @criteria.send(:session)
+      end
+
+      def acknowledged_write?
+        collection.write_concern.nil? || collection.write_concern.acknowledged?
+      end
     end
   end
 end

data/lib/mongoid/criteria.rb

@@ -28,6 +28,7 @@ module Mongoid
     include Scopable
     include Clients::Options
     include Options
+    include Clients::Sessions
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.

data/lib/mongoid/criteria/queryable/mergeable.rb

@@ -259,7 +259,9 @@ module Mongoid
         def prepare(field, operator, value)
           unless operator =~ /exists|type|size/
             value = value.__expand_complex__
-            serializer = serializers[field]
+            field = field.to_s
+            name = aliases[field] || field
+            serializer = serializers[name]
             value = serializer ? serializer.evolve(value) : value
           end
           selection = { operator => value }

data/lib/mongoid/errors.rb

@@ -18,6 +18,7 @@ require "mongoid/errors/invalid_path"
 require "mongoid/errors/invalid_persistence_option"
 require "mongoid/errors/invalid_relation"
 require "mongoid/errors/invalid_scope"
+require "mongoid/errors/invalid_session_use"
 require "mongoid/errors/invalid_set_polymorphic_relation"
 require "mongoid/errors/invalid_storage_options"
 require "mongoid/errors/invalid_storage_parent"

data/lib/mongoid/errors/invalid_session_use.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a session is attempted to be used with a model whose client cannot use it, if
+    #   sessions are nested, or if the mongodb deployment doesn't support sessions.
+    #
+    # @since 6.4.0
+    class InvalidSessionUse < MongoidError
+
+      # Create the error.
+      #
+      # @example Create the error.
+      #   InvalidSessionUse.new(:invalid_session_use)
+      #
+      # @param [ :invalid_sesion_use, :invalid_session_nesting ] error_type The type of session misuse.
+      #
+      # @since 6.4.0
+      def initialize(error_type)
+        super(compose_message(error_type.to_s))
+      end
+    end
+  end
+end

data/lib/mongoid/indexable.rb

@@ -32,10 +32,10 @@ module Mongoid
           key, options = spec.key, spec.options
           if database = options[:database]
             with(database: database) do |klass|
-              klass.collection.indexes.create_one(key, options.except(:database))
+              klass.collection.indexes(session: session).create_one(key, options.except(:database))
             end
           else
-            collection.indexes.create_one(key, options)
+            collection.indexes(session: session).create_one(key, options)
           end
         end and true
       end
@@ -53,9 +53,9 @@ module Mongoid
         indexed_database_names.each do |database|
           with(database: database) do |klass|
             begin
-              klass.collection.indexes.each do |spec|
+              klass.collection.indexes(session: session).each do |spec|
                 unless spec["name"] == "_id_"
-                  klass.collection.indexes.drop_one(spec["key"])
+                  klass.collection.indexes(session: session).drop_one(spec["key"])
                   logger.info(
                     "MONGOID: Removed index '#{spec["name"]}' on collection " +
                     "'#{klass.collection.name}' in database '#{database}'."

data/lib/mongoid/persistable.rb

@@ -204,7 +204,7 @@ module Mongoid
     def persist_atomic_operations(operations)
       if persisted? && operations
         selector = atomic_selector
-        _root.collection.find(selector).update_one(positionally(selector, operations))
+        _root.collection.find(selector).update_one(positionally(selector, operations), session: session)
       end
     end
   end

data/lib/mongoid/persistable/creatable.rb

@@ -61,7 +61,9 @@ module Mongoid
           _parent.insert
         else
           selector = _parent.atomic_selector
-          _root.collection.find(selector).update_one(positionally(selector, atomic_inserts))
+          _root.collection.find(selector).update_one(
+              positionally(selector, atomic_inserts),
+              session: session)
         end
       end
 
@@ -76,7 +78,7 @@ module Mongoid
       #
       # @since 4.0.0
       def insert_as_root
-        collection.insert_one(as_attributes)
+        collection.insert_one(as_attributes, session: session)
       end
 
       # Post process an insert, which sets the new record attribute to false

data/lib/mongoid/persistable/deletable.rb

@@ -62,7 +62,9 @@ module Mongoid
         _parent.remove_child(self) if notifying_parent?(options)
         if _parent.persisted?
           selector = _parent.atomic_selector
-          _root.collection.find(selector).update_one(positionally(selector, atomic_deletes))
+          _root.collection.find(selector).update_one(
+              positionally(selector, atomic_deletes),
+              session: session)
         end
         true
       end
@@ -78,7 +80,7 @@ module Mongoid
       #
       # @since 4.0.0
       def delete_as_root
-        collection.find(atomic_selector).delete_one
+        collection.find(atomic_selector).delete_one(session: session)
         true
       end
 

data/lib/mongoid/persistable/destroyable.rb

@@ -48,11 +48,7 @@ module Mongoid
         #
         # @since 1.0.0
         def destroy_all(conditions = nil)
-          selector = conditions || {}
-          documents = where(selector)
-          destroyed = documents.count
-          documents.each { |doc| doc.destroy }
-          destroyed
+          where(conditions || {}).destroy
         end
       end
     end

data/lib/mongoid/persistable/updatable.rb

@@ -134,9 +134,9 @@ module Mongoid
           unless updates.empty?
             coll = collection(_root)
             selector = atomic_selector
-            coll.find(selector).update_one(positionally(selector, updates))
+            coll.find(selector).update_one(positionally(selector, updates), session: session)
             conflicts.each_pair do |key, value|
-              coll.find(selector).update_one(positionally(selector, { key => value }))
+              coll.find(selector).update_one(positionally(selector, { key => value }), session: session)
             end
           end
         end