mongo 2.17.4 → 2.21.0

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -43,12 +43,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.
+        # @param [ Operation::Context | nil ] context the operation context that
+        #   was active when this result was produced.
         #
         # @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, context: nil)
+          super(replies, connection_description, connection_global_id, context: context)
           @inserted_ids = ids
         end
 
@@ -67,7 +72,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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,9 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-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/command_builder.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/kill_cursors.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -16,9 +16,7 @@
 # limitations under the License.
 
 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
@@ -30,7 +28,7 @@ module Mongo
     # @since 2.0.0
     class KillCursors
       include Specifiable
-      include OpMsgOrFindCommand
+      include OpMsgExecutable
     end
   end
 end

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

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -85,7 +85,7 @@ module Mongo
           if successful?
             self
           else
-            raise Error::OperationFailure.new(
+            raise operation_failure_class.new(
               parser.message,
               self,
               code: parser.code,

data/lib/mongo/operation/list_collections.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/list_collections/command'
 require 'mongo/operation/list_collections/op_msg'
 require 'mongo/operation/list_collections/result'
 
@@ -29,7 +28,7 @@ module Mongo
     # @since 2.0.0
     class ListCollections
       include Specifiable
-      include OpMsgOrCommand
+      include OpMsgExecutable
     end
   end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -108,7 +108,7 @@ module Mongo
         # @example Validate the result.
         #   result.validate!
         #
-        # @raise [ Error::OperationFailure ] If an error is in the result.
+        # @raise [ Error::OperationFailure::Family ] If an error is in the result.
         #
         # @return [ Result ] The result if verification passed.
         #
@@ -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/map_reduce.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/map_reduce/command'
 require 'mongo/operation/map_reduce/op_msg'
 require 'mongo/operation/map_reduce/result'
 
@@ -29,7 +28,7 @@ module Mongo
     # @since 2.5.0
     class MapReduce
       include Specifiable
-      include OpMsgOrCommand
+      include OpMsgExecutable
     end
   end
 end

data/lib/mongo/operation/op_msg_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -22,11 +22,13 @@ module Mongo
       include Specifiable
       include Executable
       include SessionsSupported
+      include Timed
 
       private
 
       def message(connection)
-        Protocol::Msg.new(flags, options(connection), command(connection))
+        cmd = apply_relevant_timeouts_to(command(connection), connection)
+        Protocol::Msg.new(flags, options(connection), cmd)
       end
     end
   end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/operation/parallel_scan.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/parallel_scan/command'
 require 'mongo/operation/parallel_scan/op_msg'
 require 'mongo/operation/parallel_scan/result'
 
@@ -29,7 +28,7 @@ module Mongo
     # @since 2.0.0
     class ParallelScan
       include Specifiable
-      include OpMsgOrCommand
+      include OpMsgExecutable
     end
   end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/remove_user.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/remove_user/command'
 require 'mongo/operation/remove_user/op_msg'
 
 module Mongo
@@ -28,7 +27,7 @@ module Mongo
     # @since 2.0.0
     class RemoveUser
       include Specifiable
-      include OpMsgOrCommand
+      include OpMsgExecutable
     end
   end
 end

data/lib/mongo/operation/result.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -97,9 +97,16 @@ 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.
+      # @param [ Operation::Context | nil ] context the context that was active
+      #   when this result was produced.
       #
       # @api private
-      def initialize(replies, connection_description = nil)
+      def initialize(replies, connection_description = nil, connection_global_id = nil, context: nil, connection: nil)
+        @context = context
+
         if replies
           if replies.is_a?(Array)
             if replies.length != 1
@@ -114,6 +121,8 @@ module Mongo
           end
           @replies = [ reply ]
           @connection_description = connection_description
+          @connection_global_id = connection_global_id
+          @connection = connection
         end
       end
 
@@ -128,6 +137,20 @@ 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
+
+      # @return [ Operation::Context | nil ] the operation context (if any)
+      #   that was active when this result was produced.
+      #
+      # @api private
+      attr_reader :context
+
+      attr_reader :connection
+
       # @api private
       def_delegators :parser,
         :not_master?, :node_recovering?, :node_shutting_down?
@@ -148,6 +171,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 +270,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.
       #
@@ -304,7 +333,7 @@ module Mongo
       # @example Validate the result.
       #   result.validate!
       #
-      # @raise [ Error::OperationFailure ] If an error is in the result.
+      # @raise [ Error::OperationFailure::Family ] If an error is in the result.
       #
       # @return [ Result ] The result if verification passed.
       #
@@ -314,16 +343,16 @@ module Mongo
         !successful? ? raise_operation_failure : self
       end
 
-      # The exception instance (of the Error::OperationFailure class)
+      # The exception instance (of Error::OperationFailure::Family)
       # that would be raised during processing of this result.
       #
       # This method should only be called when result is not successful.
       #
-      # @return [ Error::OperationFailure ] The exception.
+      # @return [ Error::OperationFailure::Family ] The exception.
       #
       # @api private
       def error
-        @error ||= Error::OperationFailure.new(
+        @error ||= operation_failure_class.new(
           parser.message,
           self,
           code: parser.code,
@@ -437,6 +466,14 @@ module Mongo
 
       private
 
+      def operation_failure_class
+        if context&.csot? && parser.code == 50
+          Error::ServerTimeoutError
+        else
+          Error::OperationFailure
+        end
+      end
+
       def aggregate_returned_count
         replies.reduce(0) do |n, reply|
           n += reply.number_returned

data/lib/mongo/operation/shared/bypass_document_validation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/causal_consistency_supported.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/executable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/error'
+
 module Mongo
   module Operation
 
@@ -26,29 +28,57 @@ module Mongo
 
       include ResponseHandling
 
+      # @return [ Operation::Context | nil ] the operation context used to
+      #   execute this operation.
+      attr_accessor :context
+
       def do_execute(connection, context, options = {})
-        unpin_maybe(session) do
+        # Save the context on the instance, to avoid having to pass it as a
+        # parameter to every single method. There are many legacy methods that
+        # still accept it as a parameter, which are left as-is for now to
+        # minimize the impact of this change. Moving forward, it may be
+        # reasonable to refactor things so this saved reference is used instead.
+        @context = context
+
+        session&.materialize_if_needed
+        unpin_maybe(session, connection) do
           add_error_labels(connection, context) do
-            add_server_diagnostics(connection) do
-              get_result(connection, context, options).tap do |result|
-                if session
-                  if session.in_transaction? &&
-                    connection.description.load_balancer?
-                  then
-                    if session.pinned_service_id
-                      unless session.pinned_service_id == connection.service_id
-                        raise Error::InternalDriverError, "Expected operation to use service #{session.pinned_session_id} but it used #{connection.service_id}"
+            check_for_network_error do
+              add_server_diagnostics(connection) do
+                get_result(connection, context, options).tap do |result|
+                  if session
+                    if session.in_transaction? &&
+                      connection.description.load_balancer?
+                    then
+                      if session.pinned_connection_global_id
+                        unless session.pinned_connection_global_id == connection.global_id
+                          raise(
+                            Error::InternalDriverError,
+                            "Expected operation to use connection #{session.pinned_connection_global_id} but it used #{connection.global_id}"
+                          )
+                        end
+                      else
+                        session.pin_to_connection(connection.global_id)
+                        connection.pin
                       end
-                    else
-                      session.pin_to_service(connection.service_id)
+                    end
+
+                    if session.snapshot? && !session.snapshot_timestamp
+                      session.snapshot_timestamp = result.snapshot_timestamp
                     end
                   end
 
-                  if session.snapshot? && !session.snapshot_timestamp
-                    session.snapshot_timestamp = result.snapshot_timestamp
+                  if result.has_cursor_id? &&
+                    connection.description.load_balancer?
+                  then
+                    if result.cursor_id == 0
+                      connection.unpin
+                    else
+                      connection.pin
+                    end
                   end
+                  process_result(result, connection)
                 end
-                process_result(result, connection)
               end
             end
           end
@@ -74,7 +104,7 @@ module Mongo
       end
 
       def get_result(connection, context, options = {})
-        result_class.new(*dispatch_message(connection, context, options))
+        result_class.new(*dispatch_message(connection, context, options), context: context, connection: connection)
       end
 
       # Returns a Protocol::Message or nil as reply.
@@ -82,7 +112,7 @@ module Mongo
         message = build_message(connection, context)
         message = message.maybe_encrypt(connection, context)
         reply = connection.dispatch([ message ], context, options)
-        [reply, connection.description]
+        [reply, connection.description, connection.global_id]
       end
 
       # @param [ Mongo::Server::Connection ] connection The connection on which
@@ -129,6 +159,18 @@ module Mongo
           connection.server.scan_semaphore.signal
         end
       end
+
+      NETWORK_ERRORS = [
+        Error::SocketError,
+        Error::SocketTimeoutError
+      ].freeze
+
+      def check_for_network_error
+        yield
+      rescue *NETWORK_ERRORS
+        session&.dirty!
+        raise
+      end
     end
   end
 end

data/lib/mongo/operation/shared/executable_no_validate.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/executable_transaction_label.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/idable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/limited.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/operation/shared/object_id_generator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #