redis-sentinel 1.1.3 → 1.1.4

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# CHANGELOG
+
+## 1.1.4
+
+* Fix discover_master procedure wich failover_reconnect_wait option
+* Add test_wait_for_failover_write example
+
+## 1.1.3
+
+* Cache sentinel connections
+* Add option failover_reconnect_timeout
+* Add option failover_reconnect_wait
+* Add test_wait_for_failover example
+
+## 1.1.2
+
+* Ruby 1.8.7 compatibility
+
+## 1.1.1
+
+* Fix initialize Redis::ConnectionError
+
+## 1.1.0
+
+* Remove background thread, which subscribes switch-master message
+* Add example
+
+## 1.0.0
+
+* First version

data/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# CONTRIBUTING
+
+We love pull requests. Here's a quick guide:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Please make sure you add a test for your change and all tests are passed.
+(`bundle && rspec spec`)

data/README.md

@@ -1,9 +1,9 @@
 # Redis::Sentinel
 
-another redis automatic master/slave failover solution for ruby by
+Another redis automatic master/slave failover solution for ruby by
 using built-in redis sentinel.
 
-it subscribes message with channel "+switch-master", when message
+It subscribes message with channel "+switch-master", when message
 received, it will disconnect current connection and connect to new
 master server.
 
@@ -27,7 +27,7 @@ Specify the sentinel servers and master name
 
     Redis.new(master_name: "master1", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])
 
-There are two additional options: 
+There are two additional options:
 
 1. `:failover_reconnect_timeout` (seconds) will block for that long when
    redis is unreachable to give failover enough time to take place. Does
@@ -38,26 +38,26 @@ There are two additional options:
 
 ## Example
 
-start redis master server, listen on port 16379
+Start redis master server, listen on port 16379
 
 ```
 $ redis-server example/redis-master.conf
 ```
 
-start redis slave server, listen on  port 16380
+Start redis slave server, listen on  port 16380
 
 ```
 $ redis-server example/redis-slave.conf
 ```
 
-start 2 sentinel servers
+Start 2 sentinel servers
 
 ```
 $ redis-server example/redis-sentinel1.conf --sentinel
 $ redis-server example/redis-sentinel2.conf --sentinel
 ```
 
-run example/test.rb, which will query value of key "foo" every second.
+Run example/test.rb, which will query value of key "foo" every second.
 
 ```
 $ bundle exec ruby example/test.rb
@@ -82,12 +82,18 @@ You will see the stream of "bar" will stop while failover is taking
 place and will resume once it has completed, provided that failover
 takes less than 30 seconds.
 
-## Contributing
+## Authors and Contributors
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* [Richard Huang](https://github.com/flyerhzm) - Creator of the project
+* [Donald Plummer](https://github.com/dplummer) - Add wait / timeout for
+  redis connection
+* [Rafał Michalski](https://github.com/royaltm) - Ensure promoted slave
+  become master
 
-[0]: https://github.com/redis/redis-rb
+Please fork and contribute, any help in making this project better is appreciated!
+
+This project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
+
+## Copyright
+
+Copyright @ 2012 - 2013 Richard Huang. See [MIT-LICENSE](https://github.com/flyerhzm/redis-sentinel/blob/master/MIT-LICENSE) for details

data/example/test_wait_for_failover_write.rb

@@ -0,0 +1,21 @@
+require 'redis'
+require 'redis-sentinel'
+
+redis = Redis.new(:master_name => "example-test",
+                  :sentinels => [
+                    {:host => "localhost", :port => 26379},
+                    {:host => "localhost", :port => 26380}
+                  ],
+                  :failover_reconnect_timeout => 30,
+                  :failover_reconnect_wait => 0.0001)
+
+redis.set "foo", 1
+
+while true
+  begin
+    puts redis.incr "foo"
+  rescue Redis::CannotConnectError => e
+    puts "failover took too long to recover", e
+  end
+  sleep 1
+end

data/lib/redis-sentinel/client.rb

@@ -49,7 +49,7 @@ class Redis::Client
     def try_next_sentinel
       @sentinels << @sentinels.shift
       if @logger && @logger.debug?
-        @logger.debug? "Trying next sentinel: #{@sentinels[0][:host]}:#{@sentinels[0][:port]}"
+        @logger.debug "Trying next sentinel: #{@sentinels[0][:host]}:#{@sentinels[0][:port]}"
       end
       return @sentinels[0]
     end
@@ -63,13 +63,18 @@ class Redis::Client
           if !host && !port
             raise Redis::ConnectionError.new("No master named: #{@master_name}")
           end
-          @options.merge!(:host => host, :port => port.to_i)
-
+          is_down, runid = sentinel.sentinel("is-master-down-by-addr", host, port)
           break
         rescue Redis::CannotConnectError
           try_next_sentinel
         end
       end
+
+      if is_down == "1" || runid == '?'
+        raise Redis::CannotConnectError.new("The master: #{@master_name} is currently not available.")
+      else
+        @options.merge!(:host => host, :port => port.to_i)
+      end
     end
 
   private

data/lib/redis-sentinel/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Sentinel
-    VERSION = "1.1.3"
+    VERSION = "1.1.4"
   end
 end

data/spec/redis-sentinel/client_spec.rb

@@ -37,10 +37,43 @@ describe Redis::Client do
     it "gets the current master" do
       redis.should_receive(:sentinel).
             with("get-master-addr-by-name", "master")
+      redis.should_receive(:sentinel).
+            with("is-master-down-by-addr", "remote.server", 8888)
       subject.discover_master
     end
 
     it "should update options" do
+      redis.should_receive(:sentinel).
+            with("is-master-down-by-addr", "remote.server", 8888).once.
+            and_return(["0", "abc"])
+      subject.discover_master
+      expect(subject.host).to eq "remote.server"
+      expect(subject.port).to eq 8888
+    end
+
+    it "should not update options" do
+      redis.should_receive(:sentinel).
+            with("is-master-down-by-addr", "remote.server", 8888).twice.
+            and_return(["1", "abc"], ["0", "?"])
+      2.times do
+        expect do
+          subject.discover_master
+        end.to raise_error(Redis::CannotConnectError, /currently not available/)
+        expect(subject.host).not_to eq "remote.server"
+        expect(subject.port).not_to eq 8888
+      end
+    end
+
+    it "should select next sentinel" do
+      Redis.should_receive(:new).with({:host => "localhost", :port => 26379})
+      redis.should_receive(:sentinel).
+            with("get-master-addr-by-name", "master").
+            and_raise(Redis::CannotConnectError)
+      Redis.should_receive(:new).with({:host => "localhost", :port => 26380})
+      redis.should_receive(:sentinel).
+            with("get-master-addr-by-name", "master")
+      redis.should_receive(:sentinel).
+            with("is-master-down-by-addr", "remote.server", 8888)
       subject.discover_master
       expect(subject.host).to eq "remote.server"
       expect(subject.port).to eq 8888

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-sentinel
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -52,8 +52,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - example/redis-master.conf
@@ -62,6 +64,7 @@ files:
 - example/redis-slave.conf
 - example/test.rb
 - example/test_wait_for_failover.rb
+- example/test_wait_for_failover_write.rb
 - lib/redis-sentinel.rb
 - lib/redis-sentinel/client.rb
 - lib/redis-sentinel/version.rb