perf(core): improve overall discovery performance (#1333)

Author: brendt

packages/console/src/Exceptions/ConsoleExceptionHandler.php

@@ -6,6 +6,7 @@
 
 use Tempest\Console\Console;
 use Tempest\Console\ExitCode;
+use Tempest\Console\GlobalFlags;
 use Tempest\Console\HasExitCode;
 use Tempest\Console\Input\ConsoleArgumentBag;
 use Tempest\Container\Container;
@@ -51,7 +52,7 @@ public function handle(Throwable $throwable): void
                 ->writeln($this->getSnippet($throwable->getFile(), $throwable->getLine()))
                 ->writeln();
 
-            if ($this->argumentBag->get('-v') !== null) {
+            if ($this->argumentBag->get(GlobalFlags::VERBOSE_SHORTHAND->value) || $this->argumentBag->get(GlobalFlags::VERBOSE->value)) {
                 foreach ($throwable->getTrace() as $i => $trace) {
                     $this->console->writeln("<style='bold fg-blue'>#{$i}</style> " . $this->formatTrace($trace));
                 }

packages/console/src/GlobalFlags.php

@@ -10,6 +10,8 @@ enum GlobalFlags: string
 
     case FORCE = 'force';
     case FORCE_SHORTHAND = '-f';
+    case VERBOSE = 'verbose';
+    case VERBOSE_SHORTHAND = '-v';
     case HELP = 'help';
     case HELP_SHORTHAND = '-h';
     case INTERACTION = 'interaction';

packages/core/src/Commands/DiscoveryGenerateCommand.php

@@ -43,11 +43,9 @@ public function __invoke(): void
         $this->clearDiscoveryCache();
 
         $this->console->task(
-            label: "Generating discovery cache using the {$strategy->value} strategy",
+            label: "Generating discovery cache using the `{$strategy->value}` strategy",
             handler: fn (Closure $log) => $this->generateDiscoveryCache($strategy, $log),
         );
-
-        $this->discoveryCache->storeStrategy($strategy);
     }
 
     public function clearDiscoveryCache(): void
@@ -68,16 +66,12 @@ public function generateDiscoveryCache(DiscoveryCacheStrategy $strategy, Closure
 
         $discoveries = $loadDiscoveryClasses->build();
 
-        foreach ($discoveries as $discovery) {
-            $log($discovery::class);
-            $discoveryItems = $discovery->getItems();
-
-            if ($strategy === DiscoveryCacheStrategy::PARTIAL) {
-                $discoveryItems = $discoveryItems->onlyVendor();
-            }
-
-            $this->discoveryCache->store($discovery, $discoveryItems);
+        foreach ($this->kernel->discoveryLocations as $location) {
+            $this->discoveryCache->store($location, $discoveries);
+            $log($location->path);
         }
+
+        $this->discoveryCache->storeStrategy($strategy);
     }
 
     public function resolveKernel(): Kernel

packages/core/src/DiscoveryCache.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Tempest\Discovery\Discovery;
 use Tempest\Discovery\DiscoveryItems;
+use Tempest\Discovery\DiscoveryLocation;
 use Throwable;
 
 use function Tempest\internal_storage_path;
@@ -32,24 +33,40 @@ public function __construct(
         );
     }
 
-    public function restore(string $className): ?DiscoveryItems
+    /**
+     * @return array<class-string<\Tempest\Discovery\Discovery>, DiscoveryItems>
+     */
+    public function restore(DiscoveryLocation $location): ?array
     {
         if (! $this->enabled) {
             return null;
         }
 
         return $this->pool
-            ->getItem(str_replace('\\', '_', $className))
+            ->getItem($location->key)
             ->get();
     }
 
-    public function store(Discovery $discovery, DiscoveryItems $discoveryItems): void
+    /**
+     * @param Discovery[] $discoveries
+     */
+    public function store(DiscoveryLocation $location, array $discoveries): void
     {
-        $key = str_replace('\\', '_', $discovery::class);
+        $cachedForLocation = [];
+
+        foreach ($discoveries as $discovery) {
+            $items = $discovery->getItems();
+
+            if ($this->strategy === DiscoveryCacheStrategy::PARTIAL) {
+                $items = $items->onlyVendor();
+            }
+
+            $cachedForLocation[$discovery::class] = $items->getForLocation($location);
+        }
 
         $item = $this->pool
-            ->getItem($key)
-            ->set($discoveryItems);
+            ->getItem($location->key)
+            ->set($cachedForLocation);
 
         $this->pool->save($item);
     }

packages/core/src/DiscoveryCacheInitializer.php

@@ -22,7 +22,7 @@ public function initialize(Container $container): DiscoveryCache
 
     private function resolveDiscoveryCacheStrategy(bool $isProduction): DiscoveryCacheStrategy
     {
-        if ($this->isDiscoveryGenerateCommand()) {
+        if ($this->isDiscoveryGenerateCommand() || $this->isDiscoveryClearCommand()) {
             return DiscoveryCacheStrategy::NONE;
         }
 
@@ -49,6 +49,17 @@ private function isDiscoveryGenerateCommand(): bool
 
         $command = $_SERVER['argv'][1] ?? null;
 
-        return $command === 'dg' || $command === 'discovery:generate';
+        return $command === 'dg' || $command === 'discovery:generate' || $command === 'd:g';
+    }
+
+    private function isDiscoveryClearCommand(): bool
+    {
+        if (PHP_SAPI !== 'cli') {
+            return false;
+        }
+
+        $command = $_SERVER['argv'][1] ?? null;
+
+        return $command === 'dc' || $command === 'discovery:clear' || $command === 'd:c';
     }
 }

packages/core/src/DiscoveryCacheStrategy.php

@@ -6,7 +6,7 @@
 
 enum DiscoveryCacheStrategy: string
 {
-    case FULL = 'all';
+    case FULL = 'full';
     case PARTIAL = 'partial';
     case NONE = 'none';
     case INVALID = 'invalid';
@@ -16,7 +16,7 @@ public static function make(mixed $input): self
         return match ($input) {
             true, 'true', '1', 1, 'all', 'full' => self::FULL,
             'partial' => self::PARTIAL,
-            'invalid' => self::INVALID,
+            null, 'invalid' => self::INVALID,
             default => self::NONE,
         };
     }

packages/core/src/FrameworkKernel.php

@@ -5,7 +5,6 @@
 namespace Tempest\Core;
 
 use Dotenv\Dotenv;
-use Tempest\Console\Exceptions\ConsoleExceptionHandler;
 use Tempest\Container\Container;
 use Tempest\Container\GenericContainer;
 use Tempest\Core\Kernel\FinishDeferredTasks;
@@ -15,7 +14,6 @@
 use Tempest\Core\Kernel\RegisterEmergencyExceptionHandler;
 use Tempest\Core\ShellExecutors\GenericShellExecutor;
 use Tempest\EventBus\EventBus;
-use Tempest\Router\Exceptions\HttpExceptionHandler;
 
 final class FrameworkKernel implements Kernel
 {