Merge pull request #170 from tacerus/unix

Support Unix sockets

Author: byroot

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+- Accept `unix://` schemes as well as simple paths in the `url:` config parameter. #170.
 - Make basic usage Ractor compatible.
 
 # 0.19.1

README.md

@@ -62,7 +62,9 @@ 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.
+- `url`: A Redis connection URL, e.g. `redis://example.com:6379/5` - a `rediss://` scheme enables SSL, and the path is interpreted as a database number.
+  To connect to UNIX domain sockets, the `url` can also just be a path, and the database specified as query parameter: `/run/redis/foo.sock?db=5`, or optionally
+  have a `unix://` scheme: `unix:///run/redis/foo.sock?db=5`
   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`.

lib/redis_client/config.rb

@@ -176,15 +176,20 @@ def initialize(
         }.compact.merge(kwargs)
         host ||= url_config.host
         port ||= url_config.port
+        path ||= url_config.path
         username ||= url_config.username
         password ||= url_config.password
       end
 
       super(username: username, password: password, **kwargs)
 
-      @host = host || DEFAULT_HOST
-      @port = Integer(port || DEFAULT_PORT)
-      @path = path
+      if @path = path
+        @host = nil
+        @port = nil
+      else
+        @host = host || DEFAULT_HOST
+        @port = Integer(port || DEFAULT_PORT)
+      end
     end
   end
 end

lib/redis_client/url_config.rb

@@ -4,26 +4,41 @@
 
 class RedisClient
   class URLConfig
-    DEFAULT_SCHEMA = "redis"
-    SSL_SCHEMA = "rediss"
-
     attr_reader :url, :uri
 
     def initialize(url)
       @url = url
       @uri = URI(url)
-      unless uri.scheme == DEFAULT_SCHEMA || uri.scheme == SSL_SCHEMA
-        raise ArgumentError, "Invalid URL: #{url.inspect}"
+      @unix = false
+      @ssl = false
+      case uri.scheme
+      when "redis"
+        # expected
+      when "rediss"
+        @ssl = true
+      when "unix", nil
+        @unix = true
+      else
+        raise ArgumentError, "Unknown URL scheme: #{url.inspect}"
       end
     end
 
     def ssl?
-      @uri.scheme == SSL_SCHEMA
+      @ssl
     end
 
     def db
-      db_path = uri.path&.delete_prefix("/")
-      Integer(db_path) if db_path && !db_path.empty?
+      unless @unix
+        db_path = uri.path&.delete_prefix("/")
+        return Integer(db_path) if db_path && !db_path.empty?
+      end
+
+      unless uri.query.nil? || uri.query.empty?
+        _, db_query = URI.decode_www_form(uri.query).find do |key, _|
+          key == "db"
+        end
+        return Integer(db_query) if db_query && !db_query.empty?
+      end
     end
 
     def username
@@ -44,6 +59,12 @@ def host
       uri.host.sub(/\A\[(.*)\]\z/, '\1')
     end
 
+    def path
+      if @unix
+        File.join(*[uri.host, uri.path].compact)
+      end
+    end
+
     def port
       return unless uri.port
 

test/redis_client/config_test.rb

@@ -14,16 +14,42 @@ def test_simple_uri
       refute_predicate config, :ssl?
     end
 
+    def test_unix_uri
+      config = Config.new(url: "/run/redis/test.sock?db=1")
+      assert_equal "/run/redis/test.sock", config.path
+      assert_nil config.host
+      assert_nil config.port
+      assert_equal 1, config.db
+
+      config = Config.new(url: "run/redis/test.sock?db=1")
+      assert_equal "run/redis/test.sock", config.path
+      assert_nil config.host
+      assert_nil config.port
+      assert_equal 1, config.db
+
+      config = Config.new(url: "unix:///run/redis/test.sock?db=1")
+      assert_equal "/run/redis/test.sock", config.path
+      assert_nil config.host
+      assert_nil config.port
+      assert_equal 1, config.db
+
+      config = Config.new(url: "unix://run/redis/test.sock?db=1")
+      assert_equal "run/redis/test.sock", config.path
+      assert_nil config.host
+      assert_nil config.port
+      assert_equal 1, config.db
+    end
+
     def test_uri_instance
       config = Config.new(url: URI.parse("redis://example.com"))
       assert_equal "example.com", config.host
     end
 
     def test_invalid_url
       error = assert_raises ArgumentError do
-        Config.new(url: "example.com")
+        Config.new(url: "http://example.com")
       end
-      assert_includes error.message, "Invalid URL"
+      assert_includes error.message, "Unknown URL scheme"
       assert_includes error.message, "example.com"
     end