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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
# Copyright (C) 2015 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
# Defines basic behaviour around retrying operations.
#
# @since 2.1.0
module Retryable
# Execute a read operation with a retry.
#
# @api private
#
# @example Execute the read.
# read_with_retry do
# ...
# end
#
# @note This only retries read operations on socket errors.
#
# @param [ Proc ] block The block to execute.
#
# @yieldparam [ Server ] server The server to which the write should be sent.
#
# @return [ Result ] The result of the operation.
#
# @since 2.1.0
def read_with_retry
attempt = 0
begin
attempt += 1
yield
rescue Error::SocketError, Error::SocketTimeoutError => e
raise(e) if attempt > cluster.max_read_retries
log_retry(e)
cluster.scan!
retry
rescue Error::OperationFailure => e
if cluster.sharded? && e.retryable?
raise(e) if attempt > cluster.max_read_retries
log_retry(e)
sleep(cluster.read_retry_interval)
retry
else
raise e
end
end
end
# Execute a read operation with a single retry.
#
# @api private
#
# @example Execute the read.
# read_with_one_retry do
# ...
# end
#
# @note This only retries read operations on socket errors.
#
# @param [ Proc ] block The block to execute.
#
# @return [ Result ] The result of the operation.
#
# @since 2.2.6
def read_with_one_retry
yield
rescue Error::SocketError, Error::SocketTimeoutError
yield
end
# Execute a write operation with a retry.
#
# @api private
#
# @example Execute the write.
# write_with_retry do
# ...
# end
#
# @note This only retries operations on not master failures, since it is
# the only case we can be sure a partial write did not already occur.
#
# @param [ Proc ] block The block to execute.
#
# @return [ Result ] The result of the operation.
#
# @since 2.1.0
def write_with_retry(session, write_concern, &block)
unless retry_write_allowed?(session, write_concern)
return legacy_write_with_retry(&block)
end
server = cluster.next_primary
unless server.retry_writes?
return legacy_write_with_retry(server, &block)
end
begin
txn_num = session.next_txn_num
yield(server, txn_num)
rescue Error::SocketError, Error::SocketTimeoutError => e
retry_write(e, txn_num, &block)
rescue Error::OperationFailure => e
raise e unless e.write_retryable?
retry_write(e, txn_num, &block)
end
end
private
def retry_write_allowed?(session, write_concern)
session && session.retry_writes? &&
(write_concern.nil? || write_concern.acknowledged?)
end
def retry_write(original_error, txn_num, &block)
cluster.scan!
server = cluster.next_primary
raise original_error unless (server.retry_writes? && txn_num)
log_retry(original_error)
yield(server, txn_num)
rescue Error::SocketError, Error::SocketTimeoutError => e
cluster.scan!
raise e
rescue Error::OperationFailure => e
raise original_error unless e.write_retryable?
cluster.scan!
raise e
rescue
raise original_error
end
def legacy_write_with_retry(server = nil)
attempt = 0
begin
attempt += 1
yield(server || cluster.next_primary)
rescue Error::OperationFailure => e
server = nil
raise(e) if attempt > Cluster::MAX_WRITE_RETRIES
if e.write_retryable?
log_retry(e)
cluster.scan!
retry
else
raise(e)
end
end
end
# Log a warning so that any application slow down is immediately obvious.
def log_retry(e)
Logger.logger.warn "Retry due to: #{e.class.name} #{e.message}"
end
end
end
|
