mongo 2.10.5 → 2.15.1

data/lib/mongo/error/operation_failure.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,17 +31,18 @@ module Mongo
       # @since 2.6.0
       # @api private
       WRITE_RETRY_ERRORS = [
-        {:code_name => 'InterruptedAtShutdown', :code => 11600},
-        {:code_name => 'InterruptedDueToStepDown', :code => 11602},
-        {:code_name => 'NotMaster', :code => 10107},
-        {:code_name => 'NotMasterNoSlaveOk', :code => 13435},
-        {:code_name => 'NotMasterOrSecondary', :code => 13436},
-        {:code_name => 'PrimarySteppedDown', :code => 189},
-        {:code_name => 'ShutdownInProgress', :code => 91},
-        {:code_name => 'HostNotFound', :code => 7},
         {: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},
       ].freeze
 
       # These are magic error messages that could indicate a master change.
@@ -70,6 +74,14 @@ module Mongo
 
       def_delegators :@result, :operation_time
 
+      # @!method connection_description
+      #
+      # @return [ Server::Description ] Server description of the server that
+      #   the operation that this exception refers to was performed on.
+      #
+      # @api private
+      def_delegator :@result, :connection_description
+
       # @return [ Integer ] The error code parsed from the document.
       #
       # @since 2.6.0
@@ -80,6 +92,12 @@ module Mongo
       # @since 2.6.0
       attr_reader :code_name
 
+      # @return [ String ] The server-returned error message
+      #   parsed from the response.
+      #
+      # @api experimental
+      attr_reader :server_message
+
       # Whether the error is a retryable error according to the legacy
       # read retry logic.
       #
@@ -88,7 +106,8 @@ module Mongo
       # @since 2.1.1
       # @deprecated
       def retryable?
-        write_retryable? || RETRY_MESSAGES.any?{ |m| message.include?(m) }
+        write_retryable? ||
+        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
       end
 
       # Whether the error is a retryable error according to the modern retryable
@@ -101,11 +120,11 @@ module Mongo
       #
       # @since 2.4.2
       def write_retryable?
-        WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) } ||
-        write_retryable_code?
+        write_retryable_code? ||
+        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
       end
 
-      def write_retryable_code?
+      private def write_retryable_code?
         if code
           WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
         else
@@ -113,17 +132,30 @@ module Mongo
           false
         end
       end
-      private :write_retryable_code?
 
       # Error codes and code names that should result in a failing getMore
       # command on a change stream NOT being resumed.
       #
-      # @since 2.6.0
       # @api private
-      CHANGE_STREAM_NOT_RESUME_ERRORS = [
-        {:code_name => 'CappedPositionLost', :code => 136},
-        {:code_name => 'CursorKilled', :code => 237},
-        {:code_name => 'Interrupted', :code => 11601},
+      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},
       ].freeze
 
       # Change stream can be resumed when these error messages are encountered.
@@ -143,61 +175,60 @@ module Mongo
       # @since 2.6.0
       def change_stream_resumable?
         if @result && @result.is_a?(Mongo::Operation::GetMore::Result)
-          !change_stream_not_resumable_label? &&
-          (change_stream_resumable_message? ||
-          change_stream_resumable_code?)
+          # CursorNotFound exceptions are always resumable because the server
+          # is not aware of the cursor id, and thus cannot determine if
+          # the cursor is a change stream and cannot add the
+          # ResumableChangeStreamError label.
+          return true if code == 43
+
+          # Connection description is not populated for unacknowledged writes.
+          if connection_description.max_wire_version >= 9
+            label?('ResumableChangeStreamError')
+          else
+            change_stream_resumable_code?
+          end
         else
           false
         end
       end
 
-      def change_stream_resumable_message?
-        CHANGE_STREAM_RESUME_MESSAGES.any? { |m| message.include?(m) }
-      end
-      private :change_stream_resumable_message?
-
       def change_stream_resumable_code?
-        if code
-          !CHANGE_STREAM_NOT_RESUME_ERRORS.any? { |e| e[:code] == code }
-        else
-          true
-        end
+        CHANGE_STREAM_RESUME_ERRORS.any? { |e| e[:code] == code }
       end
       private :change_stream_resumable_code?
 
-      def change_stream_not_resumable_label?
-        if labels
-          labels.include? 'NonResumableChangeStreamError'
-        else
-          false
-        end
-      end
-      private :change_stream_not_resumable_label?
-
       # @return [ true | false ] Whether the failure includes a write
       #   concern error. A failure may have a top level error and a write
       #   concern error or either one of the two.
       #
       # @since 2.10.0
-      # @api experimental
       def write_concern_error?
-        @write_concern_error
+        !!@write_concern_error_document
       end
 
+      # Returns the write concern error document as it was reported by the
+      # server, if any.
+      #
+      # @return [ Hash | nil ] Write concern error as reported to the server.
+      attr_reader :write_concern_error_document
+
       # @return [ Integer | nil ] The error code for the write concern error,
       #   if a write concern error is present and has a code.
       #
       # @since 2.10.0
