redis-client 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc78ecaeaed568c9917391585a7a185c90f8d7d569b8443c0fb2f0e918c2ca6
-  data.tar.gz: f9c7cbcb9c39267853681e926a71c27c3619bf0683fa5cd86885c585f2dfa239
+  metadata.gz: dc26284bc8ddd661e51d52ecf7afcf6d853b566128baa4176908eed4ed7e6ce2
+  data.tar.gz: 4051332c5b82220c88cb43efc0257e6dc61cba6b2c61ace4429d197591ecbd53
 SHA512:
-  metadata.gz: 3738437f5876f4f8c09f82a19e4e75462779dae006ed37ac06d3d0ca997bb0190fc676b705e5f6186a5854caff4d98dddc8b035c0fbaa854f9d77b179cb01c94
-  data.tar.gz: 4f9788a5547647cee34ddf01f60400e9645ca2c73f5329155b58670019733ec945331674f94b5a7720754ea2dd12b85d62040060166145beaea9b462514e6500
+  metadata.gz: 7f200a254286ae8c63dd708f4cc1d945b33a8ec96e5466de8b6fe966ddb2ebdca727cb532d817a05021eabdba9809eb2450a0ad31dfc24e39ae2e4473ca9a36a
+  data.tar.gz: 192f624ea10bf819f8d4f98d980861b945cbe5fad8a079dbb0ed247d031b70646eb16cf9a34eb9f0b7b80abb7eee191a3b006bc46a7b0ac8d7b9a9924ee00d1a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# 0.29.0
+
+- Fix connecting to Redis 7.1 and older with `driver_info:`set.
+- Added `RedisClient::Error#next_error` for an easier way to check all errors produced by a pipeline.
+
 # 0.28.0
 
 - Added `RedisClient::HashRing` for horizontal sharing (compatible with `Redis::Distributed` from `redis-rb`).

data/README.md

@@ -145,6 +145,29 @@ If you specify a username and/or password at the top level for your main Redis i
 
 ```ruby
 
+# Use 'mysecret' to authenticate against the mymaster instance, but skip authentication for the sentinels:
+SENTINELS = [{ host: '127.0.0.1', port: 26380 },
+             { host: '127.0.0.1', port: 26381 }]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret')
+```
+
+So you have to provide Sentinel credential and Redis explicitly even they are the same
+
+```ruby
+# Use 'mysecret' to authenticate against the mymaster instance and sentinel
+SENTINELS = [{ host: '127.0.0.1', port: 26380 },
+             { host: '127.0.0.1', port: 26381 }]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret', sentinel_password: 'mysecret')
+```
+
+Also the `name`, `password`, `username` and `db` for Redis instance can be passed as an url:
+
+```ruby
+redis_config = RedisClient.sentinel(url: "redis://appuser:mysecret@mymaster/10", sentinels: SENTINELS, role: :master)
+```
+
 ### Consistent Hashing
 
 To horizontally shard keys across multiple servers without relying on clustering, a `RedisClient::HashRing` class is provided:
@@ -169,29 +192,6 @@ end
 
 Note that regular clients do respond to `node_for`, `nodes_for` and `nodes`, so that code that support `RedisClient.ring` is also usable with a single server.
 
-# Use 'mysecret' to authenticate against the mymaster instance, but skip authentication for the sentinels:
-SENTINELS = [{ host: '127.0.0.1', port: 26380 },
-             { host: '127.0.0.1', port: 26381 }]
-
-redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret')
-```
-
-So you have to provide Sentinel credential and Redis explicitly even they are the same
-
-```ruby
-# Use 'mysecret' to authenticate against the mymaster instance and sentinel
-SENTINELS = [{ host: '127.0.0.1', port: 26380 },
-             { host: '127.0.0.1', port: 26381 }]
-
-redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret', sentinel_password: 'mysecret')
-```
-
-Also the `name`, `password`, `username` and `db` for Redis instance can be passed as an url:
-
-```ruby
-redis_config = RedisClient.sentinel(url: "redis://appuser:mysecret@mymaster/10", sentinels: SENTINELS, role: :master)
-```
-
 ### Type support
 
 Only a select few Ruby types are supported as arguments beside strings.
@@ -361,7 +361,11 @@ end
 
 #### Exception management
 
-The `exception` flag in the `#pipelined` method of `RedisClient` is a feature that modifies the pipeline execution
+By default, when a pipeline produce multiple command errors, only the first encountered error is raised.
+
+However, the raised exception have a `.next_error` method you can use like a linked list to check all encountered errors.
+
+Alternatively, the `exception` flag in the `#pipelined` method of `RedisClient` is a feature that modifies the pipeline execution
 behavior. When set to `false`, it doesn't raise an exception when a command error occurs. Instead, it allows the
 pipeline to execute all commands, and any failed command will be available in the returned array. (Defaults to `true`)
 

data/lib/redis_client/connection_mixin.rb

@@ -47,7 +47,7 @@ class RedisClient
     end
 
     def call_pipelined(commands, timeouts, exception: true)
-      first_exception = nil
+      first_error = last_error = nil
 
       size = commands.size
       results = Array.new(commands.size)
@@ -69,14 +69,16 @@ class RedisClient
           result._set_command(commands[index])
           result._set_config(config)
           result._set_retry_attempt(@retry_attempt)
-          first_exception ||= result
+
+          last_error&._set_next_error(result)
+          first_error ||= last_error = result
         end
 
         results[index] = result
       end
 
-      if first_exception && exception
-        raise first_exception
+      if first_error && exception
+        raise first_error
       else
         results
       end

data/lib/redis_client/sentinel_config.rb

@@ -116,6 +116,10 @@ class RedisClient
     end
 
     def check_role!(role)
+      unless role.is_a?(String)
+        raise TypeError, "Expected role to be a string, got: #{role.inspect}"
+      end
+
       if @role == :master
         unless role == "master"
           sleep SENTINEL_DELAY

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -148,11 +148,17 @@ class RedisClient
     include HasConfig
     include Retriable
 
+    attr_reader :next_error
+
     def self.with_config(message, config = nil)
       error = new(message)
       error._set_config(config)
       error
     end
+
+    def _set_next_error(error) # :nodoc:
+      @next_error = error
+    end
   end
 
   ProtocolError = Class.new(Error)
@@ -863,19 +869,26 @@ class RedisClient
       prelude << ["CLIENT", "SETNAME", id]
     end
 
-    # The connection prelude is deliberately not sent to Middlewares
     if config.sentinel?
       prelude << ["ROLE"]
-      role, = @middlewares.call_pipelined(prelude, config) do
-        @raw_connection.call_pipelined(prelude, nil).last
+    end
+
+    unless prelude.empty?
+      results = @middlewares.call_pipelined(prelude, config) do
+        @raw_connection.call_pipelined(prelude, nil, exception: false)
       end
-      config.check_role!(role)
-    else
-      unless prelude.empty?
-        @middlewares.call_pipelined(prelude, config) do
-          @raw_connection.call_pipelined(prelude, nil)
+
+      results.each do |result|
+        # CLIENT SETINFO is unsupported on Redis < 7.2. The pipeline drained all responses before raising,
+        # so if that's the only error, the socket is healthy: keep it.
+        if result.is_a?(CommandError) && !(result.command[0] == "CLIENT" && result.command[1] == "SETINFO")
+          raise result
         end
       end
+
+      if config.sentinel?
+        config.check_role!(results.last.first)
+      end
     end
   rescue FailoverError, CannotConnectError => error
     @raw_connection&.close
@@ -888,12 +901,10 @@ class RedisClient
     raise connect_error
   rescue CommandError => error
     @raw_connection&.close
-    if error.message.match?(/ERR unknown command ['`]HELLO['`]/)
+
+    if error.command&.first == "HELLO" && error.message.match?(/ERR unknown command/)
       raise UnsupportedServer,
-        "redis-client requires Redis 6+ with HELLO command available (#{config.server_url})"
-    # Ignore CLIENT SETINFO errors (Redis < 7.2 doesn't support it)
-    elsif error.message.match?(/unknown subcommand.*setinfo/i)
-      # Silently ignore - CLIENT SETINFO is not supported on Redis < 7.2
+        "redis-client requires Redis 6+ with HELLO command available (#{config.server_url})", cause: error
     else
       raise
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Jean Boussier
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []