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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
|
# frozen_string_literal: true
describe Retriable do
let(:time_table_handler) do
->(_exception, try, _elapsed_time, next_interval) { @next_interval_table[try] = next_interval }
end
before(:each) do
described_class.configure { |c| c.sleep_disabled = true }
@tries = 0
@next_interval_table = {}
end
def increment_tries
@tries += 1
end
def increment_tries_with_exception(exception_class = nil)
exception_class ||= StandardError
increment_tries
raise exception_class, "#{exception_class} occurred"
end
context "global scope extension" do
it "cannot be called in the global scope without requiring the core_ext/kernel" do
expect { retriable { puts "should raise NoMethodError" } }.to raise_error(NoMethodError)
end
it "can be called once the kernel extension is required" do
begin
require_relative "../lib/retriable/core_ext/kernel"
rescue LoadError
require "retriable/core_ext/kernel"
end
expect { retriable { increment_tries_with_exception } }.to raise_error(StandardError)
expect(@tries).to eq(3)
end
end
context "#retriable" do
it "raises a LocalJumpError if not given a block" do
expect { described_class.retriable }.to raise_error(LocalJumpError)
expect { described_class.retriable(timeout: 2) }.to raise_error(LocalJumpError)
end
it "stops at first try if the block does not raise an exception" do
described_class.retriable { increment_tries }
expect(@tries).to eq(1)
end
it "makes 3 tries when retrying block of code raising StandardError with no arguments" do
expect { described_class.retriable { increment_tries_with_exception } }.to raise_error(StandardError)
expect(@tries).to eq(3)
end
it "makes only 1 try when exception raised is not descendent of StandardError" do
expect do
described_class.retriable { increment_tries_with_exception(NonStandardError) }
end.to raise_error(NonStandardError)
expect(@tries).to eq(1)
end
it "with custom exception tries 3 times and re-raises the exception" do
expect do
described_class.retriable(on: NonStandardError) { increment_tries_with_exception(NonStandardError) }
end.to raise_error(NonStandardError)
expect(@tries).to eq(3)
end
it "tries 10 times when specified" do
expect { described_class.retriable(tries: 10) { increment_tries_with_exception } }.to raise_error(StandardError)
expect(@tries).to eq(10)
end
it "will timeout after 1 second" do
expect { described_class.retriable(timeout: 1) { sleep(1.1) } }.to raise_error(Timeout::Error)
end
it "applies a randomized exponential backoff to each try" do
expect do
described_class.retriable(on_retry: time_table_handler, tries: 10) { increment_tries_with_exception }
end.to raise_error(StandardError)
expect(@next_interval_table).to eq(
1 => 0.5244067512211441,
2 => 0.9113920238761231,
3 => 1.2406087918999114,
4 => 1.7632403621664823,
5 => 2.338001204738311,
6 => 4.350816718580626,
7 => 5.339852157217869,
8 => 11.889873261212443,
9 => 18.756037881636484,
10 => nil,
)
expect(@tries).to eq(10)
end
it "does not call on_retry when explicitly set to false" do
callback_called = false
original_on_retry = described_class.config.on_retry
begin
described_class.configure do |c|
c.on_retry = proc { |_exception, _try, _elapsed_time, _next_interval| callback_called = true }
end
expect do
described_class.retriable(on_retry: false, tries: 3) { increment_tries_with_exception }
end.to raise_error(StandardError)
expect(@tries).to eq(3)
expect(callback_called).to be(false)
ensure
described_class.configure do |c|
c.on_retry = original_on_retry
end
end
end
context "with rand_factor 0.0 and an on_retry handler" do
let(:tries) { 6 }
let(:no_rand_timetable) { { 1 => 0.5, 2 => 0.75, 3 => 1.125 } }
let(:args) { { on_retry: time_table_handler, rand_factor: 0.0, tries: tries } }
it "applies a non-randomized exponential backoff to each try" do
described_class.retriable(args) do
increment_tries
raise StandardError if @tries < tries
end
expect(@tries).to eq(tries)
expect(@next_interval_table).to eq(no_rand_timetable.merge(4 => 1.6875, 5 => 2.53125))
end
it "obeys a max interval of 1.5 seconds" do
expect do
described_class.retriable(args.merge(max_interval: 1.5)) { increment_tries_with_exception }
end.to raise_error(StandardError)
expect(@next_interval_table).to eq(no_rand_timetable.merge(4 => 1.5, 5 => 1.5, 6 => nil))
end
it "obeys custom defined intervals" do
interval_hash = no_rand_timetable.merge(4 => 1.5, 5 => 1.5, 6 => nil)
intervals = interval_hash.values.compact.sort
expect do
described_class.retriable(on_retry: time_table_handler, intervals: intervals) do
increment_tries_with_exception
end
end.to raise_error(StandardError)
expect(@next_interval_table).to eq(interval_hash)
expect(@tries).to eq(intervals.size + 1)
end
it "intervals option overrides tries, base_interval, max_interval, rand_factor, and multiplier" do
# Even though we specify tries: 10, base_interval: 1.0, max_interval: 100.0,
# rand_factor: 0.8, and multiplier: 2.0, the explicit intervals should take precedence
custom_intervals = [0.1, 0.2, 0.3]
expect do
described_class.retriable(
intervals: custom_intervals,
tries: 10,
base_interval: 1.0,
max_interval: 100.0,
rand_factor: 0.8,
multiplier: 2.0,
on_retry: time_table_handler,
) do
increment_tries_with_exception
end
end.to raise_error(StandardError)
# Should have 4 tries (3 intervals + 1), not 10
expect(@tries).to eq(4)
# Should use the exact intervals provided, not generate them
expect(@next_interval_table[1]).to eq(0.1)
expect(@next_interval_table[2]).to eq(0.2)
expect(@next_interval_table[3]).to eq(0.3)
expect(@next_interval_table[4]).to be_nil
end
end
context "with an array :on parameter" do
it "handles both kinds of exceptions" do
described_class.retriable(on: [StandardError, NonStandardError]) do
increment_tries
raise StandardError if @tries == 1
raise NonStandardError if @tries == 2
end
expect(@tries).to eq(3)
end
end
context "with a hash :on parameter" do
let(:on_hash) { { NonStandardError => /NonStandardError occurred/ } }
it "where the value is an exception message pattern" do
expect do
described_class.retriable(on: on_hash) { increment_tries_with_exception(NonStandardError) }
end.to raise_error(NonStandardError, /NonStandardError occurred/)
expect(@tries).to eq(3)
end
it "matches exception subclasses when message matches pattern" do
expect do
described_class.retriable(on: on_hash.merge(DifferentError => [/shouldn't happen/, /also not/])) do
increment_tries_with_exception(SecondNonStandardError)
end
end.to raise_error(SecondNonStandardError, /SecondNonStandardError occurred/)
expect(@tries).to eq(3)
end
it "does not retry matching exception subclass but not message" do
expect do
described_class.retriable(on: on_hash) do
increment_tries
raise SecondNonStandardError, "not a match"
end
end.to raise_error(SecondNonStandardError, /not a match/)
expect(@tries).to eq(1)
end
it "successfully retries when the values are arrays of exception message patterns" do
exceptions = []
handler = ->(exception, try, _elapsed_time, _next_interval) { exceptions[try] = exception }
on_hash = { StandardError => nil, NonStandardError => [/foo/, /bar/] }
expect do
described_class.retriable(tries: 4, on: on_hash, on_retry: handler) do
increment_tries
case @tries
when 1
raise NonStandardError, "foo"
when 2
raise NonStandardError, "bar"
when 3
raise StandardError
else
raise NonStandardError, "crash"
end
end
end.to raise_error(NonStandardError, /crash/)
expect(exceptions[1]).to be_a(NonStandardError)
expect(exceptions[1].message).to eq("foo")
expect(exceptions[2]).to be_a(NonStandardError)
expect(exceptions[2].message).to eq("bar")
expect(exceptions[3]).to be_a(StandardError)
end
end
context "with a :retry_if parameter" do
it "retries only when retry_if returns true" do
described_class.retriable(tries: 3, retry_if: ->(_exception) { @tries < 3 }) do
increment_tries
raise StandardError, "StandardError occurred" if @tries < 3
end
expect(@tries).to eq(3)
end
it "does not retry when retry_if returns false" do
expect do
described_class.retriable(tries: 3, retry_if: ->(_exception) { false }) do
increment_tries_with_exception
end
end.to raise_error(StandardError)
expect(@tries).to eq(1)
end
it "can retry based on the wrapped exception cause" do
root_cause_class = Class.new(StandardError)
wrapper_class = Class.new(StandardError)
described_class.retriable(
on: [wrapper_class],
tries: 3,
retry_if: ->(exception) { exception.cause.is_a?(root_cause_class) },
) do
increment_tries
if @tries < 3
begin
raise root_cause_class, "root cause"
rescue root_cause_class
raise wrapper_class, "wrapped"
end
end
end
expect(@tries).to eq(3)
end
end
it "runs for a max elapsed time of 2 seconds" do
described_class.configure { |c| c.sleep_disabled = false }
expect do
described_class.retriable(base_interval: 1.0, multiplier: 1.0, rand_factor: 0.0, max_elapsed_time: 2.0) do
increment_tries_with_exception
end
end.to raise_error(StandardError)
expect(@tries).to eq(2)
end
it "retries up to tries limit when max_elapsed_time is nil" do
expect do
described_class.retriable(tries: 4, max_elapsed_time: nil) { increment_tries_with_exception }
end.to raise_error(StandardError)
expect(@tries).to eq(4)
end
it "uses monotonic clock for elapsed time tracking" do
# Stub Process.clock_gettime to return controlled values so we can
# verify elapsed_time passed to on_retry is derived from the monotonic clock.
clock_calls = 0
allow(Process).to receive(:clock_gettime).with(Process::CLOCK_MONOTONIC) do
value = clock_calls.to_f
clock_calls += 1
value
end
elapsed_times = []
on_retry = ->(_exception, _try, elapsed_time, _next_interval) { elapsed_times << elapsed_time }
expect do
described_class.retriable(tries: 3, on_retry: on_retry) { increment_tries_with_exception }
end.to raise_error(StandardError)
# start_time (call 0) + at least one elapsed_time computation per retry
expect(clock_calls).to be >= 3
# elapsed_time values should be positive and non-decreasing
expect(elapsed_times).to all(be > 0)
expect(elapsed_times).to eq(elapsed_times.sort)
end
it "raises ArgumentError on invalid options" do
expect { described_class.retriable(does_not_exist: 123) { increment_tries } }.to raise_error(ArgumentError)
end
end
context "#configure" do
it "exposes only the intended public API" do
public_api_methods = %i[
retriable
with_context
configure
config
]
expect(described_class.singleton_methods(false)).to match_array(public_api_methods)
end
it "raises NoMethodError on invalid configuration" do
expect { described_class.configure { |c| c.does_not_exist = 123 } }.to raise_error(NoMethodError)
end
end
context "#with_context" do
let(:api_tries) { 4 }
before do
described_class.configure do |c|
c.contexts[:sql] = { tries: 1 }
c.contexts[:api] = { tries: api_tries }
end
end
it "stops at first try if the block does not raise an exception" do
described_class.with_context(:sql) { increment_tries }
expect(@tries).to eq(1)
end
it "returns nil when called without a block" do
expect(described_class.with_context(:sql)).to be_nil
expect(@tries).to eq(0)
end
it "passes try count through to the context block" do
seen_tries = []
described_class.with_context(:api) do |try|
seen_tries << try
raise StandardError if try < 3
end
expect(seen_tries).to eq([1, 2, 3])
end
it "respects the context options" do
expect { described_class.with_context(:api) { increment_tries_with_exception } }.to raise_error(StandardError)
expect(@tries).to eq(api_tries)
end
it "allows override options" do
expect do
described_class.with_context(:sql, tries: 5) { increment_tries_with_exception }
end.to raise_error(StandardError)
expect(@tries).to eq(5)
end
it "raises an ArgumentError when the context isn't found" do
expect { described_class.with_context(:wtf) { increment_tries } }.to raise_error(ArgumentError, /wtf not found/)
end
end
end
|