mongo 2.13.0 → 2.15.0.alpha

data/lib/mongo/server/app_metadata.rb

@@ -43,6 +43,11 @@ module Mongo
       # @api private
       AUTH_OPTION_KEYS = [:user, :auth_source, :auth_mech].freeze
 
+      # Possible connection purposes.
+      #
+      # @api private
+      PURPOSES = %i(application monitor push_monitor).freeze
+
       # Instantiate the new AppMetadata object.
       #
       # @api private
@@ -60,10 +65,16 @@ module Mongo
       # @option options [ Array<String> ] :compressors A list of potential
       #   compressors to use, in order of preference. The driver chooses the
       #   first compressor that is also supported by the server. Currently the
-      #   driver only supports 'zlib'.
+      #   driver only supports 'zstd', 'snappy' and 'zlib'.
       # @option options [ String ] :platform Platform information to include in
       #   the metadata printed to the mongod logs upon establishing a connection
       #   in server versions >= 3.4.
+      # @option options [ Symbol ] :purpose The purpose of this connection.
+      # @option options [ Hash ] :server_api The requested server API version.
+      #   This hash can have the following items:
+      #   - *:version* -- string
+      #   - *:strict* -- boolean
+      #   - *:deprecation_errors* -- boolean
       # @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
@@ -71,11 +82,17 @@ module Mongo
       #   :platform.
       #
       # @since 2.4.0
-      def initialize(options)
+      def initialize(options = {})
         @app_name = options[:app_name].to_s if options[:app_name]
         @platform = options[:platform]
+        if @purpose = options[:purpose]
+          unless PURPOSES.include?(@purpose)
+            raise ArgumentError, "Invalid purpose: #{@purpose}"
+          end
+        end
         @compressors = options[:compressors] || []
         @wrapping_libraries = options[:wrapping_libraries]
+        @server_api = options[:server_api]
 
         if options[:user] && !options[:auth_mech]
           auth_db = options[:auth_source] || 'admin'
@@ -83,6 +100,12 @@ module Mongo
         end
       end
 
+      # @return [ Symbol ] The purpose of the connection for which this
+      #   app metadata is created.
+      #
+      # @api private
+      attr_reader :purpose
+
       # @return [ Array<Hash> | nil ] Information about libraries wrapping
       #   the driver.
       attr_reader :wrapping_libraries
@@ -130,22 +153,29 @@ module Mongo
       end
 
       def document
-        client_document = full_client_document
-        while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
-          if client_document[:os][:name] || client_document[:os][:architecture]
-            client_document[:os].delete(:name)
-            client_document[:os].delete(:architecture)
-          elsif client_document[:platform]
-            client_document.delete(:platform)
-          else
-            client_document = nil
+        @document ||= begin
+          client_document = full_client_document
+          while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
+            if client_document[:os][:name] || client_document[:os][:architecture]
+              client_document[:os].delete(:name)
+              client_document[:os].delete(:architecture)
+            elsif client_document[:platform]
+              client_document.delete(:platform)
+            else
+              client_document = nil
+            end
+          end
+          document = Server::Monitor::Connection::ISMASTER
+          document = document.merge(compression: @compressors)
+          document[:client] = client_document
+          document[:saslSupportedMechs] = @request_auth_mech if @request_auth_mech
+          if @server_api
+            document.update(
+              Utils.transform_server_api(@server_api)
+            )
           end
+          document
         end
-        document = Server::Monitor::Connection::ISMASTER
-        document = document.merge(compression: @compressors)
-        document[:client] = client_document
-        document[:saslSupportedMechs] = @request_auth_mech if @request_auth_mech
-        document
       end
 
       def driver_doc
@@ -192,12 +222,16 @@ module Mongo
           ruby_versions = ["Ruby #{RUBY_VERSION}"]
           platforms = [RUBY_PLATFORM]
         end
-        platform = [
+        platforms = [
           @platform,
           *ruby_versions,
           *platforms,
           RbConfig::CONFIG['build'],
-        ].compact.join(', ')
+        ]
+        if @purpose
+          platforms << @purpose.to_s[0].upcase
+        end
+        platform = platforms.compact.join(', ')
         platforms = [platform]
         if wrapping_libraries
           wrapping_libraries.each do |library|

data/lib/mongo/server/connection.rb

@@ -85,6 +85,11 @@ module Mongo
       #
       # @option options [ Integer ] :generation Connection pool's generation
       #   for this connection.
+      # @option options [ Hash ] :server_api The requested server API version.
+      #   This hash can have the following items:
+      #   - *:version* -- string
+      #   - *:strict* -- boolean
+      #   - *:deprecation_errors* -- boolean
       #
       # @since 2.0.0
       def initialize(server, options = {})

data/lib/mongo/server/connection_base.rb

@@ -105,7 +105,7 @@ module Mongo
           if same
             @server.app_metadata
           else
-            AppMetadata.new(options)
+            AppMetadata.new(options.merge(purpose: @server.app_metadata.purpose))
           end
         end
       end
@@ -124,7 +124,7 @@ module Mongo
       #
       # @param [ Array<Message> ] messages A one-element array containing
       #   the message to dispatch.
-      # @param [ Integer ] operation_id The operation id to link messages.
+      # @param [ Operation::Context ] context The operation context.
       # @param [ Hash ] options
       #
       # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
@@ -134,24 +134,27 @@ module Mongo
       # @return [ Protocol::Message | nil ] The reply if needed.
       #
       # @since 2.0.0
-      def dispatch(messages, operation_id = nil, client = nil, options = {})
+      def dispatch(messages, context, options = {})
         # 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
+        if description.unknown?
+          raise Error::InternalDriverError, "Cannot dispatch a message on a connection with unknown description: #{description.inspect}"
+        end
         message = messages.first
-        deliver(message, client, options)
+        deliver(message, context, options)
       end
 
       private
 
-      def deliver(message, client, options = {})
+      def deliver(message, context, options = {})
         if Lint.enabled? && !@socket
           raise Error::LintError, "Trying to deliver a message over a disconnected connection (to #{address})"
         end
-        buffer = serialize(message, client)
+        buffer = serialize(message, context)
         ensure_connected do |socket|
           operation_id = Monitoring.next_operation_id
           command_started(address, operation_id, message.payload,
@@ -178,14 +181,14 @@ module Mongo
             total_duration = Time.now - start
             command_completed(result, address, operation_id, message.payload, total_duration)
           end
-          if client && result
-            result = result.maybe_decrypt(client)
+          if result && context.decrypt?
+            result = result.maybe_decrypt(context)
           end
           result
         end
       end
 
-      def serialize(message, client, buffer = BSON::ByteBuffer.new)
+      def serialize(message, context, buffer = BSON::ByteBuffer.new)
         # Driver specifications only mandate the fixed 16MiB limit for
         # serialized BSON documents. However, the server returns its
         # active serialized BSON document size limit in the ismaster response,
@@ -194,7 +197,7 @@ module Mongo
         # only as the default if the server's ismaster did not contain
         # maxBsonObjectSize.
         max_bson_size = max_bson_object_size || DEFAULT_MAX_BSON_OBJECT_SIZE
-        if client && client.encrypter && client.encrypter.encrypt?
+        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
@@ -204,10 +207,8 @@ 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_COMMAND_OVERHEAD
+            max_bson_size = REDUCED_MAX_BSON_SIZE
           end
-        else
-          max_bson_size += MAX_BSON_COMMAND_OVERHEAD
         end
 
         # RUBY-2234: It is necessary to check that the message size does not
@@ -232,7 +233,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)
+          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
@@ -243,7 +244,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)
+        final_message.serialize(buffer, max_bson_size, MAX_BSON_COMMAND_OVERHEAD)
 
         buffer
       end

data/lib/mongo/server/connection_common.rb

@@ -105,8 +105,8 @@ module Mongo
           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
+          # 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}

data/lib/mongo/server/connection_pool.rb

@@ -684,8 +684,6 @@ module Mongo
       # @return [ Proc ] The Finalizer.
       def self.finalize(available_connections, pending_connections, populator)
         proc do
-          populator.stop!
-
           available_connections.each do |connection|
             connection.disconnect!(reason: :pool_closed)
           end
@@ -705,8 +703,12 @@ module Mongo
       private
 
       def create_connection
-        connection = Connection.new(@server, options.merge(generation: generation,
-          connection_pool: self))
+        connection = Connection.new(@server, options.merge(
+          generation: generation,
+          connection_pool: self,
+          # Do not pass app metadata - this will be retrieved by the connection
+          # based on the auth needs.
+        ))
       end
 
       # Create a connection, connect it, and add it to the pool.
@@ -766,6 +768,9 @@ module Mongo
           connection.disconnect!(reason: :error)
           raise
         end
+      rescue Error::SocketError, Error::SocketTimeoutError => exc
+        @server.unknown!(generation: exc.generation, stop_push_monitor: true)
+        raise
       end
 
       def check_invariants

data/lib/mongo/server/description.rb

@@ -182,13 +182,20 @@ module Mongo
       # @since 2.5.0
       LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'.freeze
 
+      # Constant for reading connectionId info from config.
+      #
+      # @api private
+      CONNECTION_ID = 'connectionId'.freeze
+
       # Fields to exclude when comparing two descriptions.
       #
       # @since 2.0.6
       EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME,
                                  LAST_WRITE,
                                  OPERATION_TIME,
-                                 Operation::CLUSTER_TIME ].freeze
+                                 Operation::CLUSTER_TIME,
+                                 CONNECTION_ID,
+                               ].freeze
 
       # Instantiate the new server description from the result of the ismaster
       # command.
@@ -783,6 +790,10 @@ module Mongo
       # @api private
       def server_version_gte?(version)
         required_wv = case version
+          when '5.0'
+            12
+          when '4.4'
+            9
           when '4.2'
             8
           when '4.0'

data/lib/mongo/server/description/features.rb

@@ -23,14 +23,15 @@ module Mongo
         # List of features and the wire protocol version they appear in.
         #
         # Wire protocol versions map to server releases as follows:
