feat: add redis cache and insights support

innocenzi · innocenzi · commit c1635fe4e683 · 2025-05-23T22:52:10.000+02:00
diff --git a/packages/cache/composer.json b/packages/cache/composer.json
@@ -7,6 +7,7 @@
         "symfony/cache": "^7.2",
         "tempest/core": "dev-main",
         "tempest/clock": "dev-main",
+        "tempest/kv-store": "dev-main",
         "tempest/container": "dev-main"
     },
     "require-dev": {
diff --git a/packages/cache/src/CacheInitializer.php b/packages/cache/src/CacheInitializer.php
@@ -25,10 +25,13 @@ public function canInitialize(ClassReflector $class, null|string|UnitEnum $tag):
     #[Singleton]
     public function initialize(ClassReflector $class, null|string|UnitEnum $tag, Container $container): Cache
     {
+        $config = $container->get(CacheConfig::class, $tag);
+
         return new GenericCache(
-            cacheConfig: $container->get(CacheConfig::class, $tag),
-            deferredTasks: $container->get(DeferredTasks::class),
+            adapter: $config->createAdapter($container),
             enabled: $this->shouldCacheBeEnabled($tag),
+            deferredTasks: $container->get(DeferredTasks::class),
+            tag: $tag,
         );
     }
 
diff --git a/packages/cache/src/Commands/CacheStatusCommand.php b/packages/cache/src/Commands/CacheStatusCommand.php
@@ -99,12 +99,10 @@ private function getCacheName(Cache $cache): string
             return $cache::class;
         }
 
-        $tag = $cache->cacheConfig->tag;
-
-        if ($tag instanceof UnitEnum) {
-            return $tag->name;
+        if ($cache->tag instanceof UnitEnum) {
+            return $cache->tag->name;
         }
 
-        return $tag ?? 'default';
+        return $cache->tag ?? 'default';
     }
 }
diff --git a/packages/cache/src/Config/CacheConfig.php b/packages/cache/src/Config/CacheConfig.php
@@ -3,12 +3,13 @@
 namespace Tempest\Cache\Config;
 
 use Psr\Cache\CacheItemPoolInterface;
+use Tempest\Container\Container;
 use Tempest\Container\HasTag;
 
 interface CacheConfig extends HasTag
 {
     /**
      * Creates the adapter.
      */
-    public function createAdapter(): CacheItemPoolInterface;
+    public function createAdapter(Container $container): CacheItemPoolInterface;
 }
diff --git a/packages/cache/src/Config/CustomCacheConfig.php b/packages/cache/src/Config/CustomCacheConfig.php
@@ -3,6 +3,7 @@
 namespace Tempest\Cache\Config;
 
 use Symfony\Component\Cache\Adapter\AdapterInterface;
+use Tempest\Container\Container;
 use UnitEnum;
 
 use function Tempest\get;
@@ -26,8 +27,8 @@ public function __construct(
         public null|string|UnitEnum $tag = null,
     ) {}
 
-    public function createAdapter(): AdapterInterface
+    public function createAdapter(Container $container): AdapterInterface
     {
-        return get($this->adapter);
+        return $container->get($this->adapter);
     }
 }
diff --git a/packages/cache/src/Config/FilesystemCacheConfig.php b/packages/cache/src/Config/FilesystemCacheConfig.php
@@ -3,6 +3,7 @@
 namespace Tempest\Cache\Config;
 
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Tempest\Container\Container;
 use UnitEnum;
 
 use function Tempest\internal_storage_path;
@@ -29,7 +30,7 @@ public function __construct(
         public null|string|UnitEnum $tag = null,
     ) {}
 
-    public function createAdapter(): FilesystemAdapter
+    public function createAdapter(Container $container): FilesystemAdapter
     {
         return new FilesystemAdapter(
             namespace: $this->namespace ?? '',
diff --git a/packages/cache/src/Config/InMemoryCacheConfig.php b/packages/cache/src/Config/InMemoryCacheConfig.php
@@ -4,10 +4,9 @@
 
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Tempest\Clock\Clock;
+use Tempest\Container\Container;
 use UnitEnum;
 
-use function Tempest\get;
-
 /**
  * Store cache in an array, for a single request.
  */
@@ -20,10 +19,10 @@ public function __construct(
         public null|string|UnitEnum $tag = null,
     ) {}
 
-    public function createAdapter(): ArrayAdapter
+    public function createAdapter(Container $container): ArrayAdapter
     {
         return new ArrayAdapter(
-            clock: get(Clock::class)->toPsrClock(),
+            clock: $container->get(Clock::class)->toPsrClock(),
         );
     }
 }
diff --git a/packages/cache/src/Config/PhpCacheConfig.php b/packages/cache/src/Config/PhpCacheConfig.php
@@ -2,8 +2,8 @@
 
 namespace Tempest\Cache\Config;
 
-use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
+use Tempest\Container\Container;
 use UnitEnum;
 
 use function Tempest\internal_storage_path;
@@ -30,7 +30,7 @@ public function __construct(
         public null|string|UnitEnum $tag = null,
     ) {}
 
-    public function createAdapter(): PhpFilesAdapter
+    public function createAdapter(Container $container): PhpFilesAdapter
     {
         return new PhpFilesAdapter(
             namespace: $this->namespace ?? '',
diff --git a/packages/cache/src/Config/RedisCacheConfig.php b/packages/cache/src/Config/RedisCacheConfig.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace Tempest\Cache\Config;
+
+use Symfony\Component\Cache\Adapter\RedisAdapter;
+use Tempest\Container\Container;
+use Tempest\KeyValue\Redis\Redis;
+use UnitEnum;
+
+/**
+ * Use a Redis connection for caching.
+ */
+final class RedisCacheConfig implements CacheConfig
+{
+    public function __construct(
+        /**
+         * The directory where the cache files are stored.
+         */
+        public ?string $directory = null,
+
+        /**
+         * Optional namespace to avoid collisions with other caches in the same directory.
+         */
+        public ?string $namespace = null,
+
+        /*
+         * Identifies the {@see \Tempest\Cache\Cache} instance in the container, in case you need more than one configuration.
+         */
+        public null|string|UnitEnum $tag = null,
+    ) {}
+
+    public function createAdapter(Container $container): RedisAdapter
+    {
+        return new RedisAdapter(
+            redis: $container->get(Redis::class)->getClient(),
+            namespace: $this->namespace ?? '',
+        );
+    }
+}
diff --git a/packages/cache/src/GenericCache.php b/packages/cache/src/GenericCache.php
@@ -6,24 +6,22 @@
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
 use Stringable;
-use Tempest\Cache\Config\CacheConfig;
 use Tempest\Core\DeferredTasks;
 use Tempest\DateTime\DateTime;
 use Tempest\DateTime\DateTimeInterface;
 use Tempest\DateTime\Duration;
 use Tempest\Support\Arr;
 use Tempest\Support\Random;
+use UnitEnum;
 
 final class GenericCache implements Cache
 {
     public function __construct(
-        private(set) CacheConfig $cacheConfig,
+        private(set) CacheItemPoolInterface $adapter,
         public bool $enabled = true,
-        private ?CacheItemPoolInterface $adapter = null,
         private ?DeferredTasks $deferredTasks = null,
-    ) {
-        $this->adapter ??= $this->cacheConfig->createAdapter();
-    }
+        public null|UnitEnum|string $tag = null,
+    ) {}
 
     public function lock(Stringable|string $key, null|Duration|DateTimeInterface $expiration = null, null|Stringable|string $owner = null): Lock
     {
diff --git a/packages/cache/src/Testing/TestingCache.php b/packages/cache/src/Testing/TestingCache.php
@@ -9,10 +9,8 @@
 use Stringable;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Tempest\Cache\Cache;
-use Tempest\Cache\Config\CustomCacheConfig;
 use Tempest\Cache\GenericCache;
 use Tempest\Cache\GenericLock;
-use Tempest\Core\DeferredTasks;
 use Tempest\DateTime\DateTimeInterface;
 use Tempest\DateTime\Duration;
 use Tempest\Support\Random;
@@ -32,10 +30,7 @@ public function __construct(
         ClockInterface $clock,
     ) {
         $this->adapter = new ArrayAdapter(clock: $clock);
-        $this->cache = new GenericCache(
-            cacheConfig: new CustomCacheConfig(adapter: ArrayAdapter::class, tag: $tag),
-            adapter: $this->adapter,
-        );
+        $this->cache = new GenericCache($this->adapter);
     }
 
     public function lock(Stringable|string $key, null|Duration|DateTimeInterface $expiration = null, null|Stringable|string $owner = null): TestingLock
diff --git a/packages/cache/src/UserCacheInsightsProvider.php b/packages/cache/src/UserCacheInsightsProvider.php
@@ -2,10 +2,12 @@
 
 namespace Tempest\Cache;
 
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
+use Symfony\Component\Cache\Adapter\RedisAdapter;
 use Tempest\Cache\Config\CacheConfig;
-use Tempest\Cache\Config\FilesystemCacheConfig;
 use Tempest\Cache\Config\InMemoryCacheConfig;
-use Tempest\Cache\Config\PhpCacheConfig;
 use Tempest\Container\Container;
 use Tempest\Container\GenericContainer;
 use Tempest\Core\Insight;
@@ -39,10 +41,11 @@ public function getInsights(): array
     private function getInsight(Cache $cache): array
     {
         $type = ($cache instanceof GenericCache)
-            ? match (get_class($cache->cacheConfig)) {
-                FilesystemCacheConfig::class => new Insight('Filesystem'),
-                PhpCacheConfig::class => new Insight('PHP'),
-                InMemoryCacheConfig::class => new Insight('In-memory'),
+            ? match (get_class($cache->adapter)) {
+                FilesystemAdapter::class => new Insight('Filesystem'),
+                PhpFilesAdapter::class => new Insight('PHP'),
+                ArrayAdapter::class => new Insight('In-memory'),
+                RedisAdapter::class => new Insight('Redis'),
                 default => null,
             }
             : null;
@@ -60,12 +63,10 @@ private function getCacheName(Cache $cache): string
             return $cache::class;
         }
 
-        $tag = $cache->cacheConfig->tag;
-
-        if ($tag instanceof UnitEnum) {
-            return $tag->name;
+        if ($cache->tag instanceof UnitEnum) {
+            return $cache->tag->name;
         }
 
-        return $tag ?? 'default';
+        return $cache->tag ?? 'default';
     }
 }
diff --git a/packages/kv-store/src/Redis/PhpRedisClient.php b/packages/kv-store/src/Redis/PhpRedisClient.php
@@ -140,6 +140,10 @@ private function serializeValue(mixed $value): mixed
 
     public function getClient(): \Redis
     {
+        if (! $this->client->isConnected()) {
+            $this->connect();
+        }
+
         return $this->client;
     }
 }
diff --git a/packages/kv-store/src/Redis/RedisInsightsProvider.php b/packages/kv-store/src/Redis/RedisInsightsProvider.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Tempest\KeyValue\Redis;
+
+use Predis;
+use Tempest\Core\Insight;
+use Tempest\Core\InsightsProvider;
+use Tempest\Support\Regex;
+
+final class RedisInsightsProvider implements InsightsProvider
+{
+    public string $name = 'Redis';
+
+    public function __construct(
+        private readonly Redis $redis,
+    ) {}
+
+    public function getInsights(): array
+    {
+        $client = $this->redis->getClient();
+        $version = Regex\get_match($this->redis->command('info', 'server'), '/redis_version:(?<version>[0-9.]+)/', match: 'version');
+
+        return [
+            'Engine' => match (get_class($client)) {
+                \Redis::class => 'Redis extension',
+                Predis\Client::class => 'Predis',
+                default => new Insight('None', Insight::WARNING),
+            },
+            'Version' => $version ?: new Insight('Unknown', Insight::WARNING),
+        ];
+    }
+}
diff --git a/packages/kv-store/src/Redis/redis.config.php b/packages/kv-store/src/Redis/redis.config.php
@@ -0,0 +1,14 @@
+<?php
+
+use Tempest\KeyValue\Redis\Config\RedisConfig;
+
+use function Tempest\env;
+
+return new RedisConfig(
+    prefix: env('REDIS_PREFIX'),
+    username: env('REDIS_USERNAME'),
+    password: env('REDIS_PASSWORD'),
+    host: env('REDIS_HOST'),
+    port: env('REDIS_PORT'),
+    database: env('REDIS_DATABASE'),
+);
diff --git a/tests/Integration/Cache/CacheTest.php b/tests/Integration/Cache/CacheTest.php
diff --git a/tests/Integration/Cache/LockTest.php b/tests/Integration/Cache/LockTest.php
diff --git a/tests/Integration/Cache/RedisCacheTest.php b/tests/Integration/Cache/RedisCacheTest.php

Original file line number	Diff line number	Diff line change
`@@ -99,12 +99,10 @@ private function getCacheName(Cache $cache): string`
`99`	`99`	`return $cache::class;`
`100`	`100`	`}`
`101`	`101`
`102`		`- $tag = $cache->cacheConfig->tag;`
`103`		`-`
`104`		`- if ($tag instanceof UnitEnum) {`
`105`		`- return $tag->name;`
	`102`	`+ if ($cache->tag instanceof UnitEnum) {`
	`103`	`+ return $cache->tag->name;`
`106`	`104`	`}`
`107`	`105`
`108`		`- return $tag ?? 'default';`
	`106`	`+ return $cache->tag ?? 'default';`
`109`	`107`	`}`
`110`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,13 @@`
`3`	`3`	`namespace Tempest\Cache\Config;`
`4`	`4`
`5`	`5`	`use Psr\Cache\CacheItemPoolInterface;`
	`6`	`+use Tempest\Container\Container;`
`6`	`7`	`use Tempest\Container\HasTag;`
`7`	`8`
`8`	`9`	`interface CacheConfig extends HasTag`
`9`	`10`	`{`
`10`	`11`	`/**`
`11`	`12`	`* Creates the adapter.`
`12`	`13`	`*/`
`13`		`- public function createAdapter(): CacheItemPoolInterface;`
	`14`	`+ public function createAdapter(Container $container): CacheItemPoolInterface;`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Tempest\Cache\Config;`
`4`	`4`
`5`	`5`	`use Symfony\Component\Cache\Adapter\AdapterInterface;`
	`6`	`+use Tempest\Container\Container;`
`6`	`7`	`use UnitEnum;`
`7`	`8`
`8`	`9`	`use function Tempest\get;`
`@@ -26,8 +27,8 @@ public function __construct(`
`26`	`27`	`public null\|string\|UnitEnum $tag = null,`
`27`	`28`	`) {}`
`28`	`29`
`29`		`- public function createAdapter(): AdapterInterface`
	`30`	`+ public function createAdapter(Container $container): AdapterInterface`
`30`	`31`	`{`
`31`		`- return get($this->adapter);`
	`32`	`+ return $container->get($this->adapter);`
`32`	`33`	`}`
`33`	`34`	`}`