mongo 2.18.1 → 2.19.0

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -82,7 +82,7 @@ module Mongo
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (6..17).freeze
+        DRIVER_WIRE_VERSIONS = (6..21).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #

data/lib/mongo/server/description.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -299,11 +299,6 @@ module Mongo
         @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
 
@@ -844,6 +839,8 @@ module Mongo
         config['connectionId']
       end
 
+      # @return [ nil | Object ] The service id, if any.
+      #
       # @api experimental
       def service_id
         config['serviceId']
@@ -872,6 +869,10 @@ module Mongo
       # @api private
       def server_version_gte?(version)
         required_wv = case version
+          when '7.0'
+            21
+          when '6.0'
+            17
           when '5.2'
             15
           when '5.1'

data/lib/mongo/server/monitor/app_metadata.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 

data/lib/mongo/server/monitor/connection.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/server/monitor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -223,13 +223,17 @@ module Mongo
         @mutex.synchronize do
           throttle_scan_frequency!
 
-          result = do_scan
-
-          run_sdam_flow(result)
+          begin
+            result = do_scan
+          rescue => e
+            run_sdam_flow({}, scan_error: e)
+          else
+            run_sdam_flow(result)
+          end
         end
       end
 
-      def run_sdam_flow(result, awaited: false)
+      def run_sdam_flow(result, awaited: false, scan_error: nil)
         @sdam_mutex.synchronize do
           old_description = server.description
 
@@ -237,7 +241,7 @@ module Mongo
             average_round_trip_time: server.round_trip_time_averager.average_round_trip_time
           )
 
-          server.cluster.run_sdam_flow(server.description, new_description, awaited: awaited)
+          server.cluster.run_sdam_flow(server.description, new_description, awaited: awaited, scan_error: scan_error)
 
           server.description.tap do |new_description|
             unless awaited
@@ -290,7 +294,7 @@ module Mongo
             log_prefix: options[:log_prefix],
             bg_error_backtrace: options[:bg_error_backtrace],
           )
-          {}
+          raise exc
         end
       end
 

data/lib/mongo/server/pending_connection.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/server/push_monitor/connection.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/server/push_monitor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/server/round_trip_time_averager.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 

data/lib/mongo/server.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -54,6 +54,15 @@ 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 ] :populator_io For internal driver
+    #   use only. Set to false to prevent the populator threads from being
+    #   created and started in the server's connection pool. It is intended
+    #   for use in tests that also turn off monitoring_io, unless the populator
+    #   is explicitly needed. If monitoring_io is off, but the populator_io
+    #   is on, the populator needs to be manually closed at the end of the
+    #   test, since a cluster without monitoring is considered not connected,
+    #   and thus will not clean up the connection pool populator threads on
+    #   close.
     # @option options [ true | false ] :load_balancer Whether this server
     #   is a load balancer.
     # @option options [ String ] :connect The client connection mode.
@@ -267,25 +276,41 @@ module Mongo
       if monitor
         monitor.stop!
       end
-      _pool = @pool_lock.synchronize do
-        @pool
-      end
-      if _pool
-        # For backwards compatibility we disconnect/clear the pool rather
-        # than close it here. We also stop the populator which allows the
-        # the pool to continue providing connections but stops it from
-        # connecting in background on clients/servers that are in fact
-        # intended to be closed and no longer used.
-        begin
-          _pool.disconnect!(stop_populator: true)
-        rescue Error::PoolClosedError
-          # If the pool was already closed, we don't need to do anything here.
-        end
-      end
+
       @connected = false
+
+      # The current CMAP spec requires a pool to be mostly unusable
+      # if its server is unknown (or, therefore, disconnected).
+      # However any outstanding operations should continue to completion,
+      # and their connections need to be checked into the pool to be
+      # torn down. Because of this cleanup requirement we cannot just
+      # close the pool and set it to nil here, to be recreated the next
+      # time the server is discovered.
+      pool_internal&.clear
+
       true
     end
 
+    def close
+      if monitor
+        monitor.stop!
+      end
+
+      @connected = false
+
+      _pool = nil
+      @pool_lock.synchronize do
+        _pool, @pool = @pool, nil
+      end
+
+      # TODO: change this to _pool.close in RUBY-3174.
+      # Clear the pool. If the server is not unknown then the
+      # pool will stay ready. Stop the background populator thread.
+      _pool&.close(stay_ready: true)
+
+      nil
+    end
+
     # Whether the server is connected.
     #
     # @return [ true|false ] Whether the server is connected.
@@ -397,8 +422,29 @@ module Mongo
     #
     # @since 2.0.0
     def pool
+      if unknown?
+        raise Error::ServerNotUsable, address
+      end
+
       @pool_lock.synchronize do
-        @pool ||= ConnectionPool.new(self, options)
+        opts = connected? ? options : options.merge(populator_io: false)
+        @pool ||= ConnectionPool.new(self, opts).tap do |pool|
+          pool.ready
+        end
+      end
+    end
+
+    # Internal driver method to retrieve the connection pool for this server.
+    #
+    # Unlike +pool+, +pool_internal+ will not create a pool if one does not
+    # already exist.
+    #
+    # @return [ Server::ConnectionPool | nil ] The connection pool, if one exists.
+    #
+    # @api private
+    def pool_internal
+      @pool_lock.synchronize do
+        @pool
       end
     end
 
@@ -480,18 +526,15 @@ module Mongo
     rescue Mongo::Error::SocketTimeoutError
       # possibly cluster is slow, do not give up on it
       raise
-    rescue Mongo::Error::SocketError => e
-      # non-timeout network error
+    rescue Mongo::Error::SocketError, Auth::Unauthorized => e
+      # non-timeout network error or auth error, clear the pool and mark the
+      # topology as unknown
       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
-      pool.disconnect!
-      raise
     end
 
     # Whether the server supports modern read retries.
@@ -547,6 +590,8 @@ module Mongo
     #
     # @since 2.4.0, SDAM events are sent as of version 2.7.0
     def unknown!(options = {})
+      pool = pool_internal
+
       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
@@ -555,15 +600,18 @@ module Mongo
         # 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.
+        #
+        # It is possible for a load balancer server to not have a service id,
+        # for example if there haven't been any successful connections yet to
+        # this server, but the server can still be marked unknown if one
+        # of such connections failed midway through its establishment.
         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'
+          pool&.disconnect!(service_id: service_id)
         end
         return
       end
 
-      if options[:generation] && options[:generation] < pool.generation
+      if options[:generation] && options[:generation] < pool&.generation
         return
       end
 
@@ -595,17 +643,35 @@ module Mongo
 
     # @api private
     def update_description(description)
+      pool = pool_internal
+      if pool && !description.unknown?
+        pool.ready
+      end
       @description = description
     end
 
+    # Clear the servers description so that it is considered unknown and can be
+    # safely disconnected.
+    #
+    # @api private
+    def clear_description
+      @description = Mongo::Server::Description.new(address, {})
+    end
+
     # @param [ Object ] :service_id Close connections with the specified
     #   service id only.
+    # @param [ true | false ] :interrupt_in_use_connections Whether or not the
+    #   cleared connections should be interrupted as well.
     #
     # @api private
-    def clear_connection_pool(service_id: nil)
+    def clear_connection_pool(service_id: nil, interrupt_in_use_connections: false)
       @pool_lock.synchronize do
-        if @pool
-          @pool.disconnect!(service_id: service_id)
+        # A server being marked unknown after it is closed is technically
+        # incorrect but it does not meaningfully alter any state.
+        # Because historically the driver permitted servers to be marked
+        # unknown at any time, continue doing so even if the pool is closed.
+        if @pool && !@pool.closed?
+          @pool.disconnect!(service_id: service_id, interrupt_in_use_connections: interrupt_in_use_connections)
         end
       end
     end

data/lib/mongo/server_selector/base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -175,6 +175,15 @@ module Mongo
       #
       # @since 2.0.0
       def select_server(cluster, ping = nil, session = nil, write_aggregation: false)
+        select_server_impl(cluster, ping, session, write_aggregation).tap do |server|
+          if Lint.enabled? && !server.pool.ready?
+            raise Error::LintError, 'Server selector returning a server with a pool which is not ready'
+          end
+        end
+      end
+
+      # Parameters and return values are the same as for select_server.
+      private def select_server_impl(cluster, ping, session, write_aggregation)
         if cluster.topology.is_a?(Cluster::Topology::LoadBalanced)
           return cluster.servers.first
         end
@@ -245,6 +254,18 @@ module Mongo
 =end
 
         loop do
+          if Lint.enabled?
+            cluster.servers.each do |server|
+              # TODO: Add this back in RUBY-3174.
+              # if !server.unknown? && !server.connected?
+              #   raise Error::LintError, "Server #{server.summary} is known but is not connected"
+              # end
+              if !server.unknown? && !server.pool.ready?
+                raise Error::LintError, "Server #{server.summary} is known but has non-ready pool"
+              end
+            end
+          end
+
           server = try_select_server(cluster, write_aggregation: write_aggregation)
 
           if server
@@ -604,9 +625,9 @@ module Mongo
         if cluster.server_selection_semaphore
           # Since the semaphore may have been signaled between us checking
           # the servers list earlier and the wait call below, we should not
-          # wait for the full remaining time - wait for up to 1 second, then
+          # wait for the full remaining time - wait for up to 0.5 second, then
           # recheck the state.
-          cluster.server_selection_semaphore.wait([time_remaining, 1].min)
+          cluster.server_selection_semaphore.wait([time_remaining, 0.5].min)
         else
           if Lint.enabled?
             raise Error::LintError, 'Waiting for server selection without having a server selection semaphore'

data/lib/mongo/server_selector/nearest.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/server_selector/primary.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/server_selector/primary_preferred.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/server_selector/secondary.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/server_selector.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/session/server_session.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #

data/lib/mongo/session/session_pool.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #

data/lib/mongo/session.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -522,7 +522,7 @@ module Mongo
     #
     # @option options [ Integer ] :max_commit_time_ms The maximum amount of
     #   time to allow a single commitTransaction command to run, in milliseconds.
-    # @option options [ Hash ] read_concern The read concern options hash,
+    # @option options [ Hash ] :read_concern The read concern options hash,
     #   with the following optional keys:
     #   - *:level* -- the read preference level as a symbol; valid values
     #      are *:local*, *:majority*, and *:snapshot*

data/lib/mongo/socket/ocsp_cache.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/socket/ocsp_verifier.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/socket/ssl.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/socket/tcp.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/socket/unix.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/socket.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -334,12 +334,36 @@ module Mongo
             raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
           end
         end
+        pipe = options[:pipe]
         if exc.is_a?(IO::WaitReadable)
-          select_args = [[@socket], nil, [@socket], select_timeout]
+          if pipe
+            select_args = [[@socket, pipe], nil, [@socket, pipe], select_timeout]
+          else
+            select_args = [[@socket], nil, [@socket], select_timeout]
+          end
         else
           select_args = [nil, [@socket], [@socket], select_timeout]
         end
+
         rv = Kernel.select(*select_args)
+        if Lint.enabled?
+          if pipe && rv&.include?(pipe)
+            # If the return value of select is the read end of the pipe, and
+            # an IOError is not raised, then that means the socket is still
+            # open. Select is interrupted be closing the write end of the
+            # pipe, which either returns the pipe if the socket is open, or
+            # raises an IOError if it isn't. Select is interrupted after all
+            # of the pending and checked out connections have been interrupted
+            # and closed, and this only happens once the pool is cleared with
+            # interrupt_in_use connections flag. This means that in order for
+            # the socket to still be open when the select is interrupted, and
+            # that socket is being read from, that means after clear was
+            # called, a connection from the previous generation was checked
+            # out of the pool, for reading on its socket. This should be impossible.
+            raise Mongo::LintError, "Select interrupted for live socket. This should be impossible."
+          end
+        end
+
         if BSON::Environment.jruby?
           # Ignore the return value of Kernel.select.
           # On JRuby, select appears to return nil prior to timeout expiration
@@ -414,11 +438,14 @@ module Mongo
 
     DEFAULT_TCP_KEEPIDLE = 120
 
+    DEFAULT_TCP_USER_TIMEOUT = 210
+
     def set_keepalive_opts(sock)
       sock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, true)
       set_option(sock, :TCP_KEEPINTVL, DEFAULT_TCP_KEEPINTVL)
       set_option(sock, :TCP_KEEPCNT, DEFAULT_TCP_KEEPCNT)
       set_option(sock, :TCP_KEEPIDLE, DEFAULT_TCP_KEEPIDLE)
+      set_option(sock, :TCP_USER_TIMEOUT, DEFAULT_TCP_USER_TIMEOUT)
     rescue
       # JRuby 9.2.13.0 and lower do not define TCP_KEEPINTVL etc. constants.
       # JRuby 9.2.14.0 defines the constants but does not allow to get or

data/lib/mongo/srv/monitor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -70,8 +70,6 @@ module Mongo
       end
 
       def scan!
-        old_hosts = last_result.address_strs
-
         begin
           last_result = Timeout.timeout(timeout) do
             @resolver.get_records(@srv_uri.query_hostname)

data/lib/mongo/srv/resolver.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #

data/lib/mongo/srv/result.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #

data/lib/mongo/srv.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/timeout.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -36,7 +36,7 @@ module Mongo
           ::Timeout.timeout(sec) do
             yield
           end
-        rescue ::Timeout::Error => e
+        rescue ::Timeout::Error
           raise klass, message
         end
       else

data/lib/mongo/topology_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #