refactor: select proper client automatically

Author: innocenzi

packages/kv-store/src/Redis/Config/PhpRedisConfig.php

@@ -2,8 +2,74 @@
 
 namespace Tempest\KeyValue\Redis\Config;
 
-use Tempest\Container\HasTag;
+use UnitEnum;
 
-interface RedisConfig extends HasTag
+final class RedisConfig
 {
+    public function __construct(
+        /**
+         * Add a prefix to all keys in the Redis database.
+         */
+        public ?string $prefix = null,
+
+        /**
+         * Username to the Redis instance.
+         */
+        public ?string $username = null,
+
+        /**
+         * Password to the Redis instance.
+         */
+        public ?string $password = null,
+
+        /**
+         * IP or hostname of the target server. This is ignored when connecting to Redis using UNIX domain sockets.
+         */
+        public ?string $host = null,
+
+        /**
+         * TCP/IP port of the target server. This is ignored when connecting to Redis using UNIX domain sockets.
+         */
+        public ?int $port = null,
+
+        /**
+         * Logical database to connect to.
+         */
+        public ?int $database = null,
+
+        /**
+         * Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets.
+         */
+        public ?int $unixSocketPath = null,
+
+        /**
+         * Specifies the protocol used to communicate with the Redis instance. This is specific to predis.
+         */
+        public Scheme $scheme = Scheme::TCP,
+
+        /**
+         * Specifies if the underlying connection resource should be left open when a script ends its lifecycle.
+         */
+        public bool $persistent = false,
+
+        /**
+         * The maximum duration, in seconds, to wait for a connection to be established.
+         */
+        public ?float $connectionTimeOut = null,
+
+        /**
+         * Less common Predis or PhpRedis client options.
+         */
+        public array $options = [],
+
+        /**
+         * Less common connection options.
+         */
+        public array $connection = [],
+
+        /**
+         * Identifier for this key-value store configuration.
+         */
+        public null|string|UnitEnum $tag = null,
+    ) {}
 }

packages/kv-store/src/Redis/Config/PredisConfig.php

@@ -2,6 +2,9 @@
 
 namespace Tempest\KeyValue\Redis\Config;
 
+/**
+ * Represents the connection scheme used to connect to Redis (predis only).
+ */
 enum Scheme: string
 {
     /**

packages/kv-store/src/Redis/Config/RedisConfig.php

@@ -7,7 +7,7 @@
 use Tempest\DateTime\DateTimeInterface;
 use Tempest\DateTime\Duration;
 use Tempest\EventBus\EventBus;
-use Tempest\KeyValue\Redis\Config\PhpRedisConfig;
+use Tempest\KeyValue\Redis\Config\RedisConfig;
 use Tempest\Support\Arr\ArrayInterface;
 
 use function Tempest\Support\Arr\is_associative;
@@ -16,7 +16,7 @@
 {
     public function __construct(
         private \Redis $client,
-        private PhpRedisConfig $config,
+        private RedisConfig $config,
         private ?EventBus $eventBus = null,
     ) {}
 

packages/kv-store/src/Redis/Config/Scheme.php

@@ -7,31 +7,31 @@
 use Tempest\Container\DynamicInitializer;
 use Tempest\Container\Singleton;
 use Tempest\EventBus\EventBus;
-use Tempest\KeyValue\Redis\Config\PhpRedisConfig;
-use Tempest\KeyValue\Redis\Config\PredisConfig;
 use Tempest\KeyValue\Redis\Config\RedisConfig;
 use Tempest\Reflection\ClassReflector;
+use UnitEnum;
 
 final class RedisInitializer implements DynamicInitializer
 {
-    public function canInitialize(ClassReflector $class, ?string $tag): bool
+    public function canInitialize(ClassReflector $class, null|string|UnitEnum $tag): bool
     {
         return $class->getType()->matches(Redis::class);
     }
 
     #[Singleton]
-    public function initialize(ClassReflector $class, ?string $tag, Container $container): Redis
+    public function initialize(ClassReflector $class, null|string|UnitEnum $tag, Container $container): Redis
     {
         $config = $container->get(RedisConfig::class, $tag);
         $bus = $container->get(EventBus::class);
 
-        return match ($config::class) {
-            PredisConfig::class => new PredisClient($this->buildPredisClient($config), $bus),
-            PhpRedisConfig::class => new PhpRedisClient($this->buildPhpRedisClient($config), $config, $bus),
-        };
+        try {
+            return new PhpRedisClient($this->buildPhpRedisClient(), $config, $bus);
+        } catch (MissingRedisException) {
+            return new PredisClient($this->buildPredisClient($config), $bus);
+        }
     }
 
-    private function buildPhpRedisClient(PhpRedisConfig $config): \Redis
+    private function buildPhpRedisClient(): \Redis
     {
         if (! extension_loaded('redis') || ! class_exists(\Redis::class)) {
             throw new MissingRedisException(Redis::class);
@@ -40,7 +40,7 @@ private function buildPhpRedisClient(PhpRedisConfig $config): \Redis
         return new \Redis();
     }
 
-    private function buildPredisClient(PredisConfig $config): Predis\Client
+    private function buildPredisClient(RedisConfig $config): Predis\Client
     {
         if (! class_exists(Predis\Client::class)) {
             throw new MissingRedisException(Predis\Client::class);

packages/kv-store/src/Redis/PhpRedisClient.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Tempest\KeyValue\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Tempest\KeyValue\Redis\Config\RedisConfig;
+use Tempest\KeyValue\Redis\PhpRedisClient;
+
+final class PhpRedisClientTest extends TestCase
+{
+    private PhpRedisClient $redis;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->redis = new PhpRedisClient(
+            client: new \Redis(),
+            config: new RedisConfig(
+                prefix: 'tempest_test:',
+                database: 6,
+                connectionTimeOut: .2,
+            ),
+        );
+
+        try {
+            $this->redis->connect();
+        } catch (\Throwable) {
+            $this->markTestSkipped('Could not connect to Redis.');
+        }
+    }
+
+    protected function tearDown(): void
+    {
+        try {
+            $this->redis->flush();
+        } finally {
+            parent::tearDown();
+        }
+    }
+
+    public function test_basic(): void
+    {
+        $this->assertSame('response', $this->redis->command('PING', 'response'));
+        $this->assertInstanceOf(\Redis::class, $this->redis->getClient());
+    }
+
+    public function test_set(): void
+    {
+        $this->redis->set('key_string', 'my-value');
+        $this->redis->set('key_array_associative', ['foo' => 'bar']);
+        $this->redis->set('key_array_list', ['foo', 'bar']);
+
+        $this->assertSame('my-value', $this->redis->getClient()->rawcommand('GET', 'key_string'));
+        $this->assertSame('{"foo":"bar"}', $this->redis->getClient()->rawcommand('GET', 'key_array_associative'));
+        $this->assertSame('["foo","bar"]', $this->redis->getClient()->rawcommand('GET', 'key_array_list'));
+    }
+
+    public function test_get(): void
+    {
+        $this->redis->getClient()->rawcommand('SET', 'key_string', 'my_value');
+        $this->redis->getClient()->rawcommand('SET', 'key_array_associative', '{"foo":"bar"}');
+        $this->redis->getClient()->rawcommand('SET', 'key_array_list', '["foo","bar"]');
+
+        $this->assertSame('my_value', $this->redis->get('key_string'));
+        $this->assertSame(['foo' => 'bar'], $this->redis->get('key_array_associative'));
+        $this->assertSame(['foo', 'bar'], $this->redis->get('key_array_list'));
+    }
+}