mongo 2.16.4 → 2.20.0

data/lib/mongo/crypt/rewrap_many_data_key_result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# 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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 ## Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -26,11 +26,26 @@ module Mongo
     autoload(:Context, 'mongo/crypt/context')
     autoload(:DataKeyContext, 'mongo/crypt/data_key_context')
     autoload(:ExplicitEncryptionContext, 'mongo/crypt/explicit_encryption_context')
+    autoload(:ExplicitEncryptionExpressionContext, 'mongo/crypt/explicit_encryption_expression_context')
     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')
+
+    def validate_ffi!
+      return if defined?(FFI)
+
+      require 'ffi'
+    rescue LoadError => e
+      raise Error::UnmetDependency, 'Cannot enable encryption because the ffi gem ' \
+                                    "has not been installed. Add \"gem 'ffi'\" to your Gemfile and run " \
+                                    "\"bundle install\" to install the gem. (#{e.class}: #{e})"
+    end
+    module_function :validate_ffi!
   end
 end

data/lib/mongo/cursor/kill_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -25,14 +25,52 @@ module Mongo
     # @api private
     class KillSpec
 
-      def initialize(cursor_id:, coll_name:, db_name:, service_id:)
+      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
+      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 &&
+          connection_global_id == other.connection_global_id &&
+          server_address == other.server_address &&
+          session == other.session
+      end
+
+      def eql?(other)
+        self.==(other)
+      end
+
+      def hash
+        [
+          cursor_id,
+          coll_name,
+          db_name,
+          connection_global_id,
+          server_address,
+          session,
+        ].compact.hash
+      end
     end
   end
 end

data/lib/mongo/cursor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -76,18 +76,19 @@ module Mongo
       @initial_result = result
       @namespace = result.namespace
       @remaining = limit if limited?
-      @cursor_id = result.cursor_id
+      set_cursor_id(result)
       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]
+      @explicitly_closed = false
+      @lock = Mutex.new
       unless closed?
         register
-        ObjectSpace.define_finalizer(self, self.class.finalize(kill_spec,
-          cluster,
-          server,
-          @session))
+        ObjectSpace.define_finalizer(self, self.class.finalize(kill_spec(@connection_global_id),
+          cluster))
       end
     end
 
@@ -102,18 +103,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, server, 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, server)
-        session.end_session if session && session.implicit?
+        cluster.schedule_kill_cursor(kill_spec)
       end
     end
 
@@ -167,6 +166,9 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
+          if explicitly_closed?
+            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
+          end
           yield document if document
         end
         self
@@ -175,6 +177,9 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
+          if explicitly_closed?
+            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
+          end
           documents << document if document
         end
         documents
@@ -254,7 +259,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?
@@ -274,9 +284,6 @@ module Mongo
     # the server.
     #
     # @return [ nil ] Always nil.
-    #
-    # @raise [ Error::OperationFailure ] If the server cursor close fails.
-    # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error.
     def close
       return if closed?
 
@@ -292,9 +299,14 @@ module Mongo
       end
 
       nil
+    rescue Error::OperationFailure, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable
+      # Errors are swallowed since there is noting can be done by handling them.
     ensure
       end_session
       @cursor_id = 0
+      @lock.synchronize do
+        @explicitly_closed = true
+      end
     end
 
     # Get the parsed collection name.
@@ -367,12 +379,14 @@ module Mongo
     end
 
     # @api private
-    def kill_spec
+    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 +397,20 @@ module Mongo
 
     private
 
+    def explicitly_closed?
+      @lock.synchronize do
+        @explicitly_closed
+      end
+    end
+
+    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 +433,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 +444,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
 
@@ -434,7 +465,7 @@ module Mongo
       # Thus we need to check both @cursor_id and the cursor_id of the result
       # prior to calling unregister here.
       unregister if !closed? && result.cursor_id == 0
-      @cursor_id = result.cursor_id
+      @cursor_id = set_cursor_id(result)
 
       if result.respond_to?(:post_batch_resume_token)
         @post_batch_resume_token = result.post_batch_resume_token
@@ -468,10 +499,28 @@ 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
+
+    # Sets @cursor_id from the operation result.
+    #
+    # In the operation result cursor id can be represented either as Integer
+    # value or as BSON::Int64. This method ensures that the instance variable
+    # is always of type Integer.
+    #
+    # @param [ Operation::Result ] result The result of the operation.
+    #
+    # @api private
+    def set_cursor_id(result)
+      @cursor_id = if result.cursor_id.is_a?(BSON::Int64)
+                     result.cursor_id.value
+                   else
+                     result.cursor_id
+                   end
+    end
+
   end
 end
 

data/lib/mongo/database/view.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -28,7 +28,7 @@ module Mongo
 
       def_delegators :@database, :cluster, :read_preference, :client
       # @api private
-      def_delegators :@database, :server_selector, :read_concern
+      def_delegators :@database, :server_selector, :read_concern, :write_concern
       def_delegators :cluster, :next_primary
 
       # @return [ Integer ] batch_size The size of the batch of results
@@ -53,10 +53,13 @@ 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.
       #
       # @return [ Array<String> ] The names of all non-system collections.
       #
@@ -98,14 +101,18 @@ 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.
+      # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
+      #   this message using BSON types instead of native Ruby types wherever
+      #   possible.
       #
       # @return [ Array<Hash> ] Info for each collection in the database.
       #
       # @since 2.0.5
       def list_collections(options = {})
-        session = client.send(:get_session)
+        session = client.send(:get_session, options)
         collections_info(session, ServerSelector.primary, options)
       end
 
@@ -137,7 +144,7 @@ module Mongo
       # @param [ Array<Hash> ] pipeline The aggregation pipeline.
       # @param [ Hash ] options The aggregation options.
       #
-      # @return [ Aggregation ] The aggregation object.
+      # @return [ Collection::View::Aggregation ] The aggregation object.
       #
       # @since 2.10.0
       # @api private
@@ -168,7 +175,7 @@ module Mongo
             doc['name'].start_with?('system.') || doc['name'].include?('$')
           end
         else
-          docs = cursor.reject do |doc|
+          cursor.reject do |doc|
             doc['name'].start_with?("#{database.name}.system") || doc['name'].include?('$')
           end
         end
@@ -184,6 +191,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
 
@@ -191,8 +199,42 @@ module Mongo
         Operation::CollectionsInfo.new(collections_info_spec(session, options))
       end
 
+      # Sends command that obtains information about the database.
+      #
+      # This command returns a cursor, so there could be additional commands,
+      # therefore this method is called send *initial* command.
+      #
+      # @param [ Server ] server Server to send the query to.
+      # @param [ Session ] session Session that should be used to send the query.
+      # @param [ Hash ] options
+      # @option options [ Hash | nil ] :filter A query expression to filter
+      #   the list of collections.
+      # @option options [ true | false | nil ] :name_only A flag to indicate
+      #   whether the command should return just the collection/view names
+      #   and type or return both the name and other information.
+      # @option options [ true | false | nil ] :authorized_collections A flag,
+      #   when set to true and used with name_only: true, that allows a user
+      #   without the required privilege (i.e. listCollections
+      #   action on the database) to run the command when access control
+      #   is enforced.
+      # @option options [ Object | nil ] :comment A user-provided comment to attach
+      #   to this command.
+      # @option options [ true | false | nil ] :deserialize_as_bson Whether the
+      #   query results should be deserialized to BSON types, or to Ruby
+      #   types (where possible).
+      #
+      # @return [ Operation::Result ] Result of the query.
       def send_initial_query(server, session, options = {})
-        initial_query_op(session, options).execute(server, context: Operation::Context.new(client: client, session: session))
+        opts = options.dup
+        execution_opts = {}
+        if opts.key?(:deserialize_as_bson)
+          execution_opts[:deserialize_as_bson] = opts.delete(:deserialize_as_bson)
+        end
+        initial_query_op(session, opts).execute(
+          server,
+          context: Operation::Context.new(client: client, session: session),
+          options: execution_opts
+        )
       end
     end
   end

data/lib/mongo/database.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -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
@@ -253,12 +260,13 @@ module Mongo
 
       client.send(:with_session, opts) do |session|
         read_with_retry(session, preference) do |server|
-          Operation::Command.new({
-            :selector => operation.dup,
-            :db_name => name,
-            :read => preference,
-            :session => session
-          }).execute(server, context: Operation::Context.new(client: client, session: session))
+          Operation::Command.new(
+            selector: operation.dup,
+            db_name: name,
+            read: preference,
+            session: session,
+            comment: opts[:comment],
+          ).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       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.
@@ -388,7 +397,7 @@ module Mongo
     #   cursor and this option is therefore not valid.
     # @option options [ Session ] :session The session to use.
     #
-    # @return [ Aggregation ] The aggregation object.
+    # @return [ Collection::View::Aggregation ] The aggregation object.
     #
     # @since 2.10.0
     def aggregate(pipeline, options = {})
@@ -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)