redis_failover 0.8.2 → 0.8.3

data/Changes.md

@@ -1,3 +1,9 @@
+0.8.3
+-----------
+- Added a way to gracefully shutdown/reconnect a RedisFailover::Client. (#13)
+- Upgraded to latest ZK version that supports forking.
+- Handle case where the same RedisFailover::Client is referenced by a #multi block (#14)
+
 0.8.2
 -----------
 - Fix method signature for RedisFailover::Client#respond_to_missing? (#12)

data/lib/redis_failover/client.rb

@@ -148,6 +148,26 @@ module RedisFailover
       self
     end
 
+    # Gracefully performs a shutdown of this client. This method is
+    # mostly useful when the client is used in a forking environment.
+    # When a fork occurs, you can call this method in an after_fork hook,
+    # and then create a new instance of the client. The underlying
+    # ZooKeeper client and redis clients will be closed.
+    def shutdown
+      @zk.close! if @zk
+      @zk = nil
+      purge_clients
+    end
+
+    # Reconnect will first perform a shutdown of the underlying redis clients.
+    # Next, it attempts to reopen the ZooKeeper client and re-create the redis
+    # clients after it fetches the most up-to-date list from ZooKeeper.
+    def reconnect
+      purge_clients
+      @zk ? @zk.reopen : setup_zk
+      build_clients
+    end
+
     private
 
     # Sets up the underlying ZooKeeper connection.
@@ -191,22 +211,13 @@ module RedisFailover
     # @return [Object] the result of dispatching the command
     def dispatch(method, *args, &block)
       unless recently_heard_from_node_manager?
-        @lock.synchronize do
-          reconnect_zk
-          build_clients
-        end
+        build_clients
       end
 
       verify_supported!(method)
       tries = 0
       begin
-        if REDIS_READ_OPS.include?(method)
-          # send read operations to a slave
-          slave.send(method, *args, &block)
-        else
-          # direct everything else to master
-          master.send(method, *args, &block)
-        end
+        client_for(method).send(method, *args, &block)
       rescue *CONNECTIVITY_ERRORS => ex
         logger.error("Error while handling `#{method}` - #{ex.inspect}")
         logger.error(ex.backtrace.join("\n"))
@@ -218,6 +229,12 @@ module RedisFailover
           retry
         end
         raise
+      ensure
+        if info = Thread.current[:last_operation_info]
+          if info[:method] == method
+            Thread.current[:last_operation_info] = nil
+          end
+        end
       end
     end
 
@@ -251,8 +268,6 @@ module RedisFailover
     # The current master/slaves are fetched via ZooKeeper.
     def build_clients
       @lock.synchronize do
-        retried = false
-
         begin
           nodes = fetch_nodes
           return unless nodes_changed?(nodes)
@@ -263,16 +278,8 @@ module RedisFailover
           new_slaves = new_clients_for(*nodes[:slaves])
           @master = new_master
           @slaves = new_slaves
-        rescue ZK::Exceptions::InterruptedSession => ex
-          logger.error("ZK error while attempting to build clients: #{ex.inspect}")
-          logger.error(ex.backtrace.join("\n"))
-
-          # when ZK is disconnected, retry once
-          unless retried
-            reconnect_zk
-            retried = true
-            retry
-          end
+        rescue
+          purge_clients
           raise
         end
       end
@@ -287,6 +294,10 @@ module RedisFailover
       logger.debug("Fetched nodes: #{nodes}")
 
       nodes
+    rescue Zookeeper::Exceptions::InheritedConnectionError => ex
+      logger.debug { "Caught #{ex.class} '#{ex.message}' reconstructing the zk instance" }
+      @zk.reopen
+      retry
     end
 
     # Builds new Redis clients for the specified nodes.
@@ -404,5 +415,33 @@ module RedisFailover
       return false unless @last_znode_timestamp
       Time.now - @last_znode_timestamp <= ZNODE_UPDATE_TIMEOUT
     end
+
+    # Returns the client to use for the specified operation.
+    #
+    # @param [Symbol] method the method for which to retrieve a client
+    # @return [Redis] a redis client to use
+    # @note
+    #   This method stores the last client/method used to handle the case
+    #   where the same RedisFailover::Client instance is referenced by a
+    #   block passed to multi.
+    def client_for(method)
+      if info = Thread.current[:last_operation_info]
+        return info[:client]
+      elsif REDIS_READ_OPS.include?(method)
+        # send read operations to a slave
+        Thread.current[:last_operation_info] = {
+          :client => slave,
+          :method => method
+        }
+      else
+        # direct everything else to master
+        Thread.current[:last_operation_info] = {
+          :client => master,
+          :method => method
+        }
+      end
+
+      Thread.current[:last_operation_info][:client]
+    end
   end
 end

data/lib/redis_failover/version.rb

@@ -1,3 +1,3 @@
 module RedisFailover
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/redis_failover.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency('redis')
   gem.add_dependency('redis-namespace')
   gem.add_dependency('multi_json', '~> 1')
-  gem.add_dependency('zk', '~> 1.1')
+  gem.add_dependency('zk', '~> 1.4')
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')

data/spec/client_spec.rb

@@ -92,7 +92,7 @@ module RedisFailover
 
       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(:reconnect_zk)
+        client.should_receive(:build_clients)
         client.del('foo')
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_failover
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -197947266055602859
+      hash: -651053748036205721
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -197947266055602859
+      hash: -651053748036205721
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23