retriable 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1518899ae471b83e7167d0f2dce18e198a5069d30e6f05f04c0754ebd1c3b3a
-  data.tar.gz: 5fdd9babcd9dcb9dceeec99ce861018fd58435f50a184e62a64fa5142523d235
+  metadata.gz: 7ec8418b3d0009ce1ddfd7aa839eab270ae479a2a9498660e9cc0da8fa2541c5
+  data.tar.gz: efccc4c3e6e29f5ba12426f1ec39503e9c59a9b606389a2c318606a205bb18b7
 SHA512:
-  metadata.gz: af50822074d864951bc299bea96cb52ea5d35cbe7d5b0d079e5e633dec30cce8131a8db30339613562155015ee396a8fc7eb21ea841cf8beb0a826842ce314f0
-  data.tar.gz: d9dfa3ae45a889ee8326ba5aa7fb119af47302dc087e6c4a6b4033cbe0da9178ea41214b3fd5360f904b72f056ff709b5526c7298c2ff173d115803d88ca661e
+  metadata.gz: b7a1f5935366d2b243e508f5da6308ebdd403e61b4d4c9dc05f7f3018c3d93a0bacca1e9a2c9c84a0ebdf0fe685116cd4e3a76bf8dbafeaf6edb25f03a4b31fe
+  data.tar.gz: b5bdcef731117fc3c379b65a54e8acfecc9403e188089d269c86f721e6f7bf080f4c2670dc20f15ce09941f69e5ee117a493d593ec94c076c300c86eb02de841

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # HEAD
 
+## 5.0.1
+
+### Bug fixes
+
+- `Retriable.retriable` now propagates `StopIteration` instead of reporting it as
+  retry exhaustion. The retry loop used `Kernel#loop`, which rescues
+  `StopIteration`, so a block or callback (`on_retry`, `on_give_up`) raising it
+  was converted into a `Retriable::ExhaustedError` even when retries remained.
+  The loop no longer goes through `Kernel#loop`, so `StopIteration` reaches the
+  caller as any other exception would.
+  ([#155](https://github.com/kamui/retriable/pull/155))
+- A reused configuration is now validated once, when it is picked up for an
+  attempt, instead of being validated again immediately before every use. The
+  validation guarantee is unchanged; this only removes the duplicate work on
+  each retry.
+  ([#156](https://github.com/kamui/retriable/pull/156))
+
 ## 5.0.0
 
 **This is a major release with a breaking change. Please read carefully before

data/lib/retriable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Retriable
-  VERSION = "5.0.0"
+  VERSION = "5.0.1"
 end

data/lib/retriable.rb

@@ -124,14 +124,13 @@ module Retriable
   def retriable_with_config(base_config, opts = {}, &)
     override_config = current_override
     local_config = if opts.empty? && !override_config
+                     # A reused config may have been mutated inside configure.
+                     base_config.validate!
                      base_config
                    else
                      Config.new(apply_override_options(merge_layer(base_config.to_h, opts), override_config))
                    end
 
-    # Config is mutable through `configure`, so validate again immediately before use.
-    local_config.validate!
-
     plan = retry_plan(local_config)
     on = local_config.on
     retry_if = local_config.retry_if
@@ -158,7 +157,7 @@ module Retriable
     on:, retry_if:, on_retry:, on_give_up:, elapsed_time:, max_elapsed_time:, sleep_disabled:
   )
     try = 0
-    loop do
+    while true # rubocop:disable Style/InfiniteLoop -- Kernel#loop swallows StopIteration.
       try += 1
       begin
         return yield(try)

data/spec/retriable_spec.rb

@@ -133,6 +133,19 @@ describe Retriable do
       expect(@tries).to eq(3)
     end
 
+    it "re-raises StopIteration after the configured tries" do
+      failure = StopIteration.new("end of input")
+
+      expect do
+        described_class.retriable(tries: 2) do
+          increment_tries
+          raise failure
+        end
+      end.to(raise_error { |error| expect(error).to equal(failure) })
+
+      expect(@tries).to eq(2)
+    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) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Jack Chu