redis-sentinel 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20c20d9586d8c9751e1ec9e9dff72133a6c07854
-  data.tar.gz: 9d5e482d914cc224b46061a846468c285368b85a
+  metadata.gz: 822e055ecb4e148a1bf08b701e21f6712c519373
+  data.tar.gz: de6b225b065c14d3e429f19a94aa786aa728c9f2
 SHA512:
-  metadata.gz: e0f05568866ee3a20d2ed22784fd93488e7ad00a9f41064973eee7e561a98463cc5f802466bb1f2e568a7caf9b22556c0a2ecbb34c29ecda406a59c8e4354eb0
-  data.tar.gz: 0a0e3dd641a640f9819f1aa84ca63a45e6c9aca77e874c21abc6f0a1cc182456bd5c4ad504561306d31f8ad1797e73ab0fded4445356d61347ae7e8b46006805
+  metadata.gz: 0b6a20ab1e214763b79a47aa0122ea054e45ee9527512a1a56ffc27f6caea384c495d153fe229cb184459e8482805eef7d3377387a83ed377c0d0710952ecda2
+  data.tar.gz: 00e40455360c4969dca6f38cfe2aa9707ead89f04e4a0eff35565ac3977c471979acc23f22ff18524337867d942734ab37dc3c0a44a3fff3b3012c017f8350f7

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 1.5.0
+
+* Subscribe +switch-master again
+* Prevents master discovery to get stuck in endless loop if sentinels
+  are not available
+* Always reconnect at least once, even if reconnect timeout is 0
+* Catch networking errors which bubble up past redis
+
+## 1.4.4
+
+* Allow client to return list of slaves
+* Fix compatibility issues with ruby 1.8.7
+
+## 1.4.3
+
+* Fix for pipelined requests and readonly calls
+
+## 1.4.2
+
+* Fix sentinel reconnection broken
+
 ## 1.4.1
 
 * Fix only one sentinel client reconnect issue

data/README.md

@@ -37,6 +37,11 @@ Sentinels can also be specified using a URI. This URI syntax is required when us
     config.cache_store = :redis_store, { master_name: "master1",
                                          sentinels: ['sentinel://localhost:26379', 'sentinel://localhost:26380'] }
 
+After doing the above, you might still see `#<Redis client v3.1.0 for redis://localhost:6379/0>`. 
+This is fine because redis-sentinel will only try to connect when it is actually required. 
+
+However, if none of the sentinel servers can be reached, a Redis::CannotConnectError will be thrown.
+
 There are two additional options:
 
 1. `:failover_reconnect_timeout` (seconds) will block for that long when
@@ -46,6 +51,20 @@ There are two additional options:
 2. `:failover_reconnect_wait` (seconds) how long to sleep after each
    failed reconnect during a failover event. Defaults to 0.1s.
 
+## Slaves clients
+
+If you need it, you can get an array of Redis clients, each pointing to one of the slaves:
+
+    client = Redis.new(master_name: "master1", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])
+    client.slaves
+    # => [#<Redis client v3.0.7 for redis://127.0.0.1:6380/0>, #<Redis client v3.0.7 for redis://127.0.0.1:6381/0>]
+
+You can also get an array of all the clients (master + slaves):
+
+    client = Redis.new(master_name: "master1", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])
+    client.all_clients
+    # => [#<Redis client v3.0.7 for redis://127.0.0.1:6379/0>, #<Redis client v3.0.7 for redis://127.0.0.1:6380/0>, #<Redis client v3.0.7 for redis://127.0.0.1:6381/0>]
+
 ## Example
 
 Start redis master server, listen on port 16379

data/Rakefile

@@ -8,7 +8,7 @@ require "rspec/core/rake_task"
 
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.pattern = "spec/redis-sentinel/client_spec.rb"
 end
 
 RSpec::Core::RakeTask.new('spec:progress') do |spec|
@@ -16,4 +16,12 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'redis-sentinel'
+  ARGV.clear
+  IRB.start
+end
+
 task :default => :spec

data/example/redis-master.conf

@@ -50,7 +50,7 @@ loglevel notice
 # Specify the log file name. Also 'stdout' can be used to force
 # Redis to log on the standard output. Note that if you use standard
 # output for logging but daemonize, logs will be sent to /dev/null
-logfile stdout
+logfile ""
 
 # To enable logging to the system logger, just set 'syslog-enabled' to yes,
 # and optionally update the other syslog parameters to suit your needs.

data/example/redis-slave.conf

@@ -50,7 +50,7 @@ loglevel notice
 # Specify the log file name. Also 'stdout' can be used to force
 # Redis to log on the standard output. Note that if you use standard
 # output for logging but daemonize, logs will be sent to /dev/null
-logfile stdout
+logfile ""
 
 # To enable logging to the system logger, just set 'syslog-enabled' to yes,
 # and optionally update the other syslog parameters to suit your needs.

data/lib/redis-sentinel.rb

@@ -1,2 +1,3 @@
 require "redis-sentinel/version"
 require "redis-sentinel/client"
+require "redis-sentinel/redis"

data/lib/redis-sentinel/client.rb

@@ -15,6 +15,8 @@ class Redis::Client
       @failover_reconnect_wait = fetch_option(options, :failover_reconnect_wait) ||
                                  DEFAULT_FAILOVER_RECONNECT_WAIT_SECONDS
 
+      Thread.new { watch_sentinel } if sentinel? && !fetch_option(options, :async)
+
       initialize_without_sentinel(options)
     end
 
@@ -36,14 +38,14 @@ class Redis::Client
     alias connect connect_with_sentinel
 
     def sentinel?
-      @master_name && @sentinels_options
+      !!(@master_name && @sentinels_options)
     end
 
     def auto_retry_with_timeout(&block)
       deadline = @failover_reconnect_timeout.to_i + Time.now.to_f
       begin
         block.call
-      rescue Redis::CannotConnectError
+      rescue Redis::CannotConnectError, Errno::EHOSTDOWN, Errno::EHOSTUNREACH
         raise if Time.now.to_f > deadline
         sleep @failover_reconnect_wait
         retry
@@ -59,14 +61,16 @@ class Redis::Client
     end
 
     def refresh_sentinels_list
-      responses = current_sentinel.sentinel("sentinels", @master_name)
-      @sentinels_options = responses.map do |response|
-        {:host => response[3], :port => response[5]}
-      end.unshift(:host => current_sentinel.host, :port => current_sentinel.port)
+      current_sentinel.sentinel("sentinels", @master_name).each do |response|
+        @sentinels_options << {:host => response[3], :port => response[5]}
+      end
+      @sentinels_options.uniq! {|h| h.values_at(:host, :port) }
     end
 
     def discover_master
+      attempts = 0
       while true
+        attempts += 1
         try_next_sentinel
 
         begin
@@ -79,14 +83,45 @@ class Redis::Client
           else
             # A null reply
           end
-        rescue Redis::CommandError
-          # An -IDONTKNOWN reply
-        rescue Redis::CannotConnectError
-          # faile to connect to current sentinel server
+        rescue Redis::CommandError => e
+          raise unless e.message.include?("IDONTKNOW")
+        rescue Redis::CannotConnectError, Errno::EHOSTDOWN, Errno::EHOSTUNREACH => e
+          # failed to connect to current sentinel server
+          raise e if attempts > @sentinels_options.count
+        end
+      end
+    end
+
+    def discover_slaves
+      while true
+        try_next_sentinel
+
+        begin
+          slaves_info = current_sentinel.sentinel("slaves", @master_name)
+          @slaves = slaves_info.map do |info|
+            info = Hash[*info]
+            ::Redis.new(@options.merge(:host => info['ip'], :port => info['port'], :driver => info[:driver]))
+          end
+
+          break
+        rescue Redis::CommandError => e
+          raise unless e.message.include?("IDONTKNOW")
+        rescue Redis::CannotConnectError, Errno::EHOSTDOWN, Errno::EHOSTUNREACH
+          # failed to connect to current sentinel server
         end
       end
     end
 
+    def slaves
+      discover_slaves
+      @slaves
+    end
+
+    def all_clients
+      clients = slaves
+      clients.unshift ::Redis.new @options
+    end
+
     def disconnect_with_sentinels
       current_sentinel.client.disconnect if current_sentinel
       disconnect_without_sentinels
@@ -96,21 +131,60 @@ class Redis::Client
     alias disconnect disconnect_with_sentinels
 
     def call_with_readonly_protection(*args, &block)
-      tries = 0
-      call_without_readonly_protection(*args, &block)
-    rescue Redis::CommandError => e
-      if e.message == "READONLY You can't write against a read only slave."
-        reconnect
-        retry if (tries += 1) < 4
-      else
-        raise
-      end
+      readonly_protection_with_timeout(:call_without_readonly_protection, *args, &block)
     end
 
     alias call_without_readonly_protection call
     alias call call_with_readonly_protection
 
+    def call_pipeline_with_readonly_protection(*args, &block)
+      readonly_protection_with_timeout(:call_pipeline_without_readonly_protection, *args, &block)
+    end
+
+    alias call_pipeline_without_readonly_protection call_pipeline
+    alias call_pipeline call_pipeline_with_readonly_protection
+
+    def watch_sentinel
+      while true
+        sentinel = Redis.new(@sentinels_options[0])
+
+        begin
+          sentinel.psubscribe("*") do |on|
+            on.pmessage do |pattern, channel, message|
+              next if channel != "+switch-master"
+
+              master_name, old_host, old_port, new_host, new_port = message.split(" ")
+
+              next if master_name != @master_name
+
+              @options.merge!(host: new_host, port: new_port.to_i)
+
+              @logger.debug "Failover: #{old_host}:#{old_port} => #{new_host}:#{new_port}" if @logger && @logger.debug?
+
+              disconnect
+            end
+          end
+        rescue Redis::CannotConnectError, Errno::EHOSTDOWN, Errno::EHOSTUNREACH
+          try_next_sentinel
+          sleep 1
+        end
+      end
+    end
+
   private
+    def readonly_protection_with_timeout(method, *args, &block)
+      deadline = @failover_reconnect_timeout.to_i + Time.now.to_f
+      send(method, *args, &block)
+    rescue Redis::CommandError => e
+      if e.message.include? "READONLY You can't write against a read only slave."
+        reconnect
+        raise if Time.now.to_f > deadline
+        sleep @failover_reconnect_wait
+        retry
+      else
+        raise
+      end
+    end
 
     def fetch_option(options, key)
       options.delete(key) || options.delete(key.to_s)
@@ -120,14 +194,16 @@ class Redis::Client
       return if options.nil?
 
       sentinel_options = []
-      options.each do |sentinel_option|
-        if sentinel_option.is_a?(Hash)
-          sentinel_options << sentinel_option
+      options.each do |opts|
+        opts = opts[:url] if opts.is_a?(Hash) && opts.key?(:url)
+        case opts
+        when Hash
+          sentinel_options << opts
         else
-          uri = URI.parse(sentinel_option)
+          uri = URI.parse(opts)
           sentinel_options << {
-              host: uri.host,
-              port: uri.port
+            :host => uri.host,
+            :port => uri.port
           }
         end
       end

data/lib/redis-sentinel/redis.rb

@@ -0,0 +1,13 @@
+require "redis"
+
+class Redis
+  class_eval do
+    def slaves
+      client.slaves
+    end
+
+    def all_clients
+      client.all_clients
+    end
+  end
+end

data/lib/redis-sentinel/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Sentinel
-    VERSION = "1.4.1"
+    VERSION = "1.5.0"
   end
 end

data/spec/redis-sentinel/client_spec.rb

@@ -2,19 +2,36 @@ require "spec_helper"
 
 describe Redis::Client do
   let(:client) { double("Client", :reconnect => true) }
-  let(:current_sentinel)  { double("Redis", :client => client, :host => "localhost", :port => 26379) }
+  let(:current_sentinel)  { double("Redis", :client => client) }
 
   let(:sentinels) do
     [
       { :host => "localhost", :port => 26379 },
-      'sentinel://localhost:26380'
+      'sentinel://localhost:26380',
+      { :url => 'sentinel://localhost:26381' },
+    ]
+  end
+
+  let(:slaves_reply) do
+    [
+      ["ip", "slave-0", "port", "6379"],
+      ["ip", "slave-1", "port", "6380"],
+      ["ip", "slave-2", "port", "6381"]
     ]
   end
 
   subject { Redis::Client.new(:master_name => "master", :master_password => "foobar",
                               :sentinels => sentinels) }
 
-  before { allow(Redis).to receive(:new).and_return(current_sentinel) }
+  context "new instances" do
+    it "should parse sentinel options" do
+      expect(subject.instance_variable_get(:@sentinels_options)).to match_array [
+        {:host=>"localhost", :port=>26379},
+        {:host=>"localhost", :port=>26380},
+        {:host=>"localhost", :port=>26381}
+      ]
+    end
+  end
 
   context "#sentinel?" do
     it "should be true if passing sentiels and master_name options" do
@@ -47,6 +64,8 @@ describe Redis::Client do
   end
 
   context "#try_next_sentinel" do
+    before { allow(Redis).to receive(:new).and_return(current_sentinel) }
+
     it "returns next sentinel server" do
       expect(subject.try_next_sentinel).to eq current_sentinel
     end
@@ -57,13 +76,15 @@ describe Redis::Client do
       allow(subject).to receive(:current_sentinel).and_return(current_sentinel)
       expect(current_sentinel).to receive(:sentinel).with("sentinels", "master").and_return([
         ["name", "localhost:26381", "ip", "localhost", "port", 26380],
-        ["name", "localhost:26381", "ip", "localhost", "port", 26381]
+        ["name", "localhost:26381", "ip", "localhost", "port", 26381],
+        ["name", "localhost:26381", "ip", "localhost", "port", 26382],
       ])
       subject.refresh_sentinels_list
       expect(subject.instance_variable_get(:@sentinels_options)).to eq [
         {:host => "localhost", :port => 26379},
         {:host => "localhost", :port => 26380},
-        {:host => "localhost", :port => 26381}
+        {:host => "localhost", :port => 26381},
+        {:host => "localhost", :port => 26382},
       ]
     end
   end
@@ -90,12 +111,51 @@ describe Redis::Client do
       expect(subject.port).to eq 8888
     end
 
+    it "selects next sentinel if sentinel doesn't know" do
+      expect(current_sentinel).to receive(:sentinel).with("get-master-addr-by-name", "master").and_raise(Redis::CommandError.new("IDONTKNOW: No idea"))
+      expect(current_sentinel).to receive(:sentinel).with("get-master-addr-by-name", "master").and_return(["master", 8888])
+      subject.discover_master
+      expect(subject.host).to eq "master"
+      expect(subject.port).to eq 8888
+    end
+
+    it "raises error if try_next_sentinel raises error" do
+      expect(current_sentinel).to receive(:sentinel).with("get-master-addr-by-name", "master").and_raise(Redis::CommandError.new("ERR: No such command"))
+      expect { subject.discover_master }.to raise_error(Redis::CommandError)
+    end
+
     it "raises error if try_next_sentinel raises error" do
       expect(subject).to receive(:try_next_sentinel).and_raise(Redis::CannotConnectError)
       expect { subject.discover_master }.to raise_error(Redis::CannotConnectError)
     end
   end
 
+  context "#discover_slaves" do
+    before do
+      allow(subject).to receive(:try_next_sentinel)
+      allow(subject).to receive(:refresh_sentinels_list)
+      allow(subject).to receive(:current_sentinel).and_return(current_sentinel)
+      expect(current_sentinel).to receive(:sentinel).with("slaves", "master").and_return(slaves_reply)
+
+      slaves = slaves_reply.map do |info|
+        info = Hash[*info]
+        double("Redis", :host => info['ip'], :port => info['port'])
+      end
+
+      allow(Redis).to receive(:new).and_return(*slaves)
+    end
+
+    it "discovers slaves correctly" do
+      slaves = subject.slaves
+
+      expect(slaves.size).to eq 3
+      3.times do |i|
+        expect(slaves[i].host).to eq "slave-#{i.to_s}"
+        expect(slaves[i].port.to_i).to eq (6379 + i)
+      end
+    end
+  end
+
   context "#auto_retry_with_timeout" do
     context "no failover reconnect timeout set" do
       subject { Redis::Client.new }

data/spec/redis-sentinel/em_client_spec.rb

@@ -5,7 +5,8 @@ require "eventmachine"
 describe Redis::Client do
   context "#auto_retry_with_timeout" do
     subject { described_class.new(:failover_reconnect_timeout => 3,
-                                :failover_reconnect_wait => 0.1) }
+                                  :failover_reconnect_wait => 0.1,
+                                  :async => true) }
     context "configured wait time" do
 
       it "uses the wait time and blocks em" do

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: redis-sentinel
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: em-synchrony
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hiredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: another redis automatic master/slave failover solution for ruby by using
@@ -102,9 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -122,6 +120,7 @@ files:
 - lib/em-synchrony/redis-sentinel.rb
 - lib/redis-sentinel.rb
 - lib/redis-sentinel/client.rb
+- lib/redis-sentinel/redis.rb
 - lib/redis-sentinel/version.rb
 - redis-sentinel.gemspec
 - spec/redis-sentinel/client_spec.rb
@@ -136,17 +135,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: another redis automatic master/slave failover solution for ruby by using

data/.ruby-gemset

@@ -1 +0,0 @@
-redis-sentinel

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.0.0