mongo 2.22.0 → 2.24.0

data/lib/mongo/operation/map_reduce.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/operation/map_reduce/result'
 
 module Mongo
   module Operation
-
     # A MongoDB mapreduce operation.
     #
     # @api private

data/lib/mongo/operation/op_msg_base.rb

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

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class ParallelScan
-
       # A MongoDB parallelscan operation sent as an op message.
       #
       # @api private
@@ -31,12 +29,13 @@ module Mongo
 
         private
 
-        def selector(connection)
-          sel = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
+        def selector(_connection)
+          sel = { parallelCollectionScan: coll_name, numCursors: cursor_count }
           sel[:maxTimeMS] = max_time_ms if max_time_ms
           if read_concern
             sel[:readConcern] = Options::Mapper.transform_values_to_strings(
-              read_concern)
+              read_concern
+            )
           end
           sel
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,18 +17,16 @@
 module Mongo
   module Operation
     class ParallelScan
-
       # Defines custom behavior of results in a parallel scan.
       #
       # @since 2.0.0
       # @api semiprivate
       class Result < Operation::Result
-
         # The name of the cursors field in the result.
         #
         # @since 2.0.0
         # @api private
-        CURSORS = 'cursors'.freeze
+        CURSORS = 'cursors'
 
         # Get all the cursor ids from the result.
         #
@@ -41,7 +38,7 @@ module Mongo
         # @since 2.0.0
         # @api private
         def cursor_ids
-          documents.map {|doc| doc[CURSOR][CURSOR_ID]}
+          documents.map { |doc| doc[CURSOR][CURSOR_ID] }
         end
 
         # Get the documents from parallel scan.

data/lib/mongo/operation/parallel_scan.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/operation/parallel_scan/result'
 
 module Mongo
   module Operation
-
     # A MongoDB parallelscan operation.
     #
     # @api private

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class RemoveUser
-
       # A MongoDB removeuser operation sent as an op message.
       #
       # @api private
@@ -29,8 +27,8 @@ module Mongo
 
         private
 
-        def selector(connection)
-          { :dropUser => user_name }
+        def selector(_connection)
+          { dropUser: user_name }
         end
       end
     end

data/lib/mongo/operation/remove_user.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'mongo/operation/remove_user/op_msg'
 
 module Mongo
   module Operation
-
     # A MongoDB removeuser operation.
     #
     # @api private

data/lib/mongo/operation/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,11 +15,9 @@
 # limitations under the License.
 
 require 'mongo/operation/shared/result/aggregatable'
-require 'mongo/operation/shared/result/use_legacy_error_parser'
 
 module Mongo
   module Operation
-
     # Result wrapper for wire protocol replies.
     #
     # An operation has zero or one replies. The only operations producing zero
@@ -39,49 +36,49 @@ module Mongo
       #
       # @since 2.2.0
       # @api private
-      CURSOR = 'cursor'.freeze
+      CURSOR = 'cursor'
 
       # The cursor id field in the cursor document.
       #
       # @since 2.2.0
       # @api private
-      CURSOR_ID = 'id'.freeze
+      CURSOR_ID = 'id'
 
       # The field name for the first batch of a cursor.
       #
       # @since 2.2.0
       # @api private
-      FIRST_BATCH = 'firstBatch'.freeze
+      FIRST_BATCH = 'firstBatch'
 
       # The field name for the next batch of a cursor.
       #
       # @since 2.2.0
       # @api private
-      NEXT_BATCH = 'nextBatch'.freeze
+      NEXT_BATCH = 'nextBatch'
 
       # The namespace field in the cursor document.
       #
       # @since 2.2.0
       # @api private
-      NAMESPACE = 'ns'.freeze
+      NAMESPACE = 'ns'
 
       # The number of documents updated in the write.
       #
       # @since 2.0.0
       # @api private
-      N = 'n'.freeze
+      N = 'n'
 
       # The ok status field in the result.
       #
       # @since 2.0.0
       # @api private
-      OK = 'ok'.freeze
+      OK = 'ok'
 
       # The result field constant.
       #
       # @since 2.2.0
       # @api private
-      RESULT = 'result'.freeze
+      RESULT = 'result'
 
       # Initialize a new result.
       #
@@ -107,23 +104,23 @@ module Mongo
       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
-              raise ArgumentError, "Only one (or zero) reply is supported, given #{replies.length}"
-            end
-            reply = replies.first
-          else
-            reply = replies
-          end
-          unless reply.is_a?(Protocol::Message)
-            raise ArgumentError, "Argument must be a Message instance, but is a #{reply.class}: #{reply.inspect}"
-          end
-          @replies = [ reply ]
-          @connection_description = connection_description
-          @connection_global_id = connection_global_id
-          @connection = connection
+        return unless replies
+
+        if replies.is_a?(Array)
+          raise ArgumentError, "Only one (or zero) reply is supported, given #{replies.length}" if replies.length != 1
+
+          reply = replies.first
+        else
+          reply = replies
         end
