mongo 2.17.2 → 2.18.1

data/lib/mongo/crypt/rewrap_many_data_key_result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2022 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Crypt
+    # Represent result of the rewrap many data ke operation.
+    #
+    # @api semiprivate
+    class RewrapManyDataKeyResult
+
+      # @returns [ BulkWrite::Result ] the result of the bulk write operation
+      #   used to update the key vault collection with rewrapped data keys.
+      attr_reader :bulk_write_result
+
+      # @param [ BulkWrite::Result | nil ] bulk_write_result The result of the
+      #   bulk write operation used to update the key vault collection
+      #   with rewrapped data keys.
+      def initialize(bulk_write_result)
+        @bulk_write_result = bulk_write_result
+      end
+    end
+  end
+end

data/lib/mongo/crypt/status.rb

@@ -118,10 +118,16 @@ module Mongo
       # information stored in this status
       #
       # Does nothing if self.ok? is true
-      def raise_crypt_error
+      #
+      # @param kms [ true | false ] Whether the operation was against the KMS.
+      #
+      # @note If kms parameter is false, the error may still have come from a
+      #   KMS. The kms parameter simply forces all errors to be treated as
+      #   KMS errors.
+      def raise_crypt_error(kms: false)
         return if ok?
 
-        if label == :error_kms
+        if kms || label == :error_kms
           error = Error::KmsError.new(message, code: code)
         else
           error = Error::CryptError.new(message, code: code)

data/lib/mongo/crypt.rb

@@ -29,8 +29,11 @@ module Mongo
     autoload(:AutoEncryptionContext, 'mongo/crypt/auto_encryption_context')
     autoload(:ExplicitDecryptionContext, 'mongo/crypt/explicit_decryption_context')
     autoload(:AutoDecryptionContext, 'mongo/crypt/auto_decryption_context')
+    autoload(:RewrapManyDataKeyContext, 'mongo/crypt/rewrap_many_data_key_context')
+    autoload(:RewrapManyDataKeyResult, 'mongo/crypt/rewrap_many_data_key_result')
     autoload(:EncryptionIO, 'mongo/crypt/encryption_io')
     autoload(:ExplicitEncrypter, 'mongo/crypt/explicit_encrypter')
     autoload(:AutoEncrypter, 'mongo/crypt/auto_encrypter')
+    autoload(:KMS, 'mongo/crypt/kms')
   end
 end

data/lib/mongo/cursor/kill_spec.rb

@@ -25,22 +25,36 @@ module Mongo
     # @api private
     class KillSpec
 
-      def initialize(cursor_id:, coll_name:, db_name:, service_id:, server_address:)
+      def initialize(
+        cursor_id:,
+        coll_name:,
+        db_name:,
+        connection_global_id:,
+        server_address:,
+        session:
+      )
         @cursor_id = cursor_id
         @coll_name = coll_name
         @db_name = db_name
-        @service_id = service_id
+        @connection_global_id = connection_global_id
         @server_address = server_address
+        @session = session
       end
 
-      attr_reader :cursor_id, :coll_name, :db_name, :service_id, :server_address
+      attr_reader :cursor_id,
+      :coll_name,
+      :db_name,
+      :connection_global_id,
+      :server_address,
+      :session
 
       def ==(other)
         cursor_id == other.cursor_id &&
           coll_name == other.coll_name &&
           db_name == other.db_name &&
-          service_id == other.service_id &&
-          server_address == other.server_address
+          connection_global_id == other.connection_global_id &&
+          server_address == other.server_address &&
+          session == other.session
       end
 
       def eql?(other)
@@ -48,7 +62,14 @@ module Mongo
       end
 
       def hash
-        [cursor_id, coll_name, db_name, service_id, server_address].compact.hash
+        [
+          cursor_id,
+          coll_name,
+          db_name,
+          connection_global_id,
+          server_address,
+          session,
+        ].compact.hash
       end
     end
   end

data/lib/mongo/cursor.rb

@@ -80,13 +80,13 @@ module Mongo
       if @cursor_id.nil?
         raise ArgumentError, 'Cursor id must be present in the result'
       end
+      @connection_global_id = result.connection_global_id
       @options = options
       @session = @options[:session]
       unless closed?
         register
