chore: cache refactor (#582)

Author: brendt

.env.example

@@ -1,4 +1,18 @@
-ENVIRONMENT=production
+# Possible values: local, staging, production, ci, testing, other
+ENVIRONMENT=local
+
+# The base URI that's used for all generated URIs
 BASE_URI=http://localhost
+
+# The CACHE key is used as a global override to turn all caches on or off
+# Should be true in production, but null or false in local development
+CACHE=null
+
+# Enable or disable discovery cache
 DISCOVERY_CACHE=false
-CACHE=false
+
+# Enable or disable view cache
+VIEW_CACHE=false
+
+# Enable or disable project cache (allround cache)
+PROJECT_CACHE=false

phpunit.xml.dist

@@ -31,5 +31,7 @@
   <php>
     <env name="ENVIRONMENT" value="testing" />
     <env name="BASE_URI" value="" />
+    <env name="CACHE" value="null" />
+    <env name="DISCOVERY_CACHE" value="true" />
   </php>
 </phpunit>

src/Tempest/Cache/src/Cache.php

@@ -20,4 +20,6 @@ public function resolve(string $key, Closure $cache, ?DateTimeInterface $expires
     public function remove(string $key): void;
 
     public function clear(): void;
+
+    public function isEnabled(): bool;
 }

src/Tempest/Cache/src/CacheConfig.php

@@ -5,25 +5,32 @@
 namespace Tempest\Cache;
 
 use Psr\Cache\CacheItemPoolInterface;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use function Tempest\env;
 
 final class CacheConfig
 {
     /** @var class-string<\Tempest\Cache\Cache>[] */
     public array $caches = [];
 
-    public bool $enabled;
+    public ?bool $enable;
+
+    public bool $projectCache = false;
+
+    public bool $viewCache = false;
+
+    public bool $discoveryCache = false;
 
     public function __construct(
-        public CacheItemPoolInterface $pool = new FilesystemAdapter(
-            namespace: '',
-            defaultLifetime: 0,
-            directory: __DIR__ . '/../../../../.cache',
-        ),
-        ?bool $enabled = null,
+        public string $directory = __DIR__ . '/../../../../.cache',
+        public ?CacheItemPoolInterface $projectCachePool = null,
+
+        /** Used as a global override, should be true in production, null in local */
+        ?bool $enable = null,
     ) {
-        $this->enabled = $enabled ?? env('CACHE', true);
+        $this->enable = $enable ?? env('CACHE') ?? null;
+        $this->projectCache = (bool) env('PROJECT_CACHE', false);
+        $this->viewCache = (bool) env('VIEW_CACHE', false);
+        $this->discoveryCache = (bool) env('DISCOVERY_CACHE', false);
     }
 
     /** @param class-string<\Tempest\Cache\Cache> $className */

src/Tempest/Cache/src/CacheInitializer.php

@@ -11,8 +11,8 @@
 final readonly class CacheInitializer implements Initializer
 {
     #[Singleton]
-    public function initialize(Container $container): Cache|GenericCache
+    public function initialize(Container $container): Cache|ProjectCache
     {
-        return new GenericCache($container->get(CacheConfig::class));
+        return new ProjectCache($container->get(CacheConfig::class));
     }
 }

src/Tempest/Cache/src/CacheStatusCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Cache;
+
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Console\HasConsole;
+use Tempest\Container\Container;
+
+final readonly class CacheStatusCommand
+{
+    use HasConsole;
+
+    public function __construct(
+        private Console $console,
+        private CacheConfig $cacheConfig,
+        private Container $container,
+    ) {
+    }
+
+    #[ConsoleCommand(name: 'cache:status', aliases: ['cs'])]
+    public function __invoke(): void
+    {
+        $caches = $this->cacheConfig->caches;
+
+        foreach ($caches as $cacheClass) {
+            /** @var Cache $cache */
+            $cache = $this->container->get($cacheClass);
+
+            $reason = match($this->cacheConfig->enable) {
+                true => ' (global CACHE = true)',
+                false => ' (global CACHE = false)',
+                null => '',
+            };
+
+            $this->writeln(sprintf(
+                '<em>%s</em> %s%s',
+                $cacheClass,
+                $cache->isEnabled() ? '<success>enabled</success>' : '<error>disabled</error>',
+                $reason
+            ));
+        }
+    }
+}

src/Tempest/Cache/src/GenericCache.php

@@ -13,8 +13,6 @@ trait IsCache
 {
     abstract protected function getCachePool(): CacheItemPoolInterface;
 
-    abstract protected function isEnabled(): bool;
-
     public function put(string $key, mixed $value, ?DateTimeInterface $expiresAt = null): CacheItemInterface
     {
         $item = $this->getCachePool()
@@ -25,13 +23,19 @@ public function put(string $key, mixed $value, ?DateTimeInterface $expiresAt = n
             $item = $item->expiresAt($expiresAt);
         }
 
-        $this->getCachePool()->save($item);
+        if ($this->isEnabled()) {
+            $this->getCachePool()->save($item);
+        }
 
         return $item;
     }
 
     public function get(string $key): mixed
     {
+        if (! $this->isEnabled()) {
+            return null;
+        }
+
         return $this->getCachePool()->getItem($key)->get();
     }
 
@@ -53,6 +57,10 @@ public function resolve(string $key, Closure $cache, ?DateTimeInterface $expires
 
     public function remove(string $key): void
     {
+        if (! $this->isEnabled()) {
+            return;
+        }
+
         $this->getCachePool()->deleteItem($key);
     }
 

src/Tempest/Cache/src/IsCache.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Cache;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use function Tempest\path;
+
+final class ProjectCache implements Cache
+{
+    use IsCache;
+
+    private CacheItemPoolInterface $pool;
+
+    public function __construct(
+        private readonly CacheConfig $cacheConfig,
+    ) {
+        $this->pool = $this->cacheConfig->projectCachePool ?? new FilesystemAdapter(
+            directory: path($this->cacheConfig->directory, 'project'),
+        );
+    }
+
+    protected function getCachePool(): CacheItemPoolInterface
+    {
+        return $this->pool;
+    }
+
+    public function isEnabled(): bool
+    {
+        return $this->cacheConfig->enable ?? $this->cacheConfig->projectCache;
+    }
+}

src/Tempest/Cache/src/ProjectCache.php

@@ -8,7 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Tempest\Cache\CacheConfig;
-use Tempest\Cache\GenericCache;
+use Tempest\Cache\ProjectCache;
 use Tempest\Clock\MockClock;
 
 /**
@@ -20,7 +20,7 @@ public function test_put(): void
     {
         $clock = new MockClock();
         $pool = new ArrayAdapter(clock: $clock);
-        $cache = new GenericCache(new CacheConfig($pool));
+        $cache = new ProjectCache(new CacheConfig(projectCachePool: $pool, enable: true));
         $interval = new DateInterval('P1D');
 
         $cache->put('a', 'a', $clock->now()->add($interval));
@@ -44,7 +44,7 @@ public function test_get(): void
     {
         $clock = new MockClock();
         $pool = new ArrayAdapter(clock: $clock);
-        $cache = new GenericCache(new CacheConfig($pool));
+        $cache = new ProjectCache(new CacheConfig(projectCachePool: $pool, enable: true));
         $interval = new DateInterval('P1D');
 
         $cache->put('a', 'a', $clock->now()->add($interval));
@@ -64,10 +64,10 @@ public function test_resolve(): void
         $clock = new MockClock();
         $pool = new ArrayAdapter(clock: $clock);
         $config = new CacheConfig(
-            pool: $pool,
-            enabled: true,
+            projectCachePool: $pool,
+            enable: true,
         );
-        $cache = new GenericCache($config);
+        $cache = new ProjectCache($config);
         $interval = new DateInterval('P1D');
 
         $a = $cache->resolve('a', fn () => 'a', $clock->now()->add($interval));
@@ -88,7 +88,7 @@ public function test_resolve(): void
     public function test_remove(): void
     {
         $pool = new ArrayAdapter();
-        $cache = new GenericCache(new CacheConfig($pool));
+        $cache = new ProjectCache(new CacheConfig(projectCachePool: $pool, enable: true));
 
         $cache->put('a', 'a');
 
@@ -100,7 +100,7 @@ public function test_remove(): void
     public function test_clear(): void
     {
         $pool = new ArrayAdapter();
-        $cache = new GenericCache(new CacheConfig($pool));
+        $cache = new ProjectCache(cacheConfig: new CacheConfig(projectCachePool: $pool));
 
         $cache->put('a', 'a');
         $cache->put('b', 'b');