redisent 0.0.1 → 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a94d9eca24c1582cf8ed550514a0a4d4e9b5d3fa
+  data.tar.gz: 8901e7d03da59f40b9e377ac87fd456819fd3120
+SHA512:
+  metadata.gz: 3621af7ae4f480b177a0f3c4c221f754fef2cb574939ed308f2655a1ad725475f7bcba0e69b46ce284a3d4424808d35fa754eae5047cb55c1d3a982f69900d19
+  data.tar.gz: 8a2478cbbd51e01196eae3c22d78d73fc90ff3e1774977f6b5ddd5a6bf63388551496e8dacb4a5c02ff0cb23a08342cef422d6894018e2cc1014ed4726881d22

data/.gems

@@ -0,0 +1,2 @@
+redic -v 1.5.0
+cutest -v 1.2.3

data/{README → README.md}

@@ -35,6 +35,14 @@ redis = Redisent.new(sentinels, master, options)
 If the sentinels can't be reached, or if there is no master available,
 you will get the exception `Redis::CannotConnectError`.
 
+## Failover
+
+In case of a failover, it is important that the clients don't engage
+with the failed master even if it's restored. For that reason, clients
+must connect to the Redis sentinels in order to get the address of the
+promoted master, and the way to accomplish that is by using
+Redisent.new each time a reconnection is needed.
+
 ## Installation
 
 You can install it using rubygems:

data/lib/redisent.rb

@@ -1,23 +1,148 @@
-require "redis"
+require "redic"
 
-module Redisent
-  def self.new(sentinels, master, options = {})
-    sentinels.each do |sentinel|
+class Redisent
+  class UnreachableHosts < ArgumentError; end
+  class UnknownMaster < ArgumentError; end
+
+  ECONN = [
+    Errno::ECONNREFUSED,
+    Errno::EINVAL,
+  ]
+
+  attr_reader :hosts
+  attr_reader :healthy
+  attr_reader :invalid
+  attr_reader :unknown
+  attr_reader :prime
+  attr_reader :scout
+
+  def initialize(hosts:, name:, client: Redic, auth: nil)
+    @name = name
+    @auth = auth
+
+    # Client library
+    @client = client
+
+    # Hosts according to availability
+    @healthy = []
+    @invalid = []
+    @unknown = []
+
+    # Last known healthy hosts
+    @hosts = hosts
+
+    # Primary client
+    @prime = @client.new
+
+    # Scout client
+    @scout = @client.new
+
+    explore!
+  end
+
+  def url
+    @prime.url
+  end
+
+  private def explore!
+    @unknown = []
+    @invalid = []
+    @healthy = []
+
+    @hosts.each do |host|
       begin
-        master = find_master(sentinel, master, options)
-        return master if master
-      rescue Redis::CannotConnectError
+        @scout.configure(sentinel_url(host))
+
+        sentinels = @scout.call("SENTINEL", "sentinels", @name)
+
+        if RuntimeError === sentinels
+          unknown.push(host)
+        else
+          healthy.push(host)
+
+          sentinels.each do |sentinel|
+            info = Hash[*sentinel]
+
+            healthy.push(sprintf("%s:%s", info["ip"], info["port"]))
+          end
+        end
+
+        @scout.quit
+
+      rescue *ECONN
+        invalid.push(host)
       end
     end
 
-    raise Redis::CannotConnectError
+    if healthy.any?
+      @hosts.replace(healthy)
+      @prime.configure(master)
+      return true
+    end
+
+    if invalid.any?
+      raise UnreachableHosts, invalid
+    end
+
+    if unknown.any?
+      raise UnknownMaster, @name
+    end
+  end
+
+  def call(*args)
+    forward do
+      @prime.call(*args)
+    end
+  end
+
+  def call!(*args)
+    forward do
+      @prime.call!(*args)
+    end
+  end
+
+  def queue(*args)
+    @prime.queue(*args)
   end
 
-  def self.find_master(sentinel, master, options)
-    redis = Redis.new(url: sentinel)
+  def commit
+    buffer = @prime.buffer
 
-    host, port = redis.sentinel("get-master-addr-by-name", master)
+    forward do
+      @prime.buffer.replace(buffer)
+      @prime.commit
+    end
+  end
 
-    Redis.new(options.merge(:host => host, :port => port))
+  def forward
+    yield
+  rescue
+    explore!
+    retry
+  end
+
+  private def sentinel_url(host)
+    sprintf("redis://%s", host)
+  end
+
+  private def redis_url(host)
+    if @auth then
+      sprintf("redis://:%s@%s", @auth, host)
+    else
+      sprintf("redis://%s", host)
+    end
+  end
+
+  private def master
+    hosts.each do |host|
+      begin
+        @scout.configure(sentinel_url(host))
+        ip, port = @scout.call("SENTINEL", "get-master-addr-by-name", @name)
+
+        break redis_url(sprintf("%s:%s", ip, port))
+      rescue *ECONN
+        $stderr.puts($!.inspect)
+      end
+    end
   end
 end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/redisent.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "redisent"
+  s.version           = "0.1.0.alpha"
+  s.summary           = "Sentinel aware Redis client."
+  s.description       = "Redisent is a wrapper for the Redis client that fetches configuration details from sentinels."
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/redisent"
+  s.files             = `git ls-files`.split("\n")
+  s.license           = "MIT"
+
+  s.add_dependency "redic", "~> 1.5"
+  s.add_development_dependency "cutest", "~> 0"
+end

data/test/all.rb

@@ -0,0 +1,95 @@
+require_relative "helper"
+
+require "stringio"
+
+module Silencer
+  @output = nil
+
+  def self.start
+    $olderr = $stderr
+    $stderr = StringIO.new
+  end
+
+  def self.stop
+    @output = $stderr.string
+    $stderr = $olderr
+  end
+
+  def self.output
+    @output
+  end
+end
+
+SENTINEL_HOSTS = [
+  "127.0.0.1:27000",
+  "127.0.0.1:27001",
+  "127.0.0.1:27002",
+  "127.0.0.1:27003",
+  "127.0.0.1:27004",
+]
+
+SENTINEL_BAD_HOSTS = SENTINEL_HOSTS[0,1]
+SENTINEL_GOOD_HOSTS = SENTINEL_HOSTS[1,4]
+
+prepare do
+  c = Redic.new
+
+  SENTINEL_GOOD_HOSTS.each do |host|
+    c.configure(sprintf("redis://%s", host))
+
+    c.call("SENTINEL", "monitor", "master-6379", "127.0.0.1", "6379", "3")
+    c.call("QUIT")
+  end
+end
+
+setup do
+  Redic.new.tap do |c|
+    c.call("FLUSHDB")
+  end
+end
+
+test "invalid hosts" do
+  assert_raise(Redisent::UnreachableHosts) do
+    Redisent.new(hosts: SENTINEL_BAD_HOSTS, name: "master-6379")
+  end
+end
+
+test "invalid master" do
+  assert_raise(Redisent::UnknownMaster) do
+    Redisent.new(hosts: SENTINEL_GOOD_HOSTS, name: "master-6380")
+  end
+end
+
+setup do
+  Redisent.new(hosts: SENTINEL_GOOD_HOSTS, name: "master-6379")
+end
+
+test "call" do |c|
+  assert_equal "PONG", c.call("PING")
+end
+
+test "call!" do |c|
+  assert_equal "PONG", c.call("PING")
+end
+
+test "queue/commit" do |c|
+  assert_equal [["PING"]], c.queue("PING")
+  assert_equal [["PING"], ["PING"]], c.queue("PING")
+  assert_equal ["PONG", "PONG"], c.commit
+end
+
+test "retry on connection failures" do |c|
+  assert_equal "PONG", c.call("PING")
+
+  # Simulate a server disconnection.
+  c.prime.configure(sprintf("redis://%s", SENTINEL_BAD_HOSTS.first))
+
+  assert_equal "PONG", c.call("PING")
+
+  # Simulate a server disconnection.
+  c.prime.configure(sprintf("redis://%s", SENTINEL_BAD_HOSTS.first))
+
+  assert_equal [["PING"]], c.queue("PING")
+  assert_equal [["PING"], ["PING"]], c.queue("PING")
+  assert_equal ["PONG", "PONG"], c.commit
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/redisent"

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: redisent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0.alpha
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-09 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
-  requirement: &2155997400 !ruby/object:Gem::Requirement
-    none: false
+  name: redic
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2155997400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2155996720 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155996720
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Redisent is a wrapper for the Redis client that fetches configuration
   details from sentinels.
 email:
@@ -41,33 +46,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gems"
 - LICENSE
-- README
+- README.md
 - lib/redisent.rb
-- test/redisent_test.rb
+- makefile
+- redisent.gemspec
+- test/all.rb
+- test/helper.rb
 homepage: https://github.com/soveran/redisent
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sentinel aware Redis client.
 test_files: []

data/test/redisent_test.rb

@@ -1,38 +0,0 @@
-require File.expand_path("../lib/redisent", File.dirname(__FILE__))
-
-test "basics" do |redis|
-  redis = Redisent.new(
-    ["redis://localhost:27378/",
-     "redis://localhost:27379/",
-     "redis://localhost:27380/",
-     "redis://localhost:27381/"],
-    "server-1", :timeout => 5)
-
-  redis.set("foo", 1)
-
-  assert_equal "1", redis.get("foo")
-  assert_equal "6379", redis.info["tcp_port"]
-  assert_equal 5.0, redis.client.timeout
-end
-
-test "no available sentinel" do
-  assert_raise Redis::CannotConnectError do
-    redis = Redisent.new(
-      ["redis://localhost:27478/",
-       "redis://localhost:27479/",
-       "redis://localhost:27480/",
-       "redis://localhost:27481/"],
-      "server-1")
-  end
-end
-
-test "no available master" do
-  assert_raise Redis::CannotConnectError do
-    redis = Redisent.new(
-      ["redis://localhost:27478/",
-       "redis://localhost:27479/",
-       "redis://localhost:27480/",
-       "redis://localhost:27481/"],
-      "server-2")
-  end
-end