+        unless reply.is_a?(Protocol::Message)
+          raise ArgumentError, "Argument must be a Message instance, but is a #{reply.class}: #{reply.inspect}"
+        end
+
+        @replies = [ reply ]
+        @connection_description = connection_description
+        @connection_global_id = connection_global_id
+        @connection = connection
       end
 
       # @return [ Array<Protocol::Message> ] replies The wrapped wire protocol replies.
@@ -153,16 +150,10 @@ module Mongo
 
       # @api private
       def_delegators :parser,
-        :not_master?, :node_recovering?, :node_shutting_down?
+                     :not_master?, :node_recovering?, :node_shutting_down?
 
       # Is the result acknowledged?
       #
-      # @note On MongoDB 2.6 and higher all writes are acknowledged since the
-      #   driver uses write commands for all write operations. On 2.4 and
-      #   lower, the result is acknowledged if the GLE has been executed after
-      #   the command. If not, no replies will be specified. Reads will always
-      #   return true here since a replies is always provided.
-      #
       # @return [ true, false ] If the result is acknowledged.
       #
       # @since 2.0.0
@@ -263,11 +254,9 @@ module Mongo
       # @since 2.0.0
       # @api private
       def reply
-        if acknowledged?
-          replies.first
-        else
-          nil
-        end
+        return unless acknowledged?
+
+        replies.first
       end
 
       # Get the number of documents returned by the server in this batch.
@@ -298,7 +287,8 @@ module Mongo
       # @since 2.0.0
       # @api public
       def successful?
-        return true if !acknowledged?
+        return true unless acknowledged?
+
         if first_document.has_key?(OK)
           ok? && parser.message.empty?
         else
@@ -340,7 +330,7 @@ module Mongo
       # @since 2.0.0
       # @api private
       def validate!
-        !successful? ? raise_operation_failure : self
+        successful? ? self : raise_operation_failure
       end
 
       # The exception instance (of Error::OperationFailure::Family)
@@ -365,7 +355,7 @@ module Mongo
           wtimeout: parser.wtimeout,
           connection_description: connection_description,
           document: parser.document,
-          server_message: parser.server_message,
+          server_message: parser.server_message
         )
       end
 
@@ -383,7 +373,7 @@ module Mongo
       def topology_version
         unless defined?(@topology_version)
           @topology_version = first_document['topologyVersion'] &&
-            TopologyVersion.new(first_document['topologyVersion'])
+                              TopologyVersion.new(first_document['topologyVersion'])
         end
         @topology_version
       end
@@ -406,7 +396,7 @@ module Mongo
       end
 
       # @api public
-      alias :n :written_count
+      alias n written_count
 
       # Get the operation time reported in the server response.
       #
@@ -459,9 +449,9 @@ module Mongo
       end
 
       def snapshot_timestamp
-        if doc = reply.documents.first
-          doc['cursor']&.[]('atClusterTime') || doc['atClusterTime']
-        end
+        return unless doc = reply.documents.first
+
+        doc['cursor']&.[]('atClusterTime') || doc['atClusterTime']
       end
 
       private
@@ -483,7 +473,7 @@ module Mongo
 
       def aggregate_written_count
         documents.reduce(0) do |n, document|
-          n += (document[N] || 0)
+          n += document[N] || 0
           n
         end
       end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,20 +16,16 @@
 
 module Mongo
   module Operation
-
     # Custom behavior for operations that support the bypassdocumentvalidation option.
     #
     # @since 2.5.2
     # @api private
     module BypassDocumentValidation
-
       private
 
       def command(connection)
-        if Lint.enabled?
-          unless connection.is_a?(Server::Connection)
-            raise Error::LintError, "Connection is not a Connection instance: #{connection}"
-          end
+        if Lint.enabled? && !connection.is_a?(Server::Connection)
+          raise Error::LintError, "Connection is not a Connection instance: #{connection}"
         end
 
         sel = super
@@ -39,6 +34,7 @@ module Mongo
 
       def add_bypass_document_validation(sel)
         return sel unless bypass_document_validation
+
         sel.merge(bypassDocumentValidation: true)
       end
     end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Operation
-
     # Custom behavior for operations that support causal consistency.
     #
     # @since 2.5.2
     # @api private
     module CausalConsistencySupported
-
       private
 
       # Adds causal consistency document to the selector, if one can be

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,13 +18,11 @@ require 'mongo/error'
 
 module Mongo
   module Operation
-
     # Shared executable behavior of operations.
     #
     # @since 2.5.2
     # @api private
     module Executable
-
       include ResponseHandling
 
       # @return [ Operation::Context | nil ] the operation context used to
@@ -45,11 +42,10 @@ module Mongo
           add_error_labels(connection, context) do
             check_for_network_error do
               add_server_diagnostics(connection) do
-                get_result(connection, context, options).tap do |result|
+                get_result(connection, context, options) do |result|
                   if session
                     if session.in_transaction? &&
-                      connection.description.load_balancer?
-                    then
+                       connection.description.load_balancer?
                       if session.pinned_connection_global_id
                         unless session.pinned_connection_global_id == connection.global_id
                           raise(
@@ -57,9 +53,9 @@ module Mongo
                             "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
+                      elsif !session.committing_transaction? && !session.aborting_transaction?
+                        session.pin_to_connection(connection.global_id, connection: connection)
+                        connection.pin(:transaction)
                       end
                     end
 
@@ -69,8 +65,7 @@ module Mongo
                   end
 
                   if result.has_cursor_id? &&
-                    connection.description.load_balancer?
-                  then
+                     connection.description.load_balancer?
                     if result.cursor_id == 0
                       connection.unpin
                     else
@@ -86,10 +81,8 @@ module Mongo
       end
 
       def execute(connection, context:, options: {})
-        if Lint.enabled?
-          unless connection.is_a?(Mongo::Server::Connection)
-            raise Error::LintError, "Connection argument is of wrong type: #{connection}"
-          end
+        if Lint.enabled? && !connection.is_a?(Mongo::Server::Connection)
+          raise Error::LintError, "Connection argument is of wrong type: #{connection}"
         end
 
         do_execute(connection, context, options).tap do |result|
@@ -104,15 +97,23 @@ module Mongo
       end
 
       def get_result(connection, context, options = {})
-        result_class.new(*dispatch_message(connection, context, options), context: context, connection: connection)
+        message = build_message(connection, context)
+        connection.tracer.trace_command(message, context, connection) do
+          result = result_class.new(*dispatch_message(message, connection, context, options), context: context,
+                                                                                              connection: connection)
+          if block_given?
+            yield result
+          else
+            result
+          end
+        end
       end
 
       # Returns a Protocol::Message or nil as reply.
-      def dispatch_message(connection, context, options = {})
-        message = build_message(connection, context)
+      def dispatch_message(message, connection, context, options = {})
         message = message.maybe_encrypt(connection, context)
         reply = connection.dispatch([ message ], context, options)
-        [reply, connection.description, connection.global_id]
+        [ reply, connection.description, connection.global_id ]
       end
 
       # @param [ Mongo::Server::Connection ] connection The connection on which
@@ -131,29 +132,26 @@ module Mongo
 
         process_result_for_sdam(result, connection)
 
-        if session
-          session.process(result)
-        end
+        session.process(result) if session
 
         result
       end
 
       def process_result_for_sdam(result, connection)
         if (result.not_master? || result.node_recovering?) &&
-          connection.generation >= connection.server.pool.generation(service_id: connection.service_id)
-        then
-          if result.node_shutting_down?
-            keep_pool = false
-          else
-            # Max wire version needs to be examined while the server is known
-            keep_pool = connection.description.server_version_gte?('4.2')
-          end
+           connection.generation >= connection.server.pool.generation(service_id: connection.service_id)
+          keep_pool = if result.node_shutting_down?
+                        false
+                      else
+                        # Max wire version needs to be examined while the server is known
+                        connection.description.server_version_gte?('4.2')
+                      end
 
           connection.server.unknown!(
             keep_connection_pool: keep_pool,
             generation: connection.generation,
             service_id: connection.service_id,
-            topology_version: result.topology_version,
+            topology_version: result.topology_version
           )
 
           connection.server.scan_semaphore.signal

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Operation
-
     # Shared executable behavior of operations for operations
     # whose result should not be validated.
     #
     # @api private
     module ExecutableNoValidate
-
       def execute(connection, context:)
         do_execute(connection, context)
       end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of applying transaction error label to execution result.
     #
     # @note This module should be included after ExecutableNoValidate,

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Operation
-
-    # Shared behavior of operations that require its documents to each have an id.
+    # Shared behavior of operations that require their documents to each have an id.
     #
     # @since 2.5.2
     # @api private
     module Idable
-
       def documents
         @documents ||= ensure_ids(super)
       end
@@ -33,7 +30,7 @@ module Mongo
       # The option for a custom id generator.
       #
       # @since 2.2.0
-      ID_GENERATOR = :id_generator.freeze
+      ID_GENERATOR = :id_generator
 
       # Get the id generator.
       #
@@ -44,7 +41,7 @@ module Mongo
       #
       # @since 2.2.0
       def id_generator
-        @id_generator ||= (spec[ID_GENERATOR] || Operation::ObjectIdGenerator.new)
+        @id_generator ||= spec[ID_GENERATOR] || Operation::ObjectIdGenerator.new
       end
 
       def id(doc)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of operations that require its documents to each have an id.
     #
     # @since 2.5.2
     # @api private
     module Limited
-
       private
 
       # Get the options for executing the operation on a particular connection.

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Operation
-
     # The default generator of ids for documents.
     #
     # @since 2.2.0
     # @api private
     class ObjectIdGenerator
-
       # Generate a new id.
       #
       # @example Generate the id.

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of executing the operation as an OpMsg.
     #
     # @api private

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of looking up a class based on the name of
     # the receiver's class.
     #