redis-client 0.15.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa81349f7f830db128f2637bc4c782543b9c51a16075b54fdc4700810a95ae83
-  data.tar.gz: d34e19d6229292bb6b15e61aebeda57729780040e098f0fae1beb534f9717ff9
+  metadata.gz: 3e73c2e13870d3adcb345e544fe99bbffa6ad1bf5f7267203e49f838c56a7492
+  data.tar.gz: d090544eb97a93ad0d21d5a6c14c40ffb3ca384425ccf27d82c797f0f7e2d35a
 SHA512:
-  metadata.gz: 01ed887cfc90ffc36ff82669a459d1c9b13b72c9d81f66ca770e7642c16cba90d30cfd31768029b81a1519778f6af2905b145ab606f070008ac471192ce812fa
-  data.tar.gz: 64320bfdcdaa3fd4402ae41350dc0451127f895e3f224d916140ea3fc5813dfe9344f04dc18c20d82e9c3a0878d19ade9b3716274278a21fbe3fd1c5da855797
+  metadata.gz: 60e0fbf2c30888ac05855af2ba6b145ac96e0e011cc58d989f66e9379baa549c9af1ad2f7077ce431b334d6b1318b83463eac7bcb7a323752c79644e0dbce495
+  data.tar.gz: 1e3e10ef87472a412239261c0642e134f9521e83e49def834bb76b1aa6481c8e8fc9b13cfe1916c0f0ed43af8799a331e9649caa61155ce9eeb8391b0c15c98a

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Unreleased
 
+# 0.17.1
+
+- Add support for `NaN` in RESP3 protocol doubles.
+  This was initially missing from the spec and added about a year ago.
+
+# 0.17.0
+
+- Adds `sentinel_username` and `sentinel_password` options for `RedisClient#sentinel`
+
+# 0.16.0
+
+- Add `RedisClient#disable_reconnection`.
+- Reverted the special discard of connection. A regular `close(2)` should be enough.
+
 # 0.15.0
 
 - Discard sockets rather than explictly close them when a fork is detected. #126.
@@ -66,7 +80,7 @@
 
 - Make the client resilient to `Timeout.timeout` or `Thread#kill` use (it still is very much discouraged to use either).
   Use of async interrupts could cause responses to be interleaved.
-- hiredis: handle commands returning a top-level `false` (no command does this today, but some extensions might). 
+- hiredis: handle commands returning a top-level `false` (no command does this today, but some extensions might).
 - Workaround a bug in Ruby 2.6 causing a crash if the `debug` gem is enabled when `redis-client` is being required. Fix: #48
 
 # 0.8.0
@@ -85,7 +99,7 @@
 
 - Raise a distinct `RedisClient::OutOfMemoryError`, for Redis `OOM` errors.
 - Fix the instrumentation API to be called even for authentication commands.
-- Fix `url:` configuration to accept a trailing slash. 
+- Fix `url:` configuration to accept a trailing slash.
 
 # 0.7.1
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.15.0)
+    redis-client (0.17.1)
       connection_pool
 
 GEM
@@ -19,7 +19,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rake-compiler (1.2.3)
+    rake-compiler (1.2.5)
       rake
     redis (4.6.0)
     regexp_parser (2.5.0)

data/README.md

@@ -42,7 +42,7 @@ redis.with do |r|
 end
 ```
 
-If you are working in a single threaded environment, or wish to use your own connection pooling mechanism,
+If you are working in a single-threaded environment, or wish to use your own connection pooling mechanism,
 you can obtain a raw client with `#new_client`
 
 ```ruby
@@ -67,11 +67,11 @@ redis.call("GET", "mykey")
 - `host`: The server hostname or IP address. Defaults to `"localhost"`.
 - `port`: The server port. Defaults to `6379`.
 - `path`: The path to a UNIX socket, if set `url`, `host` and `port` are ignored.
-- `ssl`: Wether to connect using SSL or not.
+- `ssl`: Whether to connect using SSL or not.
 - `ssl_params`: A configuration Hash passed to [`OpenSSL::SSL::SSLContext#set_params`](https://www.rubydoc.info/stdlib/openssl/OpenSSL%2FSSL%2FSSLContext:set_params), notable options include:
   - `cert`: The path to the client certificate (e.g. `client.crt`).
   - `key`: The path to the client key (e.g. `client.key`).
-  - `ca_file`: The certificate authority to use, useful for self signed certificates (e.g. `ca.crt`),
+  - `ca_file`: The certificate authority to use, useful for self-signed certificates (e.g. `ca.crt`),
 - `db`: The database to select after connecting, defaults to `0`.
 - `id` ID for the client connection, assigns name to current connection by sending `CLIENT SETNAME`.
 - `username` Username to authenticate against server, defaults to `"default"`.
@@ -83,7 +83,7 @@ redis.call("GET", "mykey")
 - `reconnect_attempts`: Specify how many times the client should retry to send queries. Defaults to `0`. Makes sure to read the [reconnection section](#reconnection) before enabling it.
 - `circuit_breaker`: A Hash with circuit breaker configuration. Defaults to `nil`. See the [circuit breaker section](#circuit-breaker) for details.
 - `protocol:` The version of the RESP protocol to use. Default to `3`.
-- `custom`: A user owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user specific metadatas.
+- `custom`: A user-owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user-specific metadata.
 
 ### Sentinel support
 
@@ -128,6 +128,41 @@ but a few so that if one is down the client will try the next one. The client
 is able to remember the last Sentinel that was able to reply correctly and will
 use it for the next requests.
 
+To [authenticate](https://redis.io/docs/management/sentinel/#configuring-sentinel-instances-with-authentication) Sentinel itself, you can specify the `sentinel_username` and `sentinel_password` options per instance. Exclude the `sentinel_username` option if you're using password-only authentication.
+
+```ruby
+SENTINELS = [{ host: '127.0.0.1', port: 26380},
+             { host: '127.0.0.1', port: 26381}]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinel_username: 'appuser', sentinel_password: 'mysecret', sentinels: SENTINELS, role: :master)
+```
+
+If you specify a username and/or password at the top level for your main Redis instance, Sentinel *will not* using thouse credentials
+
+```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 explictly 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.
@@ -344,7 +379,7 @@ end
 ```
 
 *Note*: pubsub connections are stateful, as such they won't ever reconnect automatically.
-The caller is resonsible for reconnecting if the connection is lost and to resubscribe to
+The caller is responsible for reconnecting if the connection is lost and to resubscribe to
 all channels.
 
 ## Production
@@ -380,7 +415,7 @@ redis_config = RedisClient.config(middlewares: [AnotherRedisInstrumentation])
 redis_config.new_client
 ```
 
-If middlewares need a client specific configuration, `Config#custom` can be used
+If middlewares need a client-specific configuration, `Config#custom` can be used
 
 ```ruby
 module MyGlobalRedisInstrumentation
@@ -454,9 +489,9 @@ redis_config = RedisClient.config(reconnect_attempts: [0, 0.05, 0.1])
 ```
 
 This configuration is generally used when the Redis server is expected to failover or recover relatively quickly and
-that it's not really possibe to continue without issuing the command.
+that it's not really possible to continue without issuing the command.
 
-When the Redis server is used as an ephemeral cache, circuit breakers are generally prefered.
+When the Redis server is used as an ephemeral cache, circuit breakers are generally preferred.
 
 ### Circuit Breaker
 

data/lib/redis_client/config.rb

@@ -159,21 +159,23 @@ class RedisClient
       host: nil,
       port: nil,
       path: nil,
+      username: nil,
+      password: nil,
       **kwargs
     )
       if url
         url_config = URLConfig.new(url)
         kwargs = {
           ssl: url_config.ssl?,
-          username: url_config.username,
-          password: url_config.password,
           db: url_config.db,
         }.compact.merge(kwargs)
         host ||= url_config.host
         port ||= url_config.port
+        username ||= url_config.username
+        password ||= url_config.password
       end
 
-      super(**kwargs)
+      super(username: username, password: password, **kwargs)
 
       @host = host || DEFAULT_HOST
       @port = Integer(port || DEFAULT_PORT)

data/lib/redis_client/ruby_connection/buffered_io.rb

@@ -24,10 +24,6 @@ class RedisClient
         @io.to_io.close
       end
 
-      def reopen(*args)
-        @io.to_io.reopen(*args)
-      end
-
       def closed?
         @io.to_io.closed?
       end

data/lib/redis_client/ruby_connection/resp3.rb

@@ -175,6 +175,8 @@ class RedisClient
 
     def parse_double(io)
       case value = io.gets_chomp
+      when "nan"
+        Float::NAN
       when "inf"
         Float::INFINITY
       when "-inf"

data/lib/redis_client/ruby_connection.rb

@@ -58,13 +58,6 @@ class RedisClient
       super
     end
 
-    def discard
-      unless @io.closed?
-        @io.reopen(File::NULL)
-      end
-      close
-    end
-
     def read_timeout=(timeout)
       @read_timeout = timeout
       @io.read_timeout = timeout if @io

data/lib/redis_client/sentinel_config.rb

@@ -9,8 +9,16 @@ class RedisClient
 
     attr_reader :name
 
-    def initialize(sentinels:, role: :master, name: nil, url: nil, **client_config)
-      unless %i(master replica slave).include?(role)
+    def initialize(
+      sentinels:,
+      sentinel_password: nil,
+      sentinel_username: nil,
+      role: :master,
+      name: nil,
+      url: nil,
+      **client_config
+    )
+      unless %i(master replica slave).include?(role.to_sym)
         raise ArgumentError, "Expected role to be either :master or :replica, got: #{role.inspect}"
       end
 
@@ -30,7 +38,11 @@ class RedisClient
       end
 
       @to_list_of_hash = @to_hash = nil
-      @extra_config = {}
+      @extra_config = {
+        username: sentinel_username,
+        password: sentinel_password,
+        db: nil,
+      }
       if client_config[:protocol] == 2
         @extra_config[:protocol] = client_config[:protocol]
         @to_list_of_hash = lambda do |may_be_a_list|
@@ -43,7 +55,7 @@ class RedisClient
       end
 
       @sentinels = {}.compare_by_identity
-      @role = role
+      @role = role.to_sym
       @mutex = Mutex.new
       @config = nil
 
@@ -106,9 +118,9 @@ class RedisClient
       sentinels.map do |sentinel|
         case sentinel
         when String
-          Config.new(**@client_config, **@extra_config, url: sentinel, db: nil)
+          Config.new(**@client_config, **@extra_config, url: sentinel)
         else
-          Config.new(**@client_config, **@extra_config, **sentinel, db: nil)
+          Config.new(**@client_config, **@extra_config, **sentinel)
         end
       end
     end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -175,6 +175,10 @@ class RedisClient
     "#<#{self.class.name} #{config.server_url}#{id_string}>"
   end
 
+  def server_url
+    config.server_url
+  end
+
   def size
     1
   end
@@ -358,9 +362,8 @@ class RedisClient
     self
   end
 
-  def discard
-    @raw_connection&.discard
-    self
+  def disable_reconnection(&block)
+    ensure_connected(retryable: false, &block)
   end
 
   def pipelined
@@ -623,7 +626,7 @@ class RedisClient
   end
 
   def ensure_connected(retryable: true)
-    discard if !config.inherit_socket && @pid != PIDCache.pid
+    close if !config.inherit_socket && @pid != PIDCache.pid
 
     if @disable_reconnection
       if block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool