mongo 2.22.0 → 2.24.0

data/lib/mongo/server/connection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Server
-
     # This class models the socket connections for servers and their behavior.
     #
     # @since 2.0.0
@@ -32,37 +30,23 @@ module Mongo
       # @since 2.1.0
       #
       # @deprecated No longer necessary with Server Selection specification.
-      PING = { :ping => 1 }.freeze
+      PING = { ping: 1 }.freeze
 
-      # The ping command for an OP_MSG (server versions >= 3.6).
+      # The ping command for an OP_MSG
       #
       # @since 2.5.0
       #
       # @deprecated No longer necessary with Server Selection specification.
       PING_OP_MSG = { :ping => 1, '$db' => Database::ADMIN }.freeze
 
-      # Ping message.
-      #
-      # @since 2.1.0
-      #
-      # @deprecated No longer necessary with Server Selection specification.
-      PING_MESSAGE = Protocol::Query.new(Database::ADMIN, Database::COMMAND, PING, :limit => -1)
-
-      # Ping message as an OP_MSG (server versions >= 3.6).
+      # Ping message as an OP_MSG
       #
       # @since 2.5.0
       #
       # @deprecated No longer necessary with Server Selection specification.
       PING_OP_MSG_MESSAGE = Protocol::Msg.new([], {}, PING_OP_MSG)
 
-      # The ping message as raw bytes.
-      #
-      # @since 2.1.0
-      #
-      # @deprecated No longer necessary with Server Selection specification.
-      PING_BYTES = PING_MESSAGE.serialize.to_s.freeze
-
-      # The ping OP_MSG message as raw bytes (server versions >= 3.6).
+      # The ping OP_MSG message as raw bytes
       #
       # @since 2.5.0
       #
@@ -105,7 +89,7 @@ module Mongo
       # @since 2.0.0
       def initialize(server, options = {})
         if server.load_balancer? && options[:generation]
-          raise ArgumentError, "Generation cannot be set when server is a load balancer"
+          raise ArgumentError, 'Generation cannot be set when server is a load balancer'
         end
 
         @id = server.next_connection_id
@@ -117,7 +101,7 @@ module Mongo
         @last_checkin = nil
         @auth_mechanism = nil
         @pid = Process.pid
-        @pinned = false
+        @pin_reasons = Set.new
 
         publish_cmap_event(
           Monitoring::Event::Cmap::ConnectionCreated.new(address, id)
@@ -139,6 +123,8 @@ module Mongo
       # across all connections.
       attr_reader :global_id
 
+      def_delegators :server, :tracer
+
       # The connection pool from which this connection was created.
       # May be nil.
       #
@@ -196,21 +182,34 @@ module Mongo
       #
       # @api private
       def pinned?
-        @pinned
+        !@pin_reasons.empty?
       end
 
-      # Mark the connection as pinned.
+      # Mark the connection as pinned for the given reason.
+      #
+      # @param [ Symbol ] reason The reason for pinning (:cursor or
+      #   :transaction). Defaults to :cursor for backward compatibility.
       #
       # @api private
-      def pin
-        @pinned = true
+      def pin(reason = :cursor)
+        @pin_reasons << reason
       end
 
-      # Mark the connection as not pinned.
+      # Remove a pin from the connection for the given reason.
+      #
+      # @param [ Symbol ] reason The reason to unpin (:cursor or
+      #   :transaction). Defaults to :cursor for backward compatibility.
       #
       # @api private
-      def unpin
-        @pinned = false
+      def unpin(reason = :cursor)
+        @pin_reasons.delete(reason)
+      end
+
+      # Remove all pins from the connection.
+      #
+      # @api private
+      def unpin_all
+        @pin_reasons.clear
       end
 
       # Establishes a network connection to the target address.
@@ -234,10 +233,9 @@ module Mongo
           @description, @compressor = do_connect
 
           if server.load_balancer?
-            if Lint.enabled?
-              unless service_id
-                raise Error::InternalDriverError, "The connection is to a load balancer and it must have service_id set here, but does not"
-              end
+            if Lint.enabled? && !service_id
+              raise Error::InternalDriverError,
+                    'The connection is to a load balancer and it must have service_id set here, but does not'
             end
             @generation = connection_pool.generation_manager.generation(service_id: service_id)
           end
@@ -278,7 +276,8 @@ module Mongo
         raise_if_closed!
         begin
           pending_connection = PendingConnection.new(
-            socket, @server, monitoring, options.merge(id: id))
+            socket, @server, monitoring, options.merge(id: id)
+          )
           pending_connection.handshake_and_authenticate!
         rescue Exception
           socket&.close
@@ -286,7 +285,7 @@ module Mongo
           raise
         end
 
-        [pending_connection.description, pending_connection.compressor]
+        [ pending_connection.description, pending_connection.compressor ]
       end
 
       # Disconnect the connection.
@@ -309,12 +308,16 @@ module Mongo
       #
       # @since 2.0.0
       def disconnect!(options = nil)
-        # Note: @closed may be true here but we also may have a socket.
+        # NOTE: @closed may be true here but we also may have a socket.
         # Check the socket and not @closed flag.
         @auth_mechanism = nil
         @last_checkin = nil
         if socket
-          socket.close rescue nil
+          begin
+            socket.close
+          rescue StandardError
+            nil
+          end
           @socket = nil
         end
         @closed = true
@@ -331,8 +334,8 @@ module Mongo
             Monitoring::Event::Cmap::ConnectionClosed.new(
               address,
               id,
-              reason,
-            ),
+              reason
+            )
           )
           @close_event_published = true
         end
@@ -354,10 +357,9 @@ module Mongo
       #
       # @deprecated No longer necessary with Server Selection specification.
       def ping
-        bytes = features.op_msg_enabled? ? PING_OP_MSG_BYTES : PING_BYTES
         ensure_connected do |socket|
           reply = add_server_diagnostics do
-            socket.write(bytes)
+            socket.write(PING_OP_MSG_BYTES)
             Protocol::Message.deserialize(socket, max_message_size)
           end
           reply.documents[0][Operation::Result::OK] == 1
@@ -373,7 +375,7 @@ module Mongo
         @timeout ||= options[:socket_timeout]
       end
       # @deprecated Please use :socket_timeout instead. Will be removed in 3.0.0
-      alias :timeout :socket_timeout
+      alias timeout socket_timeout
 
       # Record the last checkin time.
       #
@@ -388,6 +390,22 @@ module Mongo
         self
       end
 
+      # Get the transport type for this connection.
+      #
+      # @return [ Symbol | nil ] The transport type, :tcp or :unix, or nil
+      #  if no socket.
+      # @api private
+      def transport
+        return nil if @socket.nil?
+
+        case @socket
+        when Mongo::Socket::Unix
+          :unix
+        else
+          :tcp
+        end
+      end
+
       private
 
       def deliver(message, client, options = {})
@@ -397,31 +415,31 @@ module Mongo
       end
 
       def handle_errors
-        begin
-          yield
-        rescue Error::SocketError => e
-          @error = e
-          @server.unknown!(
-            generation: e.generation,
-            # or description.service_id?
-            service_id: e.service_id,
-            stop_push_monitor: true,
-          )
-          raise
-        rescue Error::SocketTimeoutError => e
-          @error = e
-          raise
-        end
+        yield
+      rescue Error::SocketError => e
+        @error = e
+        @server.unknown!(
+          generation: e.generation,
+          # or description.service_id?
+          service_id: e.service_id,
+          stop_push_monitor: true
+        )
+        raise
+      rescue Error::SocketTimeoutError => e
+        @error = e
+        raise
       end
 
       def raise_if_closed!
         if error?
-          raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is perished. Reconnecting closed or errored connections is no longer supported"
+          raise Error::ConnectionPerished,
+                "Connection #{generation}:#{id} for #{address.seed} is perished. Reconnecting closed or errored connections is no longer supported"
         end
 
-        if closed?
-          raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is closed. Reconnecting closed or errored connections is no longer supported"
-        end
+        return unless closed?
+
+        raise Error::ConnectionPerished,
+              "Connection #{generation}:#{id} for #{address.seed} is closed. Reconnecting closed or errored connections is no longer supported"
       end
     end
   end

data/lib/mongo/server/connection_base.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Server
-
     # This class encapsulates common connection functionality.
     #
     # @note Although methods of this module are part of the public API,
@@ -37,17 +35,17 @@ module Mongo
       # MAX_BSON_COMMAND_OVERHEAD.
       #
       # @api private
-      DEFAULT_MAX_BSON_OBJECT_SIZE = 16777216
+      DEFAULT_MAX_BSON_OBJECT_SIZE = 16_777_216
 
       # The additional overhead allowed for command data (i.e. fields added
       # to the command document by the driver, as opposed to documents
       # provided by the user) when serializing a complete command to BSON.
       #
       # @api private
-      MAX_BSON_COMMAND_OVERHEAD = 16384
+      MAX_BSON_COMMAND_OVERHEAD = 16_384
 
       # @api private
-      REDUCED_MAX_BSON_SIZE = 2097152
+      REDUCED_MAX_BSON_SIZE = 2_097_152
 
       # @return [ Hash ] options The passed in options.
       attr_reader :options
@@ -83,10 +81,10 @@ module Mongo
 
       # @deprecated
       def_delegators :description,
-        :features,
-        :max_bson_object_size,
-        :max_message_size,
-        :mongos?
+                     :features,
+                     :max_bson_object_size,
+                     :max_message_size,
+                     :mongos?
 
       # @return [ nil | Object ] The service id, if any.
       def service_id
@@ -151,12 +149,13 @@ module Mongo
         # The monitoring code does not correctly handle multiple messages,
         # and the driver internally does not send more than one message at
         # a time ever. Thus prohibit multiple message use for now.
-        if messages.length != 1
-          raise ArgumentError, 'Can only dispatch one message at a time'
-        end
+        raise ArgumentError, 'Can only dispatch one message at a time' if messages.length != 1
+
         if description.unknown?
-          raise Error::InternalDriverError, "Cannot dispatch a message on a connection with unknown description: #{description.inspect}"
+          raise Error::InternalDriverError,
+                "Cannot dispatch a message on a connection with unknown description: #{description.inspect}"
         end
+
         message = messages.first
         deliver(message, context, options)
       end
@@ -168,16 +167,16 @@ module Mongo
         if Lint.enabled? && !@socket
           raise Error::LintError, "Trying to deliver a message over a disconnected connection (to #{address})"
         end
+
         buffer = serialize(message, context)
         check_timeout!(context)
         ensure_connected do |socket|
           operation_id = Monitoring.next_operation_id
           started_event = command_started(address, operation_id, message.payload,
-            socket_object_id: socket.object_id, connection_id: id,
-            connection_generation: generation,
-            server_connection_id: description.server_connection_id,
-            service_id: description.service_id,
-          )
+                                          socket_object_id: socket.object_id, connection_id: id,
+                                          connection_generation: generation,
+                                          server_connection_id: description.server_connection_id,
+                                          service_id: description.service_id)
           start = Utils.monotonic_time
           result = nil
           begin
@@ -185,32 +184,27 @@ module Mongo
               socket.write(buffer.to_s, timeout: context.remaining_timeout_sec)
               if message.replyable?
                 check_timeout!(context)
-                Protocol::Message.deserialize(socket, max_message_size, message.request_id, options.merge(timeout: context.remaining_timeout_sec))
-              else
-                nil
+                Protocol::Message.deserialize(socket, max_message_size, message.request_id,
+                                              options.merge(timeout: context.remaining_timeout_sec))
               end
             end
           rescue Exception => e
             total_duration = Utils.monotonic_time - start
             command_failed(nil, address, operation_id, message.payload,
-              e.message, total_duration,
-              started_event: started_event,
-              server_connection_id: description.server_connection_id,
-              service_id: description.service_id,
-            )
+                           e.message, total_duration,
+                           started_event: started_event,
+                           server_connection_id: description.server_connection_id,
+                           service_id: description.service_id)
             raise
           else
             total_duration = Utils.monotonic_time - start
             command_completed(result, address, operation_id, message.payload,
-              total_duration,
-              started_event: started_event,
-              server_connection_id: description.server_connection_id,
-              service_id: description.service_id,
-            )
-          end
-          if result && context.decrypt?
-            result = result.maybe_decrypt(context)
+                              total_duration,
+                              started_event: started_event,
+                              server_connection_id: description.server_connection_id,
+                              service_id: description.service_id)
           end
+          result = result.maybe_decrypt(context) if result && context.decrypt?
           result
         end
       end
@@ -224,18 +218,16 @@ module Mongo
         # only as the default if the server's hello did not contain
         # maxBsonObjectSize.
         max_bson_size = max_bson_object_size || DEFAULT_MAX_BSON_OBJECT_SIZE
-        if context.encrypt?
-          # The client-side encryption specification requires bulk writes to
-          # be split at a reduced maxBsonObjectSize. If this message is a bulk
-          # write and its size exceeds the reduced size limit, the serializer
-          # will raise an exception, which is caught by BulkWrite. BulkWrite
-          # will split the operation into individual writes, which will
-          # not be subject to the reduced maxBsonObjectSize.
-          if message.bulk_write?
-            # Make the new maximum size equal to the specified reduced size
-            # limit plus the 16KiB overhead allowance.
-            max_bson_size = REDUCED_MAX_BSON_SIZE
-          end
+        # The client-side encryption specification requires bulk writes to
+        # be split at a reduced maxBsonObjectSize. If this message is a bulk
+        # write and its size exceeds the reduced size limit, the serializer
+        # will raise an exception, which is caught by BulkWrite. BulkWrite
+        # will split the operation into individual writes, which will
+        # not be subject to the reduced maxBsonObjectSize.
+        if context.encrypt? && message.bulk_write?
+          # Make the new maximum size equal to the specified reduced size
+          # limit plus the 16KiB overhead allowance.
+          max_bson_size = REDUCED_MAX_BSON_SIZE
         end
 
         # RUBY-2234: It is necessary to check that the message size does not
@@ -261,9 +253,7 @@ module Mongo
           temp_buffer.put_bytes(buffer.get_bytes(buffer.length))
 
           message.serialize(temp_buffer, max_bson_size, MAX_BSON_COMMAND_OVERHEAD)
-          if temp_buffer.length > max_message_size
-            raise Error::MaxMessageSize.new(max_message_size)
-          end
+          raise Error::MaxMessageSize.new(max_message_size) if temp_buffer.length > max_message_size
         end
 
         # RUBY-2335: When the un-compressed message is smaller than the maximum
@@ -286,12 +276,12 @@ module Mongo
       # @raise [ Mongo::Error::TimeoutError ] if timeout expired or there is
       #   not enough time to send the message to the server.
       def check_timeout!(context)
-        return if [nil, 0].include?(context.deadline)
+        return if [ nil, 0 ].include?(context.deadline)
 
         time_to_execute = context.remaining_timeout_sec - server.minimum_round_trip_time
-        if time_to_execute <= 0
-          raise Mongo::Error::TimeoutError
-        end
+        return unless time_to_execute <= 0
+
+        raise Mongo::Error::TimeoutError
       end
     end
   end

data/lib/mongo/server/connection_common.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Server
-
     # Common methods used by both monitoring and non-monitoring connections.
     #
     # @note Although methods of this module are part of the public API,
@@ -26,7 +24,6 @@ module Mongo
     #
     # @api semipublic
     class ConnectionCommon
-
       # The compressor negotiated during the handshake for this connection,
       # if any.
       #
@@ -73,12 +70,8 @@ module Mongo
                      LEGACY_HELLO_DOC
                    end
         document.merge(app_metadata.validated_document).tap do |doc|
-          if speculative_auth_doc
-            doc.update(speculativeAuthenticate: speculative_auth_doc)
-          end
-          if load_balancer
-            doc.update(loadBalanced: true)
-          end
+          doc.update(speculativeAuthenticate: speculative_auth_doc) if speculative_auth_doc
+          doc.update(loadBalanced: true) if load_balancer
         end
       end
 
@@ -94,19 +87,18 @@ module Mongo
       def handshake_command(handshake_document)
         if handshake_document['apiVersion'] || handshake_document['loadBalanced']
           Protocol::Msg.new(
-            [], {}, handshake_document.merge({'$db' => Database::ADMIN})
+            [], {}, handshake_document.merge({ '$db' => Database::ADMIN })
           )
         else
           Protocol::Query.new(
             Database::ADMIN,
             Database::COMMAND,
             handshake_document,
-            :limit => -1
+            limit: -1
           )
         end
       end
 
-
       private
 
       HELLO_DOC = BSON::Document.new({ hello: 1 }).freeze
@@ -118,22 +110,22 @@ module Mongo
       def set_compressor!(reply)
         server_compressors = reply['compression']
 
-        if options[:compressors]
-          if intersection = (server_compressors & options[:compressors])
-            @compressor = intersection.first
-          else
-            msg = if server_compressors
-              "The server at #{address} has no compression algorithms in common with those requested. " +
-                "Server algorithms: #{server_compressors.join(', ')}; " +
-                "Requested algorithms: #{options[:compressors].join(', ')}. " +
-                "Compression will not be used"
-            else
-              "The server at #{address} did not advertise compression support. " +
-                "Requested algorithms: #{options[:compressors].join(', ')}. " +
-                "Compression will not be used"
-            end
-            log_warn(msg)
-          end
+        return unless options[:compressors]
+
+        if intersection = (server_compressors & options[:compressors])
+          @compressor = intersection.first
+        else
+          msg = if server_compressors
+                  "The server at #{address} has no compression algorithms in common with those requested. " +
+                    "Server algorithms: #{server_compressors.join(', ')}; " +
+                    "Requested algorithms: #{options[:compressors].join(', ')}. " +
+                    'Compression will not be used'
+                else
+                  "The server at #{address} did not advertise compression support. " +
+                    "Requested algorithms: #{options[:compressors].join(', ')}. " +
+                    'Compression will not be used'
+                end
+          log_warn(msg)
         end
       end
 
@@ -151,57 +143,42 @@ module Mongo
         # knows its address. Server::Connection delegates the address to its
         # server.
         note = +"on #{address.seed}"
-        if respond_to?(:id)
-          note << ", connection #{generation}:#{id}"
-        end
+        note << ", connection #{generation}:#{id}" if respond_to?(:id)
         # Non-monitoring connections have service id.
         # Monitoring connections do not.
-        if respond_to?(:service_id) && service_id
-          note << ", service id #{service_id}"
-        end
+        note << ", service id #{service_id}" if respond_to?(:service_id) && service_id
         e.add_note(note)
         if respond_to?(:generation)
           # Non-monitoring connections
           e.generation = generation
-          if respond_to?(:global_id)
-            e.connection_global_id = global_id
-          end
-          if respond_to?(:description)
-            e.service_id = service_id
-          end
+          e.connection_global_id = global_id if respond_to?(:global_id)
+          e.service_id = service_id if respond_to?(:description)
         end
         raise e
       end
 
       def ssl_options
         @ssl_options ||= if options[:ssl]
-          options.select { |k, v| k.to_s.start_with?('ssl') }
-        else
-          # Due to the way options are propagated from the client, if we
-          # decide that we don't want to use TLS we need to have the :ssl
-          # option explicitly set to false or the value provided to the
-          # connection might be overwritten by the default inherited from
-          # the client.
-          {ssl: false}
-        end.freeze
+                           options.select { |k, _v| k.to_s.start_with?('ssl') }
+                         else
+                           # Due to the way options are propagated from the client, if we
+                           # decide that we don't want to use TLS we need to have the :ssl
+                           # option explicitly set to false or the value provided to the
+                           # connection might be overwritten by the default inherited from
+                           # the client.
+                           { ssl: false }
+                         end.freeze
       end
 
       def ensure_connected
-        begin
-          unless socket
-            raise ArgumentError, "Connection #{generation}:#{id} for #{address.seed} is not connected"
-          end
-          if @error
-            raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is perished"
-          end
-          result = yield socket
-          success = true
-          result
-        ensure
-          unless success
-            @error = true
-          end
-        end
+        raise ArgumentError, "Connection #{generation}:#{id} for #{address.seed} is not connected" unless socket
+        raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is perished" if @error
+
+        result = yield socket
+        success = true
+        result
+      ensure
+        @error = true unless success
       end
     end
   end