mongo 2.23.0 → 2.24.1

data/lib/mongo/error/invalid_update_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,16 +16,14 @@
 
 module Mongo
   class Error
-
     # Exception raised if the object is not a valid update document.
     #
     # @since 2.0.0
     class InvalidUpdateDocument < Error
-
       # The error message.
       #
       # @deprecated
-      MESSAGE = 'Invalid update document provided'.freeze
+      MESSAGE = 'Invalid update document provided'
 
       # Construct the error message.
       #
@@ -36,7 +33,7 @@ module Mongo
       #
       # @api private
       def self.message(key)
-        message = "Invalid update document provided. Updates documents must only "
+        message = 'Invalid update document provided. Update documents must only '
         message += "contain only atomic modifiers. The \"#{key}\" key is invalid."
         message
       end

data/lib/mongo/error/invalid_uri.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   class Error
-
     # Exception that is raised when trying to parse a URI that does not match
     # the specification.
     #
     # @since 2.0.0
     class InvalidURI < Error
-
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
@@ -32,7 +29,7 @@ module Mongo
       # @since 2.0.0
       def initialize(uri, details, format = nil)
         message = "Bad URI: #{uri}\n" +
-                    "#{details}\n"
+                  "#{details}\n"
         message += "MongoDB URI must be in the following format: #{format}\n" if format
         message += "Please see the following URL for more information: #{Mongo::URI::HELP}\n"
         super(message)

data/lib/mongo/error/invalid_write_concern.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Raised when an invalid write concern is provided.
     #
     # @since 2.2.0
     class InvalidWriteConcern < Error
-
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
@@ -30,8 +27,8 @@ module Mongo
       #
       # @since 2.2.0
       def initialize(msg = nil)
-        super(msg || 'Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
-              'If w is 0, it cannot be combined with a true value for fsync or j (journal).')
+        super(msg || ('Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
+          'If w is 0, it cannot be combined with a true value for fsync or j (journal).'))
       end
     end
   end

data/lib/mongo/error/kms_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # A KMS-related error during client-side encryption.
     class KmsError < CryptError
       def initialize(message, code: nil, network_error: nil)

data/lib/mongo/error/labelable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2022 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # A module encapsulating functionality to manage labels added to errors.
     #
     # @note Although methods of this module are part of the public API,
@@ -26,7 +24,6 @@ module Mongo
     #
     # @api semipublic
     module Labelable
-
       # Does the error have the given label?
       #
       # @example

data/lib/mongo/error/lint_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the driver is used incorrectly.
     #
     # Normally the driver passes certain data to the server and lets the

data/lib/mongo/error/max_bson_size.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,17 +16,15 @@
 
 module Mongo
   class Error
-
     # Exception that is raised when trying to serialize a document that
     # exceeds max BSON object size.
     #
     # @since 2.0.0
     class MaxBSONSize < Error
-
       # The message is constant.
       #
       # @since 2.0.0
-      MESSAGE = "The document exceeds maximum allowed BSON size".freeze
+      MESSAGE = 'The document exceeds maximum allowed BSON size'
 
       # Instantiate the new exception.
       #
@@ -40,13 +37,13 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(max_size_or_msg = nil)
-        if max_size_or_msg.is_a?(Numeric)
-          msg = "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
-        elsif max_size_or_msg
-          msg = max_size_or_msg
-        else
-          msg = MESSAGE
-        end
+        msg = if max_size_or_msg.is_a?(Numeric)
+                "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
+              elsif max_size_or_msg
+                max_size_or_msg
+              else
+                MESSAGE
+              end
         super(msg)
       end
     end

data/lib/mongo/error/max_message_size.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,17 +16,15 @@
 
 module Mongo
   class Error
-
     # Exception that is raised when trying to send a message that exceeds max
     # message size.
     #
     # @since 2.0.0
     class MaxMessageSize < Error
-
       # The message is constant.
       #
       # @since 2.0.0
-      MESSAGE = "Message exceeds allowed max message size.".freeze
+      MESSAGE = 'Message exceeds allowed max message size.'
 
       # Instantiate the new exception.
       #
@@ -38,7 +35,7 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(max_size = nil)
-        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+        super(max_size ? MESSAGE + " The max is #{max_size}." : MESSAGE)
       end
     end
   end

data/lib/mongo/error/mismatched_domain.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # This exception is raised when the URI Parser's DNS query returns SRV record(s)
     #   whose parent domain does not match the hostname used for the query.
     #

data/lib/mongo/error/missing_connection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2022 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Exception raised when trying to check out a connection with a specific
     # global id, and the connection for that global id no longer exists in the
     # pool.

data/lib/mongo/error/missing_file_chunk.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   class Error
-
     # Raised if the next chunk when reading from a GridFSBucket does not have the
     # expected sequence number (n).
     #
     # @since 2.1.0
     class MissingFileChunk < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.

data/lib/mongo/error/missing_password.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the operations that require a password (e.g. retrieving
     # a salted or hashed password) are attempted on a User object that was
     # not created with a password.

data/lib/mongo/error/missing_resume_token.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -17,16 +16,14 @@
 
 module Mongo
   class Error
-
     # Raised if a change stream document is returned without a resume token.
     #
     # @since 2.5.0
     class MissingResumeToken < Error
-
       # The error message.
       #
       # @since 2.5.0
-      MESSAGE = 'Cannot provide resume functionality when the resume token is missing'.freeze
+      MESSAGE = 'Cannot provide resume functionality when the resume token is missing'
 
       # Create the new exception.
       #

data/lib/mongo/error/missing_scram_server_signature.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,13 +16,12 @@
 
 module Mongo
   class Error
-
     # This exception is raised when the server returned +{done: true}+ in a
     # SCRAM conversation but did not provide a ServerSignature.
     class MissingScramServerSignature < Error
       def initialize(msg = nil)
-        msg ||= "Server signaled completion of SCRAM conversation without providing ServerSignature"
-        super(msg)
+        msg ||= 'Server signaled completion of SCRAM conversation without providing ServerSignature'
+        super
       end
     end
   end

data/lib/mongo/error/missing_service_id.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the driver is in load-balancing mode via the URI option
     # but a connection does not report a value in the serviceId field.
     class MissingServiceId < Error

data/lib/mongo/error/mongocryptd_spawn_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # An error related to spawning mongocryptd for client-side encryption.
     class MongocryptdSpawnError < CryptError
     end

data/lib/mongo/error/multi_index_drop.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Exception raised if '*' is passed to drop_one on indexes.
     #
     # @since 2.0.0
     class MultiIndexDrop < Error
-
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.

data/lib/mongo/error/need_primary_server.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when a primary server is needed but not found.
     #
     # @since 2.0.0

data/lib/mongo/error/no_server_available.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Raised if there are no servers available matching the preference.
     #
     # @since 2.0.0
     class NoServerAvailable < Error
-
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
@@ -34,14 +31,12 @@ module Mongo
       #   performed on. (added in 2.7.0)
       #
       # @since 2.0.0
-      def initialize(server_selector, cluster=nil, msg=nil)
+      def initialize(server_selector, cluster = nil, msg = nil)
         unless msg
           msg = "No #{server_selector.name} server is available"
-          if cluster
-            msg += " in cluster: #{cluster.summary}"
-          end
+          msg += " in cluster: #{cluster.summary}" if cluster
           msg += " with timeout=#{server_selector.server_selection_timeout}, " +
-            "LT=#{server_selector.local_threshold}"
+                 "LT=#{server_selector.local_threshold}"
         end
 
         super(msg)

data/lib/mongo/error/no_service_connection_available.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the driver requires a connection to a particular service
     # but no matching connections exist in the connection pool.
     class NoServiceConnectionAvailable < Error
@@ -41,7 +39,7 @@ module Mongo
         new(
           "The connection pool for #{address} does not have a connection for service #{service_id}",
           address: address,
-          service_id: service_id,
+          service_id: service_id
         )
       end
     end

data/lib/mongo/error/no_srv_records.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # This exception is raised when the URI Parser's DNS query returns no SRV records.
     #
     # @example Instantiate the exception.

data/lib/mongo/error/notable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error < StandardError
-
     # A module encapsulating functionality to manage data attached to
     # exceptions in the driver, since the driver does not currently have a
     # single exception hierarchy root.
@@ -25,7 +23,6 @@ module Mongo
     # @since 2.11.0
     # @api private
     module Notable
-
       # Returns an array of strings with additional information about the
       # exception.
       #
@@ -43,17 +40,14 @@ module Mongo
 
       # @api private
       def add_note(note)
-        unless @notes
-          @notes = []
-        end
-        if Lint.enabled?
-          if @notes.include?(note)
-            # The driver makes an effort to not add duplicated notes, by
-            # keeping track of *when* a particular exception should have the
-            # particular notes attached to it throughout the call stack.
-            raise Error::LintError, "Adding a note which already exists in exception #{self}: #{note}"
-          end
+        @notes ||= []
+        if Lint.enabled? && @notes.include?(note)
+          # The driver makes an effort to not add duplicated notes, by
+          # keeping track of *when* a particular exception should have the
+          # particular notes attached to it throughout the call stack.
+          raise Error::LintError, "Adding a note which already exists in exception #{self}: #{note}"
         end
+
         @notes << note
       end
 
@@ -94,9 +88,7 @@ module Mongo
       # @api private
       def notes_tail
         msg = ''
-        unless notes.empty?
-          msg += " (#{notes.join(', ')})"
-        end
+        msg += " (#{notes.join(', ')})" unless notes.empty?
         msg
       end
     end

data/lib/mongo/error/operation_failure.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -54,29 +53,33 @@ 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.
         #
         # @api private
         CHANGE_STREAM_RESUME_ERRORS = [
-          {code_name: 'HostUnreachable', code: 6},
-          {code_name: 'HostNotFound', code: 7},
-          {code_name: 'NetworkTimeout', code: 89},
-          {code_name: 'ShutdownInProgress', code: 91},
-          {code_name: 'PrimarySteppedDown', code: 189},
-          {code_name: 'ExceededTimeLimit', code: 262},
-          {code_name: 'SocketException', code: 9001},
-          {code_name: 'NotMaster', code: 10107},
-          {code_name: 'InterruptedAtShutdown', code: 11600},
-          {code_name: 'InterruptedDueToReplStateChange', code: 11602},
-          {code_name: 'NotPrimaryNoSecondaryOk', code: 13435},
-          {code_name: 'NotMasterOrSecondary', code: 13436},
-
-          {code_name: 'StaleShardVersion', code: 63},
-          {code_name: 'FailedToSatisfyReadPreference', code: 133},
-          {code_name: 'StaleEpoch', code: 150},
-          {code_name: 'RetryChangeStream', code: 234},
-          {code_name: 'StaleConfig', code: 13388},
+          { code_name: 'HostUnreachable', code: 6 },
+          { code_name: 'HostNotFound', code: 7 },
+          { code_name: 'NetworkTimeout', code: 89 },
+          { code_name: 'ShutdownInProgress', code: 91 },
+          { code_name: 'PrimarySteppedDown', code: 189 },
+          { code_name: 'ExceededTimeLimit', code: 262 },
+          { code_name: 'SocketException', code: 9001 },
+          { code_name: 'NotMaster', code: 10_107 },
+          { code_name: 'InterruptedAtShutdown', code: 11_600 },
+          { code_name: 'InterruptedDueToReplStateChange', code: 11_602 },
+          { code_name: 'NotPrimaryNoSecondaryOk', code: 13_435 },
+          { code_name: 'NotMasterOrSecondary', code: 13_436 },
+
+          { code_name: 'StaleShardVersion', code: 63 },
+          { code_name: 'FailedToSatisfyReadPreference', code: 133 },
+          { code_name: 'StaleEpoch', code: 150 },
+          { code_name: 'RetryChangeStream', code: 234 },
+          { code_name: 'StaleConfig', code: 13_388 },
         ].freeze
 
         # Change stream can be resumed when these error messages are encountered.
@@ -173,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
@@ -186,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]
@@ -219,20 +225,6 @@ module Mongo
           code == 50 # MaxTimeMSExpired
         end
 
-        # Whether the error is caused by an attempted retryable write
-        # on a storage engine that does not support retryable writes.
-        #
-        # @return [ true | false ] Whether the error is caused by an attempted
-        # retryable write on a storage engine that does not support retryable writes.
-        #
-        # @since 2.10.0
-        def unsupported_retryable_write?
-          # code 20 is IllegalOperation.
-          # Note that the document is expected to be a BSON::Document, thus
-          # either having string keys or providing indifferent access.
-          code == 20 && server_message&.start_with?("Transaction numbers") || false
-        end
-
         private
 
         # Retrieve the details from a document
@@ -240,10 +232,11 @@ module Mongo
         # @return [ Hash | nil ] the details extracted from the document
         def retrieve_details(document)
           return nil unless document
+
           if wce = document['writeConcernError']
-            return wce['errInfo']
+            wce['errInfo']
           elsif we = document['writeErrors']&.first
-            return we['errInfo']
+            we['errInfo']
           end
         end
 
@@ -252,8 +245,41 @@ module Mongo
         # @return [ String ] the message with the details appended to it
         def append_details(message, details)
           return message unless details && message
+
           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