mongo 2.15.0 → 2.16.0.alpha1

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

@@ -38,28 +38,29 @@ module Mongo
         #
         # @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.

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

@@ -15,8 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/server/description/features'
-
 module Mongo
   class Server
 
@@ -201,7 +199,8 @@ module Mongo
                                ].freeze
 
       # Instantiate the new server description from the result of the hello
-      # command.
+      # command or fabricate a placeholder description for Unknown and
+      # LoadBalancer servers.
       #
       # @example Instantiate the new description.
       #   Description.new(address, { 'isWritablePrimary' => true }, 0.5)
@@ -209,17 +208,67 @@ module Mongo
       # @param [ Address ] address The server address.
       # @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.
+      #   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.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
           hosts
@@ -237,11 +286,23 @@ module Mongo
       # @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 [ 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
 
@@ -625,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?
@@ -659,6 +721,7 @@ module Mongo
       #
       # @since 2.0.0
       def unknown?
+        return false if load_balancer?
         config.empty? || config.keys == %w(topologyVersion) || !ok?
       end
 
@@ -780,6 +843,11 @@ module Mongo
         config['connectionId']
       end
 
+      # @api experimental
+      def service_id
+        config['serviceId']
+      end
+
       # Check equality of two descriptions.
       #
       # @example Check description equality.
@@ -825,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/connection.rb

@@ -194,13 +194,12 @@ module Mongo
         #
         # @raise [Mongo::Error] If handshake failed.
         def handshake!
-          document = handshake_document(
-            @app_metadata,
-            server_api: options[:server_api]
+          command = handshake_command(
+            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)
           result = Operation::Result.new(message)

data/lib/mongo/server/monitor.rb

@@ -215,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)
 

data/lib/mongo/server/pending_connection.rb

@@ -71,32 +71,41 @@ module Mongo
           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"
-          end
-          case speculative_auth_user.mechanism
-          when :mongodb_x509
-            # Done
-          # We default auth mechanism to scram256, but if user specified
-          # scram explicitly we may be able to authenticate speculatively
-          # with scram.
-          when :scram, :scram256
-            authenticate!(
-              speculative_auth_client_nonce: speculative_auth.conversation.client_nonce,
-              speculative_auth_mech: speculative_auth_user.mechanism,
-              speculative_auth_result: speculative_auth_result,
-            )
-          else
-            raise Error::InternalDriverError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
+        begin
+          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"
+            end
+            case speculative_auth_user.mechanism
+            when :mongodb_x509
+              # Done
+            # We default auth mechanism to scram256, but if user specified
+            # scram explicitly we may be able to authenticate speculatively
+            # with scram.
+            when :scram, :scram256
+              authenticate!(
+                speculative_auth_client_nonce: speculative_auth.conversation.client_nonce,
+                speculative_auth_mech: speculative_auth_user.mechanism,
+                speculative_auth_result: speculative_auth_result,
+              )
+            else
+              raise Error::InternalDriverError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
+            end
+          elsif !description.arbiter?
+            authenticate!
           end
-        elsif !description.arbiter?
-          authenticate!
+        rescue Mongo::Error, Mongo::Error::AuthError => exc
+          exc.service_id = service_id
+          raise
         end
 
         if description.unknown?
           raise Error::InternalDriverError, "Connection description cannot be unknown after successful authentication: #{description.inspect}"
         end
+
+        if server.load_balancer? && !description.mongos?
+          raise Error::BadLoadBalancerTarget, "Load-balanced operation requires being connected a mongos, but the server at #{address.seed} reported itself as #{description.server_type.to_s.gsub('_', ' ')}"
+        end
       end
 
       private
@@ -111,16 +120,14 @@ module Mongo
           raise Error::InternalDriverError, "Cannot handshake because there is no usable socket (for #{address})"
         end
 
-        hello_doc = handshake_document(
-          app_metadata,
-          speculative_auth_doc: speculative_auth_doc,
-          server_api: options[:server_api],
+        hello_command = handshake_command(
+          handshake_document(
+            app_metadata,
+            speculative_auth_doc: speculative_auth_doc,
+            load_balancer: server.load_balancer?,
+            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
-        hello_command = Protocol::Query.new(Database::ADMIN, Database::COMMAND, hello_doc, :limit => -1)
-
         doc = nil
         @server.handle_handshake_failure! do
           begin
@@ -144,6 +151,10 @@ module Mongo
           end
         end
 
+        if @server.force_load_balancer?
+          doc['serviceId'] ||= "fake:#{rand(2**32-1)+1}"
+        end
+
         post_handshake(doc, @server.round_trip_time_averager.average_round_trip_time)
 
         doc
@@ -193,7 +204,7 @@ module Mongo
       # This is a separate method to keep the nesting level down.
       #
       # @return [ Server::Description ] The server description calculated from
-      #   hello response for this particular connection.
+      #   the handshake response for this particular connection.
       def post_handshake(response, average_rtt)
         if response["ok"] == 1
           # Auth mechanism is entirely dependent on the contents of
@@ -210,7 +221,12 @@ module Mongo
           @sasl_supported_mechanisms = nil
         end
 
-        @description = Description.new(address, response, average_rtt).tap do |new_description|
+        @description = Description.new(
+          address, response,
+          average_round_trip_time: average_rtt,
+          load_balancer: server.load_balancer?,
+          force_load_balancer: options[:connect] == :load_balanced,
+        ).tap do |new_description|
           @server.cluster.run_sdam_flow(@server.description, new_description)
         end
       end

data/lib/mongo/server/push_monitor.rb

@@ -111,6 +111,12 @@ module Mongo
           @topology_version = new_description.topology_version
         end
       rescue Mongo::Error => exc
+        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],

data/lib/mongo/server.rb

@@ -54,6 +54,9 @@ module Mongo
     #   done by this server. Note: setting this option to false will make
     #   the server non-functional. It is intended for use in tests which
     #   manually invoke SDAM state transitions.
+    # @option options [ true | false ] :load_balancer Whether this server
+    #   is a load balancer.
+    # @option options [ String ] :connect The client connection mode.
     #
     # @since 2.0.0
     def initialize(address, cluster, monitoring, event_listeners, options = {})
@@ -69,7 +72,10 @@ module Mongo
       end
       @scan_semaphore = DistinguishingSemaphore.new
       @round_trip_time_averager = RoundTripTimeAverager.new
-      @description = Description.new(address, {})
+      @description = Description.new(address, {},
+        load_balancer: !!@options[:load_balancer],
+        force_load_balancer: force_load_balancer?,
+      )
       @last_scan = nil
       @last_scan_monotime = nil
       unless options[:monitoring_io] == false
@@ -107,6 +113,15 @@ module Mongo
     #   description the monitor refreshes.
     attr_reader :description
 
+    # Returns whether this server is forced to be a load balancer.
+    #
+    # @return [ true | false ] Whether this server is forced to be a load balancer.
+    #
+    # @api private
+    def force_load_balancer?
+      options[:connect] == :load_balanced
+    end
+
     # @return [ Time | nil ] last_scan The time when the last server scan
     #   completed, or nil if the server has not been scanned yet.
     #
@@ -180,6 +195,7 @@ module Mongo
                    :secondary?,
                    :standalone?,
                    :unknown?,
+                   :load_balancer?,
                    :last_write_date,
                    :logical_session_timeout
 
@@ -222,20 +238,6 @@ module Mongo
       address == other.address
     end
 
-    # Get a new context for this server in which to send messages.
-    #
-    # @example Get the server context.
-    #   server.context
-    #
-    # @return [ Mongo::Server::Context ] context The server context.
-    #
-    # @since 2.0.0
-    #
-    # @deprecated Will be removed in version 3.0
-    def context
-      Context.new(self)
-    end
-
     # Determine if a connection to the server is able to be established and
     # messages can be sent to it.
     #
@@ -301,13 +303,20 @@ module Mongo
     #
     # @api private
     def start_monitoring
+      publish_opening_event
+      if options[:monitoring_io] != false
+        monitor.run!
+      end
+    end
+
+    # Publishes the server opening event.
+    #
+    # @api private
+    def publish_opening_event
       publish_sdam_event(
         Monitoring::SERVER_OPENING,
         Monitoring::Event::ServerOpening.new(address, cluster.topology)
       )
-      if options[:monitoring_io] != false
-        monitor.run!
-      end
     end
 
     # Get a pretty printed server inspection.
@@ -327,6 +336,8 @@ module Mongo
     # @api private
     def status
       case
+      when load_balancer?
+        'LB'
       when primary?
         'PRIMARY'
       when secondary?
@@ -433,8 +444,8 @@ module Mongo
     # @return [ Object ] The result of the block execution.
     #
     # @since 2.3.0
-    def with_connection(&block)
-      pool.with_connection(&block)
+    def with_connection(service_id: nil, &block)
+      pool.with_connection(service_id: service_id, &block)
     end
 
     # Handle handshake failure.
@@ -444,7 +455,11 @@ module Mongo
     def handle_handshake_failure!
       yield
     rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e
-      unknown!(generation: e.generation, stop_push_monitor: true)
+      unknown!(
+        generation: e.generation,
+        service_id: e.service_id,
+        stop_push_monitor: true,
+      )
       raise
     end
 
@@ -467,7 +482,11 @@ module Mongo
       raise
     rescue Mongo::Error::SocketError => e
       # non-timeout network error
-      unknown!(generation: e.generation, stop_push_monitor: true)
+      unknown!(
+        generation: e.generation,
+        service_id: e.service_id,
+        stop_push_monitor: true,
+      )
       raise
     rescue Auth::Unauthorized
       # auth error, keep server description and topology as they are
@@ -513,13 +532,33 @@ module Mongo
     #   respective server is cleared. Set this option to true to keep the
     #   existing connection pool (required when handling not master errors
     #   on 4.2+ servers).
+    # @option options [ Object ] :service_id Discard state for the specified
+    #   service id only.
     # @option options [ TopologyVersion ] :topology_version Topology version
     #   of the error response that is causing the server to be marked unknown.
     # @option options [ true | false ] :stop_push_monitor Whether to stop
     #   the PushMonitor associated with the server, if any.
+    # @option options [ Object ] :service_id Discard state for the specified
+    #   service id only.
     #
     # @since 2.4.0, SDAM events are sent as of version 2.7.0
     def unknown!(options = {})
+      if load_balancer?
+        # When the client is in load-balanced topology, servers (the one and
+        # only that can be) starts out as a load balancer and stays as a
+        # load balancer indefinitely. As such it is not marked unknown.
+        #
+        # However, this method also clears connection pool for the server
+        # when the latter is marked unknown, and this part needs to happen
+        # when the server is a load balancer.
+        if service_id = options[:service_id]
+          pool.disconnect!(service_id: service_id)
+        elsif Lint.enabled?
+          raise Error::LintError, 'Load balancer was asked to be marked unknown without a service id'
+        end
+        return
+      end
+
       if options[:generation] && options[:generation] < pool.generation
         return
       end
@@ -537,10 +576,16 @@ module Mongo
       # SDAM flow will update description on the server without in-place
       # mutations and invoke SDAM transitions as needed.
       config = {}
+      if options[:service_id]
+        config['serviceId'] = options[:service_id]
+      end
       if options[:topology_version]
         config['topologyVersion'] = options[:topology_version]
       end
-      new_description = Description.new(address, config)
+      new_description = Description.new(address, config,
+        load_balancer: load_balancer?,
+        force_load_balancer: options[:connect] == :load_balanced,
+      )
       cluster.run_sdam_flow(description, new_description, options)
     end
 
@@ -549,11 +594,14 @@ module Mongo
       @description = description
     end
 
+    # @param [ Object ] :service_id Close connections with the specified
+    #   service id only.
+    #
     # @api private
-    def clear_connection_pool
+    def clear_connection_pool(service_id: nil)
       @pool_lock.synchronize do
         if @pool
-          @pool.disconnect!
+          @pool.disconnect!(service_id: service_id)
         end
       end
     end
@@ -577,7 +625,6 @@ require 'mongo/server/connection_base'
 require 'mongo/server/pending_connection'
 require 'mongo/server/connection'
 require 'mongo/server/connection_pool'
-require 'mongo/server/context'
 require 'mongo/server/description'
 require 'mongo/server/monitor'
 require 'mongo/server/round_trip_time_averager'