mongo 2.24.1 → 2.26.0

data/lib/mongo/error/unsupported_option.rb

@@ -18,24 +18,6 @@ module Mongo
   class Error
     # Raised if an unsupported option is specified for an operation.
     class UnsupportedOption < Error
-      # The error message provided when the user passes the hint option to
-      # a write operation against a server that does not support the hint
-      # option and does not provide option validation.
-      #
-      # @api private
-      HINT_MESSAGE = 'The MongoDB server handling this request does not support ' \
-                     'the hint option on this command. The hint option is supported on update ' \
-                     'commands on MongoDB server versions 4.2 and later and on findAndModify ' \
-                     'and delete commands on MongoDB server versions 4.4 and later'
-
-      # The error message provided when the user passes the hint option to
-      # an unacknowledged write operation.
-      #
-      # @api private
-      UNACKNOWLEDGED_HINT_MESSAGE = 'The hint option cannot be specified on ' \
-                                    'an unacknowledged write operation. Remove the hint option or perform ' \
-                                    'this operation with a write concern of at least { w: 1 }'
-
       # The error message provided when the user passes the allow_disk_use
       # option to a find operation against a server that does not support the
       # allow_disk_use operation and does not provide option validation.
@@ -56,28 +38,6 @@ module Mongo
                               'option is supported on createIndexes commands on MongoDB server versions ' \
                               '4.4 and later'
 
-      # Raise an error about an unsupported hint option.
-      #
-      # @option options [ Boolean ] unacknowledged_write Whether this error
-      #   pertains to a hint option passed to an unacknowledged write. Defaults
-      #   to false.
-      #
-      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
-      #   error message.
-      #
-      # @api private
-      def self.hint_error(**options)
-        unacknowledged_write = options[:unacknowledged_write] || false
-
-        error_message = if unacknowledged_write
-                          UNACKNOWLEDGED_HINT_MESSAGE
-                        else
-                          HINT_MESSAGE
-                        end
-
-        new(error_message)
-      end
-
       # Raise an error about an unsupported allow_disk_use option.
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default

data/lib/mongo/grid/fs_bucket.rb

@@ -218,10 +218,10 @@ module Mongo
       def delete(id, opts = {})
         timeout_holder = CsotTimeoutHolder.new(operation_timeouts: operation_timeouts(opts))
         result = files_collection
-                 .find({ _id: id }, @options.merge(timeout_ms: timeout_holder.remaining_timeout_ms))
+                 .find({ _id: { '$eq' => id } }, @options.merge(timeout_ms: timeout_holder.remaining_timeout_ms))
                  .delete_one(timeout_ms: timeout_holder.remaining_timeout_ms)
         chunks_collection
-          .find({ files_id: id }, @options.merge(timeout_ms: timeout_holder.remaining_timeout_ms))
+          .find({ files_id: { '$eq' => id } }, @options.merge(timeout_ms: timeout_holder.remaining_timeout_ms))
           .delete_many(timeout_ms: timeout_holder.remaining_timeout_ms)
         raise Error::FileNotFound.new(id, :id) if result.n == 0
 
@@ -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/read.rb

@@ -182,7 +182,7 @@ module Mongo
             @file_info ||= begin
               doc = options[:file_info_doc] ||
                     fs.files_collection.find(
-                      { _id: file_id },
+                      { _id: { '$eq' => file_id } },
                       { timeout_ms: @timeout_holder.remaining_timeout_ms! }
                     ).first
               File::Info.new(Options::Mapper.transform(doc, File::Info::MAPPINGS.invert)) if doc
@@ -216,7 +216,7 @@ module Mongo
                 opts[:timeout_mode] = :cursor_lifetime
               end
 
-              fs.chunks_collection.find({ files_id: file_id }, opts).sort(n: 1)
+              fs.chunks_collection.find({ files_id: { '$eq' => file_id } }, opts).sort(n: 1)
             end
           end
 

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
@@ -177,7 +177,7 @@ module Mongo
           # @since 2.1.0
           def abort
             fs.chunks_collection.find(
-              { files_id: file_id },
+              { files_id: { '$eq' => file_id } },
               @options.merge(timeout_ms: @timeout_holder.remaining_timeout_ms!)
             ).delete_many
             (@open = false) || true
@@ -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/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