Merge pull request #778 from eavgerinos/reconnect-delay

redis::client: Add exponential backoff on reconnects

Author: byroot

lib/redis/client.rb

@@ -18,6 +18,8 @@ class Client
       :id => nil,
       :tcp_keepalive => 0,
       :reconnect_attempts => 1,
+      :reconnect_delay => 0,
+      :reconnect_delay_max => 0.5,
       :inherit_socket => false
     }
 
@@ -375,6 +377,10 @@ def ensure_connected
         disconnect
 
         if attempts <= @options[:reconnect_attempts] && @reconnect
+          sleep_t = [(@options[:reconnect_delay] * 2**(attempts-1)),
+                     @options[:reconnect_delay_max]].min
+
+          Kernel.sleep(sleep_t)
           retry
         else
           raise
@@ -452,6 +458,8 @@ def _parse_options(options)
       options[:write_timeout]   = Float(options[:write_timeout])
 
       options[:reconnect_attempts] = options[:reconnect_attempts].to_i
+      options[:reconnect_delay] = options[:reconnect_delay].to_f
+      options[:reconnect_delay_max] = options[:reconnect_delay_max].to_f
 
       options[:db] = options[:db].to_i
       options[:driver] = _parse_driver(options[:driver]) || Connection.drivers.last

redis.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.2.2'
 
   s.add_development_dependency("test-unit", ">= 3.1.5")
+  s.add_development_dependency("mocha")
   s.add_development_dependency("hiredis")
   s.add_development_dependency("em-synchrony")
 end

test/helper.rb

@@ -1,4 +1,5 @@
 require "test/unit"
+require "mocha/test_unit"
 require "logger"
 require "stringio"
 

test/internals_test.rb

@@ -202,6 +202,19 @@ def test_retry_with_custom_reconnect_attempts_can_still_fail
     end
   end
 
+  def test_retry_with_custom_reconnect_attempts_and_exponential_backoff
+    close_on_ping([0, 1, 2], :reconnect_attempts => 3,
+                             :reconnect_delay_max => 0.5,
+                             :reconnect_delay => 0.01) do |redis|
+
+      Kernel.expects(:sleep).with(0.01).returns(true)
+      Kernel.expects(:sleep).with(0.02).returns(true)
+      Kernel.expects(:sleep).with(0.04).returns(true)
+
+      assert_equal "3", redis.ping
+    end
+  end
+
   def test_don_t_retry_when_second_read_in_pipeline_raises_econnreset
     close_on_ping([1]) do |redis|
       assert_raise Redis::ConnectionError do