-        ObjectSpace.define_finalizer(self, self.class.finalize(kill_spec(server),
-          cluster,
-          @session))
+        ObjectSpace.define_finalizer(self, self.class.finalize(kill_spec(@connection_global_id),
+          cluster))
       end
     end
 
@@ -101,18 +101,16 @@ module Mongo
     #
     # @param [ Cursor::KillSpec ] kill_spec The KillCursor operation specification.
     # @param [ Mongo::Cluster ] cluster The cluster associated with this cursor and its server.
-    # @param [ Mongo::Server ] server The server to send the killCursors operation to.
     #
     # @return [ Proc ] The Finalizer.
     #
     # @api private
-    def self.finalize(kill_spec, cluster, session)
+    def self.finalize(kill_spec, cluster)
       unless KillSpec === kill_spec
         raise ArgumentError, "First argument must be a KillSpec: #{kill_spec.inspect}"
       end
       proc do
         cluster.schedule_kill_cursor(kill_spec)
-        session.end_session if session && session.implicit?
       end
     end
 
@@ -253,7 +251,12 @@ module Mongo
     #
     # @since 2.2.0
     def batch_size
-      @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
+      value = @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
+      if value == 0
+        nil
+      else
+        value
+      end
     end
 
     # Is the cursor closed?
@@ -366,13 +369,14 @@ module Mongo
     end
 
     # @api private
-    def kill_spec(server)
+    def kill_spec(connection_global_id)
       KillSpec.new(
         cursor_id: id,
         coll_name: collection_name,
         db_name: database.name,
-        service_id: initial_result.connection_description.service_id,
+        connection_global_id: connection_global_id,
         server_address: server.address,
+        session: @session,
       )
     end
 
@@ -383,6 +387,14 @@ module Mongo
 
     private
 
+    def batch_size_for_get_more
+      if batch_size && use_limit?
+        [batch_size, @remaining].min
+      else
+        batch_size
+      end
+    end
+
     def exhausted?
       limited? ? @remaining <= 0 : false
     end
@@ -405,7 +417,7 @@ module Mongo
         cursor_id: id,
         # 3.2+ servers use batch_size, 3.0- servers use to_return.
         # TODO should to_return be calculated in the operation layer?
-        batch_size: batch_size,
+        batch_size: batch_size_for_get_more,
         to_return: to_return,
         max_time_ms: if view.respond_to?(:max_await_time_ms) &&
           view.max_await_time_ms &&
@@ -416,6 +428,9 @@ module Mongo
           nil
         end,
       }
+      if view.respond_to?(:options) && view.options.is_a?(Hash)
+        spec[:comment] = view.options[:comment] unless view.options[:comment].nil?
+      end
       Operation::GetMore.new(spec)
     end
 
@@ -468,7 +483,7 @@ module Mongo
       context = Operation::Context.new(
         client: client,
         session: @session,
-        service_id: initial_result.connection_description.service_id,
+        connection_global_id: @connection_global_id,
       )
       op.execute(@server, context: context)
     end

data/lib/mongo/database/view.rb

@@ -53,9 +53,11 @@ module Mongo
       # @option options [ Hash ] :filter A filter on the collections returned.
       # @option options [ true, false ] :authorized_collections A flag, when
       #   set to true, that allows a user without the required privilege
-      #   to run the command when access control is enforced
+      #   to run the command when access control is enforced.
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
-      #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+      #   See https://mongodb.com/docs/manual/reference/command/listCollections/
       #   for more information and usage.
       # @option options [ Session ] :session The session to use.
       #
@@ -99,7 +101,7 @@ module Mongo
       #   set to true and used with nameOnly: true, that allows a user without the
       #   required privilege to run the command when access control is enforced
       #
-      #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+      #   See https://mongodb.com/docs/manual/reference/command/listCollections/
       #   for more information and usage.
       # @option options [ Session ] :session The session to use.
       #
@@ -186,6 +188,7 @@ module Mongo
           spec[:selector][:nameOnly] = true if options[:name_only]
           spec[:selector][:filter] = options[:filter] if options[:filter]
           spec[:selector][:authorizedCollections] = true if options[:authorized_collections]
+          spec[:comment] = options[:comment] if options[:comment]
         end
       end
 

data/lib/mongo/database.rb

@@ -73,7 +73,8 @@ module Mongo
                    :read_preference,
                    :server_selector,
                    :read_concern,
-                   :write_concern
+                   :write_concern,
+                   :encrypted_fields_map
 
     # @return [ Mongo::Server ] Get the primary server from the cluster.
     def_delegators :cluster,
@@ -125,8 +126,10 @@ module Mongo
     # @option options [ true, false ] :authorized_collections A flag, when
     #   set to true and used with nameOnly: true, that allows a user without the
     #   required privilege to run the command when access control is enforced
+    # @option options [ Object ] :comment A user-provided
+    #   comment to attach to this command.
     #
-    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   See https://mongodb.com/docs/manual/reference/command/listCollections/
     #   for more information and usage.
     #
     # @return [ Array<String> ] Names of the collections.
@@ -150,9 +153,11 @@ module Mongo
     #   name and other information
     # @option options [ true, false ] :authorized_collections A flag, when
     #   set to true and used with nameOnly: true, that allows a user without the
-    #   required privilege to run the command when access control is enforced
+    #   required privilege to run the command when access control is enforced.
+    # @option options [ Object ] :comment A user-provided
+    #   comment to attach to this command.
     #
-    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   See https://mongodb.com/docs/manual/reference/command/listCollections/
     #   for more information and usage.
     #
     # @return [ Array<Hash> ] Array of information hashes, one for each
@@ -173,9 +178,11 @@ module Mongo
     # @option options [ Hash ] :filter A filter on the collections returned.
     # @option options [ true, false ] :authorized_collections A flag, when
     #   set to true and used with name_only: true, that allows a user without the
-    #   required privilege to run the command when access control is enforced
+    #   required privilege to run the command when access control is enforced.
+    # @option options [ Object ] :comment A user-provided
+    #   comment to attach to this command.
     #
-    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   See https://mongodb.com/docs/manual/reference/command/listCollections/
     #   for more information and usage.
     #
     # @return [ Array<Mongo::Collection> ] The collections.
@@ -219,7 +226,7 @@ module Mongo
       client.send(:with_session, opts) do |session|
         server = selector.select_server(cluster, nil, session)
         op = Operation::Command.new(
-          :selector => operation.dup,
+          :selector => operation,
           :db_name => name,
           :read => selector,
           :session => session
@@ -258,6 +265,7 @@ module Mongo
             db_name: name,
             read: preference,
             session: session,
+            comment: opts[:comment],
           ).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
@@ -378,7 +386,8 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
-    # @option options [ String ] :comment Associate a comment with the aggregation.
+    # @option options [ Object ] :comment A user-provided
+    #   comment to attach to this command.
     # @option options [ String ] :hint The index to use for the aggregation.
     # @option options [ Integer ] :max_time_ms The maximum amount of time in
     #   milliseconds to allow the aggregation to run.
@@ -405,10 +414,35 @@ module Mongo
     # @param [ Array<Hash> ] pipeline Optional additional filter operators.
     # @param [ Hash ] options The change stream options.
     #
-    # @option options [ String ] :full_document Allowed values: 'default', 'updateLookup'.
-    #   Defaults to 'default'. When set to 'updateLookup', the change notification for partial
-    #   updates will include both a delta describing the changes to the document, as well as a copy
-    #   of the entire document that was changed from some time after the change occurred.
+    # @option options [ String ] :full_document Allowed values: nil, 'default',
+    #   'updateLookup', 'whenAvailable', 'required'.
+    #
+    #   The default is to not send a value (i.e. nil), which is equivalent to
+    #   'default'. By default, the change notification for partial updates will
+    #   include a delta describing the changes to the document.
+    #
+    #   When set to 'updateLookup', the change notification for partial updates
+    #   will include both a delta describing the changes to the document as well
+    #   as a copy of the entire document that was changed from some time after
+    #   the change occurred.
+    #
+    #   When set to 'whenAvailable', configures the change stream to return the
+    #   post-image of the modified document for replace and update change events
+    #   if the post-image for this event is available.
+    #
+    #   When set to 'required', the same behavior as 'whenAvailable' except that
+    #   an error is raised if the post-image is not available.
+    # @option options [ String ] :full_document_before_change Allowed values: nil,
+    #   'whenAvailable', 'required', 'off'.
+    #
+    #   The default is to not send a value (i.e. nil), which is equivalent to 'off'.
+    #
+    #   When set to 'whenAvailable', configures the change stream to return the
+    #   pre-image of the modified document for replace, update, and delete change
+    #   events if it is available.
+    #
+    #   When set to 'required', the same behavior as 'whenAvailable' except that
+    #   an error is raised if the pre-image is not available.
     # @option options [ BSON::Document, Hash ] :resume_after Specifies the logical starting point
     #   for the new change stream.
     # @option options [ Integer ] :max_await_time_ms The maximum amount of time for the server to
