Add async handling for resolving of distributions

Author: codedmonkey

src/Controller/ApiController.php

@@ -135,11 +135,7 @@ public function packageDistribution(Request $request, string $reference, string
                 throw $this->createNotFoundException();
             }
 
-            if ($metadata->getVersion()->isDevelopment() && !$this->getParameter('dirigent.distributions.dev_versions')) {
-                throw $this->createNotFoundException();
-            }
-
-            if (!$this->distributionResolver->resolve($metadata, $type)) {
+            if (!$this->distributionResolver->resolve($metadata, $type, async: $this->getParameter('dirigent.distributions.async_api_requests'))) {
                 throw $this->createNotFoundException();
             }
         }

src/Message/ResolveDistribution.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodedMonkey\Dirigent\Message;
+
+use Symfony\Component\Messenger\Attribute\AsMessage;
+
+#[AsMessage]
+readonly class ResolveDistribution
+{
+    public function __construct(
+        public int $metadataId,
+        public string $type,
+    ) {
+    }
+}

src/Message/ResolveDistributionHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodedMonkey\Dirigent\Message;
+
+use CodedMonkey\Dirigent\Doctrine\Repository\MetadataRepository;
+use CodedMonkey\Dirigent\Package\PackageDistributionResolver;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+
+#[AsMessageHandler]
+readonly class ResolveDistributionHandler
+{
+    public function __construct(
+        private MetadataRepository $metadataRepository,
+        private PackageDistributionResolver $distributionResolver,
+    ) {
+    }
+
+    public function __invoke(ResolveDistribution $message): void
+    {
+        if (null === $metadata = $this->metadataRepository->find($message->metadataId)) {
+            return;
+        }
+
+        $this->distributionResolver->resolve($metadata, $message->type, async: false);
+    }
+}

src/Package/PackageDistributionResolver.php

@@ -6,16 +6,22 @@
 
 use CodedMonkey\Dirigent\Composer\ComposerClient;
 use CodedMonkey\Dirigent\Doctrine\Entity\Metadata;
+use CodedMonkey\Dirigent\Message\ResolveDistribution;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 
 readonly class PackageDistributionResolver
 {
     private Filesystem $filesystem;
     private string $storagePath;
 
     public function __construct(
+        private MessageBusInterface $messenger,
         private ComposerClient $composer,
+        #[Autowire(param: 'dirigent.distributions.dev_versions')]
+        private bool $includeDevVersions,
         #[Autowire(param: 'dirigent.storage.path')]
         string $storagePath,
     ) {
@@ -33,7 +39,7 @@ public function path(string $packageName, string $versionName, string $reference
         return "{$this->storagePath}/{$packageName}/{$versionName}-{$reference}.{$type}";
     }
 
-    public function resolve(Metadata $metadata, string $type): bool
+    public function resolve(Metadata $metadata, string $type, bool $async): bool
     {
         $package = $metadata->getPackage();
         $packageName = $package->getName();
@@ -48,6 +54,20 @@ public function resolve(Metadata $metadata, string $type): bool
             return false;
         }
 
+        if ($metadata->getVersion()->isDevelopment() && !$this->includeDevVersions) {
+            return false;
+        }
+
+        if ($async) {
+            // Resolve the distribution asynchronously so it's available in the future now that we know it was requested
+            $this->messenger->dispatch(new ResolveDistribution($metadata->getId(), $type), [
+                new TransportNamesStamp('async'),
+            ]);
+
+            // Still return false so the service resolving the distribution doesn't try to fetch it anyway
+            return false;
+        }
+
         $distributionUrl = $metadata->getDistributionUrl();
         $path = $this->path($packageName, $versionName, $reference, $type);
 

tests/UnitTests/Message/ResolveDistributionHandlerTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodedMonkey\Dirigent\Tests\UnitTests\Message;
+
+use CodedMonkey\Dirigent\Doctrine\Repository\MetadataRepository;
+use CodedMonkey\Dirigent\Message\ResolveDistribution;
+use CodedMonkey\Dirigent\Message\ResolveDistributionHandler;
+use CodedMonkey\Dirigent\Package\PackageDistributionResolver;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(ResolveDistributionHandler::class)]
+class ResolveDistributionHandlerTest extends TestCase
+{
+    public function testInvokeIgnoresMissingMetadata(): void
+    {
+        $metadataRepository = $this->createMock(MetadataRepository::class);
+        $metadataRepository->expects(self::once())
+            ->method('find')
+            ->with(42)
+            ->willReturn(null);
+
+        $distributionResolver = $this->createMock(PackageDistributionResolver::class);
+        $distributionResolver->expects(self::never())->method('resolve');
+
+        $handler = new ResolveDistributionHandler($metadataRepository, $distributionResolver);
+
+        $handler(new ResolveDistribution(42, 'reference', 'zip'));
+    }
+}