redis-client 0.22.0 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6471d100e48137355f30f150526beba636372c0a8ab89b1d05c9870f156bd01c
-  data.tar.gz: 6c5a17e18eabfdb54e500a1f8deec09dbe1aba9234214e34f0ade2fea170b669
+  metadata.gz: 796fe04bd550f92d5bf2656a62de54caf1f640b45ab5d5f51fed61d0b61ee883
+  data.tar.gz: 4b34ce4e0ed5a2d4816863970789e7c23ce53fe8a561718b78b79432d09e3fe8
 SHA512:
-  metadata.gz: 7b2253e3c62b2cdce341b210ceeebb25f37484161a356c3982d747884870acb040d071471ca50d0abac605a9e759a89d678fbaf19fd1a21cf0b2bfe3c5fd2472
-  data.tar.gz: 8b44296f79fa5591b5776ca6a236b1d2cbce76f9f56a008ab564d2ae8381b1da66385c74f0fe7c00d244bd418f1f7e564b8c198ade7c43588f45e25caa94581e
+  metadata.gz: d9dfb29603171606e71daaa43474812790988876720dd254a0069fc429ba035ede74b1b19d243967b9adb61c0d48ab4aa2931ef188cd2bb17d820b480967c897
+  data.tar.gz: e6ff3a4543991e139a26f8fa4bdb714aafe83678490f9890ca5fd0ec1a95bdddd0c8fec57dcb4ff88fb28a19d577a556172cb39e4bd4f290d41c6871de43345b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Unreleased
 
+# 0.22.2
+
+- Fix the sentinel client to properly extend timeout for blocking commands.
+- Fix IPv6 support in `RedisClient::Config#server_url`.
+
+# 0.22.1
+
+- Fix `ProtocolError: Unknown sigil type` errors when using SSL connection. See #190.
+
 # 0.22.0
 
 - Made various performance optimizations to the Ruby driver. See #184.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.22.0)
+    redis-client (0.22.2)
       connection_pool
 
 GEM
@@ -15,7 +15,7 @@ GEM
     hiredis (0.6.3-java)
     json (2.7.1)
     json (2.7.1-java)
-    minitest (5.22.3)
+    minitest (5.23.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)

data/README.md

@@ -149,7 +149,7 @@ SENTINELS = [{ host: '127.0.0.1', port: 26380 },
 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
+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
@@ -524,7 +524,7 @@ recover for a while.
 
 [Circuit breakers are a pattern that does exactly that](https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern).
 
-Configuation options:
+Configuration options:
 
   - `error_threshold`. The amount of errors to encounter within `error_threshold_timeout` amount of time before opening the circuit, that is to start rejecting requests instantly.
   - `error_threshold_timeout`. The amount of time in seconds that `error_threshold` errors must occur to open the circuit. Defaults to `error_timeout` seconds if not set.

data/lib/redis_client/config.rb

@@ -133,7 +133,13 @@ class RedisClient
             url = "#{url}?db=#{db}"
           end
         else
-          url = "redis#{'s' if ssl?}://#{host}:#{port}"
+          # add brackets to IPv6 address
+          redis_host = if host.count(":") >= 2
+            "[#{host}]"
+          else
+            host
+          end
+          url = "redis#{'s' if ssl?}://#{redis_host}:#{port}"
           if db != 0
             url = "#{url}/#{db}"
           end

data/lib/redis_client/connection_mixin.rb

@@ -28,7 +28,7 @@ class RedisClient
     def call(command, timeout)
       @pending_reads += 1
       write(command)
-      result = read(timeout)
+      result = read(connection_timeout(timeout))
       @pending_reads -= 1
       if result.is_a?(Error)
         result._set_command(command)
@@ -49,7 +49,7 @@ class RedisClient
 
       size.times do |index|
         timeout = timeouts && timeouts[index]
-        result = read(timeout)
+        result = read(connection_timeout(timeout))
         @pending_reads -= 1
 
         # A multi/exec command can return an array of results.
@@ -73,5 +73,14 @@ class RedisClient
         results
       end
     end
+
+    def connection_timeout(timeout)
+      return timeout unless timeout && timeout > 0
+
+      # Can't use the command timeout argument as the connection timeout
+      # otherwise it would be very racy. So we add the regular read_timeout on top
+      # to account for the network delay.
+      timeout + config.read_timeout
+    end
   end
 end

data/lib/redis_client/ruby_connection/buffered_io.rb

@@ -190,7 +190,8 @@ class RedisClient
 
       def fill_buffer(strict, size = @chunk_size)
         remaining = size
-        start = @offset - @buffer.bytesize
+        buffer_size = @buffer.bytesize
+        start = @offset - buffer_size
         empty_buffer = start >= 0
 
         loop do
@@ -199,12 +200,27 @@ class RedisClient
           else
             @io.read_nonblock([remaining, @chunk_size].max, exception: false)
           end
+
           case bytes
           when :wait_readable
+            # Ref: https://github.com/redis-rb/redis-client/issues/190
+            # SSLSocket always clear the provided buffer, even when it didn't
+            # read anything. So we need to reset the offset accordingly.
+            if empty_buffer && @buffer.empty?
+              @offset -= buffer_size
+            end
+
             unless @io.to_io.wait_readable(@read_timeout)
               raise ReadTimeoutError, "Waited #{@read_timeout} seconds" unless @blocking_reads
             end
           when :wait_writable
+            # Ref: https://github.com/redis-rb/redis-client/issues/190
+            # SSLSocket always clear the provided buffer, even when it didn't
+            # read anything. So we need to reset the offset accordingly.
+            if empty_buffer && @buffer.empty?
+              @offset -= buffer_size
+            end
+
             @io.to_io.wait_writable(@write_timeout) or raise(WriteTimeoutError, "Waited #{@write_timeout} seconds")
           when nil
             raise EOFError

data/lib/redis_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.22.2
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+