redis-client 0.30.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c611a453cbb5fecfffcb2b631d0b61a978ad151605d4ff60f8f3cf882358c272
-  data.tar.gz: 2b91f2484a543961614d9edaa56eefec31528551e8680d3677e1a71a3c4c7f3c
+  metadata.gz: a978872b66cb08635b537696d919aa49352de251b9525bc4fa17a25b84801bb3
+  data.tar.gz: 2e45ea495c8537bc5a84317d371c4dad00aecf625352eb3893240d8905f20792
 SHA512:
-  metadata.gz: 1f69e110f3f3d6775f50e07928650b0bc4bd232ccc2b0186c6579ea9a8fd5bb5e1c40def3d27184c4d30d42faf42e950cbe1c6319d36b8f1f4fb2eaea881ee7f
-  data.tar.gz: 3919d4e19ab85dababeae0ddf9d476becde0e7ff09e92d2eb18d9c093299fe18454c038835ef43ef09c31b6487d0ee027a0026df1476a9e900860bdb2db646e7
+  metadata.gz: 33fc3e223b160391b28528b8555494e64502911826d454c296d3e22293785ce0aa5b7ebe8d52fb1331ed3c5e061788b23f359ddc902fae7c433f83e6988073b1
+  data.tar.gz: 9427851d1969f93a46877dc2c3e8fdc024555ecc60adae8ffdabe82879fe1eaa21b96af5cbe98ea6bd366b40dd0ea95fcf20940497ba5d749c13d082ec291972

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+# 0.31.0
+
+- Improved the Ruby driver buffering logic, should trigger GC less, particularly for large response and when using SSL.
+- `ssl_params` can now be a proc, for environment where SSL certificates frequently change.
+- Raise `RedisClient::ProtocolError` instead of `NoMethodError` when the RESP3 parser hits an unexpected end of stream.
+
 # 0.30.1
 
 - hiredis-client: Use `pkg-config` to locate OpenSSL. Should fix compilation issue on precompiled rubies such as the ones from `mise`.

data/README.md

@@ -71,7 +71,7 @@ redis.call("GET", "mykey")
 - `port`: The server port. Defaults to `6379`.
 - `path`: The path to a UNIX socket, if set `url`, `host` and `port` are ignored.
 - `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:
+- `ssl_params`: A configuration Hash passed to [`OpenSSL::SSL::SSLContext#set_params`](https://ruby.github.io/openssl/OpenSSL/SSL/SSLContext.html#method-i-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`),

data/lib/redis_client/circuit_breaker.rb

@@ -65,6 +65,8 @@ class RedisClient
     def refresh_state
       now = RedisClient.now
       @lock.synchronize do
+        return unless @state == :open
+
         if @errors.last < (now - @error_timeout)
           if @success_threshold > 0
             @state = :half_open

data/lib/redis_client/config.rb

@@ -190,7 +190,7 @@ class RedisClient
 
       def ssl_context
         if ssl
-          @ssl_context ||= @driver.ssl_context(@ssl_params || {})
+          @driver.ssl_context(@ssl_params || {})
         end
       end
 

data/lib/redis_client/connection_mixin.rb

@@ -71,7 +71,8 @@ class RedisClient
           result._set_retry_attempt(@retry_attempt)
 
           last_error&._set_next_error(result)
-          first_error ||= last_error = result
+          first_error ||= result
+          last_error = result
         end
 
         results[index] = result

data/lib/redis_client/pooled.rb

@@ -76,7 +76,7 @@ class RedisClient
     private
 
     def pool
-      @pool ||= @mutex.synchronize { new_pool }
+      @pool || @mutex.synchronize { @pool ||= new_pool }
     end
 
     def new_pool

data/lib/redis_client/ruby_connection/buffered_io.rb

@@ -193,12 +193,17 @@ class RedisClient
         buffer_size = @buffer.bytesize
         start = @offset - buffer_size
         empty_buffer = start >= 0
+        read_buffer = nil
 
         loop do
           bytes = if empty_buffer
             @io.read_nonblock([remaining, @chunk_size].max, @buffer, exception: false)
           else
-            @io.read_nonblock([remaining, @chunk_size].max, exception: false)
+            # We're most likely reading 4kiB or more, hence the read buffer will never be
+            # embedded on any recent Ruby implementation, hence we can provide an empty
+            # buffer, Ruby will take care of preallocating the required memory.
+            read_buffer ||= "".b
+            @io.read_nonblock([remaining, @chunk_size].max, read_buffer, exception: false)
           end
 
           case bytes
@@ -233,7 +238,10 @@ class RedisClient
               @buffer << bytes.force_encoding(ENCODING)
             end
             remaining -= bytes.bytesize
-            return if !strict || remaining <= 0
+            if !strict || remaining <= 0
+              read_buffer&.clear
+              return
+            end
           end
         end
       end

data/lib/redis_client/ruby_connection/resp3.rb

@@ -16,21 +16,6 @@ class RedisClient
       Integer => :dump_numeric,
       Float => :dump_numeric,
     }.freeze
-    PARSER_TYPES = {
-      '#' => :parse_boolean,
-      '$' => :parse_blob,
-      '+' => :parse_string,
-      '=' => :parse_verbatim_string,
-      '-' => :parse_error,
-      ':' => :parse_integer,
-      '(' => :parse_integer,
-      ',' => :parse_double,
-      '_' => :parse_null,
-      '*' => :parse_array,
-      '%' => :parse_map,
-      '~' => :parse_set,
-      '>' => :parse_array,
-    }.transform_keys(&:ord).freeze
     INTEGER_RANGE = ((((2**64) / 2) * -1)..(((2**64) / 2) - 1)).freeze
 
     def dump(command, buffer = nil)
@@ -73,23 +58,6 @@ class RedisClient
       buffer
     end
 
-    def dump_set(set, buffer)
-      buffer << '~' << set.size.to_s << EOL
-      set.each do |item|
-        dump_any(item, buffer)
-      end
-      buffer
-    end
-
-    def dump_hash(hash, buffer)
-      buffer << '%' << hash.size.to_s << EOL
-      hash.each_pair do |key, value|
-        dump_any(key, buffer)
-        dump_any(value, buffer)
-      end
-      buffer
-    end
-
     def dump_numeric(numeric, buffer)
       dump_string(numeric.to_s, buffer)
     end
@@ -137,6 +105,8 @@ class RedisClient
         parse_set(io)
       elsif type == 62 # '>'.ord
         parse_array(io)
+      elsif type.nil?
+        raise SyntaxError, "Unexpected end of stream"
       else
         raise UnknownType, "Unknown sigil type: #{type.chr.inspect}"
       end
@@ -179,10 +149,6 @@ class RedisClient
       hash
     end
 
-    def parse_push(io)
-      parse_array(io)
-    end
-
     def parse_sequence(io, size)
       return if size < 0 # RESP2 nil
 

data/lib/redis_client/ruby_connection.rb

@@ -28,12 +28,6 @@ class RedisClient
 
         context = OpenSSL::SSL::SSLContext.new
         context.set_params(params)
-        if context.verify_mode != OpenSSL::SSL::VERIFY_NONE
-          if context.respond_to?(:verify_hostname) # Missing on JRuby
-            context.verify_hostname
-          end
-        end
-
         context
       end
     end
@@ -157,8 +151,9 @@ class RedisClient
       )
       true
     rescue SystemCallError, IOError, OpenSSL::SSL::SSLError, SocketError => error
-      socket&.close
       raise CannotConnectError, error.message, error.backtrace
+    ensure
+      socket&.to_io&.close unless defined?(@io) && @io
     end
 
     KEEP_ALIVE_INTERVAL = 15 # Same as hiredis defaults

data/lib/redis_client/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.31.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.12
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []