mongo 2.14.0 → 2.15.1

data/lib/mongo/server/app_metadata.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,7 +17,7 @@
 
 module Mongo
   class Server
-    # Application metadata that is sent to the server in an ismaster command,
+    # Application metadata that is sent to the server during a handshake,
     #   when a new connection is established.
     #
     # @api private
@@ -43,6 +46,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 +68,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 +85,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,25 +103,37 @@ module Mongo
         end
       end
 
+      # @return [ Symbol ] The purpose of the connection for which this
+      #   app metadata is created.
+      #
+      # @api private
+      attr_reader :purpose
+
+      # @return [ Hash | nil ] The requested server API version.
+      #
+      #   Thes hash can have the following items:
+      #   - *:version* -- string
+      #   - *:strict* -- boolean
+      #   - *:deprecation_errors* -- boolean
+      #
+      # @api private
+      attr_reader :server_api
+
       # @return [ Array<Hash> | nil ] Information about libraries wrapping
       #   the driver.
       attr_reader :wrapping_libraries
 
-      # Get the bytes of the ismaster message including this metadata.
+      # Get the metadata as BSON::Document to be sent to
+      # as part of the handshake. The document should
+      # be appended to a suitable handshake command.
       #
-      # @api private
+      # This method ensures that the metadata are valid.
       #
-      # @example Get the ismaster message bytes.
-      #   metadata.ismaster_bytes
+      # @return [BSON::Document] Valid document for connection's handshake.
       #
-      # @return [ String ] The raw bytes.
+      # @raise [ Error::InvalidApplicationName ] When the metadata are invalid.
       #
-      # @since 2.4.0
-      # @deprecated
-      def ismaster_bytes
-        @ismaster_bytes ||= validate! && serialize.to_s
-      end
-
+      # @api private
       def validated_document
         validate!
         document
@@ -109,6 +141,10 @@ module Mongo
 
       private
 
+      # Check whether it is possible to build a valid app metadata document
+      # with params provided on intialization.
+      #
+      # @raise [ Error::InvalidApplicationName ] When the metadata are invalid.
       def validate!
         if @app_name && @app_name.bytesize > MAX_APP_NAME_SIZE
           raise Error::InvalidApplicationName.new(@app_name, MAX_APP_NAME_SIZE)
@@ -116,6 +152,10 @@ module Mongo
         true
       end
 
+      # Get BSON::Document to be used as value for `client` key in
+      # handshake document.
+      #
+      # @return [BSON::Document] Document describing client for handshake.
       def full_client_document
         BSON::Document.new.tap do |doc|
           doc[:application] = { name: @app_name } if @app_name
@@ -125,27 +165,39 @@ module Mongo
         end
       end
 
-      def serialize
-        Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1).serialize
-      end
 
+      # Get the metadata as BSON::Document to be sent to
+      # as part of the handshake. The document should
+      # be appended to a suitable handshake command.
+      #
+      # @return [BSON::Document] Document for connection's handshake.
       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 = BSON::Document.new(
+            {
+              compression: @compressors,
+              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 +244,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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -85,6 +88,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 = {})
@@ -177,7 +185,7 @@ module Mongo
       # Separate method to permit easier mocking in the test suite.
       #
       # @return [ Array<Socket, Server::Description> ] Connected socket and
-      #   a server description instance from the ismaster response of the
+      #   a server description instance from the hello response of the
       #   returned socket.
       private def do_connect
         socket = add_server_diagnostics do

data/lib/mongo/server/connection_base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,7 +30,7 @@ module Mongo
       include Monitoring::Publishable
 
       # The maximum allowed size in bytes that a user-supplied document may
-      # take up when serialized, if the server's ismaster response does not
+      # take up when serialized, if the server's hello response does not
       # include maxBsonObjectSize field.
       #
       # The commands that are sent to the server may exceed this size by
@@ -63,7 +66,7 @@ module Mongo
                      :update_cluster_time
 
       # Returns the server description for this connection, derived from
-      # the isMaster response for the handshake performed on this connection.
+      # the hello response for the handshake performed on this connection.
       #
       # @note A connection object that hasn't yet connected (handshaken and
       #   authenticated, if authentication is required) does not have a
@@ -105,7 +108,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 +127,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
@@ -133,33 +136,39 @@ module Mongo
       #
       # @return [ Protocol::Message | nil ] The reply if needed.
       #
+      # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error.
+      #
       # @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 = {})
+      # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error.
+      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,
+          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,
           )
-          start = Time.now
+          start = Utils.monotonic_time
           result = nil
           begin
             result = add_server_diagnostics do
@@ -171,30 +180,36 @@ module Mongo
               end
             end
           rescue Exception => e
-            total_duration = Time.now - start
-            command_failed(nil, address, operation_id, message.payload, e.message, total_duration)
+            total_duration = Utils.monotonic_time - start
+            command_failed(nil, address, operation_id, message.payload,
+              e.message, total_duration,
+              started_event: started_event,
+            )
             raise
           else
-            total_duration = Time.now - start
-            command_completed(result, address, operation_id, message.payload, total_duration)
+            total_duration = Utils.monotonic_time - start
+            command_completed(result, address, operation_id, message.payload,
+              total_duration,
+              started_event: started_event,
+            )
           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,
+        # active serialized BSON document size limit in the hello response,
         # which is +max_bson_object_size+ below. The +DEFAULT_MAX_BSON_OBJECT_SIZE+
         # is the 16MiB value mandated by the specifications which we use
-        # only as the default if the server's ismaster did not contain
+        # 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 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

data/lib/mongo/server/connection_common.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -49,8 +52,38 @@ module Mongo
       # @api private
       attr_reader :pid
 
+      # Build a document that should be used for connection handshake.
+      #
+      # @param [ Server::AppMetadata ] app_metadata Application metadata
+      # @param [ BSON::Document ] speculative_auth_doc The speculative
+      #   authentication document, if any.
+      # @param server_api [ Hash | nil ] server_api Server API version.
+      #
+      # @return [BSON::Document] Document that should be sent to a server
+      #     for handshake purposes.
+      #
+      # @api private
+      def handshake_document(app_metadata, speculative_auth_doc: nil, server_api: nil)
+        serv_api = app_metadata.server_api || server_api
+        document = if serv_api
+                     HELLO_DOC.merge(Utils.transform_server_api(serv_api))
+                   else
+                     LEGACY_HELLO_DOC
+                   end
+        document.merge(app_metadata.validated_document).tap do |doc|
+          if speculative_auth_doc
+            doc.update(speculativeAuthenticate: speculative_auth_doc)
+          end
+        end
+      end
+
+
       private
 
+      HELLO_DOC = BSON::Document.new({ hello: 1 }).freeze
+
+      LEGACY_HELLO_DOC = BSON::Document.new({ isMaster: 1, helloOk: true }).freeze
+
       attr_reader :socket
 
       def set_compressor!(reply)
@@ -88,7 +121,7 @@ module Mongo
         # Server::Monitor::Connection does not reference its server, but
         # knows its address. Server::Connection delegates the address to its
         # server.
-        note = "on #{address.seed}"
+        note = +"on #{address.seed}"
         if respond_to?(:id)
           note << ", connection #{generation}:#{id}"
         end

data/lib/mongo/server/connection_pool/populator.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/server/connection_pool.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -291,7 +294,7 @@ module Mongo
           raise Error::PoolClosedError.new(@server.address, self)
         end
 
-        deadline = Time.now + wait_timeout
+        deadline = Utils.monotonic_time + wait_timeout
         pid = Process.pid
         connection = nil
         # It seems that synchronize sets up its own loop, thus a simple break
