redis-client 0.2.1 → 0.5.0

data/lib/redis_client.rb

@@ -1,12 +1,57 @@
 # frozen_string_literal: true
 
+require "set"
+
 require "redis_client/version"
+require "redis_client/command_builder"
 require "redis_client/config"
 require "redis_client/sentinel_config"
-require "redis_client/connection"
 require "redis_client/middlewares"
 
 class RedisClient
+  @driver_definitions = {}
+  @drivers = {}
+
+  @default_driver = nil
+
+  class << self
+    def register_driver(name, &block)
+      @driver_definitions[name] = block
+    end
+
+    def driver(name)
+      return name if name.is_a?(Class)
+
+      name = name.to_sym
+      unless @driver_definitions.key?(name)
+        raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{@driver_definitions.keys.inspect}`"
+      end
+
+      @drivers[name] ||= @driver_definitions[name]&.call
+    end
+
+    def default_driver
+      unless @default_driver
+        @driver_definitions.each_key do |name|
+          if @default_driver = driver(name)
+            break
+          end
+        rescue LoadError
+        end
+      end
+      @default_driver
+    end
+
+    def default_driver=(name)
+      @default_driver = driver(name)
+    end
+  end
+
+  register_driver :ruby do
+    require "redis_client/ruby_connection"
+    RubyConnection
+  end
+
   module Common
     attr_reader :config, :id
     attr_accessor :connect_timeout, :read_timeout, :write_timeout
@@ -23,6 +68,7 @@ class RedisClient
       @connect_timeout = connect_timeout
       @read_timeout = read_timeout
       @write_timeout = write_timeout
+      @command_builder = config.command_builder
     end
 
     def timeout=(timeout)
@@ -32,6 +78,8 @@ class RedisClient
 
   Error = Class.new(StandardError)
 
+  UnsupportedServer = Class.new(Error)
+
   ConnectionError = Class.new(Error)
 
   FailoverError = Class.new(ConnectionError)
@@ -43,6 +91,8 @@ class RedisClient
   CheckoutTimeoutError = Class.new(ConnectTimeoutError)
 
   class CommandError < Error
+    attr_reader :command
+
     class << self
       def parse(error_message)
         code = error_message.split(' ', 2).first
@@ -50,14 +100,22 @@ class RedisClient
         klass.new(error_message)
       end
     end
+
+    def _set_command(command)
+      @command = command
+    end
   end
 
   AuthenticationError = Class.new(CommandError)
   PermissionError = Class.new(CommandError)
+  ReadOnlyError = Class.new(CommandError)
+  WrongTypeError = Class.new(CommandError)
 
   CommandError::ERRORS = {
     "WRONGPASS" => AuthenticationError,
     "NOPERM" => PermissionError,
+    "READONLY" => ReadOnlyError,
+    "WRONGTYPE" => WrongTypeError,
   }.freeze
 
   class << self
@@ -90,6 +148,11 @@ class RedisClient
     @disable_reconnection = false
   end
 
+  def inspect
+    id_string = " id=#{id}" if id
+    "#<#{self.class.name} #{config.server_url}#{id_string}>"
+  end
+
   def size
     1
   end
@@ -115,67 +178,89 @@ class RedisClient
   end
 
   def pubsub
-    sub = PubSub.new(ensure_connected)
+    sub = PubSub.new(ensure_connected, @command_builder)
     @raw_connection = nil
     sub
   end
 
-  def call(*command)
-    command = RESP3.coerce_command!(command)
-    ensure_connected do |connection|
+  def call(*command, **kwargs)
+    command = @command_builder.generate!(command, kwargs)
+    result = ensure_connected do |connection|
       Middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
+
+    if block_given?
+      yield result
+    else
+      result
+    end
   end
 
-  def call_once(*command)
-    command = RESP3.coerce_command!(command)
-    ensure_connected(retryable: false) do |connection|
+  def call_once(*command, **kwargs)
+    command = @command_builder.generate!(command, kwargs)
+    result = ensure_connected(retryable: false) do |connection|
       Middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
+
+    if block_given?
+      yield result
+    else
+      result
+    end
   end
 
-  def blocking_call(timeout, *command)
-    command = RESP3.coerce_command!(command)
-    ensure_connected do |connection|
+  def blocking_call(timeout, *command, **kwargs)
+    command = @command_builder.generate!(command, kwargs)
+    result = ensure_connected do |connection|
       Middlewares.call(command, config) do
         connection.call(command, timeout)
       end
     end
+
+    if block_given?
+      yield result
+    else
+      result
+    end
   end
 
-  def scan(*args, &block)
+  def scan(*args, **kwargs, &block)
     unless block_given?
-      return to_enum(__callee__, *args)
+      return to_enum(__callee__, *args, **kwargs)
     end
 
+    args = @command_builder.generate!(args, kwargs)
     scan_list(1, ["SCAN", 0, *args], &block)
   end
 
-  def sscan(key, *args, &block)
+  def sscan(key, *args, **kwargs, &block)
     unless block_given?
-      return to_enum(__callee__, key, *args)
+      return to_enum(__callee__, key, *args, **kwargs)
     end
 
+    args = @command_builder.generate!(args, kwargs)
     scan_list(2, ["SSCAN", key, 0, *args], &block)
   end
 
-  def hscan(key, *args, &block)
+  def hscan(key, *args, **kwargs, &block)
     unless block_given?
-      return to_enum(__callee__, key, *args)
+      return to_enum(__callee__, key, *args, **kwargs)
     end
 
+    args = @command_builder.generate!(args, kwargs)
     scan_pairs(2, ["HSCAN", key, 0, *args], &block)
   end
 
-  def zscan(key, *args, &block)
+  def zscan(key, *args, **kwargs, &block)
     unless block_given?
-      return to_enum(__callee__, key, *args)
+      return to_enum(__callee__, key, *args, **kwargs)
     end
 
+    args = @command_builder.generate!(args, kwargs)
     scan_pairs(2, ["ZSCAN", key, 0, *args], &block)
   end
 
@@ -190,23 +275,27 @@ class RedisClient
   end
 
   def pipelined
-    pipeline = Pipeline.new
+    pipeline = Pipeline.new(@command_builder)
     yield pipeline
 
     if pipeline._size == 0
       []
     else
-      ensure_connected(retryable: pipeline._retryable?) do |connection|
+      results = ensure_connected(retryable: pipeline._retryable?) do |connection|
         commands = pipeline._commands
         Middlewares.call_pipelined(commands, config) do
           connection.call_pipelined(commands, pipeline._timeouts)
         end
       end
+
+      pipeline._coerce!(results)
     end
   end
 
   def multi(watch: nil, &block)
-    if watch
+    transaction = nil
+
+    results = if watch
       # WATCH is stateful, so we can't reconnect if it's used, the whole transaction
       # has to be redone.
       ensure_connected(retryable: false) do |connection|
@@ -214,7 +303,7 @@ class RedisClient
         begin
           if transaction = build_transaction(&block)
             commands = transaction._commands
-            Middlewares.call_pipelined(commands, config) do
+            results = Middlewares.call_pipelined(commands, config) do
               connection.call_pipelined(commands, nil)
             end.last
           else
@@ -239,15 +328,22 @@ class RedisClient
         end
       end
     end
+
+    if transaction
+      transaction._coerce!(results)
+    else
+      results
+    end
   end
 
   class PubSub
-    def initialize(raw_connection)
+    def initialize(raw_connection, command_builder)
       @raw_connection = raw_connection
+      @command_builder = command_builder
     end
 
-    def call(*command)
-      raw_connection.write(RESP3.coerce_command!(command))
+    def call(*command, **kwargs)
+      raw_connection.write(@command_builder.generate!(command, kwargs))
       nil
     end
 
@@ -273,20 +369,26 @@ class RedisClient
   end
 
   class Multi
-    def initialize
+    def initialize(command_builder)
+      @command_builder = command_builder
       @size = 0
       @commands = []
+      @blocks = nil
       @retryable = true
     end
 
-    def call(*command)
-      @commands << RESP3.coerce_command!(command)
+    def call(*command, **kwargs, &block)
+      command = @command_builder.generate!(command, kwargs)
+      (@blocks ||= [])[@commands.size] = block if block_given?
+      @commands << command
       nil
     end
 
-    def call_once(*command)
+    def call_once(*command, **kwargs)
+      command = @command_builder.generate!(command, kwargs)
       @retryable = false
-      @commands << RESP3.coerce_command!(command)
+      (@blocks ||= [])[@commands.size] = block if block_given?
+      @commands << command
       nil
     end
 
@@ -294,6 +396,10 @@ class RedisClient
       @commands
     end
 
+    def _blocks
+      @blocks
+    end
+
     def _size
       @commands.size
     end
@@ -309,18 +415,39 @@ class RedisClient
     def _retryable?
       @retryable
     end
+
+    def _coerce!(results)
+      if results
+        results.each_with_index do |result, index|
+          if result.is_a?(CommandError)
+            result._set_command(@commands[index + 1])
+            raise result
+          end
+        end
+
+        @blocks&.each_with_index do |block, index|
+          if block
+            results[index - 1] = block.call(results[index - 1])
+          end
+        end
+      end
+
+      results
+    end
   end
 
   class Pipeline < Multi
-    def initialize
+    def initialize(_command_builder)
       super
       @timeouts = nil
     end
 
-    def blocking_call(timeout, *command)
+    def blocking_call(timeout, *command, **kwargs)
+      command = @command_builder.generate!(command, kwargs)
       @timeouts ||= []
       @timeouts[@commands.size] = timeout
-      @commands << RESP3.coerce_command!(command)
+      (@blocks ||= [])[@commands.size] = block if block_given?
+      @commands << command
       nil
     end
 
@@ -331,12 +458,24 @@ class RedisClient
     def _empty?
       @commands.empty?
     end
+
+    def _coerce!(results)
+      return results unless results
+
+      @blocks&.each_with_index do |block, index|
+        if block
+          results[index] = block.call(results[index])
+        end
+      end
+
+      results
+    end
   end
 
   private
 
   def build_transaction
-    transaction = Multi.new
+    transaction = Multi.new(@command_builder)
     transaction.call("MULTI")
     yield transaction
     transaction.call("EXEC")
@@ -433,8 +572,16 @@ class RedisClient
     end
 
     connection
+  rescue CommandError => error
+    if error.message.include?("ERR unknown command `HELLO`")
+      raise UnsupportedServer,
+        "Your Redis server version is too old. redis-client requires Redis 6+. (#{config.server_url})"
+    else
+      raise
+    end
   end
 end
 
-require "redis_client/resp3"
 require "redis_client/pooled"
+
+RedisClient.default_driver

data/redis-client.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Simple low-level client for Redis 6+"
   spec.homepage = "https://github.com/redis-rb/redis-client"
+  spec.license = "MIT"
   spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
@@ -22,13 +23,10 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|benchmark)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|hiredis-client|test|spec|features|benchmark)/|\.(?:git|rubocop))})
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.extensions = ["ext/redis_client/hiredis/extconf.rb"]
 
   spec.add_runtime_dependency "connection_pool"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -28,79 +28,32 @@ description:
 email:
 - jean.boussier@gmail.com
 executables: []
-extensions:
-- ext/redis_client/hiredis/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- ext/redis_client/hiredis/export.clang
-- ext/redis_client/hiredis/export.gcc
-- ext/redis_client/hiredis/extconf.rb
-- ext/redis_client/hiredis/hiredis_connection.c
-- ext/redis_client/hiredis/vendor/.gitignore
-- ext/redis_client/hiredis/vendor/.travis.yml
-- ext/redis_client/hiredis/vendor/CHANGELOG.md
-- ext/redis_client/hiredis/vendor/CMakeLists.txt
-- ext/redis_client/hiredis/vendor/COPYING
-- ext/redis_client/hiredis/vendor/Makefile
-- ext/redis_client/hiredis/vendor/README.md
-- ext/redis_client/hiredis/vendor/adapters/ae.h
-- ext/redis_client/hiredis/vendor/adapters/glib.h
-- ext/redis_client/hiredis/vendor/adapters/ivykis.h
-- ext/redis_client/hiredis/vendor/adapters/libev.h
-- ext/redis_client/hiredis/vendor/adapters/libevent.h
-- ext/redis_client/hiredis/vendor/adapters/libuv.h
-- ext/redis_client/hiredis/vendor/adapters/macosx.h
-- ext/redis_client/hiredis/vendor/adapters/qt.h
-- ext/redis_client/hiredis/vendor/alloc.c
-- ext/redis_client/hiredis/vendor/alloc.h
-- ext/redis_client/hiredis/vendor/appveyor.yml
-- ext/redis_client/hiredis/vendor/async.c
-- ext/redis_client/hiredis/vendor/async.h
-- ext/redis_client/hiredis/vendor/async_private.h
-- ext/redis_client/hiredis/vendor/dict.c
-- ext/redis_client/hiredis/vendor/dict.h
-- ext/redis_client/hiredis/vendor/fmacros.h
-- ext/redis_client/hiredis/vendor/hiredis-config.cmake.in
-- ext/redis_client/hiredis/vendor/hiredis.c
-- ext/redis_client/hiredis/vendor/hiredis.h
-- ext/redis_client/hiredis/vendor/hiredis.pc.in
-- ext/redis_client/hiredis/vendor/hiredis_ssl-config.cmake.in
-- ext/redis_client/hiredis/vendor/hiredis_ssl.h
-- ext/redis_client/hiredis/vendor/hiredis_ssl.pc.in
-- ext/redis_client/hiredis/vendor/net.c
-- ext/redis_client/hiredis/vendor/net.h
-- ext/redis_client/hiredis/vendor/read.c
-- ext/redis_client/hiredis/vendor/read.h
-- ext/redis_client/hiredis/vendor/sds.c
-- ext/redis_client/hiredis/vendor/sds.h
-- ext/redis_client/hiredis/vendor/sdsalloc.h
-- ext/redis_client/hiredis/vendor/sockcompat.c
-- ext/redis_client/hiredis/vendor/sockcompat.h
-- ext/redis_client/hiredis/vendor/ssl.c
-- ext/redis_client/hiredis/vendor/test.c
-- ext/redis_client/hiredis/vendor/test.sh
-- ext/redis_client/hiredis/vendor/win32.h
 - lib/redis-client.rb
 - lib/redis_client.rb
-- lib/redis_client/buffered_io.rb
+- lib/redis_client/command_builder.rb
 - lib/redis_client/config.rb
-- lib/redis_client/connection.rb
-- lib/redis_client/hiredis_connection.rb
+- lib/redis_client/connection_mixin.rb
+- lib/redis_client/decorator.rb
 - lib/redis_client/middlewares.rb
 - lib/redis_client/pooled.rb
-- lib/redis_client/resp3.rb
+- lib/redis_client/ruby_connection.rb
+- lib/redis_client/ruby_connection/buffered_io.rb
+- lib/redis_client/ruby_connection/resp3.rb
 - lib/redis_client/sentinel_config.rb
 - lib/redis_client/version.rb
 - redis-client.gemspec
 homepage: https://github.com/redis-rb/redis-client
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/redis-rb/redis-client