redis-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53aaf68e8bf2bc7160a8b708d86c40d13a229a2bfa88734ada0ae03839d6330
-  data.tar.gz: 7ebc1e2e488dbd0bc7895db4714237e893408f017222922cc94faec4b7646e7c
+  metadata.gz: eba18b5a126a8f4f9e76c842c41fd3ab2672c6d08be0d9023536e7fdbbf2ac1c
+  data.tar.gz: 0a012bad73ae54550cae8dde282fdaf644a04a1bd748cd37993a31592ccf2259
 SHA512:
-  metadata.gz: 397746e753c9c44e6b6f7d046b9e8cb389c25c7a8d8dea40e7ab81c099f328d4f34c1d77d7c2c66c0ea7b12056f282a76c3dc5a700b1acee49b89cddc509070d
-  data.tar.gz: a2fcda7b8bbef1a0988fcd7434306da5769dbcf1ad91b5f790186646eedd1b21fa289b044bacd3f3b91486f8d06e73c51d608f92662bcb366e3d3e871a138b40
+  metadata.gz: 37ccff70160eff897f9881784db776679e8b97cec95b89e6db3f13e5294799c3d6ca7dd97e83ce54699819943c7a10904fb76567a7944a8c83fc88408217d294
+  data.tar.gz: c366d95353b081199751910676a9b0e682ff7cb0559c91d7c5112ec7f486a2edb0afa9317f9066953bd13b2f359f6fcb0c4fda268852aa7176557cc42d6b0f94

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# Unreleased
+
+# 0.2.0
+- Added `RedisClient.register` as a public instrumentation API.
+- Fix `read_timeout=` and `write_timeout=` to apply even when the client or pool is already connected.
+- Properly convert DNS resolution errors into `RedisClient::ConnectionError`. Previously it would raise `SocketError`
+
 # 0.1.0
 
 - Initial Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.0.0)
+    redis-client (0.2.0)
       connection_pool
 
 GEM

data/README.md

@@ -270,6 +270,25 @@ end
 
 ## Production
 
+### Instrumentation
+
+`redis-client` offers a public instrumentation API monitoring tools.
+
+```ruby
+module MyRedisInstrumentation
+  def call(command, redis_config)
+    MyMonitoringService.instrument("redis.query") { super }
+  end
+
+  def call_pipelined(commands, redis_config)
+    MyMonitoringService.instrument("redis.pipeline") { super }
+  end
+end
+RedisClient.register(MyRedisInstrumentation)
+```
+
+Note that this instrumentation is global.
+
 ### Timeouts
 
 The client allows you to configure connect, read, and write timeouts.

data/Rakefile

@@ -19,7 +19,15 @@ end
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
+end
+
+namespace :test do
+  Rake::TestTask.new(:sentinel) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/sentinel/*_test.rb"]
+  end
 end
 
 namespace :hiredis do
@@ -74,13 +82,13 @@ namespace :benchmark do
 end
 
 if RUBY_PLATFORM == "java"
-  task default: %i[test rubocop]
+  task default: %i[test test:sentinel rubocop]
 else
-  task default: %i[compile test rubocop]
+  task default: %i[compile test test:sentinel rubocop]
 end
 
 if ENV["DRIVER"] == "hiredis"
-  task ci: %i[compile test]
+  task ci: %i[compile test test:sentinel]
 else
-  task ci: %i[test]
+  task ci: %i[test test:sentinel]
 end

data/ext/redis_client/hiredis/export.clang

@@ -0,0 +1,2 @@
+_Init_hiredis_connection
+_ruby_abi_version

data/ext/redis_client/hiredis/export.gcc

@@ -0,0 +1,7 @@
+hiredis_connection_1.0 { 
+  global: 
+    Init_hiredis_connection;
+    ruby_abi_version;
+  local: 
+    *;
+};

data/ext/redis_client/hiredis/extconf.rb

@@ -2,13 +2,13 @@
 
 require "mkmf"
 
-if RUBY_ENGINE == "ruby"
+if RUBY_ENGINE == "ruby" && !RUBY_ENGINE.match?(/mswin/)
+  have_func("rb_hash_new_capa", "ruby.h")
+
   hiredis_dir = File.expand_path('vendor', __dir__)
 
   make_program = with_config("make-prog", ENV["MAKE"])
   make_program ||= case RUBY_PLATFORM
-  when /mswin/
-    'nmake'
   when /(bsd|solaris)/
     'gmake'
   else
@@ -37,10 +37,18 @@ if RUBY_ENGINE == "ruby"
   end
 
   $CFLAGS << " -I#{hiredis_dir}"
-  $LDFLAGS << " #{hiredis_dir}/libhiredis.a #{hiredis_dir}/libhiredis_ssl.a -lssl -lcrypto"
+  $LDFLAGS << " -lssl -lcrypto"
+  $libs << " #{hiredis_dir}/libhiredis.a #{hiredis_dir}/libhiredis_ssl.a "
   $CFLAGS << " -O3"
   $CFLAGS << " -std=c99 "
 
+  case RbConfig::CONFIG['CC']
+  when /gcc/i
+    $LDFLAGS << ' -Wl,--version-script="' << File.join(__dir__, 'export.gcc') << '"'
+  when /clang/i
+    $LDFLAGS << ' -Wl,-exported_symbols_list,"' << File.join(__dir__, 'export.clang') << '"'
+  end
+
   if ENV["EXT_PEDANTIC"]
     $CFLAGS << " -Werror"
   end

data/ext/redis_client/hiredis/hiredis_connection.c

@@ -38,6 +38,13 @@
 #include "hiredis.h"
 #include "hiredis_ssl.h"
 
+#if !defined(HAVE_RB_HASH_NEW_CAPA)
+static inline VALUE rb_hash_new_capa(long capa)
+{
+  return rb_hash_new();
+}
+#endif
+
 static VALUE rb_cSet, rb_eRedisClientCommandError, rb_eRedisClientConnectionError;
 static VALUE rb_eRedisClientConnectTimeoutError, rb_eRedisClientReadTimeoutError, rb_eRedisClientWriteTimeoutError;
 static ID id_parse, id_add, id_new;
@@ -148,6 +155,10 @@ static void *reply_create_string(const redisReadTask *task, char *cstr, size_t l
         rb_enc_associate(string, rb_ascii8bit_encoding());
     }
 
+    if (task->type == REDIS_REPLY_STATUS) {
+      rb_str_freeze(string);
+    }
+
     if (task->type == REDIS_REPLY_ERROR) {
         string = rb_funcall(rb_eRedisClientCommandError, id_parse, 1, string);
     }
@@ -162,7 +173,7 @@ static void *reply_create_array(const redisReadTask *task, size_t elements) {
             value = rb_ary_new_capa(elements);
             break;
         case REDIS_REPLY_MAP:
-            value = rb_hash_new();
+            value = rb_hash_new_capa(elements / 2);
             break;
         case REDIS_REPLY_SET:
             value = rb_funcallv(rb_cSet, id_new, 0, NULL);
@@ -428,6 +439,7 @@ static VALUE hiredis_connect_finish(hiredis_connection_t *connection, redisConte
 
     /* Check for socket error */
     if (getsockopt(context->fd, SOL_SOCKET, SO_ERROR, &optval, &optlen) < 0) {
+        context->err = REDIS_ERR_IO;
         redis_raise_error_and_disconnect(context, rb_eRedisClientConnectTimeoutError);
     }
 

data/lib/redis_client/buffered_io.rb

@@ -7,6 +7,8 @@ class RedisClient
     EOL = "\r\n".b.freeze
     EOL_SIZE = EOL.bytesize
 
+    attr_accessor :read_timeout, :write_timeout
+
     def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
       @io = io
       @buffer = "".b

data/lib/redis_client/connection.rb

@@ -6,11 +6,54 @@ require "redis_client/buffered_io"
 
 class RedisClient
   class Connection
+    module Common
+      def call(command, timeout)
+        write(command)
+        result = read(timeout)
+        if result.is_a?(CommandError)
+          raise result
+        else
+          result
+        end
+      end
+
+      def call_pipelined(commands, timeouts)
+        exception = nil
+
+        size = commands.size
+        results = Array.new(commands.size)
+        write_multi(commands)
+
+        size.times do |index|
+          timeout = timeouts && timeouts[index]
+          result = read(timeout)
+          if result.is_a?(CommandError)
+            exception ||= result
+          end
+          results[index] = result
+        end
+
+        if exception
+          raise exception
+        else
+          results
+        end
+      end
+    end
+
+    include Common
+
+    SUPPORTS_RESOLV_TIMEOUT = Socket.method(:tcp).parameters.any? { |p| p.last == :resolv_timeout }
+
     def initialize(config, connect_timeout:, read_timeout:, write_timeout:)
       socket = if config.path
         UNIXSocket.new(config.path)
       else
-        sock = Socket.tcp(config.host, config.port, connect_timeout: connect_timeout)
+        sock = if SUPPORTS_RESOLV_TIMEOUT
+          Socket.tcp(config.host, config.port, connect_timeout: connect_timeout, resolv_timeout: connect_timeout)
+        else
+          Socket.tcp(config.host, config.port, connect_timeout: connect_timeout)
+        end
         # disables Nagle's Algorithm, prevents multiple round trips with MULTI
         sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
         sock
@@ -40,7 +83,7 @@ class RedisClient
       )
     rescue Errno::ETIMEDOUT => error
       raise ConnectTimeoutError, error.message
-    rescue SystemCallError, OpenSSL::SSL::SSLError => error
+    rescue SystemCallError, OpenSSL::SSL::SSLError, SocketError => error
       raise ConnectionError, error.message
     end
 
@@ -52,6 +95,14 @@ class RedisClient
       @io.close
     end
 
+    def read_timeout=(timeout)
+      @io.read_timeout = timeout if @io
+    end
+
+    def write_timeout=(timeout)
+      @io.write_timeout = timeout if @io
+    end
+
     def write(command)
       buffer = RESP3.dump(command)
       begin

data/lib/redis_client/hiredis_connection.rb

@@ -4,6 +4,8 @@ require "redis_client/hiredis_connection.so"
 
 class RedisClient
   class HiredisConnection
+    include Connection::Common
+
     class SSLContext
       def initialize(ca_file: nil, ca_path: nil, cert: nil, key: nil, hostname: nil)
         if (error = init(ca_file, ca_path, cert, key, hostname))

data/lib/redis_client/middlewares.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class RedisClient
+  module Middlewares
+    extend self
+
+    def call(command, _config)
+      yield command
+    end
+    alias_method :call_pipelined, :call
+  end
+end

data/lib/redis_client/pooled.rb

@@ -6,17 +6,29 @@ class RedisClient
   class Pooled
     EMPTY_HASH = {}.freeze
 
-    attr_reader :config
+    include Common
 
-    def initialize(config, **kwargs)
-      @config = config
+    def initialize(
+      config,
+      id: config.id,
+      connect_timeout: config.connect_timeout,
+      read_timeout: config.read_timeout,
+      write_timeout: config.write_timeout,
+      **kwargs
+    )
+      super(config, id: id, connect_timeout: connect_timeout, read_timeout: read_timeout, write_timeout: write_timeout)
       @pool_kwargs = kwargs
       @pool = new_pool
       @mutex = Mutex.new
     end
 
-    def with(options = EMPTY_HASH, &block)
-      pool.with(options, &block)
+    def with(options = EMPTY_HASH)
+      pool.with(options) do |client|
+        client.connect_timeout = connect_timeout
+        client.read_timeout = read_timeout
+        client.write_timeout = write_timeout
+        yield client
+      end
     rescue ConnectionPool::TimeoutError => error
       raise CheckoutTimeoutError, "Couldn't checkout a connection in time: #{error.message}"
     end

data/lib/redis_client/resp3.rb

@@ -147,7 +147,7 @@ class RedisClient
       str = io.gets_chomp
       str.force_encoding(Encoding.default_external)
       str.force_encoding(Encoding::BINARY) unless str.valid_encoding?
-      str
+      str.freeze
     end
 
     def parse_error(io)

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/redis_client.rb

@@ -4,8 +4,32 @@ require "redis_client/version"
 require "redis_client/config"
 require "redis_client/sentinel_config"
 require "redis_client/connection"
+require "redis_client/middlewares"
 
 class RedisClient
+  module Common
+    attr_reader :config, :id
+    attr_accessor :connect_timeout, :read_timeout, :write_timeout
+
+    def initialize(
+      config,
+      id: config.id,
+      connect_timeout: config.connect_timeout,
+      read_timeout: config.read_timeout,
+      write_timeout: config.write_timeout
+    )
+      @config = config
+      @id = id
+      @connect_timeout = connect_timeout
+      @read_timeout = read_timeout
+      @write_timeout = write_timeout
+    end
+
+    def timeout=(timeout)
+      @connect_timeout = @read_timeout = @write_timeout = timeout
+    end
+  end
+
   Error = Class.new(StandardError)
 
   ConnectionError = Class.new(Error)
@@ -52,23 +76,16 @@ class RedisClient
         super(config(**(arg || {}), **kwargs))
       end
     end
+
+    def register(middleware)
+      Middlewares.extend(middleware)
+    end
   end
 
-  attr_reader :config, :id
-  attr_accessor :connect_timeout, :read_timeout, :write_timeout
-
-  def initialize(
-    config,
-    id: config.id,
-    connect_timeout: config.connect_timeout,
-    read_timeout: config.read_timeout,
-    write_timeout: config.write_timeout
-  )
-    @config = config
-    @id = id
-    @connect_timeout = connect_timeout
-    @read_timeout = read_timeout
-    @write_timeout = write_timeout
+  include Common
+
+  def initialize(config, **)
+    super
     @raw_connection = nil
     @disable_reconnection = false
   end
@@ -83,7 +100,18 @@ class RedisClient
   alias_method :then, :with
 
   def timeout=(timeout)
-    @connect_timeout = @read_timeout = @write_timeout = timeout
+    super
+    raw_connection.read_timeout = raw_connection.write_timeout = timeout if connected?
+  end
+
+  def read_timeout=(timeout)
+    super
+    raw_connection.read_timeout = timeout if connected?
+  end
+
+  def write_timeout=(timeout)
+    super
+    raw_connection.write_timeout = timeout if connected?
   end
 
   def pubsub
@@ -94,43 +122,28 @@ class RedisClient
 
   def call(*command)
     command = RESP3.coerce_command!(command)
-    result = ensure_connected do |connection|
-      connection.write(command)
-      connection.read
-    end
-
-    if result.is_a?(CommandError)
-      raise result
-    else
-      result
+    ensure_connected do |connection|
+      Middlewares.call(command, config) do
+        connection.call(command, nil)
+      end
     end
   end
 
   def call_once(*command)
     command = RESP3.coerce_command!(command)
-    result = ensure_connected(retryable: false) do |connection|
-      connection.write(command)
-      connection.read
-    end
-
-    if result.is_a?(CommandError)
-      raise result
-    else
-      result
+    ensure_connected(retryable: false) do |connection|
+      Middlewares.call(command, config) do
+        connection.call(command, nil)
+      end
     end
   end
 
   def blocking_call(timeout, *command)
     command = RESP3.coerce_command!(command)
-    result = ensure_connected do |connection|
-      connection.write(command)
-      connection.read(timeout)
-    end
-
-    if result.is_a?(CommandError)
-      raise result
-    else
-      result
+    ensure_connected do |connection|
+      Middlewares.call(command, config) do
+        connection.call(command, timeout)
+      end
     end
   end
 
@@ -184,7 +197,10 @@ class RedisClient
       []
     else
       ensure_connected(retryable: pipeline._retryable?) do |connection|
-        call_pipelined(connection, pipeline._commands, pipeline._timeouts)
+        commands = pipeline._commands
+        Middlewares.call_pipelined(commands, config) do
+          connection.call_pipelined(commands, pipeline._timeouts)
+        end
       end
     end
   end
@@ -197,7 +213,10 @@ class RedisClient
         call("WATCH", *watch)
         begin
           if transaction = build_transaction(&block)
-            call_pipelined(connection, transaction._commands).last
+            commands = transaction._commands
+            Middlewares.call_pipelined(commands, config) do
+              connection.call_pipelined(commands, nil)
+            end.last
           else
             call("UNWATCH")
             []
@@ -213,7 +232,10 @@ class RedisClient
         []
       else
         ensure_connected(retryable: transaction._retryable?) do |connection|
-          call_pipelined(connection, transaction._commands).last
+          commands = transaction._commands
+          Middlewares.call_pipelined(commands, config) do
+            connection.call_pipelined(commands, nil)
+          end.last
         end
       end
     end
@@ -347,29 +369,6 @@ class RedisClient
     nil
   end
 
-  def call_pipelined(connection, commands, timeouts = nil)
-    exception = nil
-
-    size = commands.size
-    results = Array.new(commands.size)
-    connection.write_multi(commands)
-
-    size.times do |index|
-      timeout = timeouts && timeouts[index]
-      result = connection.read(timeout)
-      if result.is_a?(CommandError)
-        exception ||= result
-      end
-      results[index] = result
-    end
-
-    if exception
-      raise exception
-    else
-      results
-    end
-  end
-
   def ensure_connected(retryable: true)
     if @disable_reconnection
       yield @raw_connection
@@ -407,30 +406,33 @@ class RedisClient
   end
 
   def raw_connection
-    @raw_connection ||= begin
-      connection = config.driver.new(
-        config,
-        connect_timeout: connect_timeout,
-        read_timeout: read_timeout,
-        write_timeout: write_timeout,
-      )
-
-      prelude = config.connection_prelude.dup
-
-      if id
-        prelude << ["CLIENT", "SETNAME", id.to_s]
-      end
+    @raw_connection ||= connect
+  end
 
-      if config.sentinel?
-        prelude << ["ROLE"]
-        role, = call_pipelined(connection, prelude).last
-        config.check_role!(role)
-      else
-        call_pipelined(connection, prelude)
-      end
+  def connect
+    connection = config.driver.new(
+      config,
+      connect_timeout: connect_timeout,
+      read_timeout: read_timeout,
+      write_timeout: write_timeout,
+    )
 
-      connection
+    prelude = config.connection_prelude.dup
+
+    if id
+      prelude << ["CLIENT", "SETNAME", id.to_s]
     end
+
+    # The connection prelude is deliberately not sent to Middlewares
+    if config.sentinel?
+      prelude << ["ROLE"]
+      role, = connection.call_pipelined(prelude, nil).last
+      config.check_role!(role)
+    else
+      connection.call_pipelined(prelude, nil)
+    end
+
+    connection
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -39,6 +39,8 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- ext/redis_client/hiredis/export.clang
+- ext/redis_client/hiredis/export.gcc
 - ext/redis_client/hiredis/extconf.rb
 - ext/redis_client/hiredis/hiredis_connection.c
 - ext/redis_client/hiredis/vendor/.gitignore
@@ -91,6 +93,7 @@ files:
 - lib/redis_client/config.rb
 - lib/redis_client/connection.rb
 - lib/redis_client/hiredis_connection.rb
+- lib/redis_client/middlewares.rb
 - lib/redis_client/pooled.rb
 - lib/redis_client/resp3.rb
 - lib/redis_client/sentinel_config.rb