mongo 2.18.2 → 2.19.3

data/lib/mongo/cluster/sdam_flow.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -240,17 +240,25 @@ class Mongo::Cluster
         return
       end
 
-      max_election_id = topology.new_max_election_id(updated_desc)
-      max_set_version = topology.new_max_set_version(updated_desc)
-
-      if max_election_id != topology.max_election_id ||
-        max_set_version != topology.max_set_version
-      then
+      if updated_desc.max_wire_version >= 17
         @topology = Topology::ReplicaSetWithPrimary.new(
           topology.options.merge(
-            max_election_id: max_election_id,
-            max_set_version: max_set_version
+            max_election_id: updated_desc.election_id,
+            max_set_version: updated_desc.set_version
           ), topology.monitoring, self)
+      else
+        max_election_id = topology.new_max_election_id(updated_desc)
+        max_set_version = topology.new_max_set_version(updated_desc)
+
+        if max_election_id != topology.max_election_id ||
+          max_set_version != topology.max_set_version
+        then
+          @topology = Topology::ReplicaSetWithPrimary.new(
+            topology.options.merge(
+              max_election_id: max_election_id,
+              max_set_version: max_set_version
+            ), topology.monitoring, self)
+        end
       end
 
       # At this point we have accepted the updated server description
@@ -365,7 +373,6 @@ class Mongo::Cluster
     #   This is the set of servers on which monitoring should be started.
     def add_servers_from_desc(updated_desc)
       added_servers = []
-      address_strs = servers_list.map(&:address).map(&:to_s)
       %w(hosts passives arbiters).each do |m|
         updated_desc.send(m).each do |address_str|
           if server = cluster.add(address_str, monitor: false)
@@ -414,6 +421,9 @@ class Mongo::Cluster
     def do_remove(address_str)
       servers = cluster.remove(address_str, disconnect: false)
       servers.each do |server|
+        # Clear the description so that the server is marked as unknown.
+        server.clear_description
+
         # We need to publish server closed event here, but we cannot close
         # the server because it could be the server owning the monitor in
         # whose thread this flow is presently executing, in which case closing
@@ -574,13 +584,30 @@ class Mongo::Cluster
 
     # Whether updated_desc is for a stale primary.
     def stale_primary?
-      if updated_desc.election_id && updated_desc.set_version
-        if topology.max_set_version && topology.max_election_id &&
-            (updated_desc.set_version < topology.max_set_version ||
-                (updated_desc.set_version == topology.max_set_version &&
-                    updated_desc.election_id < topology.max_election_id))
+      if updated_desc.max_wire_version >= 17
+        if updated_desc.election_id.nil? && !topology.max_election_id.nil?
+          return true
+        end
+        if updated_desc.election_id && topology.max_election_id && updated_desc.election_id < topology.max_election_id
           return true
         end
+        if updated_desc.election_id == topology.max_election_id
+          if updated_desc.set_version.nil? && !topology.max_set_version.nil?
+            return true
+          end
+          if updated_desc.set_version && topology.max_set_version && updated_desc.set_version < topology.max_set_version
+            return true
+          end
+        end
+      else
+        if updated_desc.election_id && updated_desc.set_version
+          if topology.max_set_version && topology.max_election_id &&
+              (updated_desc.set_version < topology.max_set_version ||
+                  (updated_desc.set_version == topology.max_set_version &&
+                      updated_desc.election_id < topology.max_election_id))
+            return true
+          end
+        end
       end
       false
     end

data/lib/mongo/cluster/topology/base.rb

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

data/lib/mongo/cluster/topology/load_balanced.rb

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

data/lib/mongo/cluster/topology/no_replica_set_options.rb

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

data/lib/mongo/cluster/topology/replica_set_no_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/cluster/topology/replica_set_with_primary.rb

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

data/lib/mongo/cluster/topology/sharded.rb

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

data/lib/mongo/cluster/topology/single.rb

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

data/lib/mongo/cluster/topology/unknown.rb

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

data/lib/mongo/cluster/topology.rb

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

data/lib/mongo/cluster.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -263,10 +263,10 @@ module Mongo
             log_debug("Waiting for up to #{'%.2f' % time_remaining} seconds for servers to be scanned: #{summary}")
             # Since the semaphore may have been signaled between us checking
             # the servers list above 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.
             begin
-              server_selection_semaphore.wait([time_remaining, 1].min)
+              server_selection_semaphore.wait([time_remaining, 0.5].min)
             rescue ::Timeout::Error
               # nothing
             end
@@ -497,13 +497,16 @@ module Mongo
     # events in the process. Stops SRV monitoring if it is active.
     # Marks the cluster disconnected.
     #
-    # @return [ true ] Always true.
+    # A closed cluster is no longer usable. If the client is reconnected,
+    # it will create a new cluster instance.
     #
-    # @since 2.1.0
-    def disconnect!
+    # @return [ nil ] Always nil.
+    #
+    # @api private
+    def close
       @state_change_lock.synchronize do
         unless connecting? || connected?
-          return true
+          return nil
         end
         if options[:cleanup] != false
           session_pool.end_sessions
@@ -516,7 +519,7 @@ module Mongo
         end
         @servers.each do |server|
           if server.connected?
-            server.disconnect!
+            server.close
             publish_sdam_event(
               Monitoring::SERVER_CLOSED,
               Monitoring::Event::ServerClosed.new(server.address, topology)
@@ -531,7 +534,7 @@ module Mongo
           @connecting = @connected = false
         end
       end
-      true
+      nil
     end
 
     # Reconnect all servers.
@@ -622,10 +625,12 @@ 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 aptions [ true | false ] :awaited Whether the updated description
+    # @option options [ true | false ] :awaited Whether the updated description
     #   was a result of processing an awaited hello.
     # @option options [ Object ] :service_id Change state for the specified
     #   service id only.
+    # @option options [ Mongo::Error | nil ] :scan_error The error encountered
+    #   while scanning, or nil if no error was raised.
     #
     # @api private
     def run_sdam_flow(previous_desc, updated_desc, options = {})
@@ -636,7 +641,9 @@ module Mongo
               # TODO should service id be taken out of updated_desc?
               # We could also assert that
               # options[:service_id] == updated_desc.service_id
-              server.clear_connection_pool(service_id: options[:service_id])
+              err = options[:scan_error]
+              interrupt = err && (err.is_a?(Error::SocketError) || err.is_a?(Error::SocketTimeoutError))
+              server.clear_connection_pool(service_id: options[:service_id], interrupt_in_use_connections: interrupt)
             end
           end
         end
@@ -656,7 +663,9 @@ module Mongo
           if flow.became_unknown?
             servers_list.each do |server|
               if server.address == updated_desc.address
-                server.clear_connection_pool
+                err = options[:scan_error]
+                interrupt = err && (err.is_a?(Error::SocketError) || err.is_a?(Error::SocketTimeoutError))
+                server.clear_connection_pool(interrupt_in_use_connections: interrupt)
               end
             end
           end
@@ -697,12 +706,16 @@ module Mongo
     # @api private
     def set_server_list(server_address_strs)
       @sdam_flow_lock.synchronize do
+        # If one of the new addresses is not in the current servers list,
+        # add it to the servers list.
         server_address_strs.each do |address_str|
           unless servers_list.any? { |server| server.address.seed == address_str }
             add(address_str)
           end
         end
 
+        # If one of the servers' addresses are not in the new address list,
+        # remove that server from the servers list.
         servers_list.each do |server|
           unless server_address_strs.any? { |address_str| server.address.seed == address_str }
             remove(server.address.seed)
@@ -824,6 +837,9 @@ module Mongo
       address = Address.new(host, options)
       if !addresses.include?(address)
         opts = options.merge(monitor: false)
+        # If we aren't starting the montoring threads, we also don't want to
+        # start the pool's populator thread.
+        opts.merge!(populator_io: false) unless options.fetch(:monitoring_io, true)
         # Note that in a load-balanced topology, every server must be a
         # load balancer (load_balancer: true is specified in the options)
         # but this option isn't set here because we are required by the
@@ -927,6 +943,7 @@ module Mongo
     # @api private
     def disconnect_server_if_connected(server)
       if server.connected?
+        server.clear_description
         server.disconnect!
         publish_sdam_event(
           Monitoring::SERVER_CLOSED,

data/lib/mongo/cluster_time.rb

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

data/lib/mongo/collection/helpers.rb

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

data/lib/mongo/collection/queryable_encryption.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 # Copyright (C) 2014-2022 MongoDB Inc.
 #
@@ -22,6 +21,8 @@ module Mongo
     #
     # @api private
     module QueryableEncryption
+      # The minimum wire version for QE2 support
+      QE2_MIN_WIRE_VERSION = 21
 
       # Creates auxiliary collections and indices for queryable encryption if necessary.
       #
@@ -32,32 +33,19 @@ module Mongo
       #
       # @return [ Result ] The result of provided block.
       def maybe_create_qe_collections(encrypted_fields, client, session)
-        encrypted_fields = if encrypted_fields
-          encrypted_fields
-        elsif encrypted_fields_map
-          encrypted_fields_map[namespace] || {}
-        else
-          {}
-        end
-        if encrypted_fields.empty?
-          return yield
-        end
+        encrypted_fields = encrypted_fields_from(encrypted_fields)
+        return yield if encrypted_fields.empty?
 
-        emm_collections(encrypted_fields).each do |coll|
-          context = Operation::Context.new(client: client, session: session)
-          Operation::Create.new(
-            selector: {
-              create: coll,
-              clusteredIndex: {
-                key: {
-                  _id: 1
-                },
-                unique: true
-              }
-            },
-            db_name: database.name,
-          ).execute(next_primary(nil, session), context: context)
+        server = next_primary(nil, session)
+        context = Operation::Context.new(client: client, session: session)
+        server.with_connection do |connection|
+          check_wire_version!(connection)
+          emm_collections(encrypted_fields).each do |coll|
+            create_operation_for(coll)
+              .execute_with_connection(connection, context: context)
+          end
         end
+
         yield(encrypted_fields).tap do |result|
           indexes.create_one(__safeContent__: 1) if result
         end
@@ -73,31 +61,25 @@ module Mongo
       # @return [ Result ] The result of provided block.
       def maybe_drop_emm_collections(encrypted_fields, client, session)
         encrypted_fields = if encrypted_fields
-          encrypted_fields
-        elsif encrypted_fields_map
-          if encrypted_fields_map[namespace]
-            encrypted_fields_map[namespace]
-          else
-            database.list_collections(filter: { name: name })
-              .first
-              &.fetch(:options, {})
-              &.fetch(:encryptedFields, {}) || {}
-          end
-        else
-          {}
-        end
-        if encrypted_fields.empty?
-          return yield
-        end
+                             encrypted_fields
+                           elsif encrypted_fields_map
+                             encrypted_fields_for_drop_from_map
+                           else
+                             {}
+                           end
+
+        return yield if encrypted_fields.empty?
+
         emm_collections(encrypted_fields).each do |coll|
           context = Operation::Context.new(client: client, session: session)
           operation = Operation::Drop.new(
             selector: { drop: coll },
             db_name: database.name,
-            session: session,
+            session: session
           )
           do_drop(operation, session, context)
         end
+
         yield
       end
 
@@ -112,11 +94,69 @@ module Mongo
       def emm_collections(encrypted_fields)
         [
           encrypted_fields['escCollection'] || "enxcol_.#{name}.esc",
-          encrypted_fields['eccCollection'] || "enxcol_.#{name}.ecc",
           encrypted_fields['ecocCollection'] || "enxcol_.#{name}.ecoc",
         ]
       end
 
+      # Creating encrypted collections is only supported on 7.0.0 and later
+      # (wire version 21+).
+      #
+      # @param [ Mongo::Connection ] connection The connection to check
+      #   the wire version of.
+      #
+      # @raise [ Mongo::Error ] if the wire version is not
+      #   recent enough
+      def check_wire_version!(connection)
+        return unless connection.description.max_wire_version < QE2_MIN_WIRE_VERSION
+
+        raise Mongo::Error,
+              'Driver support of Queryable Encryption is incompatible with server. ' \
+              'Upgrade server to use Queryable Encryption.'
+      end
+
+      # Tries to return the encrypted fields from the argument. If the argument
+      # is nil, tries to find the encrypted fields from the
+      # encrypted_fields_map.
+      #
+      # @param [ Hash | nil ] fields the encrypted fields
+      #
+      # @return [ Hash ] the encrypted fields
+      def encrypted_fields_from(fields)
+        fields ||
+          (encrypted_fields_map && encrypted_fields_map[namespace]) ||
+          {}
+      end
+
+      # Tries to return the encrypted fields from the {{encrypted_fields_map}}
+      # value, for the current namespace.
+      #
+      # @return [ Hash | nil ] the encrypted fields, if found
+      def encrypted_fields_for_drop_from_map
+        encrypted_fields_map[namespace] ||
+          database.list_collections(filter: { name: name })
+                  .first
+                  &.fetch(:options, {})
+                  &.fetch(:encryptedFields, {}) ||
+          {}
+      end
+
+      # Returns a new create operation for the given collection.
+      #
+      # @param [ String ] coll the name of the collection to create.
+      #
+      # @return [ Operation::Create ] the new create operation.
+      def create_operation_for(coll)
+        Operation::Create.new(
+          selector: {
+            create: coll,
+            clusteredIndex: {
+              key: { _id: 1 },
+              unique: true
+            }
+          },
+          db_name: database.name
+        )
+      end
     end
   end
 end

data/lib/mongo/collection/view/aggregation.rb

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

data/lib/mongo/collection/view/builder/aggregation.rb

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

data/lib/mongo/collection/view/builder/map_reduce.rb

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

data/lib/mongo/collection/view/builder.rb

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

data/lib/mongo/collection/view/change_stream/retryable.rb

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

data/lib/mongo/collection/view/change_stream.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -164,7 +164,7 @@ module Mongo
             document = try_next
             yield document if document
           end
-        rescue StopIteration => e
+        rescue StopIteration
           return self
         end
 
@@ -238,7 +238,7 @@ module Mongo
           unless closed?
             begin
               @cursor.close
-            rescue Error::OperationFailure, Error::SocketError, Error::SocketTimeoutError
+            rescue Error::OperationFailure, Error::SocketError, Error::SocketTimeoutError, Error::MissingConnection
               # ignore
             end
             @cursor = nil

data/lib/mongo/collection/view/explainable.rb

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

data/lib/mongo/collection/view/immutable.rb

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

data/lib/mongo/collection/view/iterable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -185,6 +185,8 @@ module Mongo
             collection.client.log_warn("The :oplog_replay option is deprecated and ignored by MongoDB 4.4 and later")
           end
 
+          maybe_set_tailable_options(spec)
+
           if explained?
             spec[:explain] = options[:explain]
             Operation::Explain.new(spec)
@@ -200,6 +202,19 @@ module Mongo
         def use_query_cache?
           QueryCache.enabled? && !collection.system_collection?
         end
+
+        # Add tailable cusror options to the command specifiction if needed.
+        #
+        # @param [ Hash ] spec The command specification.
+        def maybe_set_tailable_options(spec)
+          case cursor_type
+          when :tailable
+            spec[:tailable] = true
+          when :tailable_await
+            spec[:tailable] = true
+            spec[:await_data] = true
+          end
+        end
       end
     end
   end

data/lib/mongo/collection/view/map_reduce.rb

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

data/lib/mongo/collection/view/readable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -272,19 +272,18 @@ module Mongo
               cmd = { count: collection.name }
               cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
               if read_concern
-                cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
-                  read_concern)
-                end
-                result = Operation::Count.new(
-                  selector: cmd,
-                  db_name: database.name,
-                  read: read_pref,
-                  session: session,
-                  comment: opts[:comment],
-                ).execute(server, context: context)
-                result.n.to_i
+                cmd[:readConcern] = Options::Mapper.transform_values_to_strings(read_concern)
               end
+              result = Operation::Count.new(
+                selector: cmd,
+                db_name: database.name,
+                read: read_pref,
+                session: session,
+                comment: opts[:comment],
+              ).execute(server, context: context)
+              result.n.to_i
             end
+          end
         rescue Error::OperationFailure => exc
           if exc.code == 26
             # NamespaceNotFound

data/lib/mongo/collection/view/writable.rb

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

data/lib/mongo/collection/view.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -127,6 +127,7 @@ module Mongo
       #   return in each response from MongoDB.
       # @option options [ Hash ] :collation The collation to use.
       # @option options [ String ] :comment Associate a comment with the query.
+      # @option options [ :tailable, :tailable_await ] :cursor_type The type of cursor to use.
       # @option options [ Hash ] :explain Execute an explain with the provided
       #   explain options (known options are :verbose and :verbosity) rather
       #   than a find.