redis-client 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4742ae57d2d4b4510921d37359540257a2e70ee0f9038276f40f95506ae2ffa0
-  data.tar.gz: cb3f9702abcd04ae46cfb5d59350884fb9bcff6f6d4990f1e6a0ae66fb6a1f4a
+  metadata.gz: 6471d100e48137355f30f150526beba636372c0a8ab89b1d05c9870f156bd01c
+  data.tar.gz: 6c5a17e18eabfdb54e500a1f8deec09dbe1aba9234214e34f0ade2fea170b669
 SHA512:
-  metadata.gz: 14212b26415dd02f6b23f2f729b9690bcf9bd06c156b60ffb5cb4b9061172a3c08f670242d2e6d391770c4abb9cfdd3bd79dfd8d039ae54a9e1537ea39dfd05f
-  data.tar.gz: d5b1276dffe3c3fb6220fb06b9e22fd1440bd7d83e19e37031019f98b69ab3ae5c13cbef8bcd036e1929008f764d9b5117451c9fcb07964b28d11cad14ac449e
+  metadata.gz: 7b2253e3c62b2cdce341b210ceeebb25f37484161a356c3982d747884870acb040d071471ca50d0abac605a9e759a89d678fbaf19fd1a21cf0b2bfe3c5fd2472
+  data.tar.gz: 8b44296f79fa5591b5776ca6a236b1d2cbce76f9f56a008ab564d2ae8381b1da66385c74f0fe7c00d244bd418f1f7e564b8c198ade7c43588f45e25caa94581e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+# 0.22.0
+
+- Made various performance optimizations to the Ruby driver. See #184.
+- Always assume UTF-8 encoding instead of relying on `Encoding.default_external`.
+- Add `exception` flag in `pipelined` allowing failed commands to be returned in the result array when set to `false`. See #187.
+
 # 0.21.1
 
 - Handle unresolved Sentinel master/replica error when displaying server URL in exceptions. See #182.

data/Gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gemspec name: "redis-client"
 
 gem "minitest"
-gem "rake", "~> 13.1"
+gem "rake", "~> 13.2"
 gem "rake-compiler"
 gem "rubocop"
 gem "rubocop-minitest"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.21.1)
+    redis-client (0.22.0)
       connection_pool
 
 GEM
@@ -23,7 +23,7 @@ GEM
     racc (1.7.3)
     racc (1.7.3-java)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     rake-compiler (1.2.7)
       rake
     redis (4.6.0)
@@ -59,7 +59,7 @@ DEPENDENCIES
   byebug
   hiredis
   minitest
-  rake (~> 13.1)
+  rake (~> 13.2)
   rake-compiler
   redis (~> 4.6)
   redis-client!

data/README.md

@@ -332,6 +332,27 @@ end
 # => ["OK", 1]
 ```
 
+#### Exception management
+
+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`)
+
+```ruby
+results = redis.pipelined(exception: false) do |pipeline|
+  pipeline.call("SET", "foo", "bar") # => nil
+  pipeline.call("DOESNOTEXIST", 12) # => nil
+  pipeline.call("INCR", "baz") # => nil
+end
+# results => ["OK", #<RedisClient::CommandError: ERR unknown command 'DOESNOTEXIST', with args beginning with: '12'>, 2]
+
+results.each do |result|
+  if result.is_a?(RedisClient::CommandError)
+    # Do something with the failed result
+  end
+end
+```
+
 ### Transactions
 
 You can use [`MULTI/EXEC` to run a number of commands in an atomic fashion](https://redis.io/topics/transactions).

data/Rakefile

@@ -71,12 +71,15 @@ namespace :hiredis do
   end
 end
 
-benchmark_suites = %w(single pipelined)
+benchmark_suites = %w(single pipelined drivers)
 benchmark_modes = %i[ruby yjit hiredis]
 namespace :benchmark do
   benchmark_suites.each do |suite|
     benchmark_modes.each do |mode|
+      next if suite == "drivers" && mode == :hiredis
+
       name = "#{suite}_#{mode}"
+      desc name
       task name do
         output_path = "benchmark/#{name}.md"
         sh "rm", "-f", output_path

data/lib/redis_client/connection_mixin.rb

@@ -39,8 +39,8 @@ class RedisClient
       end
     end
 
-    def call_pipelined(commands, timeouts)
-      exception = nil
+    def call_pipelined(commands, timeouts, exception: true)
+      first_exception = nil
 
       size = commands.size
       results = Array.new(commands.size)
@@ -61,14 +61,14 @@ class RedisClient
         elsif result.is_a?(Error)
           result._set_command(commands[index])
           result._set_config(config)
-          exception ||= result
+          first_exception ||= result
         end
 
         results[index] = result
       end
 
-      if exception
-        raise exception
+      if first_exception && exception
+        raise first_exception
       else
         results
       end

data/lib/redis_client/decorator.rb

@@ -47,8 +47,8 @@ class RedisClient
       end
       ruby2_keywords :with if respond_to?(:ruby2_keywords, true)
 
-      def pipelined
-        @client.pipelined { |p| yield @_pipeline_class.new(p) }
+      def pipelined(exception: true)
+        @client.pipelined(exception: exception) { |p| yield @_pipeline_class.new(p) }
       end
 
       def multi(**kwargs)

data/lib/redis_client/ruby_connection/buffered_io.rb

@@ -10,14 +10,80 @@ class RedisClient
 
       attr_accessor :read_timeout, :write_timeout
 
-      def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
-        @io = io
-        @buffer = "".b
-        @offset = 0
-        @chunk_size = chunk_size
-        @read_timeout = read_timeout
-        @write_timeout = write_timeout
-        @blocking_reads = false
+      if String.method_defined?(:byteindex) # Ruby 3.2+
+        ENCODING = Encoding::UTF_8
+
+        def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
+          @io = io
+          @buffer = +""
+          @offset = 0
+          @chunk_size = chunk_size
+          @read_timeout = read_timeout
+          @write_timeout = write_timeout
+          @blocking_reads = false
+        end
+
+        def gets_chomp
+          fill_buffer(false) if @offset >= @buffer.bytesize
+          until eol_index = @buffer.byteindex(EOL, @offset)
+            fill_buffer(false)
+          end
+
+          line = @buffer.byteslice(@offset, eol_index - @offset)
+          @offset = eol_index + EOL_SIZE
+          line
+        end
+
+        def read_chomp(bytes)
+          ensure_remaining(bytes + EOL_SIZE)
+          str = @buffer.byteslice(@offset, bytes)
+          @offset += bytes + EOL_SIZE
+          str
+        end
+
+        private def ensure_line
+          fill_buffer(false) if @offset >= @buffer.bytesize
+          until @buffer.byteindex(EOL, @offset)
+            fill_buffer(false)
+          end
+        end
+      else
+        ENCODING = Encoding::BINARY
+
+        def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
+          @io = io
+          @buffer = "".b
+          @offset = 0
+          @chunk_size = chunk_size
+          @read_timeout = read_timeout
+          @write_timeout = write_timeout
+          @blocking_reads = false
+        end
+
+        def gets_chomp
+          fill_buffer(false) if @offset >= @buffer.bytesize
+          until eol_index = @buffer.index(EOL, @offset)
+            fill_buffer(false)
+          end
+
+          line = @buffer.byteslice(@offset, eol_index - @offset)
+          @offset = eol_index + EOL_SIZE
+          line
+        end
+
+        def read_chomp(bytes)
+          ensure_remaining(bytes + EOL_SIZE)
+          str = @buffer.byteslice(@offset, bytes)
+          @offset += bytes + EOL_SIZE
+          str.force_encoding(Encoding::UTF_8)
+        end
+
+        private def ensure_line
+          fill_buffer(false) if @offset >= @buffer.bytesize
+          until @buffer.index(EOL, @offset)
+            fill_buffer(false)
+          end
+        end
       end
 
       def close
@@ -82,28 +148,35 @@ class RedisClient
       end
 
       def getbyte
-        ensure_remaining(1)
-        byte = @buffer.getbyte(@offset)
+        unless byte = @buffer.getbyte(@offset)
+          ensure_remaining(1)
+          byte = @buffer.getbyte(@offset)
+        end
         @offset += 1
         byte
       end
 
-      def gets_chomp
-        fill_buffer(false) if @offset >= @buffer.bytesize
-        until eol_index = @buffer.index(EOL, @offset)
-          fill_buffer(false)
-        end
+      def gets_integer
+        int = 0
+        offset = @offset
+        while true
+          chr = @buffer.getbyte(offset)
 
-        line = @buffer.byteslice(@offset, eol_index - @offset)
-        @offset = eol_index + EOL_SIZE
-        line
-      end
+          if chr
+            if chr == 13 # "\r".ord
+              @offset = offset + 2
+              break
+            else
+              int = (int * 10) + chr - 48
+            end
+            offset += 1
+          else
+            ensure_line
+            return gets_integer
+          end
+        end
 
-      def read_chomp(bytes)
-        ensure_remaining(bytes + EOL_SIZE)
-        str = @buffer.byteslice(@offset, bytes)
-        @offset += bytes + EOL_SIZE
-        str
+        int
       end
 
       private
@@ -117,7 +190,8 @@ class RedisClient
 
       def fill_buffer(strict, size = @chunk_size)
         remaining = size
-        empty_buffer = @offset >= @buffer.bytesize
+        start = @offset - @buffer.bytesize
+        empty_buffer = start >= 0
 
         loop do
           bytes = if empty_buffer
@@ -126,15 +200,6 @@ class RedisClient
             @io.read_nonblock([remaining, @chunk_size].max, exception: false)
           end
           case bytes
-          when String
-            if empty_buffer
-              @offset = 0
-              empty_buffer = false
-            else
-              @buffer << bytes
-            end
-            remaining -= bytes.bytesize
-            return if !strict || remaining <= 0
           when :wait_readable
             unless @io.to_io.wait_readable(@read_timeout)
               raise ReadTimeoutError, "Waited #{@read_timeout} seconds" unless @blocking_reads
@@ -144,7 +209,15 @@ class RedisClient
           when nil
             raise EOFError
           else
-            raise "Unexpected `read_nonblock` return: #{bytes.inspect}"
+            if empty_buffer
+              @offset = start
+              empty_buffer = false
+              @buffer.force_encoding(ENCODING) unless @buffer.encoding == ENCODING
+            else
+              @buffer << bytes.force_encoding(ENCODING)
+            end
+            remaining -= bytes.bytesize
+            return if !strict || remaining <= 0
           end
         end
       end

data/lib/redis_client/ruby_connection/resp3.rb

@@ -111,15 +111,39 @@ class RedisClient
 
     def parse(io)
       type = io.getbyte
-      method = PARSER_TYPES.fetch(type) do
+      if type == 35 # '#'.ord
+        parse_boolean(io)
+      elsif type == 36 # '$'.ord
+        parse_blob(io)
+      elsif type == 43 # '+'.ord
+        parse_string(io)
+      elsif type == 61 # '='.ord
+        parse_verbatim_string(io)
+      elsif type == 45 # '-'.ord
+        parse_error(io)
+      elsif type == 58 # ':'.ord
+        parse_integer(io)
+      elsif type == 40 # '('.ord
+        parse_integer(io)
+      elsif type == 44 # ','.ord
+        parse_double(io)
+      elsif type == 95 # '_'.ord
+        parse_null(io)
+      elsif type == 42 # '*'.ord
+        parse_array(io)
+      elsif type == 37 # '%'.ord
+        parse_map(io)
+      elsif type == 126 # '~'.ord
+        parse_set(io)
+      elsif type == 62 # '>'.ord
+        parse_array(io)
+      else
         raise UnknownType, "Unknown sigil type: #{type.chr.inspect}"
       end
-      send(method, io)
     end
 
     def parse_string(io)
       str = io.gets_chomp
-      str.force_encoding(Encoding.default_external)
       str.force_encoding(Encoding::BINARY) unless str.valid_encoding?
       str.freeze
     end
@@ -140,17 +164,17 @@ class RedisClient
     end
 
     def parse_array(io)
-      parse_sequence(io, parse_integer(io))
+      parse_sequence(io, io.gets_integer)
     end
 
     def parse_set(io)
-      parse_sequence(io, parse_integer(io))
+      parse_sequence(io, io.gets_integer)
     end
 
     def parse_map(io)
       hash = {}
-      parse_integer(io).times do
-        hash[parse(io)] = parse(io)
+      io.gets_integer.times do
+        hash[parse(io).freeze] = parse(io)
       end
       hash
     end
@@ -192,11 +216,10 @@ class RedisClient
     end
 
     def parse_blob(io)
-      bytesize = parse_integer(io)
+      bytesize = io.gets_integer
       return if bytesize < 0 # RESP2 nil type
 
       str = io.read_chomp(bytesize)
-      str.force_encoding(Encoding.default_external)
       str.force_encoding(Encoding::BINARY) unless str.valid_encoding?
       str
     end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -421,7 +421,7 @@ class RedisClient
     ensure_connected(retryable: false, &block)
   end
 
-  def pipelined
+  def pipelined(exception: true)
     pipeline = Pipeline.new(@command_builder)
     yield pipeline
 
@@ -431,7 +431,7 @@ class RedisClient
       results = ensure_connected(retryable: pipeline._retryable?) do |connection|
         commands = pipeline._commands
         @middlewares.call_pipelined(commands, config) do
-          connection.call_pipelined(commands, pipeline._timeouts)
+          connection.call_pipelined(commands, pipeline._timeouts, exception: exception)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool