redis-reconnect_with_readonly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99bf3c8d0b6f2e6f28e9d495afed579f9840898c
-  data.tar.gz: d8e6e5295fbf9e8de451f956ee4a1fa999cc843b
+  metadata.gz: 15ff6c001cad1dccfdde9ba2c50f13b9993e432c
+  data.tar.gz: 8b631aa7157e62ff540abdb75c2f4972e617879b
 SHA512:
-  metadata.gz: 0a7ee1b9cf6d59033fbd1b28067438e0802581354383d1ac156bcb3ad9b2a8a2dbd1ee9fb5d4f0db299bcc2fcce67bf7c527b41e9c6e3381bffdf84beae63a4b
-  data.tar.gz: 959ca49d8e7bba3323c5080e89d2e587db66e1f1bfec18e0e5221f2c43e9425cf647c6718ceda91742cd7ffa6bc01cada2b5d9a6fdaf8b2901f9b059349da24f
+  metadata.gz: 923f28e0401979e5a86a68a628a516cc3fd56f7347f0125635fcb6e7bde0a9b0fa2be07147211c90c7d3301582ad78ad59a89bd184a6b7ba61a6c28eba98c110
+  data.tar.gz: 39729e0ea98fbc89a64e1e56111a08823bf3e2c291899760fdbc0d8df22dd074e44e4b4ab851ee456f5fb2fa9dca30540492a549e0d5547e862b1b2b15ead996

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.1.1 (2016-08-24)
+
+* Make configurable `reconnect_attempts` and `max_retry_interval`
+
 # 0.1.0 (2016-08-24)
 
 First version
+

data/README.md

@@ -1,6 +1,6 @@
 # Redis::ReconnectWithReadonly
 
-Reconnect your redis connection if `Redis::CommandError READONLY You can't write against a read only slave.` appears because of failover.
+Reconnect your redis connection if `Redis::CommandError READONLY You can't write against a read only slave.` occurs because of failover.
 
 When redis cluster failovers, the redis master is depromoted to slave and will be READONLY. Such case we have to reconnect redis connection so that new connection goes to new master which is writable.
 
@@ -26,6 +26,21 @@ Or install it yourself as:
 require 'redis/reconnect_with_readonly'
 ```
 
+## Configuration
+
+This gem tries reconnection `reconnect_attempts` times.
+It will wait `2 ^ num of retries` second interval on each retry.
+The waiting interval can be suppressed up to `max_retry_interval`.
+
+```
+Redis::ReconnectWithReadonly.reconnect_attempts = 1
+Redis::ReconnectWithReadonly.max_retry_interval = 3600
+```
+
+## Implementation
+
+This gem monkey patches `Redis::Client`.
+
 ## Development
 
 ```
@@ -44,10 +59,6 @@ $ bin/console
 > redis.set('key', 'val')
 ```
 
-## Implementation
-
-This gem monkey patches `Redis::Client#read`.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis-reconnect_with_readonly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/try

@@ -4,7 +4,9 @@ require "bundler/setup"
 require "redis/reconnect_with_readonly"
 require 'logger'
 
-logger = Logger.new(STDOUT)
+Redis::ReconnectWithReadonly.reconnect_attempts = 5
+Redis::ReconnectWithReadonly.max_retry_interval = 3
 
+logger = Logger.new(STDOUT)
 redis = Redis.new(host: 'localhost', port: '6380', logger: logger)
 redis.set('key', 'val')

data/lib/redis/reconnect_with_readonly.rb

@@ -3,19 +3,71 @@ require 'redis'
 require 'redis/client'
 require 'redis/errors'
 
+class Redis
+  class ReconnectWithReadonly
+    @reconnect_attempts = 1
+    @max_retry_interval = 3600 # sec
+
+    class << self
+      attr_accessor :reconnect_attempts, :max_retry_interval
+    end
+  end
+end
+
 class Redis
   class ReadonlyConnectionError < ConnectionError; end
 
   class Client
-    def read_with_reconnect_with_readonly
-      reply = read_without_reconnect_with_readonly
-      if reply.is_a?(CommandError)
-        logger.info { "Reconnect: #{reply.message}" } if logger
-        raise Redis::ReadonlyConnectionError.new(reply.message)
+    def reconnect_with_readonly(&block)
+      retries = 0
+      begin
+        yield block
+      rescue CommandError => e
+        if e.message =~ /READONLY/
+          if retries < (max_retries = ReconnectWithReadonly.reconnect_attempts)
+            interval = [2**retries, ReconnectWithReadonly.max_retry_interval].min
+            logger.info {
+              "Reconnect with readonly: #{e.message} " \
+              "(retries: #{retries}/#{max_retries}) (wait: #{interval}sec)"
+            } if logger
+            sleep interval
+            retries += 1
+            retry
+          else
+            logger.info {
+              "Reconnect with readonly: Give up " \
+              "(retries: #{retries}/#{max_retries})"
+            } if logger
+          end
+        else
+          raise
+        end
+      end
+    end
+
+    def call_with_reconnect_with_readonly(command, &block)
+      reconnect_with_readonly do
+        call_without_reconnect_with_readonly(command, &block)
+      end
+    end
+
+    def call_loop_with_reconnect_with_readonly(command, &block)
+      reconnect_with_readonly do
+        call_loop_without_reconnect_with_readonly(command, &block)
+      end
+    end
+
+    def call_pipeline_with_reconnect_with_readonly(command, &block)
+      reconnect_with_readonly do
+        call_pipeline_without_reconnect_with_readonly(command, &block)
       end
     end
 
-    alias :read_without_reconnect_with_readonly :read
-    alias :read :read_with_reconnect_with_readonly
+    alias :call_without_reconnect_with_readonly :call
+    alias :call :call_with_reconnect_with_readonly
+    alias :call_loop_without_reconnect_with_readonly :call_loop
+    alias :call_loop :call_loop_with_reconnect_with_readonly
+    alias :call_pipeline_without_reconnect_with_readonly :call_pipeline
+    alias :call_pipeline :call_pipeline_with_reconnect_with_readonly
   end
 end

data/lib/redis/reconnect_with_readonly/version.rb

@@ -1,5 +1,5 @@
 class Redis
-  module ReconnectWithReadonly
-    VERSION = "0.1.0"
+  class ReconnectWithReadonly
+    VERSION = "0.1.1"
   end
 end

data/redis-reconnect_with_readonly.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Naotoshi Seo"]
   spec.email         = ["sonots@gmail.com"]
 
-  spec.summary       = %q{Reconnect redis if Redis::CommandError READONLY appears.}
-  spec.description   = %q{Reconnect redis if Redis::CommandError READONLY appears.}
+  spec.summary       = %q{Reconnect redis if Redis::CommandError READONLY occurs.}
+  spec.description   = %q{Reconnect redis if Redis::CommandError READONLY occurs.}
   spec.homepage      = "https://github.com/sonots/redis-reconnect_with_readonly."
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-reconnect_with_readonly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Reconnect redis if Redis::CommandError READONLY appears.
+description: Reconnect redis if Redis::CommandError READONLY occurs.
 email:
 - sonots@gmail.com
 executables: []
@@ -97,5 +97,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Reconnect redis if Redis::CommandError READONLY appears.
+summary: Reconnect redis if Redis::CommandError READONLY occurs.
 test_files: []