mongo 2.14.0 → 2.15.1

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,44 +26,6 @@ module Mongo
       class Connection < Server::ConnectionCommon
         include Loggable
 
-        # The command used for determining server status.
-        #
-        # The case matters here for fail points.
-        #
-        # @since 2.2.0
-        ISMASTER = { isMaster: 1 }.freeze
-
-        # The command used for determining server status formatted for an
-        # OP_MSG (server versions >= 3.6).
-        #
-        # The case matters here for fail points.
-        #
-        # @since 2.5.0
-        ISMASTER_OP_MSG = {
-          isMaster: 1,
-          '$db' => Database::ADMIN,
-        }.freeze
-
-        # The constant for the ismaster command.
-        #
-        # @since 2.2.0
-        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).
-        #
-        # @since 2.5.0
-        ISMASTER_OP_MSG_MESSAGE = Protocol::Msg.new([], {}, ISMASTER_OP_MSG)
-
-        # The raw bytes for the ismaster message.
-        #
-        # @since 2.2.0
-        ISMASTER_BYTES = ISMASTER_MESSAGE.serialize.to_s.freeze
-
-        # The raw bytes for the ismaster OP_MSG message (server versions >= 3.6).
-        #
-        # @since 2.5.0
-        ISMASTER_OP_MSG_BYTES = ISMASTER_OP_MSG_MESSAGE.serialize.to_s.freeze
-
         # Creates a new connection object to the specified target address
         # with the specified options.
         #
@@ -83,7 +48,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,10 +58,13 @@ 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
+          @hello_ok = false
         end
 
         # @return [ Hash ] options The passed in options.
@@ -220,16 +188,26 @@ module Mongo
           true
         end
 
+        # Send handshake command to connected host and validate the response.
+        #
+        # @return [BSON::Document] Handshake response from server
+        #
+        # @raise [Mongo::Error] If handshake failed.
         def handshake!
-          payload = if @app_metadata
-            @app_metadata.ismaster_bytes
-          else
-            log_warn("No app metadata provided for handshake with #{address}")
-            ISMASTER_BYTES
-          end
+          document = handshake_document(
+            @app_metadata,
+            server_api: options[:server_api]
+          )
+          # TODO (DR): OP_MSG should be used if api version is declared.
+          # See https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.rst#id5
+          command = Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1)
+          payload = command.serialize.to_s
           message = dispatch_bytes(payload)
-          reply = message.documents.first
+          result = Operation::Result.new(message)
+          result.validate!
+          reply = result.documents.first
           set_compressor!(reply)
+          set_hello_ok!(reply)
           @server_connection_id = reply['connectionId']
           reply
         rescue => exc
@@ -242,6 +220,25 @@ module Mongo
           raise
         end
 
+        # Build a document that should be used for connection check.
+        #
+        # @return [BSON::Document] Document that should be sent to a server
+        #     for connection check.
+        #
+        # @api private
+        def check_document
+          server_api = @app_metadata.server_api || options[:server_api]
+          if hello_ok? || server_api
+            doc = HELLO_DOC
+            if server_api
+              doc = doc.merge(Utils.transform_server_api(server_api))
+            end
+            doc
+          else
+            LEGACY_HELLO_DOC
+          end
+        end
+
         private
 
         def add_server_connection_id
@@ -253,6 +250,19 @@ module Mongo
           end
           raise e
         end
+
+        # Update @hello_ok flag according to server reply to legacy hello
+        # command. The flag will be set to true if connected server supports
+        # hello command, otherwise the flag will be set to false.
+        #
+        # @param [ BSON::Document ] reply Server reply to legacy hello command.
+        def set_hello_ok!(reply)
+          @hello_ok = !!reply[:helloOk]
+        end
+
+        def hello_ok?
+          @hello_ok
+        end
       end
     end
   end

data/lib/mongo/server/monitor.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");
@@ -15,7 +18,7 @@
 module Mongo
   class Server
 
-    # Responsible for periodically polling a server via ismaster commands to
+    # Responsible for periodically polling a server via hello commands to
     # keep the server's status up to date.
     #
     # Does all work in a background thread so as to not interfere with other
@@ -63,6 +66,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 +79,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
@@ -119,13 +132,7 @@ module Mongo
         end
       end
 
-      # Runs the server monitor. Refreshing happens on a separate thread per
-      # server.
-      #
-      # @example Run the monitor.
-      #   monitor.run
-      #
-      # @return [ Thread ] The thread the monitor runs on.
+      # Perform a check of the server.
       #
       # @since 2.0.0
       def do_work
@@ -177,7 +184,7 @@ module Mongo
       #
       # If the server was checked less than MIN_SCAN_INTERVAL seconds
       # ago, sleep until MIN_SCAN_INTERVAL seconds have passed since the last
-      # check. Then perform the check which involves running isMaster
+      # check. Then perform the check which involves running hello
       # on the server being monitored and updating the server description
       # as a result.
       #
@@ -250,10 +257,10 @@ module Mongo
       def do_scan
         begin
           monitoring.publish_heartbeat(server) do
-            ismaster
+            check
           end
         rescue => exc
-          msg = "Error running ismaster on #{server.address}"
+          msg = "Error checking #{server.address}"
           Utils.warn_bg_exception(msg, exc,
             logger: options[:logger],
             log_prefix: options[:log_prefix],
@@ -263,7 +270,7 @@ module Mongo
         end
       end
 
-      def ismaster
+      def check
         if @connection && @connection.pid != Process.pid
           log_warn("Detected PID change - Mongo client should have been reconnected (old pid #{@connection.pid}, new pid #{Process.pid}")
           @connection.disconnect!
@@ -273,7 +280,11 @@ module Mongo
         if @connection
           result = server.round_trip_time_averager.measure do
             begin
-              message = @connection.dispatch_bytes(Monitor::Connection::ISMASTER_BYTES)
+              doc = @connection.check_document
+              cmd = Protocol::Query.new(
+                Database::ADMIN, Database::COMMAND, doc, :limit => -1
+              )
+              message = @connection.dispatch_bytes(cmd.serialize.to_s)
               message.documents.first
             rescue Mongo::Error
               @connection.disconnect!
@@ -297,6 +308,8 @@ module Mongo
                 monitoring,
                 **Utils.shallow_symbolize_keys(options.merge(
                   socket_timeout: heartbeat_interval + connection.socket_timeout,
+                  app_metadata: options[:push_monitor_app_metadata],
+                  check_document: @connection.check_document
                 )),
               )
             end

data/lib/mongo/server/pending_connection.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");
@@ -63,6 +66,11 @@ module Mongo
         end
 
         result = handshake!(speculative_auth_doc: speculative_auth_doc)
+
+        if description.unknown?
+          raise Error::InternalDriverError, "Connection description cannot be unknown after successful handshake: #{description.inspect}"
+        end
+
         if speculative_auth_doc && (speculative_auth_result = result['speculativeAuthenticate'])
           unless description.features.scram_sha_1_enabled?
             raise Error::InvalidServerAuthResponse, "Speculative auth succeeded on a pre-3.0 server"
@@ -80,42 +88,51 @@ module Mongo
               speculative_auth_result: speculative_auth_result,
             )
           else
-            raise NotImplementedError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
+            raise Error::InternalDriverError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
           end
         elsif !description.arbiter?
           authenticate!
         end
+
+        if description.unknown?
+          raise Error::InternalDriverError, "Connection description cannot be unknown after successful authentication: #{description.inspect}"
+        end
       end
 
       private
 
       # @param [ BSON::Document | nil ] speculative_auth_doc The document to
-      #   provide in speculativeAuthenticate field of ismaster command.
+      #   provide in speculativeAuthenticate field of handshake command.
       #
-      # @return [ BSON::Document ] The document of the ismaster response for
+      # @return [ BSON::Document ] The document of the handshake response for
       #   this particular connection.
       def handshake!(speculative_auth_doc: nil)
         unless socket
-          raise Error::HandshakeError, "Cannot handshake because there is no usable socket (for #{address})"
+          raise Error::InternalDriverError, "Cannot handshake because there is no usable socket (for #{address})"
         end
 
-        ismaster_doc = app_metadata.validated_document
-        if speculative_auth_doc
-          ismaster_doc = ismaster_doc.merge(speculativeAuthenticate: speculative_auth_doc)
-        end
+        hello_doc = handshake_document(
+          app_metadata,
+          speculative_auth_doc: speculative_auth_doc,
+          server_api: options[:server_api],
+        )
 
-        ismaster_command = Protocol::Query.new(Database::ADMIN, Database::COMMAND,
-          ismaster_doc, :limit => -1)
+        # TODO (DR): OP_MSG should be used if api version is declared.
+        # See https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.rst#id5
+        hello_command = Protocol::Query.new(Database::ADMIN, Database::COMMAND, hello_doc, :limit => -1)
 
-        response = nil
+        doc = nil
         @server.handle_handshake_failure! do
           begin
             response = @server.round_trip_time_averager.measure do
               add_server_diagnostics do
-                socket.write(ismaster_command.serialize.to_s)
-                Protocol::Message.deserialize(socket, Protocol::Message::MAX_MESSAGE_SIZE).documents.first
+                socket.write(hello_command.serialize.to_s)
+                Protocol::Message.deserialize(socket, Protocol::Message::MAX_MESSAGE_SIZE)
               end
             end
+            result = Operation::Result.new([response])
+            result.validate!
+            doc = result.documents.first
           rescue => exc
             msg = "Failed to handshake with #{address}"
             Utils.warn_bg_exception(msg, exc,
@@ -127,9 +144,9 @@ module Mongo
           end
         end
 
-        post_handshake(response, @server.round_trip_time_averager.average_round_trip_time)
+        post_handshake(doc, @server.round_trip_time_averager.average_round_trip_time)
 
-        response
+        doc
       end
 
       # @param [ String | nil ] speculative_auth_client_nonce The client
@@ -139,7 +156,7 @@ module Mongo
       #   for speculative auth, if speculative auth succeeded. If speculative
       #   auth was not performed or it failed, this must be nil.
       # @param [ BSON::Document | nil ] speculative_auth_result The
-      #   value of speculativeAuthenticate field of ismaster response of
+      #   value of speculativeAuthenticate field of hello response of
       #   the handshake on this connection.
       def authenticate!(
         speculative_auth_client_nonce: nil,
@@ -176,12 +193,12 @@ module Mongo
       # 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.
+      #   hello 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
+          # hello response *for this connection*.
+          # Hello 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
@@ -215,7 +232,7 @@ module Mongo
           user_options = Options::Redacted.new(
             # When speculative auth is performed, we always use SCRAM-SHA-256.
             # At the same time we perform SCRAM mechanism negotiation in the
-            # ismaster request.
+            # hello request.
             # If the credentials we are trying to authenticate with do not
             # map to an existing user, SCRAM mechanism negotiation will not
             # return anything which would cause the driver to use

data/lib/mongo/server/push_monitor/connection.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");

data/lib/mongo/server/push_monitor.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");
@@ -15,11 +18,11 @@
 module Mongo
   class Server
 
-    # A monitor utilizing server-pushed ismaster requests.
+    # A monitor utilizing server-pushed hello requests.
     #
     # When a Monitor handshakes with a 4.4+ server, it creates an instance
-    # of PushMonitor. PushMonitor subsequently executes server-pushed ismaster
-    # (i.e. awaited & exhausted ismaster) to receive topology changes from the
+    # of PushMonitor. PushMonitor subsequently executes server-pushed hello
+    # (i.e. awaited & exhausted hello) to receive topology changes from the
     # server as quickly as possible. The Monitor still monitors the server
     # for round-trip time calculations and to perform immediate checks as
     # requested by the application.
@@ -33,6 +36,14 @@ module Mongo
         if topology_version.nil?
           raise ArgumentError, 'Topology version must be provided but it was nil'
         end
+        unless options[:app_metadata]
+          raise ArgumentError, 'App metadata is required'
+        end
+        unless options[:check_document]
+          raise ArgumentError, 'Check document is required'
+        end
+        @app_metadata = options[:app_metadata]
+        @check_document = options[:check_document]
         @monitor = monitor
         @topology_version = topology_version
         @monitoring = monitoring
@@ -65,7 +76,7 @@ module Mongo
         @lock.synchronize do
           @stop_requested = true
           if @connection
-            # Interrupt any in-progress exhausted ismaster reads by
+            # Interrupt any in-progress exhausted hello reads by
             # disconnecting the connection.
             @connection.send(:socket).close
           end
@@ -86,21 +97,27 @@ module Mongo
         end
 
         result = monitoring.publish_heartbeat(server, awaited: true) do
-          ismaster
+          check
         end
         new_description = monitor.run_sdam_flow(result, awaited: true)
-        # When ismaster fails due to a fail point, the response does not
+        # When hello fails due to a fail point, the response does not
         # include topology version. In this case we need to keep our existing
         # topology version so that we can resume monitoring.
         # The spec does not appear to directly address this case but
         # https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.rst#streaming-ismaster
         # says that topologyVersion should only be updated from successful
-        # ismaster responses.
+        # hello responses.
         if new_description.topology_version
           @topology_version = new_description.topology_version
         end
       rescue Mongo::Error => exc
-        msg = "Error running awaited ismaster on #{server.address}"
+        stop_requested = @lock.synchronize { @stop_requested }
+        if stop_requested
+          # Ignore the exception, see RUBY-2771.
+          return
+        end
+
+        msg = "Error running awaited hello on #{server.address}"
         Utils.warn_bg_exception(msg, exc,
           logger: options[:logger],
           log_prefix: options[:log_prefix],
@@ -108,7 +125,7 @@ module Mongo
         )
       end
 
-      def ismaster
+      def check
         @lock.synchronize do
           if @connection && @connection.pid != Process.pid
             log_warn("Detected PID change - Mongo client should have been reconnected (old pid #{@connection.pid}, new pid #{Process.pid}")
@@ -128,7 +145,7 @@ module Mongo
 
         resp_msg = begin
           unless @server_pushing
-            write_ismaster
+            write_check_command
           end
           read_response
         rescue Mongo::Error
@@ -139,17 +156,20 @@ module Mongo
           raise
         end
         @server_pushing = resp_msg.flags.include?(:more_to_come)
-        result = resp_msg.documents.first
+        result = Operation::Result.new(resp_msg)
+        result.validate!
+        result.documents.first
       end
 
-      def write_ismaster
-        payload = Monitor::Connection::ISMASTER_OP_MSG.merge(
+      def write_check_command
+        document = @check_document.merge(
           topologyVersion: topology_version.to_doc,
           maxAwaitTimeMS: monitor.heartbeat_interval * 1000,
         )
-
-        req_msg = Protocol::Msg.new([:exhaust_allowed], {}, payload)
-        @lock.synchronize { @connection }.write_bytes(req_msg.serialize.to_s)
+        command = Protocol::Msg.new(
+          [:exhaust_allowed], {}, document.merge({'$db' => Database::ADMIN})
+        )
+        @lock.synchronize { @connection }.write_bytes(command.serialize.to_s)
       end
 
       def read_response
@@ -162,10 +182,11 @@ module Mongo
         end
         # We set the timeout twice: once passed into read_socket which applies
         # to each individual read operation, and again around the entire read.
-        Timeout.timeout(timeout, Error::SocketTimeoutError, "Failed to read an awaited ismaster response in #{timeout} seconds") do
+        Timeout.timeout(timeout, Error::SocketTimeoutError, "Failed to read an awaited hello response in #{timeout} seconds") do
           @lock.synchronize { @connection }.read_response(socket_timeout: timeout)
         end
       end
+
     end
   end
 end

data/lib/mongo/server/round_trip_time_averager.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");
@@ -31,7 +34,7 @@ module Mongo
       attr_reader :average_round_trip_time
 
       def measure
-        start = Time.now
+        start = Utils.monotonic_time
         begin
           rv = yield
         rescue Error::SocketError, Error::SocketTimeoutError
@@ -41,9 +44,9 @@ module Mongo
         rescue Error, Error::AuthError => exc
           # For other errors, RTT is valid.
         end
-        last_round_trip_time = Time.now - start
+        last_round_trip_time = Utils.monotonic_time - start
 
-        # If ismaster fails, we need to return the last round trip time
+        # If hello fails, we need to return the last round trip time
         # because it is used in the heartbeat failed SDAM event,
         # but we must not update the round trip time recorded in the server.
         unless exc

data/lib/mongo/server.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");
@@ -68,10 +71,12 @@ module Mongo
       @round_trip_time_averager = RoundTripTimeAverager.new
       @description = Description.new(address, {})
       @last_scan = nil
+      @last_scan_monotime = nil
       unless options[:monitoring_io] == false
         @monitor = Monitor.new(self, event_listeners, monitoring,
           options.merge(
-            app_metadata: Monitor::AppMetadata.new(cluster.options),
+            app_metadata: cluster.monitor_app_metadata,
+            push_monitor_app_metadata: cluster.push_monitor_app_metadata,
             heartbeat_interval: cluster.heartbeat_interval,
         ))
         unless _monitor == false
@@ -114,6 +119,18 @@ module Mongo
       end
     end
 
+    # @return [ Float | nil ] last_scan_monotime The monotonic time when the last server scan
+    #   completed, or nil if the server has not been scanned yet.
+    # @api private
+    def last_scan_monotime
+      if description && !description.config.empty?
+        description.last_update_monotime
+      else
+        @last_scan_monotime
+      end
+    end
+
+
     # @deprecated
     def heartbeat_frequency
       cluster.heartbeat_interval
@@ -172,6 +189,11 @@ module Mongo
                    :cluster_time,
                    :update_cluster_time
 
+    # @api private
+    def_delegators :cluster,
+                   :monitor_app_metadata,
+                   :push_monitor_app_metadata
+
     def_delegators :features,
                    :check_driver_support!
 
@@ -272,19 +294,6 @@ module Mongo
       @connected
     end
 
-    # When the server is flagged for garbage collection, stop the monitor
-    # thread.
-    #
-    # @example Finalize the object.
-    #   Server.finalize(monitor)
-    #
-    # @param [ Server::Monitor ] monitor The server monitor.
-    #
-    # @since 2.2.0
-    def self.finalize(monitor)
-      proc { monitor.stop! }
-    end
-
     # Start monitoring the server.
     #
     # Used internally by the driver to add a server to a cluster
@@ -297,7 +306,6 @@ module Mongo
         Monitoring::Event::ServerOpening.new(address, cluster.topology)
       )
       if options[:monitoring_io] != false
-        ObjectSpace.define_finalizer(self, self.class.finalize(monitor))
         monitor.run!
       end
     end
@@ -558,6 +566,7 @@ module Mongo
     # @api private
     def update_last_scan
       @last_scan = Time.now
+      @last_scan_monotime = Utils.monotonic_time
     end
   end
 end

data/lib/mongo/server_selector/base.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");
@@ -181,7 +184,7 @@ module Mongo
           raise Error::NoServerAvailable.new(self, cluster, msg)
         end
 
-        deadline = Time.now + server_selection_timeout
+        deadline = Utils.monotonic_time + server_selection_timeout
 
         if session && session.pinned_server
           if Mongo::Lint.enabled?
@@ -199,7 +202,7 @@ module Mongo
             # This will no longer be the case once SRV polling is implemented.
 
             unless server.mongos?
-              while (time_remaining = deadline - Time.now) > 0
+              while (time_remaining = deadline - Utils.monotonic_time) > 0
                 wait_for_server_selection(cluster, time_remaining)
               end
 
@@ -252,7 +255,7 @@ module Mongo
 
           cluster.scan!(false)
 
-          time_remaining = deadline - Time.now
+          time_remaining = deadline - Utils.monotonic_time
           if time_remaining > 0
             wait_for_server_selection(cluster, time_remaining)