1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
|
# Copyright (C) 2015-2017 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 when an operation fails for some reason.
#
# @since 2.0.0
class OperationFailure < Error
extend Forwardable
# These are magic error messages that could indicate a master change.
#
# @since 2.4.2
WRITE_RETRY_MESSAGES = [
'no master',
'not master',
'could not contact primary',
'Not primary'
].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.
#
# @since 2.1.1
RETRY_MESSAGES = WRITE_RETRY_MESSAGES + [
'transport error',
'socket exception',
"can't connect",
'connect failed',
'error querying',
'could not get last error',
'connection attempt failed',
'interrupted at shutdown',
'unknown replica set',
'dbclient error communicating with server'
].freeze
def_delegators :@result, :operation_time
# 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.
#
# @since 2.1.1
def retryable?
RETRY_MESSAGES.any?{ |m| message.include?(m) }
end
# Can the write operation that caused the error be retried?
#
# @example Is the error retryable for writes?
# error.write_retryable?
#
# @return [ true, false ] If the error is retryable.
#
# @since 2.4.2
def write_retryable?
WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
end
# 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.
#
# @since 2.5.0
def initialize(message = nil, result = nil)
@result = result
super(message)
end
end
end
end
|