redis-client 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097ad5acec4f5ea01788629c3fe2c606e54c1a2a0749c4e489487cf6bd446eae'
-  data.tar.gz: 275d778806cb7848d99ddcba33f1e932853efc9f0d149d6409692d1b39452d86
+  metadata.gz: b23930fc431afe23313aca3ef90ba49f219a6ed1a50f8153075a09b4c43678c0
+  data.tar.gz: 502388c79068a1dfe166543a6eb91cead665f42e404f679a598f5a8e2844ee82
 SHA512:
-  metadata.gz: c553d706fe8b955a0c6b65a28e9d6a1ddcdec156a562ec5092396a0bca9fa72a251441b8675484fff2d4db3d8e2f335043d226bb4c9c3359e84acc9b7605543f
-  data.tar.gz: 68dcc5d81b1632dd60d22651d0ef600903fe607230d3ac396d5e98aab7694d374d5e577777234d7e514fc4df04b332e0fdb31b3c9971fb116c6b0e87c1ddc5f5
+  metadata.gz: 9f6d4422b8c3e6608a5a8c53a55335ad0c44c034bc2cf26c7b5aace8dfdbe799409dd9783bd5928da3453d60ed28579594676f95c951a6a4dfff5e04dd09d28d
+  data.tar.gz: 3ee257ab6d509606c959079a16886389d76bfe232876aba9de1ae8922031746ad2576224fc5b0fae44a09ef13ba4d14ea862098860f923f432f63454499c1677

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Unreleased
 
+# 0.5.1
+
+- Fix a regression in the `scan` familly of methods, they would raise with `ArgumentError: can't issue an empty redis command`. Fix: #24
+
+# 0.5.0
+
+- Fix handling of connection URLs with empty passwords (`redis://:pass@example.com`).
+- Handle URLs with IPv6 hosts.
+- Add `RedisClient::Config#server_url` as a quick way to identify which server the client is pointing to.
+- Add `CommandError#command` to expose the command that caused the error.
+- Raise a more explicit error when connecting to older redises without RESP3 support (5.0 and older).
+- Properly reject empty commands early.
+
+# 0.4.0
+
+- The `hiredis` driver have been moved to the `hiredis-client` gem.
+
 # 0.3.0
 
 - `hiredis` is now the default driver when available.

data/Gemfile

@@ -3,9 +3,8 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in redis-client.gemspec
-gemspec
+gemspec name: "redis-client"
 
-gem "connection_pool"
 gem "minitest"
 gem "rake", "~> 13.0"
 gem "rake-compiler"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.3.0)
+    redis-client (0.5.1)
       connection_pool
 
 GEM
@@ -51,7 +51,6 @@ PLATFORMS
 DEPENDENCIES
   benchmark-ips
   byebug
-  connection_pool
   hiredis
   minitest
   rake (~> 13.0)

data/README.md

@@ -2,7 +2,7 @@
 
 `redis-client` is a simple, low-level, client for Redis 6+.
 
-Contrary to the `redis` gem, `redis-client` doesn't try to map all redis commands to Ruby constructs,
+Contrary to the `redis` gem, `redis-client` doesn't try to map all Redis commands to Ruby constructs,
 it merely is a thin wrapper on top of the RESP3 protocol.
 
 ## Installation
@@ -63,7 +63,7 @@ redis.call("GET", "mykey")
 ### Configuration
 
 - `url`: A Redis connection URL, e.g. `redis://example.com:6379/5`, a `rediss://` scheme enable SSL, and the path is interpreted as a database number.
-  Note tht all other configurtions take precedence, e.g. `RedisClient.config(url: "redis://localhost:3000" port: 6380)` will connect on port `6380`.
+  Note that all other configurations take precedence, e.g. `RedisClient.config(url: "redis://localhost:3000" port: 6380)` will connect on port `6380`.
 - `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.
@@ -142,7 +142,7 @@ is equivalent to:
 redis.call("LPUSH", "list", "1", "2", "3", "4")
 ```
 
-Hashes are flatenned as well:
+Hashes are flattened as well:
 
 ```ruby
 redis.call("HMSET", "hash", { "foo" => "1", "bar" => "2" })
@@ -154,7 +154,7 @@ is equivalent to:
 redis.call("HMSET", "hash", "foo", "1", "bar", "2")
 ```
 
-Any other type requires the caller to explictly cast the argument as a string.
+Any other type requires the caller to explicitly cast the argument as a string.
 
 Keywords arguments are treated as Redis command flags:
 
@@ -170,7 +170,7 @@ redis.call("SET", "mykey", "value", "nx", "ex", "60")
 redis.call("SET", "mykey", "value")
 ```
 
-If flags are built dynamically, you'll have to explictly pass them as keyword arguments with `**`:
+If flags are built dynamically, you'll have to explicitly pass them as keyword arguments with `**`:
 
 ```ruby
 flags = {}
@@ -185,7 +185,7 @@ unclosed hash literals with string keys may be interpreted differently:
 redis.call("HMSET", "hash", "foo" => "bar")
 ```
 
-On Ruby 2 `"foo" => "bar"` will be passed as a postional argument, but on Ruby 3 it will be interpreted as keyword
+On Ruby 2 `"foo" => "bar"` will be passed as a positional argument, but on Ruby 3 it will be interpreted as keyword
 arguments. To avoid such problem, make sure to enclose hash literals:
 
 ```ruby
@@ -196,7 +196,7 @@ redis.call("HMSET", "hash", { "foo" => "bar" })
 
 Contrary to the `redis` gem, `redis-client` doesn't do any type casting on the return value of commands.
 
-If you wish to cast the return value, you can pass a block to the `#call` familly of methods:
+If you wish to cast the return value, you can pass a block to the `#call` family of methods:
 
 ```ruby
 redis.call("INCR", "counter") # => 1
@@ -297,7 +297,7 @@ end
 
 If the transaction wasn't successful, `#multi` will return `nil`.
 
-Note that transactions using optimistic locking aren't automatically retried uppon connection errors.
+Note that transactions using optimistic locking aren't automatically retried upon connection errors.
 
 ### Publish / Subscribe
 
@@ -389,21 +389,17 @@ redis.call_once("INCR", "counter") # Won't be retried.
 
 ### Drivers
 
-`redis-client` ships with two connection implementations, a `hiredis` binding and a pure Ruby implementation.
+`redis-client` ships with a pure Ruby socket implementation.
 
-The hiredis binding is only available on Linux, macOS and other POSIX platforms. When available it is the default.
-
-The default driver can be set through `RedisClient.default_driver=`:
+For increased performance, you can enable the `hiredis` binding by adding `hiredis-client` to your Gemfile:
 
 ```ruby
-RedisClient.default_driver = :ruby
+gem "hiredis-client"
 ```
 
-You can also select the driver on a per connection basis:
+The hiredis binding is only available on Linux, macOS and other POSIX platforms. You can install the gem on other platforms, but it won't have any effect.
 
-```ruby
-redis_config = RedisClient.config(driver: :ruby, ...)
-```
+The default driver can be set through `RedisClient.default_driver=`:
 
 ## Notable differences with the `redis` gem
 

data/Rakefile

@@ -1,34 +1,53 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
 require "rake/extensiontask"
 require "rake/testtask"
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
+require "rake/clean"
+CLOBBER.include "pkg"
+require "bundler/gem_helper"
+Bundler::GemHelper.install_tasks(name: "redis-client")
+Bundler::GemHelper.install_tasks(dir: "hiredis-client", name: "hiredis-client")
+
 gemspec = Gem::Specification.load("redis-client.gemspec")
 Rake::ExtensionTask.new do |ext|
   ext.name = "hiredis_connection"
-  ext.ext_dir = "ext/redis_client/hiredis"
-  ext.lib_dir = "lib/redis_client"
+  ext.ext_dir = "hiredis-client/ext/redis_client/hiredis"
+  ext.lib_dir = "hiredis-client/lib/redis_client"
   ext.gem_spec = gemspec
   CLEAN.add("#{ext.ext_dir}/vendor/*.{a,o}")
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
-end
-
 namespace :test do
+  Rake::TestTask.new(:ruby) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
+  end
+
   Rake::TestTask.new(:sentinel) do |t|
     t.libs << "test/sentinel"
     t.libs << "test"
     t.libs << "lib"
     t.test_files = FileList["test/sentinel/*_test.rb"]
   end
+
+  Rake::TestTask.new(:hiredis) do |t|
+    t.libs << "test/hiredis"
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
+  end
+end
+
+hiredis_supported = RUBY_ENGINE == "ruby" && !RUBY_PLATFORM.match?(/mswin/)
+if hiredis_supported
+  task test: %i[test:ruby test:hiredis test:sentinel]
+else
+  task test: %i[test:ruby test:sentinel]
 end
 
 namespace :hiredis do
@@ -37,10 +56,14 @@ namespace :hiredis do
     archive_path = "tmp/hiredis-#{version}.tar.gz"
     url = "https://github.com/redis/hiredis/archive/refs/tags/v#{version}.tar.gz"
     system("curl", "-L", url, out: archive_path) or raise "Downloading of #{url} failed"
-    system("rm", "-rf", "ext/redis_client/hiredis/vendor/")
-    system("mkdir", "-p", "ext/redis_client/hiredis/vendor/")
-    system("tar", "xvzf", archive_path, "-C", "ext/redis_client/hiredis/vendor", "--strip-components", "1")
-    system("rm", "-rf", "ext/redis_client/hiredis/vendor/examples")
+    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/")
+    system("mkdir", "-p", "hiredis-client/ext/redis_client/hiredis/vendor/")
+    system(
+      "tar", "xvzf", archive_path,
+      "-C", "hiredis-client/ext/redis_client/hiredis/vendor",
+      "--strip-components", "1",
+    )
+    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/examples")
   end
 end
 
@@ -82,14 +105,10 @@ namespace :benchmark do
   end
 end
 
-if RUBY_PLATFORM == "java"
-  task default: %i[test test:sentinel rubocop]
-else
-  task default: %i[compile test test:sentinel rubocop]
-end
-
-if ENV["DRIVER"] == "hiredis"
-  task ci: %i[compile test test:sentinel]
+if hiredis_supported
+  task default: %i[compile test rubocop]
+  task ci: %i[compile test]
 else
-  task ci: %i[test test:sentinel]
+  task default: %i[test rubocop]
+  task ci: %i[test]
 end

data/lib/redis_client/command_builder.rb

@@ -40,6 +40,10 @@ class RedisClient
           end
         end
 
+        if command.empty?
+          raise ArgumentError, "can't issue an empty redis command"
+        end
+
         command
       end
     else
@@ -76,6 +80,10 @@ class RedisClient
           end
         end
 
+        if command.empty?
+          raise ArgumentError, "can't issue an empty redis command"
+        end
+
         command
       end
     end

data/lib/redis_client/config.rb

@@ -82,6 +82,14 @@ class RedisClient
         @ssl_context ||= @driver.ssl_context(@ssl_params)
       end
 
+      def server_url
+        if path
+          "#{path}/#{db}"
+        else
+          "redis#{'s' if ssl?}://#{host}:#{port}/#{db}"
+        end
+      end
+
       private
 
       def build_connection_prelude
@@ -110,15 +118,15 @@ class RedisClient
       path: nil,
       **kwargs
     )
-      uri = url && URI.parse(url)
-      if uri
+      if url
+        uri = URI.parse(url)
         kwargs[:ssl] = uri.scheme == "rediss" unless kwargs.key?(:ssl)
 
-        kwargs[:username] ||= uri.user && uri.password
+        kwargs[:username] ||= uri.user if uri.password && !uri.user.empty?
 
         kwargs[:password] ||= if uri.user && !uri.password
           URI.decode_www_form_component(uri.user)
-        elsif uri&.user && uri&.password
+        elsif uri.user && uri.password
           URI.decode_www_form_component(uri.password)
         end
 
@@ -127,7 +135,7 @@ class RedisClient
 
       super(**kwargs)
 
-      @host = host || uri&.host || DEFAULT_HOST
+      @host = host || uri&.host&.sub(/\A\[(.*)\]\z/, '\1') || DEFAULT_HOST
       @port = port || uri&.port || DEFAULT_PORT
       @path = path
     end

data/lib/redis_client/connection_mixin.rb

@@ -6,6 +6,7 @@ class RedisClient
       write(command)
       result = read(timeout)
       if result.is_a?(CommandError)
+        result._set_command(command)
         raise result
       else
         result
@@ -23,6 +24,7 @@ class RedisClient
         timeout = timeouts && timeouts[index]
         result = read(timeout)
         if result.is_a?(CommandError)
+          result._set_command(commands[index])
           exception ||= result
         end
         results[index] = result

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -24,7 +24,7 @@ class RedisClient
 
       name = name.to_sym
       unless @driver_definitions.key?(name)
-        raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{DRIVER_DEFINITIONS.keys.inspect}`"
+        raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{@driver_definitions.keys.inspect}`"
       end
 
       @drivers[name] ||= @driver_definitions[name]&.call
@@ -47,11 +47,6 @@ class RedisClient
     end
   end
 
-  register_driver :hiredis do
-    require "redis_client/hiredis_connection"
-    HiredisConnection
-  end
-
   register_driver :ruby do
     require "redis_client/ruby_connection"
     RubyConnection
@@ -83,6 +78,8 @@ class RedisClient
 
   Error = Class.new(StandardError)
 
+  UnsupportedServer = Class.new(Error)
+
   ConnectionError = Class.new(Error)
 
   FailoverError = Class.new(ConnectionError)
@@ -94,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
@@ -101,6 +100,10 @@ class RedisClient
         klass.new(error_message)
       end
     end
+
+    def _set_command(command)
+      @command = command
+    end
   end
 
   AuthenticationError = Class.new(CommandError)
@@ -145,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
@@ -225,8 +233,8 @@ class RedisClient
       return to_enum(__callee__, *args, **kwargs)
     end
 
-    args = @command_builder.generate!(args, kwargs)
-    scan_list(1, ["SCAN", 0, *args], &block)
+    args = @command_builder.generate!(["SCAN", 0] + args, kwargs)
+    scan_list(1, args, &block)
   end
 
   def sscan(key, *args, **kwargs, &block)
@@ -234,8 +242,8 @@ class RedisClient
       return to_enum(__callee__, key, *args, **kwargs)
     end
 
-    args = @command_builder.generate!(args, kwargs)
-    scan_list(2, ["SSCAN", key, 0, *args], &block)
+    args = @command_builder.generate!(["SSCAN", key, 0] + args, kwargs)
+    scan_list(2, args, &block)
   end
 
   def hscan(key, *args, **kwargs, &block)
@@ -243,8 +251,8 @@ class RedisClient
       return to_enum(__callee__, key, *args, **kwargs)
     end
 
-    args = @command_builder.generate!(args, kwargs)
-    scan_pairs(2, ["HSCAN", key, 0, *args], &block)
+    args = @command_builder.generate!(["HSCAN", key, 0] + args, kwargs)
+    scan_pairs(2, args, &block)
   end
 
   def zscan(key, *args, **kwargs, &block)
@@ -252,8 +260,8 @@ class RedisClient
       return to_enum(__callee__, key, *args, **kwargs)
     end
 
-    args = @command_builder.generate!(args, kwargs)
-    scan_pairs(2, ["ZSCAN", key, 0, *args], &block)
+    args = @command_builder.generate!(["ZSCAN", key, 0] + args, kwargs)
+    scan_pairs(2, args, &block)
   end
 
   def connected?
@@ -410,8 +418,9 @@ class RedisClient
 
     def _coerce!(results)
       if results
-        results.each do |result|
+        results.each_with_index do |result, index|
           if result.is_a?(CommandError)
+            result._set_command(@commands[index + 1])
             raise result
           end
         end
@@ -563,6 +572,13 @@ 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
 

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.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -28,72 +28,21 @@ 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/command_builder.rb
 - lib/redis_client/config.rb
 - lib/redis_client/connection_mixin.rb
 - lib/redis_client/decorator.rb
-- lib/redis_client/hiredis_connection.rb
 - lib/redis_client/middlewares.rb
 - lib/redis_client/pooled.rb
 - lib/redis_client/ruby_connection.rb
@@ -103,7 +52,8 @@ files:
 - 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