FI-1659: Follow redirects

Gemfile.lock

@@ -9,6 +9,7 @@ PATH
       dry-container (= 0.8.0)
       dry-system (= 0.18.1)
       faraday (~> 1.2)
+      faraday_middleware (~> 1.2)
       fhir_client (>= 5.0.3)
       fhir_models (~> 4.2.0)
       hanami-controller (~> 1.3)
@@ -116,6 +117,8 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
     fhir_client (5.0.3)
       activesupport (>= 3)
       addressable (>= 2.3)

inferno_core.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dry-container', '0.8.0'
   spec.add_runtime_dependency 'dry-system', '0.18.1'
   spec.add_runtime_dependency 'faraday', '~> 1.2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.2'
   spec.add_runtime_dependency 'fhir_client', '>= 5.0.3'
   spec.add_runtime_dependency 'fhir_models', '~> 4.2.0'
   spec.add_runtime_dependency 'hanami-controller', '~> 1.3'

lib/inferno/dsl/http_client.rb

@@ -1,3 +1,5 @@
+require 'faraday_middleware'
+
 require_relative 'request_storage'
 require_relative 'tcp_exception_handler'
 
@@ -75,14 +77,22 @@ def get(url = '', client: :default, name: nil, **options)
             if client
               client.get(url, nil, options[:headers])
             elsif url.match?(%r{\Ahttps?://})
-              Faraday.get(url, nil, options[:headers])
+              connection.get(url, nil, options[:headers])
             else
               raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
             end
           end
         end
       end
 
+      # @private
+      def connection
+        Faraday.new do |f|
+          f.request :url_encoded
+          f.use FaradayMiddleware::FollowRedirects
+        end
+      end
+
       # Perform an HTTP POST request
       #
       # @param url [String] if this request is using a defined client, this will
@@ -103,7 +113,7 @@ def post(url = '', body: nil, client: :default, name: nil, **options)
             if client
               client.post(url, body, options[:headers])
             elsif url.match?(%r{\Ahttps?://})
-              Faraday.post(url, body, options[:headers])
+              connection.post(url, body, options[:headers])
             else
               raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
             end
@@ -128,7 +138,7 @@ def delete(url = '', client: :default, name: :nil, **options)
             if client
               client.delete(url, nil, options[:headers])
             elsif url.match?(%r{\Ahttps?://})
-              Faraday.delete(url, nil, options[:headers])
+              connection.delete(url, nil, options[:headers])
             else
               raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
             end
@@ -167,7 +177,7 @@ def stream(block, url = '', limit = 100, client: :default, name: nil, **options)
             if client
               response = client.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
             elsif url.match?(%r{\Ahttps?://})
-              response = Faraday.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
+              response = connection.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
             else
               raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
             end

lib/inferno/dsl/http_client_builder.rb

@@ -1,3 +1,5 @@
+require 'faraday_middleware'
+
 module Inferno
   module DSL
     # This module contains the HTTP DSL available to test writers.
@@ -12,7 +14,10 @@ def build(runnable, block)
         params = { url: url }
         params.merge!(headers: headers) if headers
 
-        Faraday.new(params)
+        Faraday.new(params) do |f|
+          f.request :url_encoded
+          f.use FaradayMiddleware::FollowRedirects
+        end
       end
 
       # Define the base url for an HTTP client. A string or symbol can be

spec/inferno/dsl/http_client_spec.rb

@@ -98,6 +98,28 @@ def setup_default_client
         setup_default_client
       end
 
+      it 'follows redirects' do
+        original_url = 'http://example.com'
+        new_url = 'http://example.com/abc'
+        original_request =
+          stub_request(:get, original_url)
+            .to_return(status: 302, headers: { 'Location' => new_url })
+        new_request =
+          stub_request(:get, new_url)
+            .to_return(status: 200, body: 'BODY')
+
+        group.get(original_url)
+        expect(original_request).to have_been_made.once
+        expect(new_request).to have_been_made.once
+
+        expect(group.requests.length).to eq(1)
+
+        request = group.request
+        expect(request.url).to eq(new_url)
+        expect(request.status).to eq(200)
+        expect(request.response_body).to eq('BODY')
+      end
+
       context 'without a url argument' do
         let(:stub_get_request) do
           stub_request(:get, base_url)
@@ -273,6 +295,28 @@ def setup_default_client
           end.to raise_error(Faraday::ConnectionFailed, 'not a TCP error')
         end
       end
+
+      it 'follows redirects' do
+        original_url = 'http://example.com'
+        new_url = 'http://example.com/abc'
+        original_request =
+          stub_request(:get, original_url)
+            .to_return(status: 302, headers: { 'Location' => new_url })
+        new_request =
+          stub_request(:get, new_url)
+            .to_return(status: 200, body: 'BODY')
+
+        group.get(original_url)
+        expect(original_request).to have_been_made.once
+        expect(new_request).to have_been_made.once
+
+        expect(group.requests.length).to eq(1)
+
+        request = group.request
+        expect(request.url).to eq(new_url)
+        expect(request.status).to eq(200)
+        expect(request.response_body).to eq('BODY')
+      end
     end
   end