Allow to set retry options on a connection

Author: rsamoilov

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v0.11.0] - 2020-12-08
+### Added
+- Allow to set retry options on a connection([#36])
+
+
 ## [v0.9.1] - 2020-11-20
 ### Added
 - Automatically retry on network errors([#31])

README.md

@@ -112,6 +112,9 @@ Disable the middleware:
 We::Call.configure do |config|
   config.retry = false
 end
+
+# Provided at initialization
+connection = We::Call::Connection.new(retry_options: false)
 ```
 
 Adjust the middleware:
@@ -120,6 +123,9 @@ Adjust the middleware:
 We::Call.configure do |config|
   config.retry_options = { interval: 0.5 }
 end
+
+# Provided at initialization
+connection = We::Call::Connection.new(retry_options: { interval: 0.5 })
 ```
 
 The gem smartly merges the options passed, so you can specify your own list of exceptions without being afraid to override the default ones:

lib/we/call/connection.rb

@@ -46,8 +46,9 @@ def get_adapter
       # @param [String] app
       # @param [String] env
       # @yieldparam [Faraday::Connection] Faraday connection object is yielded to a block
-      def new(host:, timeout: nil, open_timeout: OPEN_TIMEOUT, app: guess_app, env: guess_env, &block)
+      def new(host:, timeout: nil, open_timeout: OPEN_TIMEOUT, app: guess_app, env: guess_env, retry_options: {}, &block)
         @host = host
+        @retry_options = retry_options
         @app = app or raise_missing_app!
         @env = env or raise_missing_env!
         @timeout = timeout or raise_missing_timeout!
@@ -57,7 +58,7 @@ def new(host:, timeout: nil, open_timeout: OPEN_TIMEOUT, app: guess_app, env: gu
 
       private
 
-      attr_reader :app, :env, :host, :timeout, :open_timeout
+      attr_reader :app, :env, :host, :timeout, :open_timeout, :retry_options
 
       # @return [Faraday::Connection] Preconfigured Faraday Connection object, for hitting get, post, etc.
       def create
@@ -78,7 +79,7 @@ def create
           if config.detect_deprecations
             faraday.response :sunset, setup_sunset_middleware(faraday)
           end
-          if config.retry
+          if should_retry?
             faraday.request :retry, fetch_retry_options
           end
 
@@ -127,8 +128,14 @@ def setup_sunset_middleware(faraday)
         options
       end
 
+      def should_retry?
+        retry_options.any? || config.retry
+      end
+
       def fetch_retry_options
-        DEFAULT_RETRY_OPTIONS.merge(config.retry_options) do |key, default_val, new_val|
+        client_options = retry_options.any? ? retry_options : config.retry_options
+
+        DEFAULT_RETRY_OPTIONS.merge(client_options) do |key, default_val, new_val|
           if key == :exceptions
             default_val + Array(new_val)
           else

lib/we/call/version.rb

@@ -1,5 +1,5 @@
 module We
   module Call
-    VERSION = "0.10.0"
+    VERSION = "0.11.0"
   end
 end

spec/unit/we/call/connection_spec.rb

@@ -273,6 +273,19 @@
                 We::Call::Connection::DEFAULT_RETRY_OPTIONS.merge(options)
               )
             end
+
+            context 'when retry options are set on a connection' do
+              let(:options) { { max: 3, backoff_factor: 2 } }
+              let(:valid_arguments) { super().merge(retry_options: options) }
+
+              it 'registers the middleware with the correct options' do
+                subject
+                expect(builder_spy).to have_received(:request).with(
+                  :retry,
+                  We::Call::Connection::DEFAULT_RETRY_OPTIONS.merge(options)
+                )
+              end
+            end
           end
 
           context 'when exceptions are overriden' do