@@ -341,7 +344,7 @@ module Mongo
               end
             end
 
-            wait = deadline - Time.now
+            wait = deadline - Utils.monotonic_time
             if wait <= 0
               publish_cmap_event(
                 Monitoring::Event::Cmap::ConnectionCheckOutFailed.new(
@@ -684,8 +687,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 +706,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.

data/lib/mongo/server/context.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -23,14 +26,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
+        # - 13 => 5.0
         #
         # @since 2.0.0
         MAPPINGS = {
@@ -73,7 +77,7 @@ module Mongo
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (2..9).freeze
+        DRIVER_WIRE_VERSIONS = (2..13).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #

data/lib/mongo/server/description.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -18,7 +21,7 @@ module Mongo
   class Server
 
     # Represents a description of the server, populated by the result of the
-    # ismaster command.
+    # hello command.
     #
     # Note: Unknown servers do not have wire versions, but for legacy reasons
     # we return 0 for min_wire_version and max_wire_version of any server that does
@@ -197,15 +200,15 @@ module Mongo
                                  CONNECTION_ID,
                                ].freeze
 
-      # Instantiate the new server description from the result of the ismaster
+      # Instantiate the new server description from the result of the hello
       # command.
       #
       # @example Instantiate the new description.
-      #   Description.new(address, { 'ismaster' => true }, 0.5)
+      #   Description.new(address, { 'isWritablePrimary' => true }, 0.5)
       #
       # @param [ Address ] address The server address.
-      # @param [ Hash ] config The result of the ismaster command.
-      # @param [ Float ] average_round_trip_time The moving average time (sec) the ismaster
+      # @param [ Hash ] config The result of the hello command.
+      # @param [ Float ] average_round_trip_time The moving average time (sec) the hello
       #   call took to complete.
       #
       # @since 2.0.0
@@ -214,7 +217,8 @@ module Mongo
         @config = config
         @features = Features.new(wire_versions, me || @address.to_s)
         @average_round_trip_time = average_round_trip_time
-        @last_update_time = Time.now.dup.freeze
+        @last_update_time = Time.now.freeze
+        @last_update_monotime = Utils.monotonic_time
 
         if Mongo::Lint.enabled?
           # prepopulate cache instance variables
@@ -230,7 +234,7 @@ module Mongo
       # @return [ Address ] address The server's address.
       attr_reader :address
 
-      # @return [ Hash ] The actual result from the ismaster command.
+      # @return [ Hash ] The actual result from the hello command.
       attr_reader :config
 
       # @return [ Features ] features The features for the server.
@@ -238,7 +242,7 @@ module Mongo
         @features
       end
 
-      # @return [ Float ] The moving average time the ismaster call took to complete.
+      # @return [ Float ] The moving average time the hello call took to complete.
       attr_reader :average_round_trip_time
 
       # Returns whether this server is an arbiter, per the SDAM spec.
@@ -569,7 +573,7 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-        config['ismaster'] == true &&
+          (config['ismaster'] == true || config['isWritablePrimary'] == true ) &&
         !!config['setName']
       end
 
@@ -739,7 +743,7 @@ module Mongo
         !!(address.to_s.downcase != me.downcase if me)
       end
 
-      # opTime in lastWrite subdocument of the ismaster response.
+      # opTime in lastWrite subdocument of the hello response.
       #
       # @return [ BSON::Timestamp ] The timestamp.
       #
@@ -762,6 +766,15 @@ module Mongo
       # @since 2.7.0
       attr_reader :last_update_time
 
+      # Time when this server description was created according to monotonic clock.
+      #
+      # @see Description::last_updated_time for more detail
+      #
+      # @return [ Float ] Server description creation monotonic time.
+      #
+      # @api private
+      attr_reader :last_update_monotime
+
       # @api experimental
       def server_connection_id
         config['connectionId']
@@ -790,6 +803,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/monitor/app_metadata.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +25,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)