-      # @api experimental
       attr_reader :write_concern_error_code
 
       # @return [ String | nil ] The code name for the write concern error,
       #   if a write concern error is present and has a code name.
       #
       # @since 2.10.0
-      # @api experimental
       attr_reader :write_concern_error_code_name
 
+      # @return [ BSON::Document | nil ] The server-returned error document.
+      #
+      # @api experimental
+      attr_reader :document
+
       # Create the operation failure.
       #
       # @example Create the error object
@@ -212,12 +243,18 @@ module Mongo
       #
       # @option options [ Integer ] :code Error code.
       # @option options [ String ] :code_name Error code name.
-      # @option options [ true | false ] :write_concern_error Whether the
-      #   write concern error is present.
+      # @option options [ BSON::Document ] :document The server-returned
+      #   error document.
+      # @option options [ String ] server_message The server-returned
+      #   error message parsed from the response.
+      # @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
       #   write concern error, if any.
       # @option options [ String ] :write_concern_error_code_name Error code
       #   name for write concern error, if any.
+      # @option options [ Array<String> ] :write_concern_error_labels Error
+      #   labels for the write concern error, if any.
       # @option options [ Array<String> ] :labels The set of labels associated
       #   with the error.
       # @option options [ true | false ] :wtimeout Whether the error is a wtimeout.
@@ -228,11 +265,14 @@ module Mongo
         @result = result
         @code = options[:code]
         @code_name = options[:code_name]
-        @write_concern_error = !!options[:write_concern_error]
+        @write_concern_error_document = options[:write_concern_error_document]
         @write_concern_error_code = options[:write_concern_error_code]
         @write_concern_error_code_name = options[:write_concern_error_code_name]
+        @write_concern_error_labels = options[:write_concern_error_labels] || []
         @labels = options[:labels] || []
         @wtimeout = !!options[:wtimeout]
+        @document = options[:document]
+        @server_message = options[:server_message]
       end
 
       # Whether the error is a write concern timeout.
@@ -261,8 +301,10 @@ module Mongo
       #
       # @since 2.10.0
       def unsupported_retryable_write?
-        # code 20 is IllegalOperation
-        code == 20 && message.start_with?("Transaction numbers")
+        # 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
     end
   end

data/lib/mongo/error/parser.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -42,28 +45,53 @@ module Mongo
     # Class for parsing the various forms that errors can come in from MongoDB
     # command responses.
     #
+    # The errors can be reported by the server in a number of ways:
+    # - {ok:0} response indicates failure. In newer servers, code, codeName
+    #   and errmsg fields should be set. In older servers some may not be set.
+    # - {ok:1} response with a write concern error (writeConcernError top-level
+    #   field). This indicates that the node responding successfully executed
+    #   the request, but not enough other nodes successfully executed the
+    #   request to satisfy the write concern.
+    # - {ok:1} response with writeErrors top-level field. This can be obtained
+    #   in a bulk write but also in a non-bulk write. In a non-bulk write
+    #   there should be exactly one error in the writeErrors list.
+    #   The case of multiple errors is handled by BulkWrite::Result.
+    # - {ok:1} response with writeConcernErrors top-level field. This can
+    #   only be obtained in a bulk write and is handled by BulkWrite::Result,
+    #   not by this class.
+    #
+    # Note that writeErrors do not have codeName fields - they just provide
+    # codes and messages. writeConcernErrors may similarly not provide code
+    # names.
+    #
     # @since 2.0.0
+    # @api private
     class Parser
       include SdamErrorDetection
 
-      # @return [ BSON::Document ] document The returned document.
+      # @return [ BSON::Document ] The returned document.
       attr_reader :document
 
-      # @return [ String ] message The error message parsed from the document.
+      # @return [ String ] The full error message to be used in the
+      #   raised exception.
       attr_reader :message
 
-      # @return [ Array<Protocol::Message> ] replies The message replies.
+      # @return [ String ] The server-returned error message
+      #   parsed from the response.
+      attr_reader :server_message
+
+      # @return [ Array<Protocol::Message> ] The message replies.
       attr_reader :replies
 
-      # @return [ Integer ] code The error code parsed from the document.
+      # @return [ Integer ] The error code parsed from the document.
       # @since 2.6.0
       attr_reader :code
 
-      # @return [ String ] code_name The error code name parsed from the document.
+      # @return [ String ] The error code name parsed from the document.
       # @since 2.6.0
       attr_reader :code_name
 
-      # @return [ Array<String> ] labels The set of labels associated with the error.
+      # @return [ Array<String> ] The set of labels associated with the error.
       # @since 2.7.0
       attr_reader :labels
 
@@ -76,7 +104,7 @@ module Mongo
       # 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
+      # { 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.
       #
@@ -112,6 +140,15 @@ module Mongo
         !!write_concern_error_document
       end
 
+      # Returns the write concern error document as it was reported by the
+      # server, if any.
+      #
+      # @return [ Hash | nil ] Write concern error as reported to the server.
+      # @api experimental
+      def write_concern_error_document
+        document['writeConcernError']
+      end
+
       # @return [ Integer | nil ] The error code for the write concern error,
       #   if a write concern error is present and has a code.
       #
@@ -130,37 +167,67 @@ module Mongo
         write_concern_error_document && write_concern_error_document['codeName']
       end
 
-      private
+      # @return [ Array<String> | nil ] The error labels associated with this
+      # write concern error, if there is a write concern error present.
+      def write_concern_error_labels
+        write_concern_error_document && write_concern_error_document['errorLabels']
+      end
 
-      def write_concern_error_document
-        document['writeConcernError']
+      class << self
+        def build_message(code: nil, code_name: nil, message: nil)
+          if code_name && code
+            "[#{code}:#{code_name}]: #{message}"
+          elsif code_name
+            # This surely should never happen, if there's a code name
+            # there ought to also be the code provided.
+            # Handle this case for completeness.
+            "[#{code_name}]: #{message}"
+          elsif code
+            "[#{code}]: #{message}"
+          else
+            message
+          end
+        end
       end
 
+      private
+
       def parse!
-        @message = ""
-        parse_single(@message, ERR)
-        parse_single(@message, ERROR)
-        parse_single(@message, ERRMSG)
+        if document['ok'] != 1 && document['writeErrors']
+          raise ArgumentError, "writeErrors should only be given in successful responses"
+        end
+
+        @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)
+          parse_single(@message, 'errmsg', write_concern_error_document)
         end
         parse_flag(@message)
         parse_code
         parse_labels
         parse_wtimeout
+
+        @server_message = @message
+        @message = self.class.build_message(
+          code: code,
+          code_name: code_name,
+          message: @message,
+        )
       end
 
       def parse_single(message, key, doc = document)
         if error = doc[key]
-          append(message ,"#{error} (#{doc[CODE]})")
+          append(message, error)
         end
       end
 
       def parse_multiple(message, key)
         if errors = document[key]
           errors.each do |error|
-            parse_single(message, ERRMSG, error)
+            parse_single(message, 'errmsg', error)
           end
         end
       end

data/lib/mongo/error/pool_closed_error.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,17 +29,24 @@ module Mongo
       # @since 2.9.0
       attr_reader :address
 
+      # @return [ Mongo::Server::ConnectionPool ] pool The pool that is closed.
+      #
+      # @since 2.11.0
+      # @api experimental
+      attr_reader :pool
+
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
-      #   Mongo::Error::PoolClosedError.new(address)
+      #   Mongo::Error::PoolClosedError.new(address, pool)
       #
       # @since 2.9.0
       # @api private
-      def initialize(address)
+      def initialize(address, pool)
         @address = address
-
-        super("Attempted to use a connection pool which has been closed (for #{address})")
+        @pool = pool
+        super("Attempted to use a connection pool which has been closed (for #{address} " +
+            "with pool 0x#{pool.object_id})")
       end
     end
   end

data/lib/mongo/error/raise_original_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 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
+  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
+    # attempt.
+    #
+    # @note This class must not derive from Error.
+    #
+    # @api private
+    class RaiseOriginalError < Exception
+    end
+  end
+end

data/lib/mongo/error/sdam_error_detection.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongo
   class Error
     # @note Although not_master? and node_recovering? methods of this module
@@ -12,7 +15,7 @@ module Mongo
       NOT_MASTER_CODES = [10107, 13435].freeze
 
       # @api private
-      NODE_RECOVERING_CODES = [11600, 11602, 13436, 189, 91].freeze
+      NODE_RECOVERING_CODES = [11600, 11602, 13436, 189, 91, 10058].freeze
 
       # @api private
       NODE_SHUTTING_DOWN_CODES = [11600, 91].freeze
@@ -25,10 +28,14 @@ module Mongo
       #
       # @since 2.8.0
       def not_master?
+        # 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
+
         if node_recovering?
           false
-        elsif code && NOT_MASTER_CODES.include?(code)
-          true
+        elsif code
+          NOT_MASTER_CODES.include?(code)
         elsif message
           message.include?('not master')
         else
@@ -44,8 +51,12 @@ module Mongo
       #
       # @since 2.8.0
       def node_recovering?
-        if code && NODE_RECOVERING_CODES.include?(code)
-          true
+        # 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
+
+        if code
+          NODE_RECOVERING_CODES.include?(code)
         elsif message
           message.include?('node is recovering') || message.include?('not master or secondary')
         else

data/lib/mongo/error/server_api_conflict.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 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
+  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
+    end
+  end
+end

data/lib/mongo/error/server_api_not_supported.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 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
+  class Error
+
+    # Exception raised when a Client has :server_api configured and an
+    # operation is executed against a pre-3.6 MongoDB server using a legacy
+    # wire protocol message that does not permit sending API parameters.
+    class ServerApiNotSupported < Error
+    end
+  end
+end

data/lib/mongo/error/server_certificate_revoked.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 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
+  class Error
+
+    # Server certificate has been revoked (determined via OCSP).
+    class ServerCertificateRevoked < Error
+    end
+  end
+end

data/lib/mongo/error/session_ended.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/sessions_not_supported.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 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
+  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)
+      end
+    end
+  end
+end