refactor(framework): centralize internal caches (#948)

Co-authored-by: brendt <[email protected]>

Author: innocenzi

composer.json

@@ -159,6 +159,7 @@
             "Tempest\\Router\\Tests\\": "src/Tempest/Router/tests",
             "Tempest\\Support\\Tests\\": "src/Tempest/Support/tests",
             "Tempest\\Validation\\Tests\\": "src/Tempest/Validation/tests",
+            "Tempest\\View\\Tests\\": "src/Tempest/View/tests",
             "Tempest\\Vite\\Tests\\": "src/Tempest/Vite/tests",
             "Tests\\Tempest\\": "tests/"
         }

src/Tempest/Cache/composer.json

@@ -6,6 +6,7 @@
         "psr/cache": "^3.0",
         "symfony/cache": "^7.2",
         "tempest/core": "dev-main",
+        "tempest/container": "dev-main",
         "tempest/highlight": "^2.11.2"
     },
     "require-dev": {

src/Tempest/Cache/src/CacheConfig.php

@@ -7,6 +7,7 @@
 use Psr\Cache\CacheItemPoolInterface;
 use Tempest\Core\DiscoveryCache;
 use function Tempest\env;
+use function Tempest\internal_storage_path;
 
 final class CacheConfig
 {
@@ -22,16 +23,20 @@ final class CacheConfig
     public DiscoveryCacheStrategy $discoveryCache;
 
     public function __construct(
-        public string $directory = __DIR__ . '/../../../../.cache',
+        /**
+         * Path to the storage directory, relative to the internal storage.
+         */
+        public string $directory = 'cache',
         public ?CacheItemPoolInterface $projectCachePool = null,
 
         /** Used as a global override, should be true in production, null in local */
         ?bool $enable = null,
     ) {
-        $this->enable = $enable ?? env('CACHE') ?? null;
+        $this->enable = $enable ?? env('CACHE');
         $this->projectCache = (bool) env('PROJECT_CACHE', false);
         $this->viewCache = (bool) env('VIEW_CACHE', false);
         $this->discoveryCache = $this->resolveDiscoveryCacheStrategy();
+        $this->directory = internal_storage_path($directory);
     }
 
     /** @param class-string<\Tempest\Cache\Cache> $className */
@@ -62,7 +67,7 @@ private function resolveDiscoveryCacheStrategy(): DiscoveryCacheStrategy
             return $current;
         }
 
-        $original = DiscoveryCacheStrategy::make(@file_get_contents(DiscoveryCache::CURRENT_DISCOVERY_STRATEGY));
+        $original = DiscoveryCacheStrategy::make(@file_get_contents(DiscoveryCache::getCurrentDiscoverStrategyCachePath()));
 
         if ($current !== $original) {
             return DiscoveryCacheStrategy::INVALID;

src/Tempest/Cache/src/ProjectCache.php

@@ -6,7 +6,6 @@
 
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
-use function Tempest\Support\path;
 
 final class ProjectCache implements Cache
 {
@@ -18,7 +17,7 @@ public function __construct(
         private readonly CacheConfig $cacheConfig,
     ) {
         $this->pool = $this->cacheConfig->projectCachePool ?? new FilesystemAdapter(
-            directory: path($this->cacheConfig->directory, 'project')->toString(),
+            directory: $this->cacheConfig->directory . '/project',
         );
     }
 

src/Tempest/Cache/tests/.gitkeep

@@ -9,18 +9,22 @@
 use Tempest\Console\Scheduler;
 use Tempest\Core\ShellExecutor;
 use function Tempest\event;
+use function Tempest\internal_storage_path;
 
 final readonly class GenericScheduler implements Scheduler
 {
-    public const string CACHE_PATH = __DIR__ . '/../../../../.cache/tempest/last-schedule-run.cache.php';
-
     public function __construct(
         private SchedulerConfig $config,
         private ConsoleArgumentBag $argumentBag,
         private ShellExecutor $executor,
     ) {
     }
 
+    public static function getCachePath(): string
+    {
+        return internal_storage_path('scheduler', 'last-schedule-run.cache.php');
+    }
+
     public function run(?DateTime $date = null): void
     {
         $date ??= new DateTime();
@@ -80,11 +84,11 @@ private function getInvocationsToRun(DateTime $date): array
      */
     private function getPreviousRuns(): array
     {
-        if (! file_exists(self::CACHE_PATH)) {
+        if (! file_exists(self::getCachePath())) {
             return [];
         }
 
-        return unserialize(file_get_contents(self::CACHE_PATH), ['allowed_classes' => false]);
+        return unserialize(file_get_contents(self::getCachePath()), ['allowed_classes' => false]);
     }
 
     /** @param ScheduledInvocation[] $ranInvocations */
@@ -96,12 +100,12 @@ private function markInvocationsAsRun(array $ranInvocations, DateTime $ranAt): v
             $lastRuns[$invocation->handler->getName()] = $ranAt->getTimestamp();
         }
 
-        $directory = dirname(self::CACHE_PATH);
+        $directory = dirname(self::getCachePath());
 
         if (! is_dir($directory)) {
             mkdir(directory: $directory, recursive: true);
         }
 
-        file_put_contents(self::CACHE_PATH, serialize($lastRuns));
+        file_put_contents(self::getCachePath(), serialize($lastRuns));
     }
 }

src/Tempest/Console/src/Scheduler/GenericScheduler.php

@@ -2,11 +2,6 @@
 
 declare(strict_types=1);
 
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Tempest\Cache\CacheConfig;
 
-return new CacheConfig(
-    projectCachePool: new FilesystemAdapter(
-        directory: __DIR__ . '/../../../../.cache',
-    ),
-);
+return new CacheConfig();

src/Tempest/Console/src/Stubs/cache.config.stub.php

@@ -9,6 +9,7 @@
 use Tempest\Cache\Cache;
 use Tempest\Cache\IsCache;
 use function Tempest\env;
+use function Tempest\internal_storage_path;
 
 final readonly class ConfigCache implements Cache
 {
@@ -19,7 +20,7 @@
     public function __construct()
     {
         $this->pool = new FilesystemAdapter(
-            directory: __DIR__ . '/.cache',
+            directory: internal_storage_path('config'),
         );
     }
 
@@ -30,6 +31,6 @@ protected function getCachePool(): CacheItemPoolInterface
 
     public function isEnabled(): bool
     {
-        return env('CACHE') ?? env('CONFIG_CACHE', false);
+        return (bool) (env('CACHE') ?? env('CONFIG_CACHE', false));
     }
 }

src/Tempest/Core/src/ConfigCache.php

@@ -12,24 +12,23 @@
 use Tempest\Cache\IsCache;
 use Tempest\Discovery\Discovery;
 use Tempest\Discovery\DiscoveryItems;
-use function Tempest\Support\path;
+use Throwable;
+use function Tempest\internal_storage_path;
 
 final class DiscoveryCache implements Cache
 {
     use IsCache {
         clear as parentClear;
     }
 
-    public const string CURRENT_DISCOVERY_STRATEGY = __DIR__ . '/.cache/current_discovery_strategy';
-
     private CacheItemPoolInterface $pool;
 
     public function __construct(
         private readonly CacheConfig $cacheConfig,
         ?CacheItemPoolInterface $pool = null,
     ) {
         $this->pool = $pool ?? new PhpFilesAdapter(
-            directory: path($this->cacheConfig->directory, 'discovery')->toString(),
+            directory: $this->cacheConfig->directory . '/discovery',
         );
     }
 
@@ -88,12 +87,21 @@ public function getStrategy(): DiscoveryCacheStrategy
 
     public function storeStrategy(DiscoveryCacheStrategy $strategy): void
     {
-        $dir = dirname(self::CURRENT_DISCOVERY_STRATEGY);
+        $dir = dirname(self::getCurrentDiscoverStrategyCachePath());
 
         if (! is_dir($dir)) {
             mkdir($dir, recursive: true);
         }
 
-        file_put_contents(self::CURRENT_DISCOVERY_STRATEGY, $strategy->value);
+        file_put_contents(self::getCurrentDiscoverStrategyCachePath(), $strategy->value);
+    }
+
+    public static function getCurrentDiscoverStrategyCachePath(): string
+    {
+        try {
+            return internal_storage_path('current_discovery_strategy');
+        } catch (Throwable) {
+            return __DIR__ . '/current_discovery_strategy';
+        }
     }
 }

src/Tempest/Core/src/DiscoveryCache.php

@@ -24,6 +24,8 @@ final class FrameworkKernel implements Kernel
 
     public array $discoveryClasses = [];
 
+    public string $internalStorage;
+
     public function __construct(
         public string $root,
         /** @var \Tempest\Discovery\DiscoveryLocation[] $discoveryLocations */
@@ -50,6 +52,7 @@ public static function boot(
             ->loadEnv()
             ->registerKernelErrorHandler()
             ->registerShutdownFunction()
+            ->registerInternalStorage()
             ->registerKernel()
             ->loadComposer()
             ->loadDiscoveryLocations()
@@ -166,6 +169,19 @@ public function registerErrorHandler(): self
         return $this;
     }
 
+    public function registerInternalStorage(): self
+    {
+        $path = $this->root . '/vendor/.tempest';
+
+        if (! is_dir($path)) {
+            mkdir($path, recursive: true);
+        }
+
+        $this->internalStorage = realpath($path);
+
+        return $this;
+    }
+
     public function finishDeferredTasks(): self
     {
         $this->container->invoke(FinishDeferredTasks::class);