mongo 2.17.1 → 2.18.1

data/lib/mongo/index/view.rb

@@ -69,7 +69,9 @@ module Mongo
         :unique => :unique,
         :version => :v,
         :weights => :weights,
-        :collation => :collation
+        :collation => :collation,
+        :comment => :comment,
+        :wildcard_projection => :wildcardProjection,
       }.freeze
 
       # Drop an index by its name.
@@ -78,13 +80,17 @@ module Mongo
       #   view.drop_one('name_1')
       #
       # @param [ String ] name The name of the index.
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_one(name)
+      def drop_one(name, options = {})
         raise Error::MultiIndexDrop.new if name == Index::ALL
-        drop_by_name(name)
+        drop_by_name(name, comment: options[:comment])
       end
 
       # Drop all indexes on the collection.
@@ -92,11 +98,16 @@ module Mongo
       # @example Drop all indexes on the collection.
       #   view.drop_all
       #
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
+      #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_all
-        drop_by_name(Index::ALL)
+      def drop_all(options = {})
+        drop_by_name(Index::ALL, comment: options[:comment])
       end
 
       # Creates an index on the collection.
@@ -134,6 +145,8 @@ module Mongo
       #   - "majority" indicating that a majority of data bearing nodes must vote
       #   - "votingMembers" which means that all voting data bearing nodes must vote
       # @option options [ Session ] :session The session to use for the operation.
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @note Note that the options listed may be subset of those available.
       # See the MongoDB documentation for a full list of supported options by server version.
@@ -148,7 +161,7 @@ module Mongo
         if session = @options[:session]
           create_options[:session] = session
         end
-        %i(commit_quorum session).each do |key|
+        %i(commit_quorum session comment).each do |key|
           if value = options.delete(key)
             create_options[key] = value
           end
@@ -185,6 +198,7 @@ module Mongo
       #     - "majority" indicating that a majority of data bearing nodes must vote
       #     - "votingMembers" which means that all voting data bearing nodes must vote
       #   - session: The session to use.
+      #   - comment: A user-provided comment to attach to this command.
       #
       # @return [ Result ] The result of the command.
       #
@@ -213,6 +227,7 @@ module Mongo
             session: session,
             commit_quorum: options[:commit_quorum],
             write_concern: write_concern,
+            comment: options[:comment],
           }
 
           Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
@@ -283,7 +298,7 @@ module Mongo
 
       private
 
-      def drop_by_name(name)
+      def drop_by_name(name, comment: nil)
         client.send(:with_session, @options) do |session|
           spec = {
             db_name: database.name,
@@ -292,6 +307,7 @@ module Mongo
             session: session,
             write_concern: write_concern,
           }
+          spec[:comment] = comment unless comment.nil?
           server = next_primary(nil, session)
           Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end

data/lib/mongo/monitoring/event/command_failed.rb

@@ -53,6 +53,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ Integer ] server_connection_id The server connection id.
+        attr_reader :server_connection_id
+
         # @return [ nil | Object ] The service id, if any.
         attr_reader :service_id
 
@@ -81,7 +84,7 @@ module Mongo
         # @api private
         def initialize(command_name, database_name, address,
           request_id, operation_id, message, failure, duration,
-          started_event:, service_id: nil
+          started_event:, server_connection_id: nil, service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -93,6 +96,7 @@ module Mongo
           @started_event = started_event
           @failure = redacted(command_name, failure)
           @duration = duration
+          @server_connection_id = server_connection_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -126,7 +130,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload, message,
-          failure, duration, started_event:, service_id: nil
+          failure, duration, started_event:, server_connection_id: nil,
+          service_id: nil
         )
           new(
             payload[:command_name],
@@ -138,6 +143,7 @@ module Mongo
             failure,
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         end

data/lib/mongo/monitoring/event/command_started.rb

@@ -60,7 +60,7 @@ module Mongo
         # @api private
         attr_reader :connection_id
 
-        # @api private
+        # @return [ Integer ] server_connection_id The server connection id.
         attr_reader :server_connection_id
 
         # @return [ true | false ] Whether the event contains sensitive data.

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -46,6 +46,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ Integer ] server_connection_id The server connection id.
+        attr_reader :server_connection_id
+
         # @return [ nil | Object ] The service id, if any.
         attr_reader :service_id
 
@@ -73,7 +76,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def initialize(command_name, database_name, address, request_id,
-          operation_id, reply, duration, started_event:, service_id: nil
+          operation_id, reply, duration, started_event:,
+          server_connection_id: nil, service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -84,6 +88,7 @@ module Mongo
           @started_event = started_event
           @reply = redacted(command_name, reply)
           @duration = duration
+          @server_connection_id = server_connection_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -116,7 +121,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, command_payload,
-          reply_payload, duration, started_event:, service_id: nil
+          reply_payload, duration, started_event:, server_connection_id: nil,
+          service_id: nil
         )
           new(
             command_payload[:command_name],
@@ -127,6 +133,7 @@ module Mongo
             generate_reply(command_payload, reply_payload),
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         end

data/lib/mongo/monitoring/publishable.rb

@@ -64,24 +64,26 @@ module Mongo
       end
 
       def command_completed(result, address, operation_id, payload, duration,
-        started_event:, service_id: nil
+        started_event:, server_connection_id: nil, service_id: nil
       )
         document = result ? (result.documents || []).first : nil
         if document && (document['ok'] && document['ok'] != 1 || document.key?('$err'))
           parser = Error::Parser.new(document)
           command_failed(document, address, operation_id,
             payload, parser.message, duration,
-            started_event: started_event, service_id: service_id,
+            started_event: started_event, server_connection_id: server_connection_id,
+            service_id: service_id,
           )
         else
           command_succeeded(result, address, operation_id, payload, duration,
-            started_event: started_event, service_id: service_id,
+            started_event: started_event, server_connection_id: server_connection_id,
+            service_id: service_id,
           )
         end
       end
 
       def command_succeeded(result, address, operation_id, payload, duration,
-        started_event:, service_id: nil
+        started_event:, server_connection_id: nil, service_id: nil
       )
         monitoring.succeeded(
           Monitoring::COMMAND,
@@ -92,19 +94,21 @@ module Mongo
             result ? result.payload : nil,
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         )
       end
 
       def command_failed(failure, address, operation_id, payload, message, duration,
-        started_event:, service_id: nil
+        started_event:, server_connection_id: nil, service_id: nil
       )
         monitoring.failed(
           Monitoring::COMMAND,
           Event::CommandFailed.generate(address, operation_id, payload,
             message, failure, duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         )

data/lib/mongo/operation/collections_info/result.rb

@@ -32,12 +32,15 @@ module Mongo
         # @param [ Server::Description ] connection_description
         #   Server description of the server that performed the operation that
         #   this result is for.
+        # @param [ Integer ] connection_global_id
+        #   Global id of the connection on which the operation that
+        #   this result is for was performed.
         # @param [ String ] database_name The name of the database that the
         #   query was sent to.
         #
         # @api private
-        def initialize(replies, connection_description, database_name)
-          super(replies, connection_description)
+        def initialize(replies, connection_description, connection_global_id, database_name)
+          super(replies, connection_description, connection_global_id)
           @database_name = database_name
         end
 

data/lib/mongo/operation/command/op_msg.rb

@@ -25,6 +25,12 @@ module Mongo
       #
       # @since 2.5.2
       class OpMsg < OpMsgBase
+
+        def selector(connection)
+          spec[:selector].dup.tap do |sel|
+            sel[:comment] = spec[:comment] unless spec[:comment].nil?
+          end
+        end
       end
     end
   end

data/lib/mongo/operation/context.rb

@@ -35,7 +35,7 @@ module Mongo
     #
     # @api private
     class Context
-      def initialize(client: nil, session: nil, service_id: nil, options: nil)
+      def initialize(client: nil, session: nil, connection_global_id: nil, options: nil)
         if options
           if client
             raise ArgumentError, 'Client and options cannot both be specified'
@@ -46,13 +46,13 @@ module Mongo
           end
         end
 
-        if service_id && session&.pinned_service_id
-          raise ArgumentError, 'Trying to pin context to a service when the session is already pinned to a service'
+        if connection_global_id && session&.pinned_connection_global_id
+          raise ArgumentError, 'Trying to pin context to a connection when the session is already pinned to a connection.'
         end
 
         @client = client
         @session = session
-        @service_id = service_id
+        @connection_global_id = connection_global_id
         @options = options
       end
 
@@ -60,8 +60,8 @@ module Mongo
       attr_reader :session
       attr_reader :options
 
-      def service_id
-        @service_id || session&.pinned_service_id
+      def connection_global_id
+        @connection_global_id || session&.pinned_connection_global_id
       end
 
       def in_transaction?
@@ -100,6 +100,24 @@ module Mongo
         end
       end
 
+      # Whether the operation is a retry (true) or an initial attempt (false).
+      def retry?
+        !!@is_retry
+      end
+
+      # Returns a new context with the parameters changed as per the
+      # provided arguments.
+      #
+      # @option opts [ true|false ] :is_retry Whether the operation is a retry
+      #   or a first attempt.
+      def with(**opts)
+        dup.tap do |copy|
+          opts.each do |k, v|
+            copy.instance_variable_set("@#{k}", v)
+          end
+        end
+      end
+
       def encrypt?
         client&.encrypter&.encrypt? || false
       end

data/lib/mongo/operation/count/op_msg.rb

@@ -30,7 +30,10 @@ module Mongo
         private
 
         def selector(connection)
-          spec[:selector].merge(collation: spec[:collation]).compact
+          spec[:selector].merge(
+            collation: spec[:collation],
+            comment: spec[:comment],
+          ).compact
         end
       end
     end

data/lib/mongo/operation/create/op_msg.rb

@@ -31,7 +31,10 @@ module Mongo
 
         def selector(connection)
           # Collation is always supported on 3.6+ servers that would use OP_MSG.
-          spec[:selector].merge(collation: spec[:collation]).compact
+          spec[:selector].merge(
+            collation: spec[:collation],
+            encryptedFields: spec[:encrypted_fields],
+          ).compact
         end
       end
     end

data/lib/mongo/operation/create_index/op_msg.rb

@@ -33,7 +33,8 @@ module Mongo
           {
             createIndexes: coll_name,
             indexes: indexes,
-          }.tap do |selector|
+            comment: spec[:comment],
+          }.compact.tap do |selector|
             if commit_quorum = spec[:commit_quorum]
               # While server versions 3.4 and newer generally perform option
               # validation, there was a bug on server versions 4.2.0 - 4.2.5 where

data/lib/mongo/operation/delete/op_msg.rb

@@ -38,6 +38,7 @@ module Mongo
             Protocol::Msg::DATABASE_IDENTIFIER => db_name,
             ordered: ordered?,
             let: spec[:let],
+            comment: spec[:comment],
           }.compact.tap do |selector|
             if hint = spec[:hint]
               validate_hint_on_update(connection, selector)

data/lib/mongo/operation/delete.rb

@@ -17,7 +17,6 @@
 
 require 'mongo/operation/delete/command'
 require 'mongo/operation/delete/op_msg'
-require 'mongo/operation/delete/legacy'
 require 'mongo/operation/delete/result'
 require 'mongo/operation/delete/bulk_result'
 

data/lib/mongo/operation/distinct/op_msg.rb

@@ -32,7 +32,10 @@ module Mongo
 
         def selector(connection)
           # Collation is always supported on 3.6+ servers that would use OP_MSG.
-          spec[:selector].merge(collation: spec[:collation]).compact
+          spec[:selector].merge(
+            collation: spec[:collation],
+            comment: spec[:comment],
+          ).compact
         end
       end
     end

data/lib/mongo/operation/drop_index/op_msg.rb

@@ -30,7 +30,11 @@ module Mongo
         private
 
         def selector(connection)
-          { :dropIndexes => coll_name, :index => index_name }
+          {
+            :dropIndexes => coll_name,
+            :index => index_name,
+            :comment => spec[:comment],
+          }.compact
         end
       end
     end

data/lib/mongo/operation/get_more/command_builder.rb

@@ -30,7 +30,11 @@ module Mongo
             collection: spec.fetch(:coll_name),
             batchSize: spec[:batch_size],
             maxTimeMS: spec[:max_time_ms],
-          }.compact
+          }.compact.tap do |sel|
+            if spec[:comment] && connection.features.get_more_comment_enabled?
+              sel[:comment] = spec[:comment]
+            end
+          end
         end
       end
     end

data/lib/mongo/operation/insert/bulk_result.rb

@@ -41,13 +41,17 @@ module Mongo
         # @param [ Server::Description ] connection_description
         #   Server description of the server that performed the operation that
         #   this result is for.
+        # @param [ Integer ] connection_global_id
+        #   Global id of the connection on which the operation that
+        #   this result is for was performed.
         # @param [ Array<Object> ] ids The ids of the inserted documents.
         #
         # @since 2.0.0
         # @api private
-        def initialize(replies, connection_description, ids)
+        def initialize(replies, connection_description, connection_global_id, ids)
           @replies = [*replies] if replies
           @connection_description = connection_description
+          @connection_global_id = connection_global_id
           if replies && replies.first && (doc = replies.first.documents.first)
             if errors = doc['writeErrors']
               # some documents were potentially inserted

data/lib/mongo/operation/insert/command.rb

@@ -46,10 +46,6 @@ module Mongo
             ordered: ordered? }
         end
 
-        def options(server)
-          super.merge(validating_keys: true)
-        end
-
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

data/lib/mongo/operation/insert/op_msg.rb

@@ -39,14 +39,17 @@ module Mongo
         end
 
         def selector(connection)
-          { insert: coll_name,
+          {
+            insert: coll_name,
             Protocol::Msg::DATABASE_IDENTIFIER => db_name,
-            ordered: ordered? }
+            ordered: ordered?,
+            comment: spec[:comment],
+          }.compact
         end
 
         def message(connection)
           section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
-          Protocol::Msg.new(flags, { validating_keys: true }, command(connection), section)
+          Protocol::Msg.new(flags, {}, command(connection), section)
         end
       end
     end

data/lib/mongo/operation/insert/result.rb

@@ -43,12 +43,15 @@ module Mongo
         # @param [ Server::Description ] connection_description
         #   Server description of the server that performed the operation that
         #   this result is for.
+        # @param [ Integer ] connection_global_id
+        #   Global id of the connection on which the operation that
+        #   this result is for was performed.
         # @param [ Array<Object> ] ids The ids of the inserted documents.
         #
         # @since 2.0.0
         # @api private
-        def initialize(replies, connection_description, ids)
-          super(replies, connection_description)
+        def initialize(replies, connection_description, connection_global_id, ids)
+          super(replies, connection_description, connection_global_id)
           @inserted_ids = ids
         end
 
@@ -67,7 +70,7 @@ module Mongo
 
         # @api public
         def bulk_result
-          BulkResult.new(@replies, connection_description, @inserted_ids)
+          BulkResult.new(@replies, connection_description, connection_global_id, @inserted_ids)
         end
       end
     end

data/lib/mongo/operation/insert.rb

@@ -17,7 +17,6 @@
 
 require 'mongo/operation/insert/command'
 require 'mongo/operation/insert/op_msg'
-require 'mongo/operation/insert/legacy'
 require 'mongo/operation/insert/result'
 require 'mongo/operation/insert/bulk_result'
 

data/lib/mongo/operation/kill_cursors.rb

@@ -18,7 +18,6 @@
 require 'mongo/operation/kill_cursors/command_builder'
 require 'mongo/operation/kill_cursors/command'
 require 'mongo/operation/kill_cursors/op_msg'
-require 'mongo/operation/kill_cursors/legacy'
 
 module Mongo
   module Operation

data/lib/mongo/operation/list_collections/op_msg.rb

@@ -31,7 +31,10 @@ module Mongo
         private
 
         def selector(connection)
-          (spec[SELECTOR] || {}).merge(listCollections: 1)
+          (spec[SELECTOR] || {}).merge({
+            listCollections: 1,
+            comment: spec[:comment]
+          }).compact
         end
       end
     end

data/lib/mongo/operation/map_reduce/result.rb

@@ -131,6 +131,22 @@ module Mongo
           0
         end
 
+        # Get the number of documents returned by the server in this batch.
+        #
+        # Map/Reduce operation returns documents inline without using
+        # cursors; as such, the standard Mongo::Reply#returned_count does
+        # not work correctly for Map/Reduce.
+        #
+        # Note that the Map/Reduce operation is limited to max BSON document
+        # size (16 MB) in its inline result set.
+        #
+        # @return [ Integer ] The number of documents returned.
+        #
+        # @api public
+        def returned_count
+          reply.documents.length
+        end
+
         private
 
         def first_document

data/lib/mongo/operation/result.rb

@@ -97,9 +97,12 @@ module Mongo
       #   this result is for. This parameter is allowed to be nil for
       #   compatibility with existing mongo_kerberos library, but should
       #   always be not nil in the driver proper.
+      # @param [ Integer ] connection_global_id
+      #   Global id of the connection on which the operation that
+      #   this result is for was performed.
       #
       # @api private
-      def initialize(replies, connection_description = nil)
+      def initialize(replies, connection_description = nil, connection_global_id = nil)
         if replies
           if replies.is_a?(Array)
             if replies.length != 1
@@ -114,6 +117,7 @@ module Mongo
           end
           @replies = [ reply ]
           @connection_description = connection_description
+          @connection_global_id = connection_global_id
         end
       end
 
@@ -128,6 +132,12 @@ module Mongo
       # @api private
       attr_reader :connection_description
 
+      # @return [ Object ] Global is of the connection that
+      #   the operation was performed on that this result is for.
+      #
+      # @api private
+      attr_reader :connection_global_id
+
       # @api private
       def_delegators :parser,
         :not_master?, :node_recovering?, :node_shutting_down?
@@ -148,6 +158,15 @@ module Mongo
         !!@replies
       end
 
+      # Whether the result contains cursor_id
+      #
+      # @return [ true, false ] If the result contains cursor_id.
+      #
+      # @api private
+      def has_cursor_id?
+        acknowledged? && replies.last.respond_to?(:cursor_id)
+      end
+
       # Get the cursor id if the response is acknowledged.
       #
       # @note Cursor ids of 0 indicate there is no cursor on the server.
@@ -238,10 +257,7 @@ module Mongo
         end
       end
 
-      # Get the count of documents returned by the server.
-      #
-      # @example Get the number returned.
-      #   result.returned_count
+      # Get the number of documents returned by the server in this batch.
       #
       # @return [ Integer ] The number of documents returned.
       #