mongo 2.14.0 → 2.16.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,39 +26,41 @@ 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 = {
-          :retryable_write_error_label => 9,
+          retryable_write_error_label: 9,
+          commit_quorum: 9,
           # Server versions older than 4.2 do not reliably validate options
           # provided by the client during findAndModify operations, requiring the
           # driver to raise client-side errors when those options are provided.
-          :find_and_modify_option_validation => 8,
-          :transactions => 7,
-          :scram_sha_256 => 7,
-          :array_filters => 6,
-          :op_msg => 6,
-          :sessions => 6,
-          :collation => 5,
-          :max_staleness => 5,
+          find_and_modify_option_validation: 8,
+          transactions: 7,
+          scram_sha_256: 7,
+          array_filters: 6,
+          op_msg: 6,
+          sessions: 6,
+          collation: 5,
+          max_staleness: 5,
           # Server versions older than 3.4 do not reliably validate options
           # provided by the client during update/delete operations, requiring the
           # driver to raise client-side errors when those options are provided.
-          :update_delete_option_validation => 5,
-          :find_command => 4,
-          :list_collections => 3,
-          :list_indexes => 3,
-          :scram_sha_1 => 3,
-          :write_command => 2,
-          :users_info => 2
+          update_delete_option_validation: 5,
+          find_command: 4,
+          list_collections: 3,
+          list_indexes: 3,
+          scram_sha_1: 3,
+          write_command: 2,
+          users_info: 2,
         }.freeze
 
         # Error message if the server is too old for this version of the driver.
@@ -73,7 +78,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/load_balancer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Server
+    class Description
+
+      # Represents an assumed description of servers behind load balancers.
+      class LoadBalancer
+        def initialize(address)
+          @address = address
+        end
+
+        # @return [ Address ] address The server's address.
+        attr_reader :address
+      end
+    end
+  end
+end

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');
@@ -12,13 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/server/description/features'
-
 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,24 +198,76 @@ module Mongo
                                  CONNECTION_ID,
                                ].freeze
 
-      # Instantiate the new server description from the result of the ismaster
-      # command.
+      # Instantiate the new server description from the result of the hello
+      # command or fabricate a placeholder description for Unknown and
+      # LoadBalancer servers.
       #
       # @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
-      #   call took to complete.
+      # @param [ Hash ] config The result of the hello command.
+      # @param [ Float ] average_round_trip_time The moving average time (sec) the hello
+      #   command took to complete.
+      # @param [ Float ] average_round_trip_time The moving average time (sec)
+      #   the ismaster call took to complete.
+      # @param [ true | false ] load_balancer Whether the server is treated as
+      #   a load balancer.
+      # @param [ true | false ] force_load_balancer Whether the server is
+      #   forced to be a load balancer.
       #
-      # @since 2.0.0
-      def initialize(address, config = {}, average_round_trip_time = nil)
+      # @api private
+      def initialize(address, config = {}, average_round_trip_time: nil,
+        load_balancer: false, force_load_balancer: false
+      )
         @address = address
         @config = config
+        @load_balancer = !!load_balancer
+        @force_load_balancer = !!force_load_balancer
         @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 load_balancer
+          # When loadBalanced=true URI option is set, the driver will refuse
+          # to work if the server it communicates with does not set serviceId
+          # in ismaster/hello response.
+          #
+          # In practice, there are currently no server version that actually
+          # sets this field.
+          #
+          # Therefore, when connect=:load_balanced Ruby option is used instead
+          # of the loadBalanced=true URI option, if serviceId is not set in
+          # ismaster/hello response, the driver fabricates a serviceId and
+          # proceeds to treat a server that does not report itself as being
+          # behind a load balancer as a server that is behind a load balancer.
+          #
+          # 5.0+ servers should provide topologyVersion.processId which
+          # is specific to the particular process instance. We can use that
+          # field as a proxy for serviceId.
+          #
+          # If the topologyVersion isn't provided for whatever reason, we
+          # fabricate a serviceId locally.
+          #
+          # In either case, a serviceId provided by an actual server behind
+          # a load balancer is supposed to be a BSON::ObjectId. The fabricated
+          # service ids are strings, to distinguish them from the real ones.
+          # In particular processId is also a BSON::ObjectId, but will be
+          # mapped to a string for clarity that this is a fake service id.
+          if ok? && !service_id
+            unless force_load_balancer
+              raise Error::MissingServiceId, "The server at #{address.seed} did not provide a service id in handshake response"
+            end
+
+            fake_service_id = if process_id = topology_version && topology_version['processId']
+              "process:#{process_id}"
+            else
+              "fake:#{rand(2**32-1)+1}"
+            end
+            @config = @config.merge('serviceId' => fake_service_id)
+          end
+        end
 
         if Mongo::Lint.enabled?
           # prepopulate cache instance variables
@@ -230,15 +283,27 @@ 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
 
+      # Returns whether this server is a load balancer.
+      #
+      # @return [ true | false ] Whether this server is a load balancer.
+      def load_balancer?
+        @load_balancer
+      end
+
       # @return [ Features ] features The features for the server.
       def features
         @features
       end
 
-      # @return [ Float ] The moving average time the ismaster call took to complete.
+      # @return [ nil | Object ] The service id, if any.
+      def service_id
+        config['serviceId']
+      end
+
+      # @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 +634,7 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-        config['ismaster'] == true &&
+          (config['ismaster'] == true || config['isWritablePrimary'] == true ) &&
         !!config['setName']
       end
 
@@ -621,6 +686,7 @@ module Mongo
       #
       # @since 2.4.0
       def server_type
+        return :load_balancer if load_balancer?
         return :arbiter if arbiter?
         return :ghost if ghost?
         return :sharded if mongos?
@@ -655,6 +721,7 @@ module Mongo
       #
       # @since 2.0.0
       def unknown?
+        return false if load_balancer?
         config.empty? || config.keys == %w(topologyVersion) || !ok?
       end
 
@@ -739,7 +806,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,11 +829,25 @@ 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']
       end
 
+      # @api experimental
+      def service_id
+        config['serviceId']
+      end
+
       # Check equality of two descriptions.
       #
       # @example Check description equality.
@@ -790,6 +871,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'
@@ -808,8 +893,19 @@ module Mongo
             raise ArgumentError, "Bogus required version #{version}"
           end
 
+        if load_balancer?
+          # If we are talking to a load balancer, there is no monitoring
+          # and we don't know what server is behind the load balancer.
+          # Assume everything is supported.
+          # TODO remove this when RUBY-2220 is implemented.
+          return true
+        end
+
         required_wv >= min_wire_version && required_wv <= max_wire_version
       end
     end
   end
 end
+
+require 'mongo/server/description/features'
+require 'mongo/server/description/load_balancer'

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.
@@ -220,16 +188,25 @@ 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
+          command = handshake_command(
+            handshake_document(
+              @app_metadata,
+              server_api: options[:server_api]
+            )
+          )
+          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 +219,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 +249,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.
       #
@@ -208,7 +215,8 @@ module Mongo
           old_description = server.description
 
           new_description = Description.new(server.address, result,
-            server.round_trip_time_averager.average_round_trip_time)
+            average_round_trip_time: server.round_trip_time_averager.average_round_trip_time
+          )
 
           server.cluster.run_sdam_flow(server.description, new_description, awaited: awaited)
 
@@ -250,10 +258,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 +271,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 +281,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 +309,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