mongo 2.13.2 → 2.15.0

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,45 +88,54 @@ 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_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],
@@ -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,
@@ -158,7 +175,7 @@ module Mongo
               auth.login
             rescue => exc
               msg = "Failed to authenticate to #{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],
@@ -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.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,29 +97,29 @@ 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}"
-        Utils.warn_monitor_exception(msg, exc,
+        msg = "Error running awaited hello on #{server.address}"
+        Utils.warn_bg_exception(msg, exc,
           logger: options[:logger],
           log_prefix: options[:log_prefix],
           bg_error_backtrace: options[:bg_error_backtrace],
         )
       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 +139,7 @@ module Mongo
 
         resp_msg = begin
           unless @server_pushing
-            write_ismaster
+            write_check_command
           end
           read_response
         rescue Mongo::Error
@@ -139,17 +150,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 +176,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/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/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_selector.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_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)
 
@@ -265,7 +268,11 @@ module Mongo
           end
         end
 
-        msg = "No #{name} server is available in cluster: #{cluster.summary} " +
+        msg = "No #{name} server"
+        if is_a?(ServerSelector::Secondary) && !tag_sets.empty?
+          msg += " with tag sets: #{tag_sets}"
+        end
+        msg += " is available in cluster: #{cluster.summary} " +
                 "with timeout=#{server_selection_timeout}, " +
                 "LT=#{local_threshold_with_cluster(cluster)}"
         msg += server_selection_diagnostic_message(cluster)

data/lib/mongo/server_selector/nearest.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");
@@ -38,13 +41,12 @@ module Mongo
         :nearest
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end
 

data/lib/mongo/server_selector/primary.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");
@@ -39,13 +42,12 @@ module Mongo
         :primary
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ false ] false
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         false
       end
 

data/lib/mongo/server_selector/primary_preferred.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");
@@ -39,13 +42,12 @@ module Mongo
         :primary_preferred
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end
 

data/lib/mongo/server_selector/secondary.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");
@@ -39,13 +42,12 @@ module Mongo
         :secondary
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end