mongo 2.13.2 → 2.15.0

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
@@ -105,8 +138,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

@@ -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.
@@ -766,6 +771,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/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/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.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
@@ -182,23 +185,30 @@ 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
+      # 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
@@ -207,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
@@ -223,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.
@@ -231,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.
@@ -562,7 +573,7 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-        config['ismaster'] == true &&
+          (config['ismaster'] == true || config['isWritablePrimary'] == true ) &&
         !!config['setName']
       end
 
@@ -732,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.
       #
@@ -755,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']
@@ -783,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/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/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,11 +257,11 @@ module Mongo
       def do_scan
         begin
           monitoring.publish_heartbeat(server) do
-            ismaster
+            check
           end
         rescue => exc
-          msg = "Error running ismaster on #{server.address}"
-          Utils.warn_monitor_exception(msg, exc,
+          msg = "Error checking #{server.address}"
+          Utils.warn_bg_exception(msg, exc,
             logger: options[:logger],
             log_prefix: options[:log_prefix],
             bg_error_backtrace: options[:bg_error_backtrace],
@@ -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/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)

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.
@@ -122,7 +90,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 +99,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.
@@ -220,21 +188,31 @@ 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
           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],
@@ -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