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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
|
# frozen_string_literal: true
# rubocop:todo all
require_relative './adds_diagnostics'
module PerformsModernRetries
shared_examples 'it performs modern retries' do
context 'for connection error' do
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: times },
data: {
failCommands: [command_name],
closeConnection: true,
}
)
end
context 'when error occurs once' do
let(:times) { 1 }
it 'retries and the operation succeeds' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
perform_operation
expect(actual_result).to eq(expected_successful_result)
end
end
context 'when error occurs twice' do
let(:times) { 2 }
it 'retries and the operation and fails' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
expect do
perform_operation
end.to raise_error(Mongo::Error::SocketError)
expect(actual_result).to eq(expected_failed_result)
end
it_behaves_like 'it adds diagnostics'
end
end
context 'for ETIMEDOUT' do
# blockConnection option in failCommand was introduced in
# server version 4.4
min_server_fcv '4.4'
# shorten socket timeout so these tests take less time to run
let(:socket_timeout) { 1 }
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: times },
data: {
failCommands: [command_name],
blockConnection: true,
blockTimeMS: 1100,
}
)
end
context 'when error occurs once' do
let(:times) { 1 }
it 'retries and the operation succeeds' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
perform_operation
expect(actual_result).to eq(expected_successful_result)
end
end
context 'when error occurs twice' do
let(:times) { 2 }
it 'retries and the operation and fails' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
expect do
perform_operation
end.to raise_error(Mongo::Error::SocketTimeoutError)
end
it_behaves_like 'it adds diagnostics'
after do
# Assure that the server has completed the operation before moving
# on to the next test.
sleep 1
end
end
end
context 'on server versions >= 4.4' do
min_server_fcv '4.4'
context 'for OperationFailure with RetryableWriteError label' do
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: times },
data: {
failCommands: [command_name],
errorCode: 5, # normally NOT a retryable error code
errorLabels: ['RetryableWriteError']
}
)
end
context 'when error occurs once' do
let(:times) { 1 }
it 'retries and the operation and succeeds' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
perform_operation
expect(actual_result).to eq(expected_successful_result)
end
end
context 'when error occurs twice' do
let(:times) { 2 }
it 'retries the operation and fails' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
expect do
perform_operation
end.to raise_error(Mongo::Error::OperationFailure, /5/)
expect(actual_result).to eq(expected_failed_result)
end
it_behaves_like 'it adds diagnostics'
end
end
context 'for OperationFailure without RetryableWriteError label' do
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: 1 },
data: {
failCommands: [command_name],
errorCode: 91, # normally a retryable error code
errorLabels: [],
}
)
end
it 'raises the error' do
expect(Mongo::Logger.logger).not_to receive(:warn)
expect do
perform_operation
end.to raise_error(Mongo::Error::OperationFailure, /91/)
expect(actual_result).to eq(expected_failed_result)
end
end
end
context 'on server versions < 4.4' do
max_server_fcv '4.2'
context 'for OperationFailure with retryable code' do
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: times },
data: {
failCommands: [command_name],
errorCode: 91, # a retryable error code
}
)
end
context 'when error occurs once' do
let(:times) { 1 }
it 'retries and the operation succeeds' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
perform_operation
expect(actual_result).to eq(expected_successful_result)
end
end
context 'when error occurs twice' do
let(:times) { 2 }
it 'retries and the operation and fails' do
expect(Mongo::Logger.logger).to receive(:warn).once.with(/modern.*attempt 1/).and_call_original
expect do
perform_operation
end.to raise_error(Mongo::Error::OperationFailure, /91/)
expect(actual_result).to eq(expected_failed_result)
end
it_behaves_like 'it adds diagnostics'
end
end
context 'for OperationFailure with non-retryable code' do
before do
client.use('admin').command(
configureFailPoint: 'failCommand',
mode: { times: times },
data: {
failCommands: [command_name],
errorCode: 5, # a non-retryable error code
}
)
end
let(:times) { 1 }
it 'raises the error' do
expect(Mongo::Logger.logger).not_to receive(:warn)
expect do
perform_operation
end.to raise_error(Mongo::Error::OperationFailure, /5/)
expect(actual_result).to eq(expected_failed_result)
end
end
end
end
end
|