redis-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd28ab66722c23791118818d83505de8cbc1b141c75959f2408b8a0c90cb6ad
-  data.tar.gz: 30f85f2bb0df340facd9a743f63dcfd2ff8fa8b8a3e363c9fdeb2f1101d5d076
+  metadata.gz: 770636c5814252674d680c45f75af4ea291b698c18382b49d93bec4e3d7ab45b
+  data.tar.gz: bdef4f0f80574a9aaf29613ec23d31d7a0c3d916ca3945ac412b36b55eecd73a
 SHA512:
-  metadata.gz: 528b4cd6f9377f083a19ca1da7b117625ad32c1849c8cc53d795dc5af8e6d23c372fdb5714c043b7c796a6fcfda54ef28ee0142268846445cbfb60e00eabf625
-  data.tar.gz: af0040e6a5cf498587818b5161122d57e3057a39a22d0eb5fc8252e4cb56e71ad61c0a381fbe35c75cd6f5e5e2998169487e33b74f7635f7e025f6e06d7351ca
+  metadata.gz: 3367281b907b6e38e73ba1e9a74f63404e40f422b319c551645fec1efa694e87c09cd96c67d308c362407c84be59eb62435b9951740cd515727a554050ae3137
+  data.tar.gz: 9dc6f5e6638405c8841b267d0c9cf882d0721cbd04655984af71bddb66cc7e2f4698e7199e752582064e4db3ca8e3f45a77b56241df309ae0c2e231ebff1cf2b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+- 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.4.0)
+    redis-client (0.5.0)
       connection_pool
 
 GEM

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
 

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.4.0"
+  VERSION = "0.5.0"
 end

data/lib/redis_client.rb

@@ -78,6 +78,8 @@ class RedisClient
 
   Error = Class.new(StandardError)
 
+  UnsupportedServer = Class.new(Error)
+
   ConnectionError = Class.new(Error)
 
   FailoverError = Class.new(ConnectionError)
@@ -89,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
@@ -96,6 +100,10 @@ class RedisClient
         klass.new(error_message)
       end
     end
+
+    def _set_command(command)
+      @command = command
+    end
   end
 
   AuthenticationError = Class.new(CommandError)
@@ -140,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
@@ -405,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
@@ -558,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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool