mongo 2.12.4 → 2.13.0

data/lib/mongo/error/operation_failure.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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,18 +28,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 => 'ExceededTimeLimit', :code => 262}
+        {:code_name => 'NotMaster', :code => 10107},
+        {:code_name => 'InterruptedAtShutdown', :code => 11600},
+        {:code_name => 'InterruptedDueToReplStateChange', :code => 11602},
+        {:code_name => 'NotMasterNoSlaveOk', :code => 13435},
+        {:code_name => 'NotMasterOrSecondary', :code => 13436},
       ].freeze
 
       # These are magic error messages that could indicate a master change.
@@ -71,6 +71,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
@@ -89,8 +97,7 @@ module Mongo
       # @since 2.1.1
       # @deprecated
       def retryable?
-        write_retryable? ||
-        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
+        write_retryable? || RETRY_MESSAGES.any?{ |m| message.include?(m) }
       end
 
       # Whether the error is a retryable error according to the modern retryable
@@ -103,11 +110,11 @@ module Mongo
       #
       # @since 2.4.2
       def write_retryable?
-        write_retryable_code? ||
-        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
+        WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) } ||
+        write_retryable_code?
       end
 
-      private def write_retryable_code?
+      def write_retryable_code?
         if code
           WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
         else
@@ -115,16 +122,31 @@ 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: 'NotMasterNoSlaveOk', 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.
@@ -144,59 +166,53 @@ 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
 
       # Create the operation failure.
@@ -213,12 +229,14 @@ 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 [ 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.
@@ -229,9 +247,10 @@ 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]
       end

data/lib/mongo/error/parser.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.
@@ -112,6 +112,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,12 +139,14 @@ module Mongo
         write_concern_error_document && write_concern_error_document['codeName']
       end
 
-      private
-
-      def write_concern_error_document
-        document['writeConcernError']
+      # @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
 
+      private
+
       def parse!
         @message = ""
         parse_single(@message, ERR)

data/lib/mongo/error/pool_closed_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# 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/raise_original_error.rb

@@ -0,0 +1,29 @@
+# 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/session_ended.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# 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,35 @@
+# 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

data/lib/mongo/error/socket_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/error/socket_timeout_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/error/unchangeable_collection_option.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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/unexpected_chunk_length.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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/unexpected_response.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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/unknown_payload_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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/unsupported_array_filters.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -19,7 +19,12 @@ module Mongo
     # selected does not support array filters.
     #
     # @since 2.5.0
-    class UnsupportedArrayFilters < Error
+    #
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    #   replaced with UnsupportedOption. To handle this error, catch
+    #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
+    #   in your application when upgrading to version 3.0 of the driver.
+    class UnsupportedArrayFilters < UnsupportedOption
 
       # The default error message describing that array filters are not supported.
       #

data/lib/mongo/error/unsupported_collation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -19,7 +19,12 @@ module Mongo
     # support collations.
     #
     # @since 2.4.0
-    class UnsupportedCollation < Error
+    #
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    #   replaced with UnsupportedOption. To handle this error, catch
+    #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
+    #   in your application when upgrading to version 3.0 of the driver.
+    class UnsupportedCollation < UnsupportedOption
 
       # The default error message describing that collations is not supported.
       #

data/lib/mongo/error/unsupported_features.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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/unsupported_message_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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/unsupported_option.rb

@@ -0,0 +1,99 @@
+# 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
+
+    # Raised if an unsupported option is specified for an operation.
+    class UnsupportedOption < Error
+      # @api private
+      #
+      # 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.
+      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"
+
+      # @api private
+      #
+      # The error message provided when the user passes the hint option to
+      # an unacknowledged write operation.
+      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 }"
+
+      # @api private
+      #
+      # 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.
+      ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
+        "not support the allow_disk_use option on this command. The " \
+        "allow_disk_use option is supported on find commands on MongoDB " \
+        "server versions 4.4 and later"
+
+      # @api private
+      #
+      # The error message provided when the user passes the commit_quorum option
+      # to a createIndexes operation against a server that does not support
+      # that option.
+      COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
+        "not support the commit_quorum option on this command. The commit_quorum " \
+        "option is supported on createIndexes commands on MongoDB server versions " \
+        "4.4 and later"
+
+      # Raise an error about an unsupported hint option.
+      #
+      # @param [ Hash ] options
+      #
+      # @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.
+      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.
+      #
+      # @param [ Hash ] options
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      def self.allow_disk_use_error
+        new(ALLOW_DISK_USE_MESSAGE)
+      end
+
+      # Raise an error about an unsupported commit_quorum option.
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      def self.commit_quorum_error
+        new(COMMIT_QUORUM_MESSAGE)
+      end
+    end
+  end
+end