mongo 2.24.1 → 2.25.0

data/lib/mongo/server_selector/base.rb

@@ -239,7 +239,7 @@ module Mongo
 
           session.unpin unless session.in_transaction?
 
-          if server = session.pinned_server
+          if (server = session.pinned_server)
             # Here we assume that a mongos stays in the topology indefinitely.
             # This will no longer be the case once SRV polling is implemented.
 
@@ -398,9 +398,7 @@ module Mongo
       # @api private
       def candidates(cluster, deprioritized = [])
         servers = cluster.servers.reject { |s| deprioritized.include?(s) }
-        if cluster.single?
-          servers
-        elsif cluster.sharded?
+        if cluster.single? || cluster.sharded?
           servers
         elsif cluster.replica_set?
           select_in_replica_set(servers)
@@ -689,8 +687,7 @@ module Mongo
         msg = ''
         dead_monitors = []
         cluster.servers_list.each do |server|
-          thread = server.monitor.instance_variable_get(:@thread)
-          dead_monitors << server if thread.nil? || !thread.alive?
+          dead_monitors << server unless server.monitor&.running?
         end
         if dead_monitors.any?
           msg += ". The following servers have dead monitor threads: #{dead_monitors.map(&:summary).join(', ')}"

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -101,7 +101,10 @@ module Mongo
       #
       # @since 2.0.0
       def select_in_replica_set(candidates)
-        near_servers(secondaries(candidates)) + primary(candidates)
+        eligible = secondaries(candidates)
+        return near_servers(eligible) unless eligible.empty?
+
+        primary(candidates)
       end
 
       def max_staleness_allowed?

data/lib/mongo/session.rb

@@ -459,13 +459,9 @@ module Mongo
       @inside_with_transaction = true
       @with_transaction_timeout_ms = options&.dig(:timeout_ms) || @options[:default_timeout_ms] || @client.timeout_ms
       @with_transaction_deadline = calculate_with_transaction_deadline(options)
-      deadline = if @with_transaction_deadline
-                   # CSOT enabled, so we have a customer defined deadline.
-                   @with_transaction_deadline
-                 else
-                   # CSOT not enabled, so we use the default deadline, 120 seconds.
-                   Utils.monotonic_time + 120
-                 end
+      # When CSOT is enabled we have a customer defined deadline; otherwise
+      # fall back to the default deadline, 120 seconds.
+      deadline = @with_transaction_deadline || (Utils.monotonic_time + 120)
       transaction_in_progress = false
       transaction_attempt = 0
       last_error = nil
@@ -1054,7 +1050,7 @@ module Mongo
           # even if transaction's read concern is not set.
           # Read concern here is the one sent to the server and may
           # include afterClusterTime.
-          if rc = c[:readConcern]
+          if (rc = c[:readConcern])
             rc = rc.dup
             rc.delete(:level)
           end
@@ -1201,7 +1197,7 @@ module Mongo
     def process(result)
       unless implicit?
         set_operation_time(result)
-        if cluster_time_doc = result.cluster_time
+        if (cluster_time_doc = result.cluster_time)
           advance_cluster_time(cluster_time_doc)
         end
       end
@@ -1312,8 +1308,6 @@ module Mongo
       @inside_with_transaction
     end
 
-    private
-
     # Get the read concern the session will use when starting a transaction.
     #
     # This is a driver style hash with underscore keys.
@@ -1324,11 +1318,24 @@ module Mongo
     # @return [ Hash ] The read concern used for starting transactions.
     #
     # @since 2.9.0
+    # @api private
     def txn_read_concern
       # Read concern is inherited from client but not db or collection.
       txn_options[:read_concern] || @client.read_concern
     end
 
+    # Returns causal consistency document if the last operation time is
+    # known and causal consistency is enabled, otherwise returns nil.
+    #
+    # @api private
+    def causal_consistency_doc
+      return unless operation_time && causal_consistency?
+
+      { afterClusterTime: operation_time }
+    end
+
+    private
+
     def within_states?(*states)
       states.include?(@state)
     end
@@ -1346,14 +1353,6 @@ module Mongo
         (@client.write_concern && @client.write_concern.options)
     end
 
-    # Returns causal consistency document if the last operation time is
-    # known and causal consistency is enabled, otherwise returns nil.
-    def causal_consistency_doc
-      return unless operation_time && causal_consistency?
-
-      { afterClusterTime: operation_time }
-    end
-
     def causal_consistency?
       @causal_consistency ||= if @options.key?(:causal_consistency)
                                 !!@options[:causal_consistency]
@@ -1391,9 +1390,9 @@ module Mongo
             raise Mongo::Error::InvalidTransactionOperation,
                   'timeoutMS cannot be overridden inside a withTransaction callback'
           end
-        elsif timeout_ms = opts[:timeout_ms]
+        elsif (timeout_ms = opts[:timeout_ms])
           result[:operation_timeout_ms] = timeout_ms
-        elsif default_timeout_ms = options[:default_timeout_ms]
+        elsif (default_timeout_ms = options[:default_timeout_ms])
           result[:operation_timeout_ms] = default_timeout_ms
         end
       end
@@ -1407,9 +1406,9 @@ module Mongo
           Utils.monotonic_time + (timeout / 1000.0)
         end
       }
-      if timeout_ms = opts&.dig(:timeout_ms)
+      if (timeout_ms = opts&.dig(:timeout_ms))
         calc.call(timeout_ms)
-      elsif default_timeout_ms = @options[:default_timeout_ms]
+      elsif (default_timeout_ms = @options[:default_timeout_ms])
         calc.call(default_timeout_ms)
       elsif @client.timeout_ms
         calc.call(@client.timeout_ms)

data/lib/mongo/socket/ssl.rb

@@ -359,7 +359,7 @@ module Mongo
         if options[:ssl_cert]
           cert_text = File.read(options[:ssl_cert])
           cert_object = nil
-        elsif cert_text = options[:ssl_cert_string]
+        elsif (cert_text = options[:ssl_cert_string])
           cert_object = nil
         else
           cert_object = options[:ssl_cert_object]
@@ -421,13 +421,13 @@ module Mongo
         # https://github.com/jruby/jruby-openssl/issues/176
         if BSON::Environment.jruby?
           [ OpenSSL::PKey::RSA, OpenSSL::PKey::DSA ].each do |cls|
-            return cls.send(:new, *args)
+            return cls.new(*args)
           rescue OpenSSL::PKey::PKeyError
             # ignore
           end
           # Neither RSA nor DSA worked, fall through to trying PKey
         end
-        OpenSSL::PKey.send(:read, *args)
+        OpenSSL::PKey.read(*args)
       end
 
       def set_cert_verification(context, options)

data/lib/mongo/socket.rb

@@ -547,10 +547,6 @@ module Mongo
       !rv.nil?
     end
 
-    def unix_socket?(sock)
-      defined?(UNIXSocket) && sock.is_a?(UNIXSocket)
-    end
-
     DEFAULT_TCP_KEEPINTVL = 10
 
     DEFAULT_TCP_KEEPCNT = 9
@@ -590,9 +586,7 @@ module Mongo
       yield
     rescue Errno::ETIMEDOUT => e
       raise Error::SocketTimeoutError, "#{e.class}: #{e} (for #{human_address})"
-    rescue IOError, SystemCallError, ::SocketError => e
-      raise Error::SocketError, "#{e.class}: #{e} (for #{human_address})"
-    rescue OpenSSL::SSL::SSLError => e
+    rescue IOError, SystemCallError, ::SocketError, OpenSSL::SSL::SSLError => e
       raise Error::SocketError, "#{e.class}: #{e} (for #{human_address})"
     end
 

data/lib/mongo/srv/monitor.rb

@@ -42,10 +42,13 @@ module Mongo
       #   Options to pass through to Resolv::DNS constructor for SRV lookups.
       def initialize(cluster, **opts)
         @cluster = cluster
