raidis 0.1.0 → 0.2.0

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/bukowskis/raidis.png)](https://travis-ci.org/bukowskis/raidis)
+
 # Raid-is
 
 Raidis is yet another failover solution for Redis.
@@ -27,7 +29,7 @@ Raidis.redis.class # => Redis::Namespace
 
 # How does it work?
 
-Whenever you call `Raidis.redis`, the connectivity to the remote redis server is monitored. If connectivity problems occur, or you're trying to make write-calls to a Redis slave, Raidis will immediately reload the `/etc/redis_master` file and try to perform the call to Redis again (hoping to have connected to a working redis server this time). If that second attempt failed (or you set `config.retries` to `0`) a `Raidis::ConnectionError` is raised. 
+Whenever you call `Raidis.redis`, the connectivity to the remote redis server is monitored. If connectivity problems occur, or you're trying to make write-calls to a Redis slave, Raidis will immediately reload the `/etc/redis_master` file and try to perform the call to Redis again (hoping to have connected to a working redis server this time). If that second attempt failed (or you set `config.retries` to `0`) a `Raidis::ConnectionError` is raised. To prevent too many retries in too short time, there is a minimum interval that Radis will wait after every retry attempt (see config `retry_interval`, default is 3 seconds).
 
 You should not have too many retries, because you don't want the end user's browser to hang and wait too long. That's where the `#available?` feature comes in. As soon as one of those connection errors occurs, the global variable `Raidis.available?` turns from `true` to `false` and any further damage can be mitigated, by simply not making any further calls to redis. You should inform your end-users about the outage in a friendly manner. E.g. like so:
 
@@ -60,6 +62,7 @@ Raidis.configure do |config|
   config.redis_timeout   = 3  # seconds                # default is whatever Redis.new has as default
 
   config.retries = 3  # times                          # default is 1
+  config.retry_interval = 3  # seconds                 # default is 3
   config.unavailability_timeout = 60  # seconds        # default is 15 seconds
   config.info_file_path         = '/opt/redis_server'  # default is '/etc/redis_master'
 

data/lib/raidis/configuration.rb

@@ -13,7 +13,7 @@ module Raidis
     end
 
     attr_accessor :redis_namespace, :redis_timeout, :redis_db
-    attr_writer :logger, :unavailability_timeout, :master, :retries
+    attr_writer :logger, :unavailability_timeout, :master, :retries, :retry_interval
 
     def logger
       @logger ||= begin
@@ -41,6 +41,10 @@ module Raidis
       @retries ||= 1
     end
 
+    def retry_interval
+      @retry_interval ||= 3
+    end
+
     def master
       unless @master
         unless info_file_path.exist?

data/lib/raidis/redis_wrapper.rb

@@ -1,3 +1,5 @@
+require 'raidis/throttle'
+
 module Raidis
   class RedisWrapper
 
@@ -24,7 +26,9 @@ module Raidis
       result = block.call
     rescue Raidis::ConnectionError => exception
       # Try again a couple of times.
+      throttle.sleep_if_needed
       if (tries -= 1) >= 0
+        throttle.action!
         reconnect!
         retry
       end
@@ -81,6 +85,10 @@ module Raidis
       @redis = nil
     end
 
+    def throttle
+      @throttle ||= Throttle.new config.retry_interval
+    end
+
     # Internal: Establishes a brand-new, raw connection to Redis.
     #
     # Returns a Redis::Namespace instance or nil if we don't know where the Redis server is.

data/lib/raidis/throttle.rb

@@ -0,0 +1,22 @@
+module Raidis
+  class Throttle
+
+    attr_reader :interval, :last_action
+
+    def initialize(seconds = 3)
+      @interval = seconds.to_i
+    end
+
+    def sleep_if_needed
+      return unless last_action
+      duration = last_action + interval - Time.now
+      return unless duration.to_i > 0
+      sleep duration
+    end
+
+    def action!
+      @last_action = Time.now
+    end
+
+  end
+end

data/spec/lib/raidis/throttle_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Raidis::Throttle do
+
+  let(:interval) { 3 }
+  let(:throttle) { Raidis::Throttle.new }
+
+  before do
+    Raidis::Throttle.stub!(:sleep)
+  end
+
+  context 'no action took place yet' do
+    describe '#sleep_if_needed' do
+      it 'does not sleep' do
+        throttle.should_not_receive(:sleep)
+        throttle.sleep_if_needed
+      end
+    end
+  end
+
+  context 'action took place 1 second ago' do
+    before do
+      Timecop.freeze
+      throttle.action!
+      Timecop.freeze Time.now + 1
+    end
+
+    describe '#sleep_if_needed' do
+      it 'sleeps for 2 seconds' do
+        throttle.should_receive(:sleep).with(2)
+        throttle.sleep_if_needed
+      end
+    end
+  end
+
+  context 'action took place 2 seconds ago' do
+    before do
+      Timecop.freeze
+      throttle.action!
+      Timecop.freeze Time.now + 2
+    end
+
+    describe '#sleep_if_needed' do
+      it 'sleeps for 1 seconds' do
+        throttle.should_receive(:sleep).with(1)
+        throttle.sleep_if_needed
+      end
+    end
+  end
+
+  context 'action took place 4 seconds ago' do
+    before do
+      Timecop.freeze
+      throttle.action!
+      Timecop.freeze Time.now + 4
+    end
+
+    describe '#sleep_if_needed' do
+      it 'does not sleep' do
+        throttle.should_not_receive(:sleep)
+        throttle.sleep_if_needed
+      end
+    end
+  end
+
+end

data/spec/lib/redis_wrapper_spec.rb

@@ -21,7 +21,7 @@ end
 
 describe Raidis::RedisWrapper do
 
-  let(:config)        { mock(:config, retries: 3) }
+  let(:config)        { mock(:config, retries: 3, retry_interval: 0) }
   let(:backend)       { mock(:backend) }
   let(:shaky_backend) { ShakyRedis.new }
   let(:wrapper)       { Raidis::RedisWrapper.new }
@@ -71,13 +71,27 @@ describe Raidis::RedisWrapper do
         wrapper.some_redis_command.should == :shaky_result
       end
 
-      context 'when running out of retries' do
+      context 'with a retry interval' do
         before do
-          config.stub!(:retries).and_return 2
+          config.stub!(:retry_interval).and_return 10
         end
 
-        it 'finally raises a unified connection error' do
-          expect { wrapper.some_redis_command }.to raise_error(Raidis::ConnectionError)
+        it 'waits some time before each retry' do
+          wrapper.throttle.should_receive(:sleep).exactly(2).times.with(10)
+          Timecop.freeze
+          wrapper.some_redis_command.should == :shaky_result
+        end
+
+        context 'when running out of retries' do
+          before do
+            config.stub!(:retries).and_return 1
+          end
+
+          it 'finally raises a unified connection error' do
+            wrapper.throttle.should_receive(:sleep).with(10)
+            Timecop.freeze
+            expect { wrapper.some_redis_command }.to raise_error(Raidis::ConnectionError)
+          end
         end
       end
     end

data/spec/spec_helper.rb

@@ -34,6 +34,7 @@ RSpec.configure do |config|
     Raidis.configure do |config|
       config.redis_db = 15
       config.redis_timeout = 0.5
+      config.retry_interval = 0
     end
     Raidis.config.stub!(:info_file_path).and_return mock(:info_file_path, exist?: true, readable?: true, read: '127.0.0.1')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raidis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -100,7 +100,9 @@ files:
 - lib/raidis/availability.rb
 - lib/raidis/configuration.rb
 - lib/raidis/redis_wrapper.rb
+- lib/raidis/throttle.rb
 - lib/raidis.rb
+- spec/lib/raidis/throttle_spec.rb
 - spec/lib/raidis_spec.rb
 - spec/lib/redis_wrapper_spec.rb
 - spec/spec_helper.rb