nogara-redis_failover 0.8.11 → 0.9.0

data/Changes.md

@@ -1,4 +1,4 @@
-HEAD
+0.9.0
 -----------
 - Make Node Manager's lock path vary with its main znode. (Bira)
 - Node Manager's znode for holding current list of redis nodes is no longer ephemeral. This is unnecessary since the current master should only be changed by redis_failover.
@@ -7,6 +7,7 @@ HEAD
 - Introduce RedisFailover::Client#on_node_change callback notification for when the currently known list of master/slave redis nodes changes.
 - Added #current_master and #current_slaves to RedisFailover::Client. This is useful for programmatically doing things based on the current master/slaves.
 - redis_node_manager should start if no redis servers are available (#29)
+- Better handling of ZK session expirations in Node Manager.
 
 0.8.9
 -----------

data/lib/redis_failover/errors.rb

@@ -44,4 +44,8 @@ module RedisFailover
       super("Operation `#{operation}` is currently unsupported")
     end
   end
+
+  # Raised when we detect an expired ZK session.
+  class ZKDisconnectedError < Error
+  end
 end

data/lib/redis_failover/node_manager.rb

@@ -52,7 +52,7 @@ module RedisFailover
         spawn_watchers
         handle_state_reports
       end
-    rescue ZK::Exceptions::InterruptedSession => ex
+    rescue ZK::Exceptions::InterruptedSession, ZKDisconnectedError => ex
       logger.error("ZK error while attempting to manage nodes: #{ex.inspect}")
       logger.error(ex.backtrace.join("\n"))
       shutdown
@@ -83,6 +83,7 @@ module RedisFailover
     def setup_zk
       @zk.close! if @zk
       @zk = ZK.new("#{@options[:zkservers]}#{@options[:chroot] || ''}")
+      @zk.on_expired_session { notify_state(:zk_disconnected, nil) }
 
       @zk.register(@manual_znode) do |event|
         @mutex.synchronize do
@@ -106,12 +107,13 @@ module RedisFailover
           when :available       then handle_available(node)
           when :syncing         then handle_syncing(node)
           when :manual_failover then handle_manual_failover(node)
+          when :zk_disconnected then raise ZKDisconnectedError
           else raise InvalidNodeStateError.new(node, state)
           end
 
           # flush current state
           write_state
-        rescue ZK::Exceptions::InterruptedSession
+        rescue ZK::Exceptions::InterruptedSession, ZKDisconnectedError
           # fail hard if this is a ZK connection-related error
           raise
         rescue => ex

data/lib/redis_failover/runner.rb

@@ -10,8 +10,8 @@ module RedisFailover
       options = CLI.parse(options)
       @node_manager = NodeManager.new(options)
       trap_signals
-      node_manager_thread = Thread.new { @node_manager.start }
-      node_manager_thread.join
+      @node_manager_thread = Thread.new { @node_manager.start }
+      @node_manager_thread.join
     end
 
     # Traps shutdown signals.
@@ -20,6 +20,7 @@ module RedisFailover
         trap(signal) do
           Util.logger.info('Shutting down ...')
           @node_manager.shutdown
+          @node_manager_thread.join
           exit(0)
         end
       end

data/lib/redis_failover/version.rb

@@ -1,3 +1,3 @@
 module RedisFailover
-  VERSION = '0.8.11'
+  VERSION = '0.9.0'
 end

data/redis_failover.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/redis_failover/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Ryan LeCompte"]
   gem.email         = ["lecompte@gmail.com"]
-  gem.description   = %(Redis Failover is a ZooKeeper-based automatic master/slave failover solution for Ruby)
-  gem.summary       = %(Redis Failover is a ZooKeeper-based automatic master/slave failover solution for Ruby)
+  gem.description   = %(redis_failover is a ZooKeeper-based automatic master/slave failover solution for Ruby)
+  gem.summary       = %(redis_failover is a ZooKeeper-based automatic master/slave failover solution for Ruby)
   gem.homepage      = "http://github.com/ryanlecompte/redis_failover"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/client_spec.rb

@@ -26,7 +26,7 @@ module RedisFailover
   end
 
   describe Client do
-    let(:client) { ClientStub.new(:zkservers => 'localhost:9281') }
+    let(:client) { ClientStub.new(:zkservers => 'localhost:9281', :safe_mode => true) }
 
     describe '#build_clients' do
       it 'properly parses master' do
@@ -48,14 +48,28 @@ module RedisFailover
         called.should be_true
       end
 
-      it 'routes read operations to a slave' do
-        called = false
-        client.current_slaves.first.change_role_to('slave')
-        client.current_slaves.first.define_singleton_method(:get) do |*args|
-          called = true
+      context 'with :master_only false' do
+        it 'routes read operations to a slave' do
+          called = false
+          client.current_slaves.first.change_role_to('slave')
+          client.current_slaves.first.define_singleton_method(:get) do |*args|
+            called = true
+          end
+          client.get('foo')
+          called.should be_true
+        end
+      end
+
+      context 'with :master_only true' do
+        it 'routes read operations to master' do
+          client = ClientStub.new(:zkservers => 'localhost:9281', :master_only => true)
+          called = false
+          client.current_master.define_singleton_method(:get) do |*args|
+            called = true
+          end
+          client.get('foo')
+          called.should be_true
         end
-        client.get('foo')
-        called.should be_true
       end
 
       it 'reconnects when node is unavailable' do
@@ -90,10 +104,21 @@ module RedisFailover
         expect { client.select }.to raise_error(UnsupportedOperationError)
       end
 
-      it 'attempts ZK reconnect when no communication from Node Manager within certain time window' do
-        client.instance_variable_set(:@last_znode_timestamp, Time.at(0))
-        client.should_receive(:build_clients)
-        client.del('foo')
+      context 'with :safe_mode enabled' do
+        it 'rebuilds clients when no communication from Node Manager within certain time window' do
+          client.instance_variable_set(:@last_znode_timestamp, Time.at(0))
+          client.should_receive(:build_clients)
+          client.del('foo')
+        end
+      end
+
+      context 'with :safe_mode disabled' do
+        it 'does not rebuild clients when no communication from Node Manager within certain time window' do
+          client = ClientStub.new(:zkservers => 'localhost:9281', :safe_mode => false)
+          client.instance_variable_set(:@last_znode_timestamp, Time.at(0))
+          client.should_not_receive(:build_clients)
+          client.del('foo')
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nogara-redis_failover
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -129,7 +129,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Redis Failover is a ZooKeeper-based automatic master/slave failover solution
+description: redis_failover is a ZooKeeper-based automatic master/slave failover solution
   for Ruby
 email:
 - lecompte@gmail.com
@@ -198,7 +198,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Redis Failover is a ZooKeeper-based automatic master/slave failover solution
+summary: redis_failover is a ZooKeeper-based automatic master/slave failover solution
   for Ruby
 test_files:
 - spec/cli_spec.rb