-        raise ArgumentError, 'SRV URI is required' unless @srv_uri = opts.delete(:srv_uri)
+        raise ArgumentError, 'SRV URI is required' unless (@srv_uri = opts.delete(:srv_uri))
 
         @options = opts.freeze
-        @resolver = Srv::Resolver.new(**opts)
+        # Per the polling-srv-records spec, mismatched-domain records and empty
+        # results MUST be logged and ignored, not raised. Force the polling
+        # resolver into log-and-continue mode regardless of caller options.
+        @resolver = Srv::Resolver.new(**opts, raise_on_invalid: false)
         @last_result = @srv_uri.srv_result
         @stop_semaphore = Semaphore.new
       end
@@ -82,6 +85,12 @@ module Mongo
         rescue Resolv::ResolvError => e
           log_warn("SRV monitor: unable to resolve hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
           return
+        rescue Mongo::Error => e
+          # Defense in depth: the polling resolver is configured to log-and-continue
+          # for mismatched-domain and empty-result cases, but if any Mongo::Error
+          # leaks out we MUST NOT let it terminate the SRV monitor thread.
+          log_warn("SRV monitor: error resolving hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
+          return
         end
 
         if last_result.empty?

data/lib/mongo/srv/resolver.rb

@@ -142,7 +142,7 @@ module Mongo
       #
       # @return [ Boolean ] Whether an error should be raised.
       def raise_on_invalid?
-        @raise_on_invalid ||= @options[:raise_on_invalid] || true
+        @options.fetch(:raise_on_invalid, true)
       end
     end
   end

data/lib/mongo/srv/result.rb

@@ -123,9 +123,11 @@ module Mongo
           raise Error::MismatchedDomain.new(format(MISMATCHED_DOMAINNAME, record_host, srv_host_domain))
         end
 
-        unless (record_host_parts.size > srv_host_domain.size) && (srv_host_domain == record_host_parts[-srv_host_domain.size..-1])
-          raise Error::MismatchedDomain.new(format(MISMATCHED_DOMAINNAME, record_host, srv_host_domain))
-        end
+        record_matches_domain = (record_host_parts.size > srv_host_domain.size) &&
+                                (srv_host_domain == record_host_parts[-srv_host_domain.size..-1])
+        return if record_matches_domain
+
+        raise Error::MismatchedDomain.new(format(MISMATCHED_DOMAINNAME, record_host, srv_host_domain))
       end
     end
   end

data/lib/mongo/timeout.rb

@@ -18,8 +18,7 @@ module Mongo
   # @api private
   module Timeout
     # A wrapper around Ruby core's Timeout::timeout method that provides
-    # a standardized API for Ruby versions older and newer than 2.4.0,
-    # which is when the third argument was introduced.
+    # a standardized API for calling it.
     #
     # @param [ Numeric ] sec The number of seconds before timeout.
     # @param [ Class ] klass The exception class to raise on timeout, optional.
@@ -28,19 +27,15 @@ module Mongo
     #   on timeout, optional. When no error message is provided, the default
     #   error message for the exception class is used.
     def timeout(sec, klass = nil, message = nil, &block)
-      if message && RUBY_VERSION < '2.94.0'
-        begin
-          ::Timeout.timeout(sec, &block)
-        rescue ::Timeout::Error
-          raise klass, message
-        end
-      else
-        # Jruby Timeout::timeout method does not support passing nil arguments.
-        # Remove the nil arguments before passing them along to the core
-        # Timeout::timeout method.
-        optional_args = [ klass, message ].compact
-        ::Timeout.timeout(sec, *optional_args, &block)
-      end
+      # provide a default error class if the message is present; otherwise,
+      # the message will be interpreted as the error class, if klass is nil
+      klass ||= ::Timeout::Error if message
+
+      # Jruby Timeout::timeout method does not support passing nil arguments.
+      # Remove the nil arguments before passing them along to the core
+      # Timeout::timeout method.
+      optional_args = [ klass, message ].compact
+      ::Timeout.timeout(sec, *optional_args, &block)
     end
     module_function :timeout
   end

data/lib/mongo/tracing/open_telemetry/command_tracer.rb

@@ -206,9 +206,23 @@ module Mongo
         # @param _context [ OpenTelemetry::Context ] the context (unused).
         # @param span [ OpenTelemetry::Trace::Span ] the current span.
         def process_cursor_context(result, _cursor_id, _context, span)
-          return unless result.has_cursor_id? && result.cursor_id.positive?
+          cursor_id = normalize_cursor_id(result.cursor_id)
+          return unless cursor_id.positive?
 
-          span.set_attribute('db.mongodb.cursor_id', result.cursor_id)
+          span.set_attribute('db.mongodb.cursor_id', cursor_id)
+        end
+
+        # Normalizes a cursor id to a plain Integer.
+        #
+        # OP_MSG replies deserialized in :bson mode expose the cursor id as a
+        # BSON::Int64, which does not implement Numeric#positive? and is not a
+        # valid OpenTelemetry attribute type.
+        #
+        # @param cursor_id [ Integer | BSON::Int64 ] the raw cursor id.
+        #
+        # @return [ Integer ] the cursor id as an Integer.
+        def normalize_cursor_id(cursor_id)
+          cursor_id.is_a?(BSON::Int64) ? cursor_id.value : cursor_id
         end
 
         # Records error status code if the command failed.

data/lib/mongo/uri/options_mapper.rb

@@ -87,7 +87,7 @@ module Mongo
           strategy = URI_OPTION_MAP[key.downcase]
           if strategy.nil?
             log_warn("Unsupported URI option '#{key}' on URI '#{@string}'. It will be ignored.")
-            return
+            next
           end
 
           group = strategy[:group]
@@ -125,7 +125,7 @@ module Mongo
           end
           next if v.nil?
 
-          if type = spec[:type]
+          if (type = spec[:type])
             v = send("revert_#{type}", v)
           end
           canonical_key = URI_OPTION_CANONICAL_NAMES[uri_key]
@@ -163,7 +163,7 @@ module Mongo
           end
           next if v.nil?
 
-          if type = spec[:type]
+          if (type = spec[:type])
             v = send("stringify_#{type}", v)
           end
           canonical_key = URI_OPTION_CANONICAL_NAMES[uri_key]
@@ -354,13 +354,25 @@ module Mongo
 
       # Converts the value into a boolean and returns it wrapped in an array.
       #
-      # @param [ String ] name Name of the URI option being processed.
+      # tls and ssl are the only repeated_bool options. An invalid value is
+      # preserved as a nil element rather than warned-and-dropped, so that
+      # URI#validate_uri_options! can detect it and raise instead of silently
+      # falling back to a plaintext connection (RUBY-3832).
+      #
+      # @param [ String ] _name Name of the URI option being processed.
       # @param [ String ] value URI option value.
       #
-      # @return [ Array<true | false> | nil ] The boolean value parsed and wraped
-      #   in an array.
-      def convert_repeated_bool(name, value)
-        [ convert_bool(name, value) ]
+      # @return [ Array<true | false | nil> ] The boolean value parsed and
+      #   wrapped in an array.
+      def convert_repeated_bool(_name, value)
+        case value
+        when true, 'true', 'TRUE'
+          [ true ]
+        when false, 'false', 'FALSE'
+          [ false ]
+        else
+          [ nil ]
+        end
       end
 
       # Reverts a repeated boolean type.
@@ -379,7 +391,7 @@ module Mongo
       # @return [ Array<true | false> | nil ] The string.
       def stringify_repeated_bool(value)
         rep = revert_repeated_bool(value)
-        if rep&.is_a?(Array)
+        if rep.is_a?(Array)
           rep.join(',')
         else
           rep

data/lib/mongo/uri/srv_protocol.rb

@@ -117,14 +117,14 @@ module Mongo
         raise Error::InvalidURI.new(@string, details, FORMAT)
       end
 
-      # Gets the SRV resolver.
-      # If domain verification fails or no SRV records are found,
-      # an error must not be raised per the spec; instead, a warning is logged.
+      # Gets the SRV resolver used for initial URI parsing.
+      # Per the Initial DNS Seedlist Discovery spec, the driver MUST raise an
+      # error if domain verification fails or no SRV records are found, so
+      # raise_on_invalid is left at its default of true.
       #
       # @return [ Mongo::Srv::Resolver ]
       def resolver
         @resolver ||= Srv::Resolver.new(
-          raise_on_invalid: false,
           resolv_options: options[:resolv_options],
           timeout: options[:connect_timeout]
         )

data/lib/mongo/uri.rb

@@ -141,6 +141,19 @@ module Mongo
     # @since 2.5.0
     SCHEME_DELIM = '://'
 
+    # Placeholder used in place of cleartext credentials when a URI is
+    # rendered for display, logging, or error reporting.
+    CREDENTIALS_PLACEHOLDER = '<credentials>'
+
+    # Pattern matching the userinfo portion of a MongoDB connection string.
+    # Anchors at the start and is bounded to the authority component (stops at
+    # the first '/', '?', or '#'), but matches greedily up to the last '@' in
+    # that component so passwords containing an unescaped '@' are still fully
+    # redacted. Case-insensitive so an unusual scheme like 'MongoDB://' is
+    # redacted too — the parser will reject it, and the redactor must not be
+    # the thing that leaks the credentials in the resulting error.
+    USERINFO_REDACTION_REGEX = %r{\A(mongodb(?:\+srv)?://)[^/?#]*@}i.freeze
+
     # Error details for an invalid options format.
     #
     # @since 2.1.0
@@ -215,6 +228,24 @@ module Mongo
     # @since 2.1.0
     REPEATABLE_OPTIONS = %i[tag_sets ssl]
 
+    # Replace the userinfo portion of a MongoDB connection string with a
+    # placeholder so the result can safely be logged, displayed, or embedded
+    # in an exception message.
+    #
+    # The input is matched as a string, not parsed, so this is safe to call
+    # on malformed URIs (which is exactly when {InvalidURI} is raised).
+    #
+    # @param [ String ] string The raw URI string.
+    #
+    # @return [ String ] The URI with any userinfo replaced by
+    #   {CREDENTIALS_PLACEHOLDER}, or the input unchanged if it is not a
+    #   string or has no userinfo.
+    def self.redact(string)
+      return string unless string.is_a?(String)
+
+      string.sub(USERINFO_REDACTION_REGEX, "\\1#{CREDENTIALS_PLACEHOLDER}@")
+    end
+
     # Get either a URI object or a SRVProtocol URI object.
     #
     # @example Get the uri object.
@@ -320,20 +351,33 @@ module Mongo
       @database || Database::ADMIN
     end
 
-    # Get the uri as a string.
+    # Get the uri as a string with any credentials redacted.
+    #
+    # Credentials are replaced with {CREDENTIALS_PLACEHOLDER} so the result is
+    # safe to log or display. Use {#credentials} to recover the original user
+    # and password.
     #
     # @example Get the uri as a string.
     #   uri.to_s
     #
-    # @return [ String ] The uri string.
+    # @return [ String ] The redacted uri string.
     def to_s
       reconstruct_uri
     end
 
+    # Return a redacted, human-readable representation of the URI. The
+    # default {Object#inspect} would dump {@string} and {@password} as
+    # instance variables, leaking credentials.
+    #
+    # @return [ String ] The redacted inspect string.
+    def inspect
+      "#<#{self.class.name}: #{reconstruct_uri}>"
+    end
+
     private
 
-    # Reconstruct the URI from its parts. Invalid options are dropped and options
-    # are converted to camelCase.
+    # Reconstruct the URI from its parts with credentials redacted. Invalid
+    # options are dropped and options are converted to camelCase.
     #
     # @return [ String ] the uri.
     def reconstruct_uri
@@ -349,9 +393,7 @@ module Mongo
       end.compact.join('&')
 
       uri = "#{scheme}#{SCHEME_DELIM}"
-      uri += @user.to_s if @user
-      uri += "#{AUTH_USER_PWD_DELIM}#{@password}" if @password
-      uri += '@' if @user || @password
+      uri += "#{CREDENTIALS_PLACEHOLDER}@" if @user || @password
       uri += @query_hostname || servers
       uri += '/' if @database || !options.empty?
       uri += @database.to_s if @database
@@ -418,7 +460,7 @@ module Mongo
     end
 
     def parse_user!(string)
-      if string && user = string.partition(AUTH_USER_PWD_DELIM)[0]
+      if string && (user = string.partition(AUTH_USER_PWD_DELIM)[0])
         raise_invalid_error!(UNESCAPED_USER_PWD) if UNSAFE.match?(user)
         user_decoded = decode(user)
         raise_invalid_error!(UNESCAPED_USER_PWD) if user_decoded =~ PERCENT_CHAR && encode(user_decoded) != user
@@ -461,6 +503,12 @@ module Mongo
       # 'tls' and 'ssl'. In order to fulfill this, we parse the values of each instance into an
       # array; assuming all values in the array are the same, we replace the array with that value.
       unless uri_options[:ssl].nil? || uri_options[:ssl].empty?
+        # A nil element means an invalid value (e.g. tls=yes) was supplied.
+        # Refuse it rather than silently connecting over plaintext (RUBY-3832).
+        if uri_options[:ssl].include?(nil)
+          raise_invalid_error_no_fmt!("invalid boolean value for 'tls' or 'ssl'; only 'true' and 'false' are accepted")
+        end
+
         unless uri_options[:ssl].uniq.length == 1
           raise_invalid_error_no_fmt!("all instances of 'tls' and 'ssl' must have the same value")
         end

data/lib/mongo/utils.rb

@@ -73,7 +73,7 @@ module Mongo
     # @note server_api must have symbol keys or be a BSON::Document.
     module_function def transform_server_api(server_api)
       {}.tap do |doc|
-        if version = server_api[:version]
+        if (version = server_api[:version])
           doc['apiVersion'] = version
         end
         doc['apiStrict'] = server_api[:strict] unless server_api[:strict].nil?

data/lib/mongo/version.rb

@@ -5,5 +5,5 @@ module Mongo
   #
   # Note that this file is automatically updated via `rake candidate:create`.
   # Manual changes to this file will be overwritten by that rake task.
-  VERSION = '2.24.1'
+  VERSION = '2.25.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo
 version: !ruby/object:Gem::Version
-  version: 2.24.1
+  version: 2.25.0
 platform: ruby
 authors:
 - The MongoDB Ruby Team
@@ -90,8 +90,6 @@ files:
 - lib/mongo/auth/stringprep.rb
 - lib/mongo/auth/stringprep/profiles/sasl.rb
 - lib/mongo/auth/stringprep/tables.rb
-- lib/mongo/auth/stringprep/unicode_normalize/normalize.rb
-- lib/mongo/auth/stringprep/unicode_normalize/tables.rb
 - lib/mongo/auth/user.rb
 - lib/mongo/auth/user/view.rb
 - lib/mongo/auth/x509.rb
@@ -191,6 +189,7 @@ files:
 - lib/mongo/cursor/nontailable.rb
 - lib/mongo/cursor_host.rb
 - lib/mongo/database.rb
+- lib/mongo/database/cursor_command_view.rb
 - lib/mongo/database/view.rb
 - lib/mongo/dbref.rb
 - lib/mongo/deprecations.rb
@@ -369,6 +368,9 @@ files:
 - lib/mongo/operation/create_search_indexes/op_msg.rb
 - lib/mongo/operation/create_user.rb
 - lib/mongo/operation/create_user/op_msg.rb
+- lib/mongo/operation/cursor_command.rb
+- lib/mongo/operation/cursor_command/op_msg.rb
+- lib/mongo/operation/cursor_command/result.rb
 - lib/mongo/operation/delete.rb
 - lib/mongo/operation/delete/bulk_result.rb
 - lib/mongo/operation/delete/op_msg.rb
@@ -559,7 +561,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Ruby driver for MongoDB
 test_files: []