mongo 2.24.0 → 2.25.0

data/lib/mongo/error/operation_failure.rb

@@ -53,6 +53,10 @@ module Mongo
         # @api experimental
         attr_reader :server_message
 
+        # @return [ String | nil ] The address ("host:port") of the server
+        #   that produced this error, if known.
+        attr_reader :server_address
+
         # Error codes and code names that should result in a failing getMore
         # command on a change stream NOT being resumed.
         #
@@ -172,6 +176,8 @@ module Mongo
         #   error document.
         # @option options [ String ] server_message The server-returned
         #   error message parsed from the response.
+        # @option options [ nil | String | Mongo::Address | Mongo::Server::Description ]
+        #   :server_address The address of the server that produced the error.
         # @option options [ Hash ] :write_concern_error_document The
         #   server-supplied write concern error document, if any.
         # @option options [ Integer ] :write_concern_error_code Error code for
@@ -185,7 +191,8 @@ module Mongo
         # @option options [ true | false ] :wtimeout Whether the error is a wtimeout.
         def initialize(message = nil, result = nil, options = {})
           @details = retrieve_details(options[:document])
-          super(append_details(message, @details))
+          @server_address = normalize_server_address(options[:server_address])
+          super(append_server_address(append_details(message, @details)))
 
           @result = result
           @code = options[:code]
@@ -226,9 +233,9 @@ module Mongo
         def retrieve_details(document)
           return nil unless document
 
-          if wce = document['writeConcernError']
+          if (wce = document['writeConcernError'])
             wce['errInfo']
-          elsif we = document['writeErrors']&.first
+          elsif (we = document['writeErrors']&.first)
             we['errInfo']
           end
         end
@@ -241,6 +248,38 @@ module Mongo
 
           message + " -- #{details.to_json}"
         end
+
+        # Append the server address suffix to the message when the
+        # Mongo.include_server_address_in_errors flag is enabled and
+        # a server address is known.
+        #
+        # @return [ String | nil ] the message with the suffix appended,
+        #   or the original message unchanged.
+        def append_server_address(message)
+          return message unless Mongo.include_server_address_in_errors
+          return message if @server_address.nil?
+          return "(on #{@server_address})" if message.nil? || message.empty?
+
+          "#{message} (on #{@server_address})"
+        end
+
+        # Normalize a server_address option into a String "host:port" form.
+        #
+        # @param [ nil | String | Mongo::Address | Mongo::Server::Description ] value
+        #
+        # @return [ String | nil ] The normalized address, or nil.
+        def normalize_server_address(value)
+          case value
+          when nil then nil
+          when String then value
+          when Mongo::Address then value.seed
+          when Mongo::Server::Description
+            value.address.is_a?(Mongo::Address) ? value.address.seed : nil
+          else
+            raise ArgumentError,
+                  "server_address must be nil, String, Mongo::Address, or Mongo::Server::Description; got #{value.class}"
+          end
+        end
       end
 
       # OperationFailure is the canonical implementor of the

data/lib/mongo/error/parser.rb

@@ -180,13 +180,13 @@ module Mongo
       end
 
       def parse_single(message, key, doc = document)
-        return unless error = doc[key]
+        return unless (error = doc[key])
 
         append(message, error)
       end
 
       def parse_multiple(message, key)
-        return unless errors = document[key]
+        return unless (errors = document[key])
 
         errors.each do |error|
           parse_single(message, 'errmsg', error)
@@ -228,7 +228,7 @@ module Mongo
         return unless @code.nil? && @code_name.nil?
         # If we have writeErrors, and all of their codes are the same,
         # use that code. Otherwise don't set the code
-        return unless write_errors = document['writeErrors']
+        return unless (write_errors = document['writeErrors'])
 
         codes = write_errors.map { |e| e['code'] }.compact
         return unless codes.uniq.length == 1

data/lib/mongo/error/sdam_error_detection.rb

@@ -29,10 +29,9 @@ module Mongo
         # Require the error to be communicated at the top level of the response
         # for it to influence SDAM state. See DRIVERS-1376 / RUBY-2516.
         return false if document && document['ok'] == 1
+        return false if node_recovering?
 
-        if node_recovering?
-          false
-        elsif code
+        if code
           NOT_MASTER_CODES.include?(code)
         elsif message
           message.include?('not master')

data/lib/mongo/grid/fs_bucket.rb

@@ -480,7 +480,7 @@ module Mongo
       #
       # @since 2.1.0
       def write_concern
-        @write_concern ||= if wco = @options[:write_concern] || @options[:write]
+        @write_concern ||= if (wco = @options[:write_concern] || @options[:write])
                              WriteConcern.get(wco)
                            else
                              database.write_concern
@@ -494,6 +494,32 @@ module Mongo
         chunks_collection.drop(timeout_ms: context.remaining_timeout_ms)
       end
 
+      # Ensures the files and chunks collections have their required indexes,
+      # creating any that are missing.
+      #
+      # @param [ CsotTimeoutHolder | nil ] timeout_holder The timeout holder.
+      #
+      # @api private
+      def ensure_indexes!(timeout_holder = nil)
+        fc_idx = files_collection.find(
+          {},
+          limit: 1,
+          projection: { _id: 1 },
+          timeout_ms: timeout_holder&.remaining_timeout_ms
+        ).first
+        create_index_if_missing!(files_collection, FSBucket::FILES_INDEX) if fc_idx.nil?
+
+        cc_idx = chunks_collection.find(
+          {},
+          limit: 1,
+          projection: { _id: 1 },
+          timeout_ms: timeout_holder&.remaining_timeout_ms
+        ).first
+        return unless cc_idx.nil?
+
+        create_index_if_missing!(chunks_collection, FSBucket::CHUNKS_INDEX, unique: true)
+      end
+
       private
 
       # @param [ Hash ] opts The options.
@@ -516,26 +542,6 @@ module Mongo
         "#{prefix}.#{Grid::File::Info::COLLECTION}"
       end
 
-      def ensure_indexes!(timeout_holder = nil)
-        fc_idx = files_collection.find(
-          {},
-          limit: 1,
-          projection: { _id: 1 },
-          timeout_ms: timeout_holder&.remaining_timeout_ms
-        ).first
-        create_index_if_missing!(files_collection, FSBucket::FILES_INDEX) if fc_idx.nil?
-
-        cc_idx = chunks_collection.find(
-          {},
-          limit: 1,
-          projection: { _id: 1 },
-          timeout_ms: timeout_holder&.remaining_timeout_ms
-        ).first
-        return unless cc_idx.nil?
-
-        create_index_if_missing!(chunks_collection, FSBucket::CHUNKS_INDEX, unique: true)
-      end
-
       def create_index_if_missing!(collection, index_spec, options = {})
         indexes_view = collection.indexes
         begin

data/lib/mongo/grid/stream/write.rb

@@ -148,7 +148,7 @@ module Mongo
           #
           # @since 2.1.0
           def write_concern
-            @write_concern ||= if wco = @options[:write_concern] || @options[:write]
+            @write_concern ||= if (wco = @options[:write_concern] || @options[:write])
                                  WriteConcern.get(wco)
                                else
                                  fs.write_concern
@@ -212,7 +212,7 @@ module Mongo
           end
 
           def ensure_indexes!
-            fs.send(:ensure_indexes!, @timeout_holder)
+            fs.ensure_indexes!(@timeout_holder)
           end
 
           def ensure_open!

data/lib/mongo/index/view.rb

@@ -168,11 +168,11 @@ module Mongo
         options = options.dup
 
         create_options = {}
-        if session = @options[:session]
+        if (session = @options[:session])
           create_options[:session] = session
         end
         %i[commit_quorum session comment timeout_ms max_time_ms].each do |key|
-          if value = options.delete(key)
+          if (value = options.delete(key))
             create_options[key] = value
           end
         end
@@ -347,10 +347,20 @@ module Mongo
         end
       end
 
+      # The query limit for an index view. Always -1; present so a Cursor
+      # can treat an index view like a collection view.
+      #
+      # @api private
+      def limit
+        -1
+      end
+
       private
 
       def drop_by_name(name, opts = {})
-        client.send(:with_session, @options) do |session|
+        session_options = @options.dup
+        session_options[:session] = opts[:session] if opts[:session]
+        client.with_session(session_options) do |session|
           spec = {
             db_name: database.name,
             coll_name: collection.name,
@@ -394,10 +404,6 @@ module Mongo
         Operation::Indexes.new(indexes_spec(session))
       end
 
-      def limit
-        -1
-      end
-
       def normalize_keys(spec)
         return false if spec.is_a?(String)
 

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

@@ -62,6 +62,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, reason)
+            super()
             @reason = reason
             @address = address
           end

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

@@ -35,6 +35,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address)
+            super()
             @address = address
           end
 

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

@@ -47,6 +47,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, id, pool)
+            super()
             @address = address
             @connection_id = id
             @pool = pool

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

@@ -48,6 +48,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, id, pool)
+            super()
             @address = address
             @connection_id = id
             @pool = pool

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

@@ -79,6 +79,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, id, reason)
+            super()
             @reason = reason
             @address = address
             @connection_id = id

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

@@ -41,6 +41,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, id)
+            super()
             @address = address
             @connection_id = id
           end

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

@@ -41,6 +41,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, id)
+            super()
             @address = address
             @connection_id = id
           end

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

@@ -43,6 +43,7 @@ module Mongo
           #
           # @api private
           def initialize(address, service_id: nil, interrupt_in_use_connections: nil)
+            super()
             @address = address
             @service_id = service_id
             @options = {}

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

@@ -42,6 +42,7 @@ module Mongo
           # @since 2.9.0
           # @api private
           def initialize(address, pool)
+            super()
             @address = address
             @pool = pool
           end

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

@@ -48,6 +48,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/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/monitoring/server_description_changed_log_subscriber.rb

@@ -23,6 +23,8 @@ module Mongo
       private
 
       def log_event(event)
+        return if event.previous_description == event.new_description
+
         log_debug(
           "Server description for #{event.address} changed from " +
           "'#{event.previous_description.server_type}' to '#{event.new_description.server_type}'#{awaited_indicator(event)}."

data/lib/mongo/monitoring/topology_changed_log_subscriber.rb

@@ -24,6 +24,9 @@ module Mongo
 
       def log_event(event)
         if event.previous_topology.class == event.new_topology.class
+          return if event.previous_topology.server_descriptions ==
+                    event.new_topology.server_descriptions
+
           log_debug(
             "There was a change in the members of the '#{event.new_topology.display_name}' " +
               'topology.'

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