mongo 2.5.3 → 2.6.0

data/lib/mongo/error/invalid_transaction_operation.rb

@@ -0,0 +1,82 @@
+# Copyright (C) 2014-2018 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 if an invalid operation is attempted as part of a transaction.
+    #
+    # @since 2.6.0
+    class InvalidTransactionOperation < Error
+
+      # The error message for when a user attempts to commit or abort a transaction when none is in
+      # progress.
+      #
+      # @since 2.6.0
+      NO_TRANSACTION_STARTED = 'no transaction started'.freeze
+
+      # The error message for when a user attempts to start a transaction when one is already in
+      # progress.
+      #
+      # @since 2.6.0.
+      TRANSACTION_ALREADY_IN_PROGRESS = 'transaction already in progress'.freeze
+
+      # The error message for when a transaction read operation uses a non-primary read preference.
+      #
+      # @since 2.6.0
+      INVALID_READ_PREFERENCE = 'read preference in a transaction must be primary'.freeze
+
+      # The error message for when a transaction is started with an unacknowledged write concern.
+      #
+      # @since 2.6.0
+      UNACKNOWLEDGED_WRITE_CONCERN = 'transactions do not support unacknowledged write concern'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidUpdateDocument.new(msg)
+      #
+      # @since 2.6.0
+      def initialize(msg)
+        super(msg)
+      end
+
+      # Create an error message for incorrectly running a transaction operation twice.
+      #
+      # @example Create the error message.
+      #   InvalidTransactionOperation.cannot_call_twice(op)
+      #
+      # @param [ Symbol ] op The operation which was run twice.
+      #
+      # @since 2.6.0
+      def self.cannot_call_twice_msg(op)
+        "cannot call #{op} twice"
+      end
+
+      # Create an error message for incorrectly running a transaction operation that cannot be run
+      # after the previous one.
+      #
+      # @example Create the error message.
+      #   InvalidTransactionOperation.cannot_call_after(last_op, current_op)
+      #
+      # @param [ Symbol ] last_op The operation which was run before.
+      # @param [ Symbol ] current_op The operation which cannot be run.
+      #
+      # @since 2.6.0
+      def self.cannot_call_after_msg(last_op, current_op)
+        "Cannot call #{current_op} after calling #{last_op}"
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_txt_record.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,22 +21,39 @@ module Mongo
     class OperationFailure < Error
       extend Forwardable
 
+      # Error codes and code names that should result in a failing write
+      # being retried.
+      #
+      # @since 2.6.0
+      # @api private
+      WRITE_RETRY_ERRORS = [
+        {:code_name => 'InterruptedAtShutdown', :code => 11600},
+        {:code_name => 'InterruptedDueToReplStateChange', :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 => 'NetworkTimeout', :code => 89},
+        {:code_name => 'SocketException', :code => 9001},
+      ].freeze
+
       # These are magic error messages that could indicate a master change.
       #
       # @since 2.4.2
+      # @api private
       WRITE_RETRY_MESSAGES = [
-        'no master',
         'not master',
-        'could not contact primary',
-        'Not primary'
+        'node is recovering',
       ].freeze
 
       # These are magic error messages that could indicate a cluster
-      # reconfiguration behind a mongos. We cannot check error codes as they
-      # change between versions, for example 15988 which has 2 completely
-      # different meanings between 2.4 and 3.0.
+      # reconfiguration behind a mongos.
       #
       # @since 2.1.1
+      # @api private
       RETRY_MESSAGES = WRITE_RETRY_MESSAGES + [
         'transport error',
         'socket exception',
@@ -52,12 +69,20 @@ module Mongo
 
       def_delegators :@result, :operation_time
 
+      # @return [ Integer ] code 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.
+      # @since 2.6.0
+      attr_reader :code_name
+
       # Can the read operation that caused the error be retried?
       #
       # @example Is the error retryable?
       #   error.retryable?
       #
-      # @return [ true, false ] If the error is retryable.
+      # @return [ true, false ] Whether the error is retryable.
       #
       # @since 2.1.1
       def retryable?
@@ -69,24 +94,93 @@ module Mongo
       # @example Is the error retryable for writes?
       #   error.write_retryable?
       #
-      # @return [ true, false ] If the error is retryable.
+      # @return [ true, false ] Whether the error is retryable.
       #
       # @since 2.4.2
       def write_retryable?
-        WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
+        WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) } ||
+        write_retryable_code?
+      end
+
+      def write_retryable_code?
+        if code
+          WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
+        else
+          # return false rather than nil
+          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},
+      ].freeze
+
+      # Change stream can be resumed when these error messages are encountered.
+      #
+      # @since 2.6.0
+      # @api private
+      CHANGE_STREAM_RESUME_MESSAGES = WRITE_RETRY_MESSAGES
+
+      # Can the change stream on which this error occurred be resumed,
+      # provided the operation that triggered this error was a getMore?
+      #
+      # @example Is the error resumable for the change stream?
+      #   error.change_stream_resumable?
+      #
+      # @return [ true, false ] Whether the error is resumable.
+      #
+      # @since 2.6.0
+      def change_stream_resumable?
+        if @result && @result.is_a?(Mongo::Operation::GetMore::Result)
+          change_stream_resumable_message? ||
+          change_stream_resumable_code?
+        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
+      end
+      private :change_stream_resumable_code?
 
       # Create the operation failure.
       #
       # @example Create the error object
       #   OperationFailure.new(message, result)
       #
-      # param [ String ] message The error message.
-      # param [ Operation::Result ] result The result object.
+      # @example Create the error object with a code and a code name
+      #   OperationFailure.new(message, result, :code => code, :code_name => code_name)
+      #
+      # @param [ String ] message The error message.
+      # @param [ Operation::Result ] result The result object.
+      # @param [ Hash ] options Additional parameters
+      #
+      # @option options [ Integer ] :code Error code
+      # @option options [ String ] :code_name Error code name
       #
-      # @since 2.5.0
-      def initialize(message = nil, result = nil)
+      # @since 2.5.0, options added in 2.6.0
+      def initialize(message = nil, result = nil, options = {})
         @result = result
+        @code = options[:code]
+        @code_name = options[:code_name]
         super(message)
       end
     end

data/lib/mongo/error/parser.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,6 +12,30 @@
 # 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
 
@@ -30,6 +54,14 @@ module Mongo
       # @return [ Array<Protocol::Message> ] replies The message replies.
       attr_reader :replies
 
+      # @return [ Integer ] code 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.
+      # @since 2.6.0
+      attr_reader :code_name
+
       # Create the new parser with the returned document.
       #
       # @example Create the new parser.
@@ -55,6 +87,7 @@ module Mongo
         parse_single(@message, ERRMSG,
                      document[WRITE_CONCERN_ERROR]) if document[WRITE_CONCERN_ERROR]
         parse_flag(@message)
+        parse_code
       end
 
       def parse_single(message, key, doc = document)
@@ -85,6 +118,22 @@ module Mongo
           message.concat(error)
         end
       end
+
+      def parse_code
+        @code = document['code']
+        @code_name = document['codeName']
+
+        # Since there is only room for one code, do not replace
+        # 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 = document[WRITE_CONCERN_ERROR]
+            @code = subdoc['code']
+            @code_name = subdoc['codeName']
+          end
+        end
+      end
     end
   end
 end

data/lib/mongo/error/socket_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@ module Mongo
     # Raised when a socket has an error.
     #
     # @since 2.0.0
-    class SocketError < Error; end
+    class SocketError < Error
+      include WriteRetryable
+      include ChangeStreamResumable
+    end
   end
 end

data/lib/mongo/error/socket_timeout_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@ module Mongo
     # Raised when a socket connection times out.
     #
     # @since 2.0.0
-    class SocketTimeoutError < Error; end
+    class SocketTimeoutError < Error
+      include WriteRetryable
+      include ChangeStreamResumable
+    end
   end
 end