mongo 2.24.1 → 2.25.0

data/lib/mongo/monitoring/event/cmap/pool_ready.rb

@@ -41,6 +41,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, options, pool)
+            super()
             @address = address
             @options = options.dup.freeze
             @pool = pool

data/lib/mongo/monitoring/event/command_failed.rb

@@ -83,6 +83,7 @@ module Mongo
         def initialize(command_name, database_name, address,
                        request_id, operation_id, message, failure, duration,
                        started_event:, server_connection_id: nil, service_id: nil)
+          super()
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address

data/lib/mongo/monitoring/event/command_started.rb

@@ -84,6 +84,7 @@ module Mongo
                        operation_id, command, socket_object_id: nil, connection_id: nil,
                        connection_generation: nil, server_connection_id: nil,
                        service_id: nil)
+          super()
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -76,6 +76,7 @@ module Mongo
         def initialize(command_name, database_name, address, request_id,
                        operation_id, reply, duration, started_event:,
                        server_connection_id: nil, service_id: nil)
+          super()
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address

data/lib/mongo/monitoring/event/secure.rb

@@ -47,18 +47,14 @@ module Mongo
         #
         # @return [ true | false ] Whether the command is sensitive.
         def sensitive?(command_name:, document:)
-          if REDACTED_COMMANDS.include?(command_name.to_s)
-            true
-          elsif %w[hello ismaster isMaster].include?(command_name.to_s) &&
-                document['speculativeAuthenticate']
-            # According to Command Monitoring spec, for hello/legacy hello commands
-            # when speculativeAuthenticate is present, their commands AND replies
-            # MUST be redacted from the events.
-            # See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md#security
-            true
-          else
-            false
-          end
+          return true if REDACTED_COMMANDS.include?(command_name.to_s)
+
+          # According to Command Monitoring spec, for hello/legacy hello commands
+          # when speculativeAuthenticate is present, their commands AND replies
+          # MUST be redacted from the events.
+          # See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md#security
+          %w[hello ismaster isMaster].include?(command_name.to_s) &&
+            !!document['speculativeAuthenticate']
         end
 
         # Redact secure information from the document if:
@@ -77,11 +73,10 @@ module Mongo
         #
         # @since 2.1.0
         def redacted(command_name, document)
-          if %w[1 true yes].include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
-            document
-          elsif respond_to?(:started_event) && started_event.sensitive
-            BSON::Document.new
-          elsif sensitive?(command_name: command_name, document: document)
+          return document if %w[1 true yes].include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
+
+          if (respond_to?(:started_event) && started_event.sensitive) ||
+             sensitive?(command_name: command_name, document: document)
             BSON::Document.new
           else
             document

data/lib/mongo/monitoring/event/server_closed.rb

@@ -37,6 +37,7 @@ module Mongo
         #
         # @since 2.4.0
         def initialize(address, topology)
+          super()
           @address = address
           @topology = topology
         end

data/lib/mongo/monitoring/event/server_description_changed.rb

@@ -58,6 +58,7 @@ module Mongo
         # @api private
         def initialize(address, topology, previous_description, new_description,
                        awaited: false)
+          super()
           @address = address
           @topology = topology
           @previous_description = previous_description

data/lib/mongo/monitoring/event/server_heartbeat_failed.rb

@@ -35,6 +35,7 @@ module Mongo
         # @since 2.7.0
         # @api private
         def initialize(address, round_trip_time, error, started_event:, awaited: false)
+          super()
           @address = address
           @round_trip_time = round_trip_time
           @error = error

data/lib/mongo/monitoring/event/server_heartbeat_started.rb

@@ -40,6 +40,7 @@ module Mongo
         # @since 2.7.0
         # @api private
         def initialize(address, awaited: false)
+          super()
           @address = address
           @awaited = !!awaited
         end

data/lib/mongo/monitoring/event/server_heartbeat_succeeded.rb

@@ -35,6 +35,7 @@ module Mongo
         # @since 2.7.0
         # @api private
         def initialize(address, round_trip_time, started_event:, awaited: false)
+          super()
           @address = address
           @round_trip_time = round_trip_time
           @awaited = !!awaited

data/lib/mongo/monitoring/event/server_opening.rb

@@ -37,6 +37,7 @@ module Mongo
         #
         # @since 2.4.0
         def initialize(address, topology)
+          super()
           @address = address
           @topology = topology
         end

data/lib/mongo/monitoring/event/topology_changed.rb

@@ -37,6 +37,7 @@ module Mongo
         #
         # @since 2.4.0
         def initialize(previous_topology, new_topology)
+          super()
           @previous_topology = previous_topology
           @new_topology = new_topology
         end

data/lib/mongo/monitoring/event/topology_closed.rb

@@ -33,6 +33,7 @@ module Mongo
         #
         # @since 2.4.0
         def initialize(topology)
+          super()
           @topology = topology
         end
 

data/lib/mongo/monitoring/event/topology_opening.rb

@@ -33,6 +33,7 @@ module Mongo
         #
         # @since 2.4.0
         def initialize(topology)
+          super()
           @topology = topology
         end
 

data/lib/mongo/operation/create/op_msg.rb

@@ -24,6 +24,7 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CausalConsistencySupported
 
         private
 

data/lib/mongo/operation/create_index/op_msg.rb

@@ -24,6 +24,7 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CausalConsistencySupported
 
         private
 
@@ -33,7 +34,7 @@ module Mongo
             indexes: indexes,
             comment: spec[:comment],
           }.compact.tap do |selector|
-            if commit_quorum = spec[:commit_quorum]
+            if (commit_quorum = spec[:commit_quorum])
               # There was a bug on server versions 4.2.0 - 4.2.5 where
               # the server would accept the commitQuorum option and use it internally
               # (see SERVER-47193). As a result, the drivers specifications require

data/lib/mongo/operation/cursor_command/op_msg.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2025 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
+  module Operation
+    class CursorCommand
+      # A cursor command operation sent as an op message.
+      #
+      # @api private
+      class OpMsg < OpMsgBase
+        include PolymorphicResult
+
+        private
+
+        # The user's command is sent verbatim. The driver MUST NOT inspect or
+        # modify it; $db, lsid and other internal fields are attached by the
+        # shared command building code.
+        def selector(_connection)
+          spec[:selector].dup
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/cursor_command/result.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2025 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
+  module Operation
+    class CursorCommand
+      # Parses the cursor field of a command response so a Cursor can be built
+      # from the result. The parsing is identical to a find command result.
+      #
+      # @api private
+      class Result < Operation::Result
+        # @return [ true | false ] Whether the command response contained a
+        #   cursor field.
+        def cursor?
+          !cursor_document.nil?
+        end
+
+        # @return [ Integer | nil ] The cursor id from the cursor document.
+        def cursor_id
+          cursor? ? cursor_document[CURSOR_ID] : super
+        end
+
+        # @return [ Array<BSON::Document> ] The first batch of documents.
+        def documents
+          cursor? ? cursor_document[FIRST_BATCH] : []
+        end
+
+        # @return [ String | nil ] The cursor namespace, "database.collection".
+        def namespace
+          cursor? ? cursor_document['ns'] : super
+        end
+
+        private
+
+        def cursor_document
+          return @cursor_document if defined?(@cursor_document)
+
+          @cursor_document = first_document[CURSOR]
+        end
+
+        def first_document
+          @first_document ||= reply.documents[0]
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/cursor_command.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2025 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.
+
+require 'mongo/operation/cursor_command/op_msg'
+require 'mongo/operation/cursor_command/result'
+
+module Mongo
+  module Operation
+    # A command operation whose response is parsed as a cursor.
+    #
+    # Unlike Command, the result exposes the firstBatch, namespace, and cursor
+    # id from the command response so that a Cursor can be built from it.
+    #
+    # @api private
+    class CursorCommand
+      include Specifiable
+      include OpMsgExecutable
+    end
+  end
+end

data/lib/mongo/operation/delete/op_msg.rb

@@ -27,6 +27,7 @@ module Mongo
         include ExecutableNoValidate
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include CausalConsistencySupported
 
         private
 

data/lib/mongo/operation/drop/op_msg.rb

@@ -24,6 +24,7 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CausalConsistencySupported
       end
     end
   end

data/lib/mongo/operation/drop_database/op_msg.rb

@@ -24,6 +24,7 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CausalConsistencySupported
       end
     end
   end

data/lib/mongo/operation/drop_index/op_msg.rb

@@ -24,6 +24,7 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CausalConsistencySupported
 
         private
 

data/lib/mongo/operation/find/builder/command.rb

@@ -60,7 +60,7 @@ module Mongo
                 end
               end
 
-              if rc = selector[:readConcern]
+              if (rc = selector[:readConcern])
                 selector[:readConcern] = Options::Mapper.transform_values_to_strings(rc)
               end
 

data/lib/mongo/operation/insert/bulk_result.rb

@@ -47,11 +47,9 @@ module Mongo
         # @since 2.0.0
         # @api private
         def initialize(replies, connection_description, connection_global_id, ids)
-          @replies = [ *replies ] if replies
-          @connection_description = connection_description
-          @connection_global_id = connection_global_id
+          super(replies, connection_description, connection_global_id)
           if replies && replies.first && (doc = replies.first.documents.first)
-            if errors = doc['writeErrors']
+            if (errors = doc['writeErrors'])
               # some documents were potentially inserted
               bad_indices = {}
               errors.map do |error|

data/lib/mongo/operation/insert/op_msg.rb

@@ -28,6 +28,7 @@ module Mongo
         include ExecutableNoValidate
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include CausalConsistencySupported
 
         private
 

data/lib/mongo/operation/result.rb

@@ -162,15 +162,6 @@ module Mongo
         !!@replies
       end
 
-      # Whether the result contains cursor_id
-      #
-      # @return [ true, false ] If the result contains cursor_id.
-      #
-      # @api private
-      def has_cursor_id?
-        acknowledged? && replies.last.respond_to?(:cursor_id)
-      end
-
       # Get the cursor id if the response is acknowledged.
       #
       # @note Cursor ids of 0 indicate there is no cursor on the server.
@@ -183,7 +174,17 @@ module Mongo
       # @since 2.0.0
       # @api private
       def cursor_id
-        acknowledged? ? replies.last.cursor_id : 0
+        return 0 unless acknowledged?
+
+        if replies.last.respond_to?(:cursor_id)
+          # Legacy OP_REPLY replies expose the cursor id directly.
+          replies.last.cursor_id
+        elsif first_document.key?(CURSOR)
+          # OP_MSG command replies carry the cursor id in the `cursor` subdocument.
+          first_document[CURSOR][CURSOR_ID] || 0
+        else
+          0
+        end
       end
 
       # Get the namespace of the cursor. The method should be defined in
@@ -450,7 +451,7 @@ module Mongo
       end
 
       def snapshot_timestamp
-        return unless doc = reply.documents.first
+        return unless (doc = reply.documents.first)
 
         doc['cursor']&.[]('atClusterTime') || doc['atClusterTime']
       end
@@ -465,20 +466,6 @@ module Mongo
         end
       end
 
-      def aggregate_returned_count
-        replies.reduce(0) do |n, reply|
-          n += reply.number_returned
-          n
-        end
-      end
-
-      def aggregate_written_count
-        documents.reduce(0) do |n, document|
-          n += document[N] || 0
-          n
-        end
-      end
-
       def parser
         @parser ||= Error::Parser.new(first_document, replies)
       end

data/lib/mongo/operation/shared/causal_consistency_supported.rb

@@ -28,8 +28,10 @@ module Mongo
       #
       # This method overrides the causal consistency addition logic of
       # SessionsSupported and is meant to be used with operations classified
-      # as "read operations accepting a read concern", as these are defined
-      # in the causal consistency spec.
+      # as "read and write operations accepting a read concern", as these are
+      # defined in the causal consistency spec. For write operations this
+      # attaches only afterClusterTime (no read concern level) so that causal
+      # ordering is preserved across writes in a causally consistent session.
       #
       # In order for the override to work correctly the
       # CausalConsistencySupported module must be included after

data/lib/mongo/operation/shared/executable.rb

@@ -64,14 +64,6 @@ module Mongo
                     end
                   end
 
-                  if result.has_cursor_id? &&
-                     connection.description.load_balancer?
-                    if result.cursor_id == 0
-                      connection.unpin
-                    else
-                      connection.pin
-                    end
-                  end
                   process_result(result, connection)
                 end
               end
@@ -121,7 +113,7 @@ module Mongo
       # @param [ Mongo::Operation::Context ] context The operation context.
       def build_message(connection, context)
         msg = message(connection)
-        if server_api = context.server_api
+        if (server_api = context.server_api)
           msg = msg.maybe_add_server_api(server_api)
         end
         msg

data/lib/mongo/operation/shared/result/aggregatable.rb

@@ -36,7 +36,7 @@ module Mongo
           return unless @replies
 
           @replies.reduce(nil) do |errors, reply|
-            next unless write_errors = reply.documents.first['writeErrors']
+            next unless (write_errors = reply.documents.first['writeErrors'])
 
             wes = write_errors.collect do |we|
               we.merge!('index' => count + we['index'])
@@ -59,7 +59,7 @@ module Mongo
           return unless @replies
 
           @replies.each_with_index.reduce(nil) do |errors, (reply, _)|
-            next unless write_concern_errors = reply.documents.first['writeConcernErrors']
+            next unless (write_concern_errors = reply.documents.first['writeConcernErrors'])
 
             (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
               wce.merge!('index' => count + wce['index'])

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -61,7 +61,7 @@ module Mongo
       def apply_causal_consistency_if_possible(selector, connection)
         return if connection.description.standalone?
 
-        cc_doc = session.send(:causal_consistency_doc)
+        cc_doc = session.causal_consistency_doc
         return unless cc_doc
 
         rc_doc = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
@@ -165,9 +165,7 @@ module Mongo
         read_doc = if connection.description.standalone?
                      # Read preference is never sent to standalones.
                      nil
-                   elsif connection.server.load_balancer?
-                     read&.to_mongos
-                   elsif connection.description.mongos?
+                   elsif connection.server.load_balancer? || connection.description.mongos?
                      # When server is a mongos:
                      # - $readPreference is never sent when mode is 'primary'
                      # - Otherwise $readPreference is sent
@@ -243,7 +241,7 @@ module Mongo
         end
 
         super.tap do |message|
-          if session = context.session
+          if (session = context.session)
             # Serialize the message to detect client-side problems,
             # such as invalid BSON keys or too large messages.
             # The message will be serialized again

data/lib/mongo/operation/update/bulk_result.rb

@@ -107,7 +107,7 @@ module Mongo
           return [] unless acknowledged?
 
           @replies.reduce([]) do |ids, reply|
-            if upserted_ids = reply.documents.first[UPSERTED]
+            if (upserted_ids = reply.documents.first[UPSERTED])
               ids += upserted_ids
             end
             ids

data/lib/mongo/operation/update/op_msg.rb

@@ -27,6 +27,7 @@ module Mongo
         include ExecutableNoValidate
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include CausalConsistencySupported
 
         private
 

data/lib/mongo/operation/write_command/op_msg.rb

@@ -21,6 +21,8 @@ module Mongo
       #
       # @api private
       class OpMsg < OpMsgBase
+        include CausalConsistencySupported
+
         private
 
         def selector(connection)

data/lib/mongo/operation.rb

@@ -38,6 +38,7 @@ require 'mongo/operation/drop'
 require 'mongo/operation/drop_database'
 require 'mongo/operation/get_more'
 require 'mongo/operation/find'
+require 'mongo/operation/cursor_command'
 require 'mongo/operation/explain'
 require 'mongo/operation/kill_cursors'
 require 'mongo/operation/indexes'

data/lib/mongo/options/redacted.rb

@@ -143,14 +143,14 @@ module Mongo
 
       def redacted_string(method)
         '{' + reduce([]) do |list, (k, v)|
-          list << "#{k.send(method)}=>#{redact(k, v, method)}"
+          list << "#{k.public_send(method)}=>#{redact(k, v, method)}"
         end.join(', ') + '}'
       end
 
       def redact(k, v, method)
         return STRING_REPLACEMENT if SENSITIVE_OPTIONS.include?(k.to_sym)
 
-        v.send(method)
+        v.public_send(method)
       end
     end
   end

data/lib/mongo/protocol/compressed.rb

@@ -74,12 +74,15 @@ module Mongo
       #
       # @since 2.5.0
       def initialize(message, compressor, zlib_compression_level = nil)
+        super()
         @original_message = message
         @original_op_code = message.op_code
         @uncompressed_size = 0
         @compressor_id = COMPRESSOR_ID_MAP[compressor]
         @compressed_message = ''
         @zlib_compression_level = zlib_compression_level if zlib_compression_level && zlib_compression_level != -1
+        # A compressed message must reuse the wrapped message's request id,
+        # overriding the fresh id assigned by the superclass initializer.
         @request_id = message.request_id
       end
 
@@ -93,11 +96,11 @@ module Mongo
         message = Registry.get(@original_op_code).allocate
         buf = decompress(@compressed_message)
 
-        message.send(:fields).each do |field|
+        message.fields.each do |field|
           if field[:multi]
-            Message.deserialize_array(message, buf, field)
+            message.deserialize_array(buf, field)
           else
-            Message.deserialize_field(message, buf, field)
+            message.deserialize_field(buf, field)
           end
         end
         message.fix_after_deserialization if message.is_a?(Msg)
@@ -116,6 +119,15 @@ module Mongo
         @original_message.replyable?
       end
 
+      # @api private
+      def serialize_fields(buffer, max_bson_size)
+        buf = BSON::ByteBuffer.new
+        @original_message.serialize_fields(buf, max_bson_size)
+        @uncompressed_size = buf.length
+        @compressed_message = compress(buf)
+        super
+      end
+
       private
 
       # The operation code for a +Compressed+ message.
@@ -140,14 +152,6 @@ module Mongo
       # @return [ String ] The actual compressed message bytes.
       field :compressed_message, Bytes
 
-      def serialize_fields(buffer, max_bson_size)
-        buf = BSON::ByteBuffer.new
-        @original_message.send(:serialize_fields, buf, max_bson_size)
-        @uncompressed_size = buf.length
-        @compressed_message = compress(buf)
-        super
-      end
-
       def compress(buffer)
         if @compressor_id == NOOP_BYTE
           buffer.to_s.force_encoding(BSON::BINARY)