mongo 2.23.0 → 2.24.0

data/lib/mongo/error/parser.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -15,33 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Sample error - mongo 3.4:
-# {
-#   "ok" : 0,
-#   "errmsg" : "not master",
-#   "code" : 10107,
-#   "codeName" : "NotMaster"
-# }
-#
-# Sample response with a write concern error - mongo 3.4:
-# {
-#   "n" : 1,
-#   "opTime" : {
-#     "ts" : Timestamp(1527728618, 1),
-#     "t" : NumberLong(4)
-#   },
-#   "electionId" : ObjectId("7fffffff0000000000000004"),
-#   "writeConcernError" : {
-#     "code" : 100,
-#     "codeName" : "CannotSatisfyWriteConcern",
-#     "errmsg" : "Not enough data-bearing nodes"
-#   },
-#   "ok" : 1
-# }
-
 module Mongo
   class Error
-
     # Class for parsing the various forms that errors can come in from MongoDB
     # command responses.
     #
@@ -100,14 +74,6 @@ module Mongo
 
       # Create the new parser with the returned document.
       #
-      # In legacy mode, the code and codeName fields of the document are not
-      # examined because the status (ok: 1) is not part of the document and
-      # there is no way to distinguish successful from failed responses using
-      # the document itself, and a successful response may legitimately have
-      # { code: 123, codeName: 'foo' } as the contents of a user-inserted
-      # document. The legacy server versions do not fill out code nor codeName
-      # thus not reading them does not lose information.
-      #
       # @example Create the new parser.
       #   Parser.new({ 'errmsg' => 'failed' })
       #
@@ -115,18 +81,15 @@ module Mongo
       # @param [ Array<Protocol::Message> ] replies The message replies.
       # @param [ Hash ] options The options.
       #
-      # @option options [ true | false ] :legacy Whether document and replies
-      #   are from a legacy (pre-3.2) response
-      #
       # @since 2.0.0
       def initialize(document, replies = nil, options = nil)
         @document = document || {}
         @replies = replies
         @options = if options
-          options.dup
-        else
-          {}
-        end.freeze
+                     options.dup
+                   else
+                     {}
+                   end.freeze
         parse!
       end
 
@@ -194,17 +157,15 @@ module Mongo
 
       def parse!
         if document['ok'] != 1 && document['writeErrors']
-          raise ArgumentError, "writeErrors should only be given in successful responses"
+          raise ArgumentError, 'writeErrors should only be given in successful responses'
         end
 
-        @message = +""
+        @message = +''
         parse_single(@message, '$err')
         parse_single(@message, 'err')
         parse_single(@message, 'errmsg')
         parse_multiple(@message, 'writeErrors')
-        if write_concern_error_document
-          parse_single(@message, 'errmsg', write_concern_error_document)
-        end
+        parse_single(@message, 'errmsg', write_concern_error_document) if write_concern_error_document
         parse_flag(@message)
         parse_code
         parse_labels
@@ -214,27 +175,27 @@ module Mongo
         @message = self.class.build_message(
           code: code,
           code_name: code_name,
-          message: @message,
+          message: @message
         )
       end
 
       def parse_single(message, key, doc = document)
-        if error = doc[key]
-          append(message, error)
-        end
+        return unless error = doc[key]
+
+        append(message, error)
       end
 
       def parse_multiple(message, key)
-        if errors = document[key]
-          errors.each do |error|
-            parse_single(message, 'errmsg', error)
-          end
+        return unless errors = document[key]
+
+        errors.each do |error|
+          parse_single(message, 'errmsg', error)
         end
       end
 
       def parse_flag(message)
         if replies && replies.first &&
-            (replies.first.respond_to?(:cursor_not_found?)) && replies.first.cursor_not_found?
+           replies.first.respond_to?(:cursor_not_found?) && replies.first.cursor_not_found?
           append(message, CURSOR_NOT_FOUND)
         end
       end
@@ -248,7 +209,7 @@ module Mongo
       end
 
       def parse_code
-        if document['ok'] == 1 || @options[:legacy]
+        if document['ok'] == 1
           @code = @code_name = nil
         else
           @code = document['code']
@@ -259,25 +220,22 @@ module Mongo
         # codes of the top level response with write concern error codes.
         # In practice this should never be an issue as a write concern
         # can only fail after the operation succeeds on the primary.
-        if @code.nil? && @code_name.nil?
-          if subdoc = write_concern_error_document
-            @code = subdoc['code']
-            @code_name = subdoc['codeName']
-          end
+        if @code.nil? && @code_name.nil? && (subdoc = write_concern_error_document)
+          @code = subdoc['code']
+          @code_name = subdoc['codeName']
         end
 
-        if @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
-          if write_errors = document['writeErrors']
-            codes = write_errors.map { |e| e['code'] }.compact
-            if codes.uniq.length == 1
-              @code = codes.first
-              # code name may not be returned by the server
-              @code_name = write_errors.map { |e| e['codeName'] }.compact.first
-            end
-          end
-        end
+        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']
+
+        codes = write_errors.map { |e| e['code'] }.compact
+        return unless codes.uniq.length == 1
+
+        @code = codes.first
+        # code name may not be returned by the server
+        @code_name = write_errors.map { |e| e['codeName'] }.compact.first
       end
 
       def parse_labels
@@ -286,8 +244,8 @@ module Mongo
 
       def parse_wtimeout
         @wtimeout = write_concern_error_document &&
-          write_concern_error_document['errInfo'] &&
-          write_concern_error_document['errInfo']['wtimeout']
+                    write_concern_error_document['errInfo'] &&
+                    write_concern_error_document['errInfo']['wtimeout']
       end
     end
   end

data/lib/mongo/error/pool_cleared_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-present MongoDB Inc.
 #
@@ -17,8 +16,7 @@
 
 module Mongo
   class Error
-
-    # Exception raised if an operation is attempted connection that was
+    # Exception raised if an operation is attempted on a connection that was
     # interrupted due to server monitor timeout.
     class PoolClearedError < PoolError
       include WriteRetryable

data/lib/mongo/error/pool_closed_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Exception raised if an operation is attempted on a closed connection pool.
     #
     # @since 2.9.0
     class PoolClosedError < PoolError
-
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.

data/lib/mongo/error/pool_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,10 +16,8 @@
 
 module Mongo
   class Error
-
     # Abstract base class for connection pool-related exceptions.
     class PoolError < Error
-
       # @return [ Mongo::Address ] address The address of the server the
       # pool's connections connect to.
       #

data/lib/mongo/error/pool_paused_error.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
-
     # Exception raised if an operation is attempted on a paused connection pool.
     class PoolPausedError < PoolError
       include WriteRetryable

data/lib/mongo/error/raise_original_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
-
     # This is a special marker exception class used internally in the
     # retryable reads/writes implementation. Its purpose is to bypass
     # note addition when raising the exception from the first read/write
@@ -26,7 +24,7 @@ module Mongo
     # @note This class must not derive from Error.
     #
     # @api private
-    class RaiseOriginalError < Exception
+    class RaiseOriginalError < Exception # rubocop:disable Lint/InheritException
     end
   end
 end

data/lib/mongo/error/read_write_retryable.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 indicate whether errors are
     # retryable.
     #
@@ -27,24 +25,23 @@ module Mongo
     #
     # @api semipublic
     module ReadWriteRetryable
-
       # Error codes and code names that should result in a failing write
       # being retried.
       #
       # @api private
       WRITE_RETRY_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: '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 },
       ].freeze
 
       # These are magic error messages that could indicate a master change.
@@ -80,7 +77,7 @@ module Mongo
       # @deprecated
       def retryable?
         write_retryable? ||
-        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
+          (code.nil? && RETRY_MESSAGES.any? { |m| message.include?(m) })
       end
 
       # Whether the error is a retryable error according to the modern retryable
@@ -92,7 +89,7 @@ module Mongo
       # @return [ true, false ]
       def write_retryable?
         write_retryable_code? ||
-        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
+          (code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) })
       end
 
       private def write_retryable_code?

data/lib/mongo/error/sdam_error_detection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongo
   class Error
@@ -10,15 +9,14 @@ module Mongo
     #
     # @api semipublic
     module SdamErrorDetection
-
       # @api private
-      NOT_MASTER_CODES = [10107, 13435].freeze
+      NOT_MASTER_CODES = [ 10_107, 13_435 ].freeze
 
       # @api private
-      NODE_RECOVERING_CODES = [11600, 11602, 13436, 189, 91, 10058].freeze
+      NODE_RECOVERING_CODES = [ 11_600, 11_602, 13_436, 189, 91, 10_058 ].freeze
 
       # @api private
-      NODE_SHUTTING_DOWN_CODES = [11600, 91].freeze
+      NODE_SHUTTING_DOWN_CODES = [ 11_600, 91 ].freeze
 
       # Whether the error is a "not master" error, or one of its variants.
       #

data/lib/mongo/error/server_api_conflict.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
-
     # Exception raised when a Client has :server_api configured and an
     # operation attempts to specify any of server API version parameters.
     class ServerApiConflict < Error

data/lib/mongo/error/server_certificate_revoked.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
-
     # Server certificate has been revoked (determined via OCSP).
     class ServerCertificateRevoked < Error
     end

data/lib/mongo/error/server_not_usable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -23,7 +22,6 @@ module Mongo
     # Exception raised if an unknown server is attempted to be used for
     # an operation.
     class ServerNotUsable < Error
-
       # Instantiate the new exception.
       #
       # @api private

data/lib/mongo/error/session_ended.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,13 +16,12 @@
 
 module Mongo
   class Error
-
     # Session was previously ended.
     #
     # @since 2.7.0
     class SessionEnded < Error
       def initialize
-        super("The session was ended and cannot be used")
+        super('The session was ended and cannot be used')
       end
     end
   end

data/lib/mongo/error/session_not_materialized.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2022 MongoDB Inc.
 #
@@ -17,12 +16,11 @@
 
 module Mongo
   class Error
-
     # This exception is raised when a session is attempted to be used but
     # it was never materialized.
     class SessionNotMaterialized < InvalidSession
       def initialize
-        super("The session was not materialized and cannot be used. Use start_session or with_session in order to start a session that will be materialized.")
+        super('The session was not materialized and cannot be used. Use start_session or with_session in order to start a session that will be materialized.')
       end
     end
   end

data/lib/mongo/error/sessions_not_supported.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,21 +16,19 @@
 
 module Mongo
   class Error
-
     # This exception is raised when a session is attempted to be used and the
     # deployment does not support sessions.
     #
     # @note The subclassing of InvalidSession only exists for backwards
     #   compatibility and will be removed in driver version 3.0.
     class SessionsNotSupported < InvalidSession
-
       # Create the new exception.
       #
       # @param [ String ] message The error message.
       #
       # @api private
       def initialize(message)
-        super(message)
+        super
       end
     end
   end

data/lib/mongo/error/snapshot_session_invalid_server_version.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,14 +16,12 @@
 
 module Mongo
   class Error
-
     # Exception raised if an operation using a snapshot session is
     # directed to a pre-5.0 server.
     class SnapshotSessionInvalidServerVersion < Error
-
       # Instantiate the new exception.
       def initialize
-        super("Snapshot reads require MongoDB 5.0 or later")
+        super('Snapshot reads require MongoDB 5.0 or later')
       end
     end
   end

data/lib/mongo/error/snapshot_session_transaction_prohibited.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   class Error
-
     # Exception raised if a transaction is attempted on a snapshot session.
     class SnapshotSessionTransactionProhibited < Error
-
       # Instantiate the new exception.
       def initialize
-        super("Transactions are not supported in snapshot sessions")
+        super('Transactions are not supported in snapshot sessions')
       end
     end
   end

data/lib/mongo/error/socket_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when a socket has an error.
     #
     # @since 2.0.0

data/lib/mongo/error/socket_timeout_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'mongo/error/timeout_error'
 
 module Mongo
   class Error
-
     # Raised when a socket connection times out.
     #
     # @since 2.0.0

data/lib/mongo/error/transactions_not_supported.rb

@@ -16,13 +16,10 @@
 
 module Mongo
   class Error
-    # Transactions are not supported by the cluster. There might be the
-    # following reasons:
-    #  - topology is standalone
-    #  - topology is replica set and server version is < 4.0
-    #  - topology is sharded and server version is < 4.2
+    # Transactions are not supported by the cluster, e.g. if the topology is
+    # standalone.
     #
-    # @param [ String ] reason The reason why transactions are no supported.
+    # @param [ String ] reason The reason why transactions are not supported.
     #
     # @since 2.7.0
     class TransactionsNotSupported < Error

data/lib/mongo/error/unchangeable_collection_option.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 a new collection is created from an existing one and options other than the
     # changeable ones are provided.
     #
     # @since 2.1.0
     class UnchangeableCollectionOption < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.
@@ -34,7 +31,7 @@ module Mongo
       # @since 2.1.0
       def initialize(option)
         super("The option #{option} cannot be set on a new collection instance." +
-                  " The options that can be updated are #{Collection::CHANGEABLE_OPTIONS}")
+          " The options that can be updated are #{Collection::CHANGEABLE_OPTIONS}")
       end
     end
   end

data/lib/mongo/error/unexpected_chunk_length.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 length.
     #
     # @since 2.1.0
     class UnexpectedChunkLength < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.

data/lib/mongo/error/unexpected_response.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 the response read from the socket does not match the latest query.
     #
     # @since 2.2.6
     class UnexpectedResponse < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.
@@ -34,7 +31,7 @@ module Mongo
       # @since 2.2.6
       def initialize(expected_response_to, response_to)
         super("Unexpected response. Got response for request ID #{response_to} " +
-              "but expected response for request ID #{expected_response_to}")
+          "but expected response for request ID #{expected_response_to}")
       end
     end
   end