@@ -420,6 +454,13 @@ module Mongo
     #   changes that occurred after the specified timestamp. Any command run
     #   against the server will return a cluster time that can be used here.
     #   Only recognized by server versions 4.0+.
+    # @option options [ Object ] :comment A user-provided
+    #   comment to attach to this command.
+    # @option options [ Boolean ] :show_expanded_events Enables the server to
+    #   send the 'expanded' list of change stream events. The list of additional
+    #   events included with this flag set are: createIndexes, dropIndexes,
+    #   modify, create, shardCollection, reshardCollection,
+    #   refineCollectionShardKey.
     #
     # @note A change stream only allows 'majority' read concern.
     # @note This helper method is preferable to running a raw aggregation with a $changeStream
@@ -429,8 +470,11 @@ module Mongo
     #
     # @since 2.6.0
     def watch(pipeline = [], options = {})
+      view_options = options.dup
+      view_options[:await_data] = true if options[:max_await_time_ms]
+
       Mongo::Collection::View::ChangeStream.new(
-        Mongo::Collection::View.new(collection("#{COMMAND}.aggregate")),
+        Mongo::Collection::View.new(collection("#{COMMAND}.aggregate"), {}, view_options),
         pipeline,
         Mongo::Collection::View::ChangeStream::DATABASE,
         options)

data/lib/mongo/dbref.rb

@@ -16,109 +16,5 @@
 # limitations under the License.
 
 module Mongo
-
-  # Represents a DBRef document in the database.
-  #
-  # @since 2.1.0
-  class DBRef
-    include BSON::JSON
-
-    # The constant for the collection reference field.
-    #
-    # @since 2.1.0
-    COLLECTION = '$ref'.freeze
-
-    # The constant for the id field.
-    #
-    # @since 2.1.0
-    ID = '$id'.freeze
-
-    # The constant for the database field.
-    #
-    # @since 2.1.0
-    DATABASE = '$db'.freeze
-
-    # @return [ String ] collection The collection name.
-    attr_reader :collection
-
-    # @return [ BSON::ObjectId ] id The referenced document id.
-    attr_reader :id
-
-    # @return [ String ] database The database name.
-    attr_reader :database
-
-    # Get the DBRef as a JSON document
-    #
-    # @example Get the DBRef as a JSON hash.
-    #   dbref.as_json
-    #
-    # @return [ Hash ] The max key as a JSON hash.
-    #
-    # @since 2.1.0
-    def as_json(*args)
-      document = { COLLECTION => collection, ID => id }
-      document.merge!(DATABASE => database) if database
-      document
-    end
-
-    # Instantiate a new DBRef.
-    #
-    # @example Create the DBRef.
-    #   Mongo::DBRef.new('users', id, 'database')
-    #
-    # @param [ String ] collection The collection name.
-    # @param [ BSON::ObjectId ] id The object id.
-    # @param [ String ] database The database name.
-    #
-    # @since 2.1.0
-    def initialize(collection, id, database = nil)
-      @collection = collection
-      @id = id
-      @database = database
-    end
-
-    # Converts the DBRef to raw BSON.
-    #
-    # @example Convert the DBRef to raw BSON.
-    #   dbref.to_bson
-    #
-    # @param [ BSON::ByteBuffer ] buffer The encoded BSON buffer to append to.
-    # @param [ true, false ] validating_keys Whether keys should be validated when serializing.
-    #
-    # @return [ String ] The raw BSON.
-    #
-    # @since 2.1.0
-    def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = BSON::Config.validating_keys?)
-      as_json.to_bson(buffer)
-    end
-
-    module ClassMethods
-
-      # Deserialize the hash from BSON, converting to a DBRef if appropriate.
-      #
-      # @param [ String ] buffer The bson representing a hash.
-      #
-      # @return [ Hash, DBRef ] The decoded hash or DBRef.
-      #
-      # @see http://bsonspec.org/#/specification
-      #
-      # @since 2.0.0
-      def from_bson(buffer, **options)
-        # bson-ruby 4.8.0 changes #from_bson API to take **options.
-        # However older bsons fail if invoked with a plain super here,
-        # even if options are empty.
-        decoded = if options.empty?
-          super(buffer)
-        else
-          super
-        end
-        if ref = decoded[COLLECTION]
-          decoded = DBRef.new(ref, decoded[ID], decoded[DATABASE])
-        end
-        decoded
-      end
-    end
-  end
-
-  ::Hash.send(:extend, DBRef::ClassMethods)
+  DBRef = BSON::DBRef
 end

data/lib/mongo/error/bulk_write_error.rb

@@ -55,15 +55,42 @@ module Mongo
 
       private
 
+      # Generates an error message when there are multiple write errors.
+      #
+      # @example Multiple documents fail validation
+      #
+      # col has validation { 'validator' => { 'x' => { '$type' => 'string' } } }
+      # col.insert_many([{_id: 1}, {_id: 2}], ordered: false)
+      #
+      # Multiple errors:
+      #   [121]: Document failed validation --
+      #     {"failingDocumentId":1,"details":{"operatorName":"$type",
+      #     "specifiedAs":{"x":{"$type":"string"}},"reason":"field was
+      #     missing"}};
+      #   [121]: Document failed validation --
+      #     {"failingDocumentId":2, "details":{"operatorName":"$type",
+      #     "specifiedAs":{"x":{"$type":"string"}}, "reason":"field was
+      #     missing"}}
+      #
+      # @return [ String ] The error message
       def build_message
         errors = @result['writeErrors']
         return nil unless errors
 
-        fragment = errors.first(10).map do |error|
-          "[#{error['code']}]: #{error['errmsg']}"
-        end.join('; ')
+        fragment = ""
+        cut_short = false
+        errors.first(10).each_with_index do |error, i|
+          fragment += "; " if fragment.length > 0
+          fragment += "[#{error['code']}]: #{error['errmsg']}"
+          fragment += " -- #{error['errInfo'].to_json}" if error['errInfo']
+
+          if fragment.length > 3000
+            cut_short = i < [9, errors.length].min
+            break
+          end
+        end
 
-        fragment += '...' if errors.length > 10
+        fragment += '...' if errors.length > 10 || cut_short
 
         if errors.length > 1
           fragment = "Multiple errors: #{fragment}"

data/lib/mongo/error/invalid_config_option.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mongo
+  class Error
+
+    # This error is raised when a bad configuration option is attempted to be
+    # set.
+    class InvalidConfigOption < Error
+
+      # Create the new error.
+      #
+      # @param [ Symbol, String ] name The attempted config option name.
+      #
+      # @api private
+      def initialize(name)
+        super("Invalid config option #{name}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_replacement_document.rb

@@ -19,23 +19,41 @@ module Mongo
   class Error
 
     # Exception raised if the object is not a valid replacement document.
-    #
-    # @since 2.0.0
     class InvalidReplacementDocument < Error
 
       # The error message.
       #
-      # @since 2.0.0
+      # @deprecated
       MESSAGE = 'Invalid replacement document provided'.freeze
 
-      # Instantiate the new exception.
+      # Construct the error message.
+      #
+      # @param [ String ] key The invalid key.
+      #
+      # @return [ String ] The error message.
       #
-      # @example Instantiate the exception.
-      #   Mongo::Error::InvalidReplacementDoc.new
+      # @api private
+      def self.message(key)
+        message = "Invalid replacement document provided. Replacement documents "
+        message += "must not contain atomic modifiers. The \"#{key}\" key is invalid."
+        message
+      end
+
+      # Send and cache the warning.
+      #
+      # @api private
+      def self.warn(logger, key)
+        @warned ||= begin
+          logger.warn(message(key))
+          true
+        end
+      end
+
+      # Instantiate the new exception.
       #
-      # @since 2.0.0
-      def initialize
-        super(MESSAGE)
+      # @param [ String ] :key The invalid key.
+      def initialize(key: nil)
+        super(self.class.message(key))
       end
     end
   end