mongo 2.12.4 → 2.13.0

data/lib/mongo/server/app_metadata.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB, Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -65,12 +65,17 @@ module Mongo
       #   the metadata printed to the mongod logs upon establishing a connection
       #   in server versions >= 3.4.
       # @option options [ String ] :user The user name.
+      # @option options [ Array<Hash> ] :wrapping_libraries Information about
+      #   libraries such as ODMs that are wrapping the driver. Specify the
+      #   lower level libraries first. Allowed hash keys: :name, :version,
+      #   :platform.
       #
       # @since 2.4.0
       def initialize(options)
         @app_name = options[:app_name].to_s if options[:app_name]
         @platform = options[:platform]
         @compressors = options[:compressors] || []
+        @wrapping_libraries = options[:wrapping_libraries]
 
         if options[:user] && !options[:auth_mech]
           auth_db = options[:auth_source] || 'admin'
@@ -78,6 +83,10 @@ module Mongo
         end
       end
 
+      # @return [ Array<Hash> | nil ] Information about libraries wrapping
+      #   the driver.
+      attr_reader :wrapping_libraries
+
       # Get the bytes of the ismaster message including this metadata.
       #
       # @api private
@@ -88,10 +97,16 @@ module Mongo
       # @return [ String ] The raw bytes.
       #
       # @since 2.4.0
+      # @deprecated
       def ismaster_bytes
         @ismaster_bytes ||= validate! && serialize.to_s
       end
 
+      def validated_document
+        validate!
+        document
+      end
+
       private
 
       def validate!
@@ -134,9 +149,17 @@ module Mongo
       end
 
       def driver_doc
+        names = [DRIVER_NAME]
+        versions = [Mongo::VERSION]
+        if wrapping_libraries
+          wrapping_libraries.each do |library|
+            names << library[:name] || ''
+            versions << library[:version] || ''
+          end
+        end
         {
-          name: DRIVER_NAME,
-          version: Mongo::VERSION
+          name: names.join('|'),
+          version: versions.join('|'),
         }
       end
 
@@ -162,12 +185,26 @@ module Mongo
       end
 
       def platform
-        [
+        if BSON::Environment.jruby?
+          ruby_versions = ["JRuby #{JRUBY_VERSION}", "like Ruby #{RUBY_VERSION}"]
+          platforms = [RUBY_PLATFORM, "JVM #{java.lang.System.get_property('java.version')}"]
+        else
+          ruby_versions = ["Ruby #{RUBY_VERSION}"]
+          platforms = [RUBY_PLATFORM]
+        end
+        platform = [
           @platform,
-          RUBY_VERSION,
-          RUBY_PLATFORM,
-          RbConfig::CONFIG['build']
+          *ruby_versions,
+          *platforms,
+          RbConfig::CONFIG['build'],
         ].compact.join(', ')
+        platforms = [platform]
+        if wrapping_libraries
+          wrapping_libraries.each do |library|
+            platforms << library[:platform] || ''
+          end
+        end
+        platforms.join('|')
       end
     end
   end

data/lib/mongo/server/connection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,6 @@ module Mongo
     #
     # @since 2.0.0
     class Connection < ConnectionBase
-      include Connectable
       include Monitoring::Publishable
       include Retryable
       extend Forwardable
@@ -103,12 +102,6 @@ module Mongo
         )
       end
 
-      # @return [ Server::Description ] The server description obtained from
-      #   the handshake on this connection.
-      #
-      # @api private
-      attr_reader :description
-
       # @return [ Time ] The last time the connection was checked back into a pool.
       #
       # @since 2.5.0
@@ -120,15 +113,6 @@ module Mongo
       # @since 2.9.0
       attr_reader :id
 
-      # Connection pool generation from which this connection was created.
-      # May be nil.
-      #
-      # @since 2.7.0
-      # @api private
-      def generation
-        options[:generation]
-      end
-
       # The connection pool from which this connection was created.
       # May be nil.
       #
@@ -149,6 +133,11 @@ module Mongo
         !!@closed
       end
 
+      # @api private
+      def error?
+        !!@error
+      end
+
       # Establishes a network connection to the target address.
       #
       # If the connection is already established, this method does nothing.
@@ -163,18 +152,18 @@ module Mongo
       #
       # @since 2.0.0
       def connect!
+        if error?
+          raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is perished. Reconnecting closed or errored connections is no longer supported"
+        end
+
         if closed?
-          if Lint.enabled?
-            raise Error::LintError, "Reconnecting closed connections is no longer supported (for #{address})"
-          else
-            log_warn("Reconnecting closed connections is deprecated (for #{address})")
-          end
+          raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is closed. Reconnecting closed or errored connections is no longer supported"
         end
 
         unless @socket
           # When @socket is assigned, the socket should have handshaken and
           # authenticated and be usable.
-          @socket, @description = do_connect
+          @socket, @description, @compressor = do_connect
 
           publish_cmap_event(
             Monitoring::Event::Cmap::ConnectionReady.new(address, id)
@@ -190,23 +179,23 @@ module Mongo
       # @return [ Array<Socket, Server::Description> ] Connected socket and
       #   a server description instance from the ismaster response of the
       #   returned socket.
-      def do_connect
-        socket = address.socket(socket_timeout, ssl_options, address.options)
+      private def do_connect
+        socket = add_server_diagnostics do
+          address.socket(socket_timeout, ssl_options.merge(
+            connection_address: address, connection_generation: generation))
+        end
 
         begin
-          new_description = handshake!(socket)
-          unless new_description.arbiter?
-            pending_connection = PendingConnection.new(socket, new_description, @server, monitoring, options.merge(id: id))
-            authenticate!(pending_connection)
-          end
+          pending_connection = PendingConnection.new(
+            socket, @server, monitoring, options.merge(id: id))
+          pending_connection.handshake_and_authenticate!
         rescue Exception
           socket.close
           raise
         end
 
-        [socket, new_description]
+        [socket, pending_connection.description, pending_connection.compressor]
       end
-      private :do_connect
 
       # Disconnect the connection.
       #
@@ -231,7 +220,7 @@ module Mongo
         @auth_mechanism = nil
         @last_checkin = nil
         if socket
-          socket.close
+          socket.close rescue nil
           @socket = nil
         end
         @closed = true
@@ -272,17 +261,16 @@ module Mongo
       def ping
         bytes = features.op_msg_enabled? ? PING_OP_MSG_BYTES : PING_BYTES
         ensure_connected do |socket|
-          socket.write(bytes)
-          reply = Protocol::Message.deserialize(socket, max_message_size)
+          reply = add_server_diagnostics do
+            socket.write(bytes)
+            Protocol::Message.deserialize(socket, max_message_size)
+          end
           reply.documents[0][Operation::Result::OK] == 1
         end
       end
 
       # Get the timeout to execute an operation on a socket.
       #
-      # @example Get the timeout to execute an operation on a socket.
-      #   connection.timeout
-      #
       # @return [ Float ] The operation timeout in seconds.
       #
       # @since 2.0.0
@@ -307,105 +295,21 @@ module Mongo
 
       private
 
-      # @return [ Server::Description ] The server description calculated from
-      #   ismaster response for this particular connection.
-      def handshake!(socket)
-        unless socket
-          raise Error::HandshakeError, "Cannot handshake because there is no usable socket (for #{address})"
-        end
-
-        response = average_rtt = nil
-        @server.handle_handshake_failure! do
-          begin
-            response, exc, rtt, average_rtt =
-              @server.round_trip_time_averager.measure do
-                socket.write(app_metadata.ismaster_bytes)
-                Protocol::Message.deserialize(socket, Protocol::Message::MAX_MESSAGE_SIZE).documents[0]
-              end
-
-            if exc
-              raise exc
-            end
-          rescue => e
-            log_warn("Failed to handshake with #{address}: #{e.class}: #{e}:\n#{e.backtrace[0..5].join("\n")}")
-            raise
-          end
-        end
-
-        post_handshake(response, average_rtt)
-      end
-
-      # This is a separate method to keep the nesting level down.
-      #
-      # @return [ Server::Description ] The server description calculated from
-      #   ismaster response for this particular connection.
-      def post_handshake(response, average_rtt)
-        if response["ok"] == 1
-          # Auth mechanism is entirely dependent on the contents of
-          # ismaster response *for this connection*.
-          # Ismaster received by the monitoring connection should advertise
-          # the same wire protocol, but if it doesn't, we use whatever
-          # the monitoring connection advertised for filling out the
-          # server description and whatever the non-monitoring connection
-          # (that's this one) advertised for performing auth on that
-          # connection.
-          @auth_mechanism = if response['saslSupportedMechs']
-            if response['saslSupportedMechs'].include?(Mongo::Auth::SCRAM::SCRAM_SHA_256_MECHANISM)
-              :scram256
-            else
-              :scram
-            end
-          else
-            # MongoDB servers < 2.6 are no longer suported.
-            # Wire versions should always be returned in ismaster.
-            # See also https://jira.mongodb.org/browse/RUBY-1584.
-            min_wire_version = response[Description::MIN_WIRE_VERSION]
-            max_wire_version = response[Description::MAX_WIRE_VERSION]
-            features = Description::Features.new(min_wire_version..max_wire_version)
-            if features.scram_sha_1_enabled?
-              :scram
-            else
-              :mongodb_cr
-            end
-          end
-          set_compressor!(response)
-        else
-          @auth_mechanism = nil
-        end
-
-        Description.new(address, response, average_rtt).tap do |new_description|
-          @server.cluster.run_sdam_flow(@server.description, new_description)
-        end
-      end
-
-      def authenticate!(pending_connection)
-        if options[:user] || options[:auth_mech]
-          user_options = Options::Redacted.new(:auth_mech => default_mechanism).merge(options)
-          if user_options[:auth_mech] == :mongodb_x509
-            user_options[:auth_source] = '$external'
-          end
-          user = Auth::User.new(user_options)
-          @server.handle_auth_failure! do
-            begin
-              Auth.get(user).login(pending_connection)
-            rescue => e
-              log_warn("Failed to handshake with #{address}: #{e.class}: #{e}:\n#{e.backtrace[0..5].join("\n")}")
-              raise
-            end
-          end
+      def deliver(message, client, options = {})
+        handle_errors do
+          super
         end
       end
 
-      def default_mechanism
-        @auth_mechanism || (@server.features.scram_sha_1_enabled? ? :scram : :mongodb_cr)
-      end
-
-      def deliver(message, client, options = {})
+      def handle_errors
         begin
-          super
-        # Important: timeout errors are not handled here
-        rescue Error::SocketError
-          @server.unknown!
+          yield
+        rescue Error::SocketError => e
+          @error = e
+          @server.unknown!(generation: e.generation, stop_push_monitor: true)
+          raise
+        rescue Error::SocketTimeoutError => e
+          @error = e
           raise
         end
       end

data/lib/mongo/server/connection_base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -57,6 +57,7 @@ module Mongo
       # @return [ Mongo::Address ] address The address to connect to.
       def_delegators :server, :address
 
+      # @deprecated
       def_delegators :server,
                      :cluster_time,
                      :update_cluster_time
@@ -77,12 +78,21 @@ module Mongo
       # @api private
       attr_reader :description
 
+      # @deprecated
       def_delegators :description,
         :features,
         :max_bson_object_size,
         :max_message_size,
         :mongos?
 
+      # Connection pool generation from which this connection was created.
+      # May be nil.
+      #
+      # @return [ Integer | nil ] Connection pool generation.
+      def generation
+        options[:generation]
+      end
+
       def app_metadata
         @app_metadata ||= begin
           same = true
@@ -145,15 +155,20 @@ module Mongo
         ensure_connected do |socket|
           operation_id = Monitoring.next_operation_id
           command_started(address, operation_id, message.payload,
-            socket_object_id: socket.object_id, connection_id: id)
+            socket_object_id: socket.object_id, connection_id: id,
+            connection_generation: generation,
+            server_connection_id: description.server_connection_id,
+          )
           start = Time.now
           result = nil
           begin
-            socket.write(buffer.to_s)
-            result = if message.replyable?
-              Protocol::Message.deserialize(socket, max_message_size, message.request_id, options)
-            else
-              nil
+            result = add_server_diagnostics do
+              socket.write(buffer.to_s)
+              if message.replyable?
+                Protocol::Message.deserialize(socket, max_message_size, message.request_id, options)
+              else
+                nil
+              end
             end
           rescue Exception => e
             total_duration = Time.now - start
@@ -189,8 +204,10 @@ module Mongo
           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
+            max_bson_size = REDUCED_MAX_BSON_SIZE + MAX_BSON_COMMAND_OVERHEAD
           end
+        else
+          max_bson_size += MAX_BSON_COMMAND_OVERHEAD
         end
 
         # RUBY-2234: It is necessary to check that the message size does not
@@ -215,7 +232,7 @@ module Mongo
           # TODO: address the fact that this line mutates the buffer.
           temp_buffer.put_bytes(buffer.get_bytes(buffer.length))
 
-          message.serialize(temp_buffer, max_bson_size, MAX_BSON_COMMAND_OVERHEAD)
+          message.serialize(temp_buffer, max_bson_size)
           if temp_buffer.length > max_message_size
             raise Error::MaxMessageSize.new(max_message_size)
           end
@@ -226,7 +243,7 @@ module Mongo
         # layer should be refactored to allow compression on an already-
         # serialized message.
         final_message = message.maybe_compress(compressor, options[:zlib_compression_level])
-        final_message.serialize(buffer, max_bson_size, MAX_BSON_COMMAND_OVERHEAD)
+        final_message.serialize(buffer, max_bson_size)
 
         buffer
       end

data/lib/mongo/server/connection_common.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2020 MongoDB, Inc.
+# Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -33,8 +33,26 @@ module Mongo
       # @return [ String | nil ] The compressor.
       attr_reader :compressor
 
+      # Determine if the connection is currently connected.
+      #
+      # @example Is the connection connected?
+      #   connection.connected?
+      #
+      # @return [ true, false ] If connected.
+      #
+      # @deprecated
+      def connected?
+        !!socket
+      end
+
+      # @return [ Integer ] pid The process id when the connection was created.
+      # @api private
+      attr_reader :pid
+
       private
 
+      attr_reader :socket
+
       def set_compressor!(reply)
         server_compressors = reply['compression']
 
@@ -56,6 +74,62 @@ module Mongo
           end
         end
       end
+
+      # Yields to the block and, if the block raises an exception, adds a note
+      # to the exception with the address of the specified server.
+      #
+      # This method is intended to add server address information to exceptions
+      # raised during execution of operations on servers.
+      def add_server_diagnostics
+        yield
+      # Note that the exception should already have been mapped to a
+      # Mongo::Error subclass when it gets to this method.
+      rescue Error::SocketError, Error::SocketTimeoutError => e
+        # Server::Monitor::Connection does not reference its server, but
+        # knows its address. Server::Connection delegates the address to its
+        # server.
+        note = "on #{address.seed}"
+        if respond_to?(:id)
+          note << ", connection #{generation}:#{id}"
+        end
+        e.add_note(note)
+        if respond_to?(:generation)
+          # Non-monitoring connections
+          e.generation = generation
+        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
+          # options 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
+      end
     end
   end
 end