mongo 2.15.0 → 2.18.1

data/lib/mongo/server/connection.rb

@@ -24,6 +24,7 @@ module Mongo
     class Connection < ConnectionBase
       include Monitoring::Publishable
       include Retryable
+      include Id
       extend Forwardable
 
       # The ping command.
@@ -86,8 +87,12 @@ module Mongo
       # @param [ Mongo::Server ] server The server the connection is for.
       # @param [ Hash ] options The connection options.
       #
-      # @option options [ Integer ] :generation Connection pool's generation
-      #   for this connection.
+      # @option options [ Integer ] :generation The generation of this
+      #   connection. The generation should only be specified in this option
+      #   when not in load-balancing mode, and it should be the generation
+      #   of the connection pool when the connection is created. In
+      #   load-balancing mode, the generation is set on the connection
+      #   after the handshake completes.
       # @option options [ Hash ] :server_api The requested server API version.
       #   This hash can have the following items:
       #   - *:version* -- string
@@ -96,7 +101,12 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(server, options = {})
+        if server.load_balancer? && options[:generation]
+          raise ArgumentError, "Generation cannot be set when server is a load balancer"
+        end
+
         @id = server.next_connection_id
+        @global_id = self.class.next_id
         @monitoring = server.monitoring
         @options = options.freeze
         @server = server
@@ -104,6 +114,7 @@ module Mongo
         @last_checkin = nil
         @auth_mechanism = nil
         @pid = Process.pid
+        @pinned = false
 
         publish_cmap_event(
           Monitoring::Event::Cmap::ConnectionCreated.new(address, id)
@@ -121,6 +132,10 @@ module Mongo
       # @since 2.9.0
       attr_reader :id
 
+      # @return [ Integer ] The global ID for the connection. This will be unique
+      # across all connections.
+      attr_reader :global_id
+
       # The connection pool from which this connection was created.
       # May be nil.
       #
@@ -146,6 +161,32 @@ module Mongo
         !!@error
       end
 
+      # Whether the connection is used by a transaction or cursor operations.
+      #
+      # Pinned connections should not be disconnected and removed from a
+      # connection pool if they are idle or stale.
+      #
+      # # @return [ true | false ] Whether connection is pinned.
+      #
+      # @api private
+      def pinned?
+        @pinned
+      end
+
+      # Mark the connection as pinned.
+      #
+      # @api private
+      def pin
+        @pinned = true
+      end
+
+      # Mark the connection as not pinned.
+      #
+      # @api private
+      def unpin
+        @pinned = false
+      end
+
       # Establishes a network connection to the target address.
       #
       # If the connection is already established, this method does nothing.
@@ -173,6 +214,15 @@ module Mongo
           # authenticated and be usable.
           @socket, @description, @compressor = do_connect
 
+          if server.load_balancer?
+            if Lint.enabled?
+              unless service_id
+                raise Error::InternalDriverError, "The connection is to a load balancer and it must have service_id set here, but does not"
+              end
+            end
+            @generation = connection_pool.generation_manager.generation(service_id: service_id)
+          end
+
           publish_cmap_event(
             Monitoring::Event::Cmap::ConnectionReady.new(address, id)
           )
@@ -314,7 +364,12 @@ module Mongo
           yield
         rescue Error::SocketError => e
           @error = e
-          @server.unknown!(generation: e.generation, stop_push_monitor: true)
+          @server.unknown!(
+            generation: e.generation,
+            # or description.service_id?
+            service_id: e.service_id,
+            stop_push_monitor: true,
+          )
           raise
         rescue Error::SocketTimeoutError => e
           @error = e

data/lib/mongo/server/connection_base.rb

@@ -88,12 +88,20 @@ module Mongo
         :max_message_size,
         :mongos?
 
+      # @return [ nil | Object ] The service id, if any.
+      def service_id
+        description&.service_id
+      end
+
       # Connection pool generation from which this connection was created.
       # May be nil.
       #
       # @return [ Integer | nil ] Connection pool generation.
       def generation
-        options[:generation]
+        # If the connection is to a load balancer, @generation is set
+        # after handshake completes. If the connection is to another server
+        # type, generation is specified during connection creation.
+        @generation || options[:generation]
       end
 
       def app_metadata
@@ -167,6 +175,7 @@ module Mongo
             socket_object_id: socket.object_id, connection_id: id,
             connection_generation: generation,
             server_connection_id: description.server_connection_id,
+            service_id: description.service_id,
           )
           start = Utils.monotonic_time
           result = nil
@@ -184,6 +193,8 @@ module Mongo
             command_failed(nil, address, operation_id, message.payload,
               e.message, total_duration,
               started_event: started_event,
+              server_connection_id: description.server_connection_id,
+              service_id: description.service_id,
             )
             raise
           else
@@ -191,6 +202,8 @@ module Mongo
             command_completed(result, address, operation_id, message.payload,
               total_duration,
               started_event: started_event,
+              server_connection_id: description.server_connection_id,
+              service_id: description.service_id,
             )
           end
           if result && context.decrypt?

data/lib/mongo/server/connection_common.rb

@@ -57,13 +57,15 @@ module Mongo
       # @param [ Server::AppMetadata ] app_metadata Application metadata
       # @param [ BSON::Document ] speculative_auth_doc The speculative
       #   authentication document, if any.
+      # @param [ true | false ] load_balancer Whether the connection is to
+      #   a load balancer.
       # @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)
+      def handshake_document(app_metadata, speculative_auth_doc: nil, load_balancer: false, server_api: nil)
         serv_api = app_metadata.server_api || server_api
         document = if serv_api
                      HELLO_DOC.merge(Utils.transform_server_api(serv_api))
@@ -74,6 +76,33 @@ module Mongo
           if speculative_auth_doc
             doc.update(speculativeAuthenticate: speculative_auth_doc)
           end
+          if load_balancer
+            doc.update(loadBalanced: true)
+          end
+        end
+      end
+
+      # Build a command that should be used for connection handshake.
+      #
+      # @param [ BSON::Document ] handshake_document Document that should be
+      #   sent to a server for handshake purpose.
+      #
+      # @return [ Protocol::Message ] Command that should be sent to a server
+      #   for handshake purposes.
+      #
+      # @api private
+      def handshake_command(handshake_document)
+        if handshake_document['apiVersion'] || handshake_document['loadBalanced']
+          Protocol::Msg.new(
+            [], {}, handshake_document.merge({'$db' => Database::ADMIN})
+          )
+        else
+          Protocol::Query.new(
+            Database::ADMIN,
+            Database::COMMAND,
+            handshake_document,
+            :limit => -1
+          )
         end
       end
 
@@ -125,10 +154,21 @@ module Mongo
         if respond_to?(:id)
           note << ", connection #{generation}:#{id}"
         end
+        # Non-monitoring connections have service id.
+        # Monitoring connections do not.
+        if respond_to?(:service_id) && service_id
+          note << ", service id #{service_id}"
+        end
         e.add_note(note)
         if respond_to?(:generation)
           # Non-monitoring connections
           e.generation = generation
+          if respond_to?(:global_id)
+            e.connection_global_id = global_id
+          end
+          if respond_to?(:description)
+            e.service_id = service_id
+          end
         end
         raise e
       end

data/lib/mongo/server/connection_pool/generation_manager.rb

@@ -0,0 +1,71 @@
+# 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 ConnectionPool
+
+      # @api private
+      class GenerationManager
+
+        def initialize(server:)
+          @map = Hash.new { |hash, key| hash[key] = 1 }
+          @server = server
+          @lock = Mutex.new
+        end
+
+        attr_reader :server
+
+        def generation(service_id: nil)
+          if service_id
+            unless server.load_balancer?
+              raise ArgumentError, "Generation scoping to services is only available in load-balanced mode, but the server at #{server.address} is not a load balancer"
+            end
+          else
+            if server.load_balancer?
+              raise ArgumentError, "The server at #{server.address} is a load balancer and therefore does not have a single global generation"
+            end
+          end
+          @lock.synchronize do
+            @map[service_id]
+          end
+        end
+
+        def bump(service_id: nil)
+          @lock.synchronize do
+            if service_id
+              @map[service_id] += 1
+            else
+              # When service id is not supplied, one of two things may be
+              # happening;
+              #
+              # 1. The pool is not to a load balancer, in which case we only
+              #    need to increment the generation for the nil service_id.
+              # 2. The pool is to a load balancer, in which case we need to
+              #    increment the generation for each service.
+              #
+              # Incrementing everything in the map accomplishes both tasks.
+              @map.each do |k, v|
+                @map[k] += 1
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/connection_pool.rb

@@ -14,7 +14,6 @@
 # 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.
-require 'mongo/server/connection_pool/populator'
 
 module Mongo
   class Server
@@ -30,7 +29,7 @@ module Mongo
       # The default max size for the connection pool.
       #
       # @since 2.9.0
-      DEFAULT_MAX_SIZE = 5.freeze
+      DEFAULT_MAX_SIZE = 20.freeze
 
       # The default min size for the connection pool.
       #
@@ -60,7 +59,8 @@ module Mongo
       # @param [ Server ] server The server which this connection pool is for.
       # @param [ Hash ] options The connection pool options.
       #
-      # @option options [ Integer ] :max_size The maximum pool size.
+      # @option options [ Integer ] :max_size The maximum pool size. Setting
+      #   this option to zero creates an unlimited connection pool.
       # @option options [ Integer ] :max_pool_size Deprecated.
       #   The maximum pool size. If max_size is also given, max_size and
       #   max_pool_size must be identical.
@@ -99,7 +99,7 @@ module Mongo
         options[:max_size] ||= options[:max_pool_size]
         options.delete(:max_pool_size)
         if options[:min_size] && options[:max_size] &&
-          options[:min_size] > options[:max_size]
+          (options[:max_size] != 0 && options[:min_size] > options[:max_size])
         then
           raise ArgumentError, "Cannot have min size #{options[:min_size]} exceed max size #{options[:max_size]}"
         end
@@ -111,7 +111,7 @@ module Mongo
         @server = server
         @options = options.freeze
 
-        @generation = 1
+        @generation_manager = GenerationManager.new(server: server)
         @closed = false
 
         # A connection owned by this pool should be either in the
@@ -189,12 +189,14 @@ module Mongo
         @max_idle_time ||= options[:max_idle_time]
       end
 
+      # @api private
+      attr_reader :generation_manager
+
       # @return [ Integer ] generation Generation of connections currently
       #   being used by the queue.
       #
-      # @since 2.9.0
       # @api private
-      attr_reader :generation
+      def_delegator :generation_manager, :generation
 
       # Size of the connection pool.
       #
@@ -277,7 +279,7 @@ module Mongo
       #   and remains so for longer than the wait timeout.
       #
       # @since 2.9.0
-      def check_out
+      def check_out(connection_global_id: nil)
         check_invariants
 
         publish_cmap_event(
@@ -306,7 +308,31 @@ module Mongo
             # a connection while this thread is waiting for one.
             @lock.synchronize do
               until @available_connections.empty?
-                connection = @available_connections.pop
+                connection = next_available_connection(
+                  connection_global_id: connection_global_id
+                )
+
+                if connection.nil?
+                  if connection_global_id
+                    # A particular connection is requested, but it is not available.
+                    # If it is nether available not checked out, we should stop here.
+                    @checked_out_connections.detect do |conn|
+                      conn.connection_global_id == connection_global_id
+                    end.tap do |conn|
+                      if conn.nil?
+                        publish_cmap_event(
+                          Monitoring::Event::Cmap::ConnectionCheckOutFailed.new(
+                            @server.address,
+                            Monitoring::Event::Cmap::ConnectionCheckOutFailed::CONNECTION_ERROR
+                          ),
+                        )
+                        raise Error::MissingConnection.new
+                      end
+                    end
+                  else
+                    break
+                  end
+                end
 
                 if connection.pid != pid
                   log_warn("Detected PID change - Mongo client should have been reconnected (old pid #{connection.pid}, new pid #{pid}")
@@ -315,32 +341,48 @@ module Mongo
                   next
                 end
 
-                if connection.generation != generation
-                  # Stale connections should be disconnected in the clear
-                  # method, but if any don't, check again here
-                  connection.disconnect!(reason: :stale)
-                  @populate_semaphore.signal
-                  next
-                end
-
-                if max_idle_time && connection.last_checkin &&
-                  Time.now - connection.last_checkin > max_idle_time
-                then
-                  connection.disconnect!(reason: :idle)
-                  @populate_semaphore.signal
-                  next
+                if !connection.pinned?
+                  # If connection is marked as pinned, it is used by a transaction
+                  # or a series of cursor operations in a load balanced setup.
+                  # In this case connection should not be disconnected until
+                  # unpinned.
+                  if connection.generation != generation(
+                    service_id: connection.service_id
+                  )
+                    # Stale connections should be disconnected in the clear
+                    # method, but if any don't, check again here
+                    connection.disconnect!(reason: :stale)
+                    @populate_semaphore.signal
+                    next
+                  end
+
+                  if max_idle_time && connection.last_checkin &&
+                    Time.now - connection.last_checkin > max_idle_time
+                  then
+                    connection.disconnect!(reason: :idle)
+                    @populate_semaphore.signal
+                    next
+                  end
                 end
 
                 @pending_connections << connection
                 throw(:done)
               end
 
-              # Ruby does not allow a thread to lock a mutex which it already
-              # holds.
-              if unsynchronized_size < max_size
-                connection = create_connection
-                @pending_connections << connection
-                throw(:done)
+              if @server.load_balancer? && connection_global_id
+                # We need a  particular connection, and if it is not available
+                # we can wait for an in-progress operation to return
+                # such a connection to the pool.
+              else
+                # If we are below pool capacity, create a new connection.
+                #
+                # Ruby does not allow a thread to lock a mutex which it already
+                # holds.
+                if max_size == 0 || unsynchronized_size < max_size
+                  connection = create_connection
+                  @pending_connections << connection
+                  throw(:done)
+                end
               end
             end
 
@@ -354,8 +396,14 @@ module Mongo
               )
 
               msg = @lock.synchronize do
+                connection_global_id_msg = if connection_global_id
+                  " for connection #{connection_global_id}"
+                else
+                  ''
+                end
+
                 "Timed out attempting to check out a connection " +
-                  "from pool for #{@server.address} after #{wait_timeout} sec. " +
+                  "from pool for #{@server.address}#{connection_global_id_msg} after #{wait_timeout} sec. " +
                   "Connections in pool: #{@available_connections.length} available, " +
                   "#{@checked_out_connections.length} checked out, " +
                   "#{@pending_connections.length} pending " +
@@ -449,7 +497,11 @@ module Mongo
             # Connection was closed - for example, because it experienced
             # a network error. Nothing else needs to be done here.
             @populate_semaphore.signal
-          elsif connection.generation != @generation
+          elsif connection.generation != generation(service_id: connection.service_id) && !connection.pinned?
+            # If connection is marked as pinned, it is used by a transaction
+            # or a series of cursor operations in a load balanced setup.
+            # In this case connection should not be disconnected until
+            # unpinned.
             connection.disconnect!(reason: :stale)
             @populate_semaphore.signal
           else
@@ -475,6 +527,8 @@ module Mongo
       #   subsequent check out operation.
       # @option options [ true | false ] :stop_populator Whether to stop
       #   the populator background thread. For internal driver use only.
+      # @option options [ Object ] :service_id Clear connections with
+      #   the specified service id only.
       #
       # @return [ true ] true.
       #
@@ -488,18 +542,38 @@ module Mongo
           stop_populator
         end
 
+        service_id = options && options[:service_id]
+
         @lock.synchronize do
-          @generation += 1
+          @generation_manager.bump(service_id: service_id)
 
           publish_cmap_event(
-            Monitoring::Event::Cmap::PoolCleared.new(@server.address)
+            Monitoring::Event::Cmap::PoolCleared.new(
+              @server.address,
+              service_id: service_id
+            )
           )
 
           unless options && options[:lazy]
-            until @available_connections.empty?
-              connection = @available_connections.pop
-              connection.disconnect!(reason: :stale)
-              @populate_semaphore.signal
+            if @server.load_balancer? && service_id
+              loop do
+                conn = @available_connections.detect do |conn|
+                  conn.service_id == service_id
+                end
+                if conn
+                  @available_connections.delete(conn)
+                  conn.disconnect!(reason: :stale)
+                  @populate_semaphore.signal
+                else
+                  break
+                end
+              end
+            else
+              until @available_connections.empty?
+                connection = @available_connections.pop
+                connection.disconnect!(reason: :stale)
+                @populate_semaphore.signal
+              end
             end
           end
         end
@@ -586,10 +660,10 @@ module Mongo
       # @return [ Object ] The result of the block.
       #
       # @since 2.0.0
-      def with_connection
+      def with_connection(connection_global_id: nil)
         raise_if_closed!
 
-        connection = check_out
+        connection = check_out(connection_global_id: connection_global_id)
         yield(connection)
       ensure
         if connection
@@ -705,13 +779,33 @@ module Mongo
 
       private
 
+      # Returns the next available connection, optionally with given
+      # global id. If no suitable connections are available,
+      # returns nil.
+      def next_available_connection(connection_global_id: nil)
+        if @server.load_balancer? && connection_global_id
+          conn = @available_connections.detect do |conn|
+            conn.global_id == connection_global_id
+          end
+          if conn
+            @available_connections.delete(conn)
+          end
+          conn
+        else
+          @available_connections.pop
+        end
+      end
+
       def create_connection
-        connection = Connection.new(@server, options.merge(
-          generation: generation,
+        opts = options.merge(
           connection_pool: self,
           # Do not pass app metadata - this will be retrieved by the connection
           # based on the auth needs.
-        ))
+        )
+        unless @server.load_balancer?
+          opts[:generation] = generation
+        end
+        connection = Connection.new(@server, opts)
       end
 
       # Create a connection, connect it, and add it to the pool.
@@ -772,7 +866,11 @@ module Mongo
           raise
         end
       rescue Error::SocketError, Error::SocketTimeoutError => exc
-        @server.unknown!(generation: exc.generation, stop_push_monitor: true)
+        @server.unknown!(
+          generation: exc.generation,
+          service_id: exc.service_id,
+          stop_push_monitor: true,
+        )
         raise
       end
 
@@ -800,3 +898,6 @@ module Mongo
     end
   end
 end
+
+require 'mongo/server/connection_pool/generation_manager'
+require 'mongo/server/connection_pool/populator'

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

@@ -35,31 +35,36 @@ module Mongo
         # -  8 => 4.2
         # -  9 => 4.4
         # - 13 => 5.0
+        # - 14 => 5.1
+        # - 17 => 6.0
         #
         # @since 2.0.0
         MAPPINGS = {
-          :retryable_write_error_label => 9,
+          merge_out_on_secondary: 13,
+          get_more_comment: 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.
@@ -77,7 +82,7 @@ module Mongo
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (2..13).freeze
+        DRIVER_WIRE_VERSIONS = (6..17).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #