mongo 2.24.1 → 2.26.0

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -101,7 +101,7 @@ module Mongo
       #
       # @api private
       def read_scheduled_kill_specs
-        while kill_spec = @kill_spec_queue.pop(true)
+        while (kill_spec = @kill_spec_queue.pop(true))
           if @active_cursor_ids.include?(kill_spec.cursor_id)
             @to_kill[kill_spec.server_address] ||= Set.new
             @to_kill[kill_spec.server_address] << kill_spec
@@ -188,14 +188,21 @@ module Mongo
             server_api: server.options[:server_api],
             connection_global_id: kill_spec.connection_global_id,
           }
-          if connection = kill_spec.connection
-            op.execute_with_connection(connection, context: Operation::Context.new(options: options))
-            connection.connection_pool.check_in(connection)
+          if (connection = kill_spec.connection)
+            begin
+              op.execute_with_connection(connection, context: Operation::Context.new(options: options))
+            rescue Error::SocketError, Error::SocketTimeoutError, Error::ConnectionPerished
+              # Connection is dead. do_check_in will detect connection.error?
+              # and disconnect it; the pool slot becomes free for a new connection.
+            ensure
+              connection.unpin(:cursor)
+              connection.connection_pool.check_in(connection) unless connection.pinned?
+            end
           else
             op.execute(server, context: Operation::Context.new(options: options))
           end
 
-          next unless session = kill_spec.session
+          next unless (session = kill_spec.session)
 
           session.end_session if session.implicit?
         end

data/lib/mongo/cluster/sdam_flow.rb

@@ -385,8 +385,8 @@ class Mongo::Cluster
     def add_servers_from_desc(updated_desc)
       added_servers = []
       %w[hosts passives arbiters].each do |m|
-        updated_desc.send(m).each do |address_str|
-          if server = cluster.add(address_str, monitor: false)
+        updated_desc.public_send(m).each do |address_str|
+          if (server = cluster.add(address_str, monitor: false))
             added_servers << server
           end
         end
@@ -402,7 +402,7 @@ class Mongo::Cluster
     # good primary).
     def remove_servers_not_in_desc(updated_desc)
       updated_desc_address_strs = %w[hosts passives arbiters].map do |m|
-        updated_desc.send(m)
+        updated_desc.public_send(m)
       end.flatten
       servers_list.each do |server|
         next if updated_desc_address_strs.include?(address_str = server.address.to_s)
@@ -541,7 +541,7 @@ class Mongo::Cluster
     end
 
     def disconnect_servers
-      while server = @servers_to_disconnect.shift
+      while (server = @servers_to_disconnect.shift)
         if server.connected?
           # Do not publish server closed event, as this was already done
           server.disconnect!

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

@@ -85,7 +85,7 @@ module Mongo
             # LST is only read from data-bearing servers
             if desc.data_bearing?
               @have_data_bearing_servers = true
-              break unless timeout = desc.logical_session_timeout
+              break unless (timeout = desc.logical_session_timeout)
 
               [ timeout, min || timeout ].min
             else

data/lib/mongo/cluster.rb

@@ -269,30 +269,6 @@ module Mongo
       start_stop_srv_monitor
     end
 
-    # Create a cluster for the provided client, for use when we don't want the
-    # client's original cluster instance to be the same.
-    #
-    # @example Create a cluster for the client.
-    #   Cluster.create(client)
-    #
-    # @param [ Client ] client The client to create on.
-    # @param [ Monitoring | nil ] monitoring. The monitoring instance to use
-    #   with the new cluster. If nil, a new instance of Monitoring will be
-    #   created.
-    #
-    # @return [ Cluster ] The cluster.
-    #
-    # @since 2.0.0
-    # @api private
-    def self.create(client, monitoring: nil)
-      cluster = Cluster.new(
-        client.cluster.addresses.map(&:to_s),
-        monitoring || Monitoring.new,
-        client.cluster_options
-      )
-      client.instance_variable_set(:@cluster, cluster)
-    end
-
     # @return [ Hash ] The options hash.
     attr_reader :options
 
@@ -324,9 +300,7 @@ module Mongo
     # @api private
     attr_reader :seeds
 
-    # @private
-    #
-    # @since 2.5.1
+    # @api private
     attr_reader :session_pool
 
     def_delegators :topology, :replica_set?, :replica_set_name, :sharded?,
@@ -612,8 +586,7 @@ module Mongo
     # @option options [ true | false ] :keep_connection_pool Usually when the
     #   new server description is unknown, the connection pool on the
     #   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).
+    #   existing connection pool (required when handling not master errors).
     # @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
@@ -802,7 +775,7 @@ module Mongo
     #
     # @since 2.5.0
     def update_cluster_time(result)
-      return unless cluster_time_doc = result.cluster_time
+      return unless (cluster_time_doc = result.cluster_time)
 
       @cluster_time_lock.synchronize do
         advance_cluster_time(cluster_time_doc)
@@ -983,6 +956,16 @@ module Mongo
       end
     end
 
+    # Forces the cluster's periodic executor to run immediately. If the cluster
+    # has no periodic executor, this method does nothing.
+    #
+    # @api private
+    def trigger_periodic_executor!
+      return unless @periodic_executor
+
+      @periodic_executor.execute
+    end
+
     private
 
     # @api private

data/lib/mongo/collection/queryable_encryption.rb

@@ -62,8 +62,8 @@ module Mongo
       def maybe_drop_emm_collections(encrypted_fields, client, session)
         encrypted_fields = if encrypted_fields
                              encrypted_fields
-                           elsif encrypted_fields_map
-                             encrypted_fields_for_drop_from_map
+                           elsif client.options[:auto_encryption_options]
+                             encrypted_fields_for_drop
                            else
                              {}
                            end
@@ -127,12 +127,13 @@ module Mongo
           {}
       end
 
-      # Tries to return the encrypted fields from the {{encrypted_fields_map}}
-      # value, for the current namespace.
+      # Tries to return the encrypted fields for the current namespace from
+      # the {{encrypted_fields_map}} value, falling back to the encrypted
+      # fields advertised by the server for the collection.
       #
       # @return [ Hash | nil ] the encrypted fields, if found
-      def encrypted_fields_for_drop_from_map
-        encrypted_fields_map[namespace] ||
+      def encrypted_fields_for_drop
+        (encrypted_fields_map && encrypted_fields_map[namespace]) ||
           database.list_collections(filter: { name: name })
                   .first
                   &.fetch(:options, {})

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

@@ -85,7 +85,7 @@ module Mongo
           end
 
           def server_selector
-            @view.send(:server_selector)
+            @view.server_selector
           end
 
           def aggregate_spec(session, read_preference = nil)

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

@@ -104,10 +104,8 @@ module Mongo
 
           primary_read_preference = { mode: :primary }
           description = connection.description
-          if description.primary?
-            log_warn('Routing the Aggregation operation to the primary server')
-            primary_read_preference
-          elsif description.mongos? && !description.features.merge_out_on_secondary_enabled?
+          if description.primary? ||
+             (description.mongos? && !description.features.merge_out_on_secondary_enabled?)
             log_warn('Routing the Aggregation operation to the primary server')
             primary_read_preference
           else

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

@@ -105,7 +105,7 @@ module Mongo
               raise ArgumentError, "Unknown view class: #{view}"
             end
             command[:pipeline] = pipeline
-            if read_concern = view.read_concern
+            if (read_concern = view.read_concern) && !read_concern.empty?
               command[:readConcern] = Options::Mapper.transform_values_to_strings(
                 read_concern
               )
@@ -117,12 +117,10 @@ module Mongo
 
           def batch_size_doc
             value = options[:batch_size] || view.batch_size
-            if value == 0 && write?
+            if value.nil? || (value == 0 && write?)
               {}
-            elsif value
-              { batchSize: value }
             else
-              {}
+              { batchSize: value }
             end
           end
         end

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

@@ -92,7 +92,7 @@ module Mongo
           private
 
           def write?(spec)
-            return unless out = spec[:selector][:out]
+            return unless (out = spec[:selector][:out])
 
             out.is_a?(String) ||
               (out.respond_to?(:keys) && out.keys.first.to_s.downcase != View::MapReduce::INLINE)

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

@@ -351,19 +351,24 @@ module Mongo
               # In load balanced topology, manually check out a connection
               # so it remains checked out and pinned to the cursor.
               connection = server.pool.check_out(context: context)
-              result = send_initial_query(connection, context)
-
-              start_at_operation_time = if doc = result.replies.first && result.replies.first.documents.first
-                                          doc['operationTime']
-                                        else
-                                          nil
-                                        end
-              result
+              begin
+                result = send_initial_query(connection, context)
+
+                start_at_operation_time = if (doc = result.replies.first && result.replies.first.documents.first)
+                                            doc['operationTime']
+                                          else
+                                            nil
+                                          end
+                result
+              rescue StandardError
+                server.pool.check_in(connection)
+                raise
+              end
             else
               server.with_connection do |connection|
                 result = send_initial_query(connection, context)
 
-                start_at_operation_time = if doc = result.replies.first && result.replies.first.documents.first
+                start_at_operation_time = if (doc = result.replies.first && result.replies.first.documents.first)
                                             doc['operationTime']
                                           else
                                             # The above may set @start_at_operation_time to nil

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

@@ -227,7 +227,7 @@ module Mongo
         #
         # @since 2.5.0
         def execute
-          view.send(:with_session, @options) do |session|
+          view.with_session(@options) do |session|
             write_concern = view.write_concern_with_session(session)
             context = Operation::Context.new(client: client, session: session)
             nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
@@ -241,7 +241,7 @@ module Mongo
         OUT_ACTIONS = %i[replace merge reduce].freeze
 
         def server_selector
-          @view.send(:server_selector)
+          @view.server_selector
         end
 
         def inline?
@@ -299,15 +299,6 @@ module Mongo
           end
         end
 
-        def fetch_query_spec
-          Builder::MapReduce.new(map_function, reduce_function, view, options).query_specification
-        end
-
-        def find_command_spec(session)
-          Builder::MapReduce.new(map_function, reduce_function, view,
-                                 options.merge(session: session)).command_specification
-        end
-
         def fetch_query_op(session)
           spec = {
             coll_name: out_collection_name,

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

@@ -678,7 +678,7 @@ module Mongo
         # @api private
         def read_concern
           if options[:session] && options[:session].in_transaction?
-            options[:session].send(:txn_read_concern) || collection.client.read_concern
+            options[:session].txn_read_concern || collection.client.read_concern
           else
             collection.read_concern
           end
@@ -749,12 +749,10 @@ module Mongo
           end
         end
 
-        private
-
-        def collation(doc = nil)
-          configure(:collation, doc)
-        end
-
+        # The server selector for this view, derived from its read
+        # preference (or the collection/client default).
+        #
+        # @api private
         def server_selector
           @server_selector ||= if options[:session] && options[:session].in_transaction?
                                  ServerSelector.get(read_preference || client.server_selector)
@@ -763,6 +761,12 @@ module Mongo
                                end
         end
 
+        private
+
+        def collation(doc = nil)
+          configure(:collation, doc)
+        end
+
         def validate_doc!(doc)
           raise Error::InvalidDocument.new unless doc.respond_to?(:keys)
         end

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

@@ -88,11 +88,6 @@ module Mongo
               operation_timeouts: operation_timeouts(opts)
             )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-              gte_4_4 = connection.server.description.server_version_gte?('4.4')
-              if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-              end
-
               Operation::WriteCommand.new(
                 selector: cmd,
                 db_name: database.name,
@@ -216,11 +211,6 @@ module Mongo
             )
             value = tracer.trace_operation(operation, context, op_name: 'findOneAndUpdate') do
               write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-                gte_4_4 = connection.server.description.server_version_gte?('4.4')
-                if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                  raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-                end
-
                 operation.txn_num = txn_num
                 operation.execute_with_connection(connection, context: context)
               end
@@ -287,11 +277,6 @@ module Mongo
             )
             tracer.trace_operation(operation, context, op_name: 'deleteMany') do
               nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
-                gte_4_4 = connection.server.description.server_version_gte?('4.4')
-                if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                  raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-                end
-
                 operation.execute_with_connection(connection, context: context)
               end
             end
@@ -346,11 +331,6 @@ module Mongo
               operation_timeouts: operation_timeouts(opts)
             )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-              gte_4_4 = connection.server.description.server_version_gte?('4.4')
-              if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-              end
-
               Operation::Delete.new(
                 deletes: [ delete_doc ],
                 db_name: collection.database.name,
@@ -428,11 +408,6 @@ module Mongo
               operation_timeouts: operation_timeouts(opts)
             )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-              gte_4_2 = connection.server.description.server_version_gte?('4.2')
-              if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-              end
-
               Operation::Update.new(
                 updates: [ update_doc ],
                 db_name: collection.database.name,
@@ -507,11 +482,6 @@ module Mongo
               operation_timeouts: operation_timeouts(opts)
             )
             nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
-              gte_4_2 = connection.server.description.server_version_gte?('4.2')
-              if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-              end
-
               Operation::Update.new(
                 updates: [ update_doc ],
                 db_name: collection.database.name,
@@ -601,11 +571,6 @@ module Mongo
             )
             tracer.trace_operation(operation, context) do
               write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-                gte_4_2 = connection.server.description.server_version_gte?('4.2')
-                if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
-                  raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-                end
-
                 operation.txn_num = txn_num
                 operation.execute_with_connection(connection, context: context)
               end
@@ -624,8 +589,8 @@ module Mongo
         # @raise [ Error::InvalidUpdateDocument ] if the first key in the
         #   document does not start with a $.
         def validate_update_documents!(spec)
-          return unless update = spec.is_a?(Array) ? spec&.first : spec
-          return unless key = update.keys&.first
+          return unless (update = spec.is_a?(Array) ? spec&.first : spec)
+          return unless (key = update.keys&.first)
           return if key.to_s.start_with?('$')
           raise Error::InvalidUpdateDocument.new(key: key) if Mongo.validate_update_replace
 
@@ -641,8 +606,8 @@ module Mongo
         # @raise [ Error::InvalidUpdateDocument ] if the first key in the
         #   document does not start with a $.
         def validate_replacement_documents!(spec)
-          return unless replace = spec.is_a?(Array) ? spec&.first : spec
-          return unless key = replace.keys&.first
+          return unless (replace = spec.is_a?(Array) ? spec&.first : spec)
+          return unless (key = replace.keys&.first)
           return unless key.to_s.start_with?('$')
           raise Error::InvalidReplacementDocument.new(key: key) if Mongo.validate_update_replace
 

data/lib/mongo/collection/view.rb

@@ -236,6 +236,14 @@ module Mongo
         end
       end
 
+      # Executes the provided block within the context of a session, using
+      # this view's options merged with the given ones.
+      #
+      # @api private
+      def with_session(opts = {}, &block)
+        client.with_session(@options.merge(opts), &block)
+      end
+
       private
 
       def initialize_copy(other)
@@ -252,10 +260,6 @@ module Mongo
       def view
         self
       end
-
-      def with_session(opts = {}, &block)
-        client.with_session(@options.merge(opts), &block)
-      end
     end
   end
 end

data/lib/mongo/collection.rb

@@ -393,7 +393,7 @@ module Mongo
       operation = { create: name }.merge(options)
       operation.delete(:write)
       operation.delete(:write_concern)
-      client.send(:with_session, opts) do |session|
+      client.with_session(opts) do |session|
         write_concern = if opts[:write_concern]
                           WriteConcern.get(opts[:write_concern])
                         else

data/lib/mongo/crypt/auto_encrypter.rb

@@ -81,6 +81,9 @@ module Mongo
       # @option options [ Boolean | nil ] :crypt_shared_lib_required Whether
       #   crypt shared library is required. If 'true', an error will be raised
       #   if a crypt_shared library cannot be loaded by libmongocrypt.
+      # @option options [ Integer | nil ] :key_expiration_ms The lifetime of the
+      #   data encryption key cache, in milliseconds. A value of 0 means the
+      #   cache never expires. Defaults to 60000.
       #
       # @raise [ ArgumentError ] If required options are missing or incorrectly
       #   formatted.
@@ -99,7 +102,8 @@ module Mongo
           bypass_query_analysis: @options[:bypass_query_analysis],
           crypt_shared_lib_path: @options[:extra_options][:crypt_shared_lib_path],
           crypt_shared_lib_required: @options[:extra_options][:crypt_shared_lib_required],
-          disable_crypt_shared_lib_search: @options[:extra_options][:disable_crypt_shared_lib_search]
+          disable_crypt_shared_lib_search: @options[:extra_options][:disable_crypt_shared_lib_search],
+          key_expiration_ms: @options[:key_expiration_ms]
         )
 
         @mongocryptd_options = @options[:extra_options].slice(
@@ -287,7 +291,7 @@ module Mongo
         @internal_client ||= client.with(
           auto_encryption_options: nil,
           min_pool_size: 0,
-          monitoring: client.send(:monitoring)
+          monitoring: client.monitoring
         )
       end
     end

data/lib/mongo/crypt/binary.rb

@@ -139,14 +139,17 @@ module Mongo
       # Wraps a String with a mongocrypt_binary_t, yielding an FFI::Pointer
       # to the wrapped struct.
       def self.wrap_string(str)
-        binary_p = Binding.mongocrypt_binary_new_from_data(
-          FFI::MemoryPointer.from_string(str),
-          str.bytesize
-        )
+        # mongocrypt_binary_new_from_data does not copy the buffer, so the
+        # MemoryPointer must outlive the mongocrypt_binary_t. Hold it in a
+        # local so it stays referenced for the whole method frame; otherwise
+        # GC can free the buffer while libmongocrypt still points into it.
+        data_p = FFI::MemoryPointer.from_string(str)
+        binary_p = Binding.mongocrypt_binary_new_from_data(data_p, str.bytesize)
         begin
           yield binary_p
         ensure
           Binding.mongocrypt_binary_destroy(binary_p)
+          data_p # rubocop:disable Lint/Void -- keep the buffer alive past destroy
         end
       end
     end