redis_failover 0.2.0 → 0.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Changes.md

@@ -1,3 +1,9 @@
+0.3.0
+-----------
+- Integrated travis-ci
+- Added background monitor to client for proactively detecting
+  changes to current set of redis nodes
+
 0.2.0
 -----------
 - Added retry support for contacting failover server from client

data/README.md

@@ -1,5 +1,7 @@
 # Automatic Redis Failover Client/Server
 
+[![Build Status](https://secure.travis-ci.org/ryanlecompte/redis_failover.png?branch=master)](http://travis-ci.org/ryanlecompte/redis_failover)
+
 Redis Failover attempts to provides a full automatic master/slave failover solution for Ruby. Redis does not provide
 an automatic failover capability when configured for master/slave replication. When the master node dies,
 a new master must be manually brought online and assigned as the slave's new master. This manual

data/lib/redis_failover/client.rb

@@ -86,11 +86,11 @@ module RedisFailover
       @retry = options[:retry_failure] || true
       @max_retries = @retry ? options.fetch(:max_retries, 3) : 0
       @server_url = "http://#{options[:host]}:#{options[:port]}/redis_servers"
-      @redis_servers = nil
       @master = nil
       @slaves = []
       @lock = Mutex.new
       build_clients
+      start_background_monitor
     end
 
     def method_missing(method, *args, &block)
@@ -106,7 +106,7 @@ module RedisFailover
     end
 
     def inspect
-      "#<RedisFailover::Client - master: #{master_info}, slaves: #{slaves_info})>"
+      "#<RedisFailover::Client - master: #{master_name}, slaves: #{slave_names})>"
     end
     alias_method :to_s, :inspect
 
@@ -141,9 +141,10 @@ module RedisFailover
     end
 
     def master
-      if @master
-        verify_role!(@master, :master)
-        return @master
+      master = @master
+      if master
+        verify_role!(master, :master)
+        return master
       end
       raise NoMasterError
     end
@@ -162,16 +163,19 @@ module RedisFailover
         tries = 0
 
         begin
-          logger.info('Attempting to fetch nodes and build redis clients.')
-          servers = fetch_redis_servers
-          master = new_clients_for(servers[:master]).first if servers[:master]
-          slaves = new_clients_for(*servers[:slaves])
+          logger.info('Checking for new redis nodes.')
+          nodes = fetch_nodes
+          return unless nodes_changed?(nodes)
+
+          logger.info('Node change detected, rebuilding clients.')
+          master = new_clients_for(nodes[:master]).first if nodes[:master]
+          slaves = new_clients_for(*nodes[:slaves])
 
           # once clients are successfully created, swap the references
           @master = master
           @slaves = slaves
         rescue => ex
-          logger.error("Failed to fetch servers from #{@server_url} - #{ex.message}")
+          logger.error("Failed to fetch nodes from #{@server_url} - #{ex.message}")
           logger.error(ex.backtrace.join("\n"))
 
           if tries < @max_retries
@@ -184,11 +188,11 @@ module RedisFailover
       end
     end
 
-    def fetch_redis_servers
+    def fetch_nodes
       open(@server_url) do |io|
-        servers = symbolize_keys(MultiJson.decode(io))
-        logger.info("Fetched servers: #{servers}")
-        servers
+        nodes = symbolize_keys(MultiJson.decode(io))
+        logger.info("Fetched nodes: #{nodes}")
+        nodes
       end
     end
 
@@ -203,26 +207,52 @@ module RedisFailover
       end
     end
 
-    def master_info
-      return "none" unless @master
-      name_for(@master)
+    def master_name
+      address_for(@master) || 'none'
     end
 
-    def slaves_info
-      return "none" if @slaves.empty?
-      @slaves.map { |slave| name_for(slave) }.join(', ')
+    def slave_names
+      return 'none' if @slaves.empty?
+      addresses_for(@slaves).join(', ')
     end
 
     def verify_role!(node, role)
       current_role = node.info['role']
       if current_role.to_sym != role
-        raise InvalidNodeRoleError.new(name_for(node), role, current_role)
+        raise InvalidNodeRoleError.new(address_for(node), role, current_role)
       end
       role
     end
 
-    def name_for(node)
+    def addresses_for(nodes)
+      nodes.map { |node| address_for(node) }
+    end
+
+    def address_for(node)
+      return unless node
       "#{node.client.host}:#{node.client.port}"
     end
+
+    def nodes_changed?(new_nodes)
+      return true if address_for(@master) != new_nodes[:master]
+      return true if different?(addresses_for(@slaves), new_nodes[:slaves])
+      false
+    end
+
+    # Spawns a background thread to periodically fetch the latest
+    # set of nodes from the redis failover server.
+    def start_background_monitor
+      Thread.new do
+        loop do
+          sleep(10)
+          begin
+            build_clients
+          rescue => ex
+            logger.error("Failed to poll for new nodes from #{@server_url} - #{ex.message}")
+            logger.error(ex.backtrace.join("\n"))
+          end
+        end
+      end
+    end
   end
 end

data/lib/redis_failover/util.rb

@@ -7,6 +7,10 @@ module RedisFailover
       Hash[hash.map { |k, v| [k.to_sym, v] }]
     end
 
+    def different?(ary_a, ary_b)
+      ((ary_a | ary_b) - (ary_a & ary_b)).size > 0
+    end
+
     def self.logger
       @logger ||= begin
         logger = Logger.new(STDOUT)

data/lib/redis_failover/version.rb

@@ -1,3 +1,3 @@
 module RedisFailover
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/client_spec.rb

@@ -11,7 +11,7 @@ module RedisFailover
       @slaves
     end
 
-    def fetch_redis_servers
+    def fetch_nodes
       {
         :master => 'localhost:6379',
         :slaves => ['localhost:1111'],
@@ -31,6 +31,18 @@ module RedisFailover
       it 'properly parses slaves' do
         client.current_slaves.first.to_s.should == 'localhost:1111'
       end
+
+      it 'does not rebuild clients if hosts have not changed' do
+        class << client
+          attr_reader :built_new_client
+          def new_clients_for(*)
+            @built_new_client = true
+          end
+        end
+
+        5.times { client.send(:build_clients) }
+        client.built_new_client.should_not be_true
+      end
     end
 
     describe '#dispatch' do
@@ -52,6 +64,15 @@ module RedisFailover
             @reconnected = true
             super
           end
+
+          def fetch_nodes
+            @calls ||= 0
+            {
+              :master => "localhost:222#{@calls += 1}",
+              :slaves => ['localhost:1111'],
+              :unreachable => []
+            }
+          end
         end
 
         client.current_master.make_unreachable!

data/spec/util_spec.rb

@@ -7,5 +7,15 @@ module RedisFailover
         Util.symbolize_keys('a' => 1, 'b' => 2).should == {:a => 1, :b => 2}
       end
     end
+
+    describe '.different?' do
+      it 'handles different arrays' do
+        Util.different?([1,2,3], [1,5,3]).should be_true
+      end
+
+      it 'handles non-different arrays' do
+        Util.different?([1,2,3], [3,2,1]).should be_false
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_failover
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70198326575220 !ruby/object:Gem::Requirement
+  requirement: &70202974273640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198326575220
+  version_requirements: *70202974273640
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70198326574780 !ruby/object:Gem::Requirement
+  requirement: &70202974273200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198326574780
+  version_requirements: *70202974273200
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70198326574360 !ruby/object:Gem::Requirement
+  requirement: &70202974272780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198326574360
+  version_requirements: *70202974272780
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70198326573940 !ruby/object:Gem::Requirement
+  requirement: &70202974272360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70198326573940
+  version_requirements: *70202974272360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70198326573520 !ruby/object:Gem::Requirement
+  requirement: &70202974271940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70198326573520
+  version_requirements: *70202974271940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70198326573100 !ruby/object:Gem::Requirement
+  requirement: &70202974271520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70198326573100
+  version_requirements: *70202974271520
 description: Redis Failover provides a full automatic master/slave failover solution
   for Ruby
 email:
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Changes.md
 - Gemfile
 - LICENSE
@@ -128,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -200241163739368802
+      hash: -1781006209108187327
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -200241163739368802
+      hash: -1781006209108187327
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16