-        # - 2 => 2.6
-        # - 3 => 3.0
-        # - 4 => 3.2
-        # - 5 => 3.4
-        # - 6 => 3.6
-        # - 7 => 4.0
-        # - 8 => 4.2
-        # - 9 => 4.4
+        # -  2 => 2.6
+        # -  3 => 3.0
+        # -  4 => 3.2
+        # -  5 => 3.4
+        # -  6 => 3.6
+        # -  7 => 4.0
+        # -  8 => 4.2
+        # -  9 => 4.4
+        # - 12 => 5.0
         #
         # @since 2.0.0
         MAPPINGS = {

data/lib/mongo/server/monitor.rb

@@ -63,6 +63,10 @@ module Mongo
       # @option options [ Float ] :heartbeat_interval The interval between
       #   regular server checks.
       # @option options [ Logger ] :logger A custom logger to use.
+      # @option options [ Mongo::Server::Monitor::AppMetadata ] :monitor_app_metadata
+      #   The metadata to use for regular monitoring connection.
+      # @option options [ Mongo::Server::Monitor::AppMetadata ] :push_monitor_app_metadata
+      #   The metadata to use for push monitor's connection.
       # @option options [ Float ] :socket_timeout The timeout, in seconds, to
       #   execute operations on the monitoring connection.
       #
@@ -72,6 +76,12 @@ module Mongo
         unless monitoring.is_a?(Monitoring)
           raise ArgumentError, "Wrong monitoring type: #{monitoring.inspect}"
         end
+        unless options[:app_metadata]
+          raise ArgumentError, 'App metadata is required'
+        end
+        unless options[:push_monitor_app_metadata]
+          raise ArgumentError, 'Push monitor app metadata is required'
+        end
         @server = server
         @event_listeners = event_listeners
         @monitoring = monitoring
@@ -254,7 +264,7 @@ module Mongo
           end
         rescue => exc
           msg = "Error running ismaster on #{server.address}"
-          Utils.warn_monitor_exception(msg, exc,
+          Utils.warn_bg_exception(msg, exc,
             logger: options[:logger],
             log_prefix: options[:log_prefix],
             bg_error_backtrace: options[:bg_error_backtrace],
@@ -273,7 +283,15 @@ module Mongo
         if @connection
           result = server.round_trip_time_averager.measure do
             begin
-              message = @connection.dispatch_bytes(Monitor::Connection::ISMASTER_BYTES)
+              ismaster_bytes = if server_api = options[:server_api]
+                ismaster_doc = Monitor::Connection::ISMASTER.merge(
+                  Utils.transform_server_api(server_api)
+                )
+                Protocol::Query.new(Database::ADMIN, Database::COMMAND, ismaster_doc, limit: -1).serialize.to_s
+              else
+                Monitor::Connection::ISMASTER_BYTES
+              end
+              message = @connection.dispatch_bytes(ismaster_bytes)
               message.documents.first
             rescue Mongo::Error
               @connection.disconnect!
@@ -297,6 +315,7 @@ module Mongo
                 monitoring,
                 **Utils.shallow_symbolize_keys(options.merge(
                   socket_timeout: heartbeat_interval + connection.socket_timeout,
+                  app_metadata: options[:push_monitor_app_metadata],
                 )),
               )
             end

data/lib/mongo/server/monitor/app_metadata.rb

@@ -22,7 +22,7 @@ module Mongo
       #
       # @api private
       class AppMetadata < Server::AppMetadata
-        def initialize(options)
+        def initialize(options = {})
           super
           if instance_variable_defined?(:@request_auth_mech)
             remove_instance_variable(:@request_auth_mech)

data/lib/mongo/server/monitor/connection.rb

@@ -44,7 +44,7 @@ module Mongo
         # The constant for the ismaster command.
         #
         # @since 2.2.0
-        ISMASTER_MESSAGE = Protocol::Query.new(Database::ADMIN, Database::COMMAND, ISMASTER, :limit => -1)
+        ISMASTER_MESSAGE = Protocol::Query.new(Database::ADMIN, Database::COMMAND, ISMASTER, limit: -1)
 
         # The constant for the ismaster command as an OP_MSG (server versions >= 3.6).
         #
@@ -83,7 +83,7 @@ module Mongo
         # @option options [ Array<String> ] :compressors A list of potential
         #   compressors to use, in order of preference. The driver chooses the
         #   first compressor that is also supported by the server. Currently the
-        #   driver only supports 'zlib'.
+        #   driver only supports 'zstd', 'snappy' and 'zlib'.
         # @option options [ Float ] :connect_timeout The timeout, in seconds,
         #   to use for network operations. This timeout is used for all
         #   socket operations rather than connect calls only, contrary to
@@ -93,7 +93,9 @@ module Mongo
         def initialize(address, options = {})
           @address = address
           @options = options.dup.freeze
-          @app_metadata = options[:app_metadata]
+          unless @app_metadata = options[:app_metadata]
+            raise ArgumentError, 'App metadata is required'
+          end
           @socket = nil
           @pid = Process.pid
           @compressor = nil
@@ -122,7 +124,7 @@ module Mongo
 
         # Sends a message and returns the result.
         #
-        # @param [ Protocol::Message ] The message to send.
+        # @param [ Protocol::Message ] message The message to send.
         #
         # @return [ Protocol::Message ] The result.
         def dispatch(message)
@@ -131,7 +133,7 @@ module Mongo
 
         # Sends a preserialized message and returns the result.
         #
-        # @param [ String ] The serialized message to send.
+        # @param [ String ] bytes The serialized message to send.
         #
         # @option opts [ Numeric ] :read_socket_timeout The timeout to use for
         #   each read operation.
@@ -221,20 +223,17 @@ module Mongo
         end
 
         def handshake!
-          payload = if @app_metadata
-            @app_metadata.ismaster_bytes
-          else
-            log_warn("No app metadata provided for handshake with #{address}")
-            ISMASTER_BYTES
-          end
+          payload = @app_metadata.ismaster_bytes
           message = dispatch_bytes(payload)
-          reply = message.documents.first
+          result = Operation::Result.new(message)
+          result.validate!
+          reply = result.documents.first
           set_compressor!(reply)
           @server_connection_id = reply['connectionId']
           reply
         rescue => exc
           msg = "Failed to handshake with #{address}"
-          Utils.warn_monitor_exception(msg, exc,
+          Utils.warn_bg_exception(msg, exc,
             logger: options[:logger],
             log_prefix: options[:log_prefix],
             bg_error_backtrace: options[:bg_error_backtrace],