http 5.2.0 → 5.3.1

data/spec/lib/http/retriable/performer_spec.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+RSpec.describe HTTP::Retriable::Performer do
+  let(:client) do
+    HTTP::Client.new
+  end
+
+  let(:response) do
+    HTTP::Response.new(
+      status:  200,
+      version: "1.1",
+      headers: {},
+      body:    "Hello world!",
+      request: request
+    )
+  end
+
+  let(:request) do
+    HTTP::Request.new(
+      verb: :get,
+      uri:  "http://example.com"
+    )
+  end
+
+  let(:perform_spy) { { counter: 0 } }
+  let(:counter_spy) { perform_spy[:counter] }
+
+  before do
+    stub_const("CustomException", Class.new(StandardError))
+  end
+
+  def perform(options = {}, client_arg = client, request_arg = request, &block)
+    # by explicitly overwriting the default delay, we make a much faster test suite
+    default_options = { delay: 0 }
+    options = default_options.merge(options)
+
+    HTTP::Retriable::Performer
+      .new(options)
+      .perform(client_arg, request_arg) do
+        perform_spy[:counter] += 1
+        block ? yield : response
+      end
+  end
+
+  def measure_wait
+    t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    result = yield
+    t2 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    [t2 - t1, result]
+  end
+
+  describe "#perform" do
+    describe "expected exception" do
+      it "retries the request" do
+        expect do
+          perform(exceptions: [CustomException], tries: 2) do
+            raise CustomException
+          end
+        end.to raise_error HTTP::OutOfRetriesError
+
+        expect(counter_spy).to eq 2
+      end
+    end
+
+    describe "unexpected exception" do
+      it "does not retry the request" do
+        expect do
+          perform(exceptions: [], tries: 2) do
+            raise CustomException
+          end
+        end.to raise_error CustomException
+
+        expect(counter_spy).to eq 1
+      end
+    end
+
+    describe "expected status codes" do
+      def response(**options)
+        HTTP::Response.new(
+          {
+            status:  200,
+            version: "1.1",
+            headers: {},
+            body:    "Hello world!",
+            request: request
+          }.merge(options)
+        )
+      end
+
+      it "retries the request" do
+        expect do
+          perform(retry_statuses: [200], tries: 2)
+        end.to raise_error HTTP::OutOfRetriesError
+
+        expect(counter_spy).to eq 2
+      end
+
+      describe "status codes can be expressed in many ways" do
+        [
+          301,
+          [200, 301, 485],
+          250...400,
+          [250...Float::INFINITY],
+          ->(status_code) { status_code == 301 },
+          [->(status_code) { status_code == 301 }]
+        ].each do |retry_statuses|
+          it retry_statuses.to_s do
+            expect do
+              perform(retry_statuses: retry_statuses, tries: 2) do
+                response(status: 301)
+              end
+            end.to raise_error HTTP::OutOfRetriesError
+          end
+        end
+      end
+    end
+
+    describe "unexpected status code" do
+      it "does not retry the request" do
+        expect(
+          perform(retry_statuses: [], tries: 2)
+        ).to eq response
+
+        expect(counter_spy).to eq 1
+      end
+    end
+
+    describe "on_retry callback" do
+      it "calls the on_retry callback on each retry with exception" do
+        callback_call_spy = 0
+
+        callback_spy = proc do |callback_request, error, callback_response|
+          expect(callback_request).to eq request
+          expect(error).to be_a HTTP::TimeoutError
+          expect(callback_response).to be_nil
+          callback_call_spy += 1
+        end
+
+        expect do
+          perform(tries: 3, on_retry: callback_spy) do
+            raise HTTP::TimeoutError
+          end
+        end.to raise_error HTTP::OutOfRetriesError
+
+        expect(callback_call_spy).to eq 2
+      end
+
+      it "calls the on_retry callback on each retry with response" do
+        callback_call_spy = 0
+
+        callback_spy = proc do |callback_request, error, callback_response|
+          expect(callback_request).to eq request
+          expect(error).to be_nil
+          expect(callback_response).to be response
+          callback_call_spy += 1
+        end
+
+        expect do
+          perform(retry_statuses: [200], tries: 3, on_retry: callback_spy)
+        end.to raise_error HTTP::OutOfRetriesError
+
+        expect(callback_call_spy).to eq 2
+      end
+    end
+
+    describe "delay option" do
+      let(:timing_slack) { 0.05 }
+
+      it "can be a positive number" do
+        time, = measure_wait do
+          perform(delay: 0.1, tries: 3, should_retry: ->(*) { true })
+        rescue HTTP::OutOfRetriesError
+        end
+        expect(time).to be_within(timing_slack).of(0.2)
+      end
+
+      it "can be a proc number" do
+        time, = measure_wait do
+          perform(delay: ->(attempt) { attempt / 10.0 }, tries: 3, should_retry: ->(*) { true })
+        rescue HTTP::OutOfRetriesError
+        end
+        expect(time).to be_within(timing_slack).of(0.3)
+      end
+
+      it "receives correct retry number when a proc" do
+        retry_count = 0
+        retry_proc = proc do |attempt|
+          expect(attempt).to eq(retry_count).and(be > 0)
+          0
+        end
+        begin
+          perform(delay: retry_proc, should_retry: ->(*) { true }) do
+            retry_count += 1
+            response
+          end
+        rescue HTTP::OutOfRetriesError
+        end
+      end
+    end
+
+    describe "should_retry option" do
+      it "decides if the request should be retried" do # rubocop:disable RSpec/MultipleExpectations
+        retry_proc = proc do |req, err, res, attempt|
+          expect(req).to eq request
+          if res
+            expect(err).to be_nil
+            expect(res).to be response
+          else
+            expect(err).to be_a CustomException
+            expect(res).to be_nil
+          end
+
+          attempt < 5
+        end
+
+        begin
+          perform(should_retry: retry_proc) do
+            rand < 0.5 ? response : raise(CustomException)
+          end
+        rescue CustomException
+        end
+
+        expect(counter_spy).to eq 5
+      end
+
+      it "raises the original error if not retryable" do
+        retry_proc = ->(*) { false }
+
+        expect do
+          perform(should_retry: retry_proc) do
+            raise CustomException
+          end
+        end.to raise_error CustomException
+
+        expect(counter_spy).to eq 1
+      end
+
+      it "raises HTTP::OutOfRetriesError if retryable" do
+        retry_proc = ->(*) { true }
+
+        expect do
+          perform(should_retry: retry_proc) do
+            raise CustomException
+          end
+        end.to raise_error HTTP::OutOfRetriesError
+
+        expect(counter_spy).to eq 5
+      end
+    end
+  end
+
+  describe "connection closing" do
+    let(:client) { double(:client) }
+
+    it "does not close the connection if we get a propper response" do
+      expect(client).not_to receive(:close)
+      perform
+    end
+
+    it "closes the connection after each raiseed attempt" do
+      expect(client).to receive(:close).exactly(3).times
+      begin
+        perform(should_retry: ->(*) { true }, tries: 3)
+      rescue HTTP::OutOfRetriesError
+      end
+    end
+
+    it "closes the connection on an unexpected exception" do
+      expect(client).to receive(:close)
+      begin
+        perform do
+          raise CustomException
+        end
+      rescue CustomException
+      end
+    end
+  end
+
+  describe HTTP::OutOfRetriesError do
+    it "has the original exception as a cause if available" do
+      err = nil
+      begin
+        perform(exceptions: [CustomException]) do
+          raise CustomException
+        end
+      rescue described_class => e
+        err = e
+      end
+      expect(err.cause).to be_a CustomException
+    end
+
+    it "has the last raiseed response as an attribute" do
+      err = nil
+      begin
+        perform(should_retry: ->(*) { true })
+      rescue described_class => e
+        err = e
+      end
+      expect(err.response).to be response
+    end
+  end
+end

data/spec/lib/http_spec.rb

@@ -152,6 +152,35 @@ RSpec.describe HTTP do
     end
   end
 
+  describe ".retry" do
+    it "ensure endpoint counts retries" do
+      expect(HTTP.get("#{dummy.endpoint}/retry-2").to_s).to eq "retried 1x"
+      expect(HTTP.get("#{dummy.endpoint}/retry-2").to_s).to eq "retried 2x"
+    end
+
+    it "retries the request" do
+      response = HTTP.retriable(delay: 0, retry_statuses: 500...600).get "#{dummy.endpoint}/retry-2"
+      expect(response.to_s).to eq "retried 2x"
+    end
+
+    it "retries the request and gives us access to the failed requests" do
+      err = nil
+      retry_callback = ->(_, _, res) { expect(res.to_s).to match(/^retried \dx$/) }
+      begin
+        HTTP.retriable(
+          should_retry: ->(*) { true },
+          tries:        3,
+          delay:        0,
+          on_retry:     retry_callback
+        ).get "#{dummy.endpoint}/retry-2"
+      rescue HTTP::Error => e
+        err = e
+      end
+
+      expect(err.response.to_s).to eq "retried 3x"
+    end
+  end
+
   context "posting forms to resources" do
     it "is easy" do
       response = HTTP.post "#{dummy.endpoint}/form", :form => {:example => "testing-form"}

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require_relative "./support/fuubar" unless ENV["CI"]
 
 require "http"
 require "rspec/its"
+require "rspec/memory"
 require "support/capture_warning"
 require "support/fakeio"
 

data/spec/support/dummy_server/servlet.rb

@@ -18,6 +18,11 @@ class DummyServer < WEBrick::HTTPServer
       @handlers ||= {}
     end
 
+    def initialize(server, memo)
+      super(server)
+      @memo = memo
+    end
+
     %w[get post head].each do |method|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def self.#{method}(path, &block)
@@ -186,5 +191,13 @@ class DummyServer < WEBrick::HTTPServer
         res["Content-Encoding"] = "deflate"
       end
     end
+
+    get "/retry-2" do |_req, res|
+      @memo[:attempts] ||= 0
+      @memo[:attempts] += 1
+
+      res.body = "retried #{@memo[:attempts]}x"
+      res.status = @memo[:attempts] == 2 ? 200 : 500
+    end
   end
 end

data/spec/support/dummy_server.rb

@@ -26,7 +26,8 @@ class DummyServer < WEBrick::HTTPServer
 
   def initialize(options = {})
     super(options[:ssl] ? SSL_CONFIG : CONFIG)
-    mount("/", Servlet)
+    @memo = {}
+    mount("/", Servlet, @memo)
   end
 
   def endpoint

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.1
 platform: ruby
 authors:
 - Tony Arcieri
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -27,20 +27,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
-- !ruby/object:Gem::Dependency
-  name: base64
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: http-cookie
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +97,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop/layout.yml"
 - ".rubocop/metrics.yml"
+- ".rubocop/rspec.yml"
 - ".rubocop/style.yml"
 - ".rubocop_todo.yml"
 - ".yardopts"
@@ -125,6 +112,7 @@ files:
 - SECURITY.md
 - http.gemspec
 - lib/http.rb
+- lib/http/base64.rb
 - lib/http/chainable.rb
 - lib/http/client.rb
 - lib/http/connection.rb
@@ -136,9 +124,11 @@ files:
 - lib/http/features/instrumentation.rb
 - lib/http/features/logging.rb
 - lib/http/features/normalize_uri.rb
+- lib/http/features/raise_error.rb
 - lib/http/headers.rb
 - lib/http/headers/known.rb
 - lib/http/headers/mixin.rb
+- lib/http/headers/normalizer.rb
 - lib/http/mime_type.rb
 - lib/http/mime_type/adapter.rb
 - lib/http/mime_type/json.rb
@@ -153,6 +143,10 @@ files:
 - lib/http/response/parser.rb
 - lib/http/response/status.rb
 - lib/http/response/status/reasons.rb
+- lib/http/retriable/client.rb
+- lib/http/retriable/delay_calculator.rb
+- lib/http/retriable/errors.rb
+- lib/http/retriable/performer.rb
 - lib/http/timeout/global.rb
 - lib/http/timeout/null.rb
 - lib/http/timeout/per_operation.rb
@@ -166,7 +160,9 @@ files:
 - spec/lib/http/features/auto_inflate_spec.rb
 - spec/lib/http/features/instrumentation_spec.rb
 - spec/lib/http/features/logging_spec.rb
+- spec/lib/http/features/raise_error_spec.rb
 - spec/lib/http/headers/mixin_spec.rb
+- spec/lib/http/headers/normalizer_spec.rb
 - spec/lib/http/headers_spec.rb
 - spec/lib/http/options/body_spec.rb
 - spec/lib/http/options/features_spec.rb
@@ -185,6 +181,8 @@ files:
 - spec/lib/http/response/parser_spec.rb
 - spec/lib/http/response/status_spec.rb
 - spec/lib/http/response_spec.rb
+- spec/lib/http/retriable/delay_calculator_spec.rb
+- spec/lib/http/retriable/performer_spec.rb
 - spec/lib/http/uri/normalizer_spec.rb
 - spec/lib/http/uri_spec.rb
 - spec/lib/http_spec.rb
@@ -209,7 +207,7 @@ metadata:
   source_code_uri: https://github.com/httprb/http
   wiki_uri: https://github.com/httprb/http/wiki
   bug_tracker_uri: https://github.com/httprb/http/issues
-  changelog_uri: https://github.com/httprb/http/blob/v5.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/httprb/http/blob/v5.3.1/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -226,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: HTTP should be easy
@@ -238,7 +236,9 @@ test_files:
 - spec/lib/http/features/auto_inflate_spec.rb
 - spec/lib/http/features/instrumentation_spec.rb
 - spec/lib/http/features/logging_spec.rb
+- spec/lib/http/features/raise_error_spec.rb
 - spec/lib/http/headers/mixin_spec.rb
+- spec/lib/http/headers/normalizer_spec.rb
 - spec/lib/http/headers_spec.rb
 - spec/lib/http/options/body_spec.rb
 - spec/lib/http/options/features_spec.rb
@@ -257,6 +257,8 @@ test_files:
 - spec/lib/http/response/parser_spec.rb
 - spec/lib/http/response/status_spec.rb
 - spec/lib/http/response_spec.rb
+- spec/lib/http/retriable/delay_calculator_spec.rb
+- spec/lib/http/retriable/performer_spec.rb
 - spec/lib/http/uri/normalizer_spec.rb
 - spec/lib/http/uri_spec.rb
 - spec/lib/http_spec.rb