Refactor distribution configuration

Signed-off-by: Tim Goudriaan <tim@codedmonkey.com>

# Conflicts:
#	src/DependencyInjection/DirigentConfiguration.php
#	src/DependencyInjection/DirigentExtension.php
#	src/Message/UpdatePackageHandler.php

Author: codedmonkey

docs/configuration-reference.md

@@ -29,10 +29,13 @@ dirigent:
     dynamic_update_delay: 'PT4H'
     periodic_updates: true
     periodic_update_interval: 'P1W'
-  dist_mirroring:
+  distributions:
     enabled: false
-    preferred: true
+    build: true
+    mirror: false
+    async_api_requests: false
     dev_packages: false
+    preferred_mirror: true
   metadata:
     mirror_vcs_repositories: false
 ```
@@ -109,18 +112,28 @@ The time between periodic updates being scheduled, defaults to once a week.
 
 The time must be defined in the [ISO 8601 durations][iso-8601-durations] format.
 
-## dist_mirroring
+## distributions
 
 ### enabled
 
 Type: `boolean` | Default: `false`
 
-Whether to enable or disable distribution mirroring
+Enable hosting of package distributions.
 
-### preferred
+### build
+
+Type: `boolean` | Default: `true`
+
+Enable building distribution from the source.
+
+### mirror
+
+### async_api_requests
 
 ### dev_packages
 
+### preferred_mirror
+
 ## metadata
 
 ### mirror_vcs_repositories

docs/dist-mirroring.md

@@ -0,0 +1,14 @@
+---
+sidebar_position: 31
+---
+
+# Distributions
+
+:::note
+
+This page is a stub.
+
+:::
+
+Dirigent mirrors distributions from their original source if it's provided by the package, or builds the distribution
+from the source code. 

docs/distributions.md

@@ -8,8 +8,11 @@ sidebar_position: 1
 - [Introduction](introduction.md)
 - [Installation](installation/readme.md)
 - [Getting Started](getting-started.md)
+
+---
+
 - [Automatic Package Updates](automatic-package-updates.md)
-- [Dist Mirroring](dist-mirroring.md)
+- [Distributions](distributions.md)
 
 ---
 

docs/readme.md

@@ -60,7 +60,7 @@ public function root(RouterInterface $router): JsonResponse
             'notify-batch' => $router->generate('api_track_installations'),
         ];
 
-        if ($this->getParameter('dirigent.dist_mirroring.enabled')) {
+        if ($this->getParameter('dirigent.distributions.mirror')) {
             $distributionUrlPattern = u($router->getRouteCollection()->get('api_package_distribution')->getPath())
                 ->replace('{package}', '%package%')
                 ->replace('{version}', '%version%')
@@ -70,7 +70,7 @@ public function root(RouterInterface $router): JsonResponse
 
             $data['mirrors'] = [[
                 'dist-url' => $distributionUrlPattern,
-                'preferred' => $this->getParameter('dirigent.dist_mirroring.preferred'),
+                'preferred' => $this->getParameter('dirigent.distributions.preferred_mirror'),
             ]];
         }
 
@@ -116,7 +116,7 @@ public function packageMetadata(Request $request): Response
     #[IsGrantedAccess]
     public function packageDistribution(Request $request, string $reference, string $type): Response
     {
-        if (!$this->getParameter('dirigent.dist_mirroring.enabled')) {
+        if (!$this->getParameter('dirigent.distributions.enabled')) {
             throw $this->createNotFoundException();
         }
 
@@ -132,11 +132,7 @@ public function packageDistribution(Request $request, string $reference, string
                 throw $this->createNotFoundException();
             }
 
-            if ($version->isDevelopment() && !$this->getParameter('dirigent.dist_mirroring.dev_packages')) {
-                throw $this->createNotFoundException();
-            }
-
-            if (!$this->distributionResolver->resolve($version, $reference, $type)) {
+            if (!$this->distributionResolver->resolve($version, $reference, $type, async: $this->getParameter('dirigent.distributions.async_api_requests'))) {
                 throw $this->createNotFoundException();
             }
         }

src/Controller/ApiController.php

@@ -68,27 +68,30 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->children()
                     ->scalarNode('path')->defaultValue('%kernel.project_dir%/storage')->end()
                 ->end()
-            ->end()
-            ->arrayNode('dist_builder')
-                ->canBeEnabled()
-                ->children()
-                    ->booleanNode('dev_packages')->defaultFalse()->end()
-                ->end()
-            ->end()
-            ->arrayNode('dist_mirroring')
-                ->canBeEnabled()
-                ->children()
-                    ->booleanNode('preferred')->defaultTrue()->end()
-                    ->booleanNode('dev_packages')->defaultFalse()->end()
-                ->end()
             ->end();
 
+        $this->addDistributionsSection($rootNode);
         $this->addMetadataSection($rootNode);
         $this->addPackagesSection($rootNode);
 
         return $treeBuilder;
     }
 
+    private function addDistributionsSection(ArrayNodeDefinition|NodeDefinition $rootNode): void
+    {
+        $rootNode->children()
+            ->arrayNode('distributions')
+                ->canBeEnabled('Host the distributions of packages')
+                ->children()
+                    ->booleanNode('build')->defaultTrue()->info('Build distributions from the source code (if not already provided)')->end()
+                    ->booleanNode('mirror')->defaultFalse()->info('Mirror distributions from the original source (if provided)')->end()
+                    ->booleanNode('async_api_requests')->defaultFalse()->info('Fetch distributions asynchronously instead of during execution (from the API)')->end()
+                    ->booleanNode('dev_versions')->defaultFalse()->info('Include distributions of development versions')->end()
+                    ->booleanNode('preferred_mirror')->defaultFalse()->info('Force Composer to download distributions from this registry first')->end()
+                ->end()
+            ->end();
+    }
+
     private function addMetadataSection(ArrayNodeDefinition|NodeDefinition $rootNode): void
     {
         $rootNode->children()

src/DependencyInjection/DirigentConfiguration.php

@@ -17,6 +17,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $container->setParameter('dirigent.title', $mergedConfig['title']);
         $container->setParameter('dirigent.slug', $slug);
 
+        $this->registerDistributionsConfiguration($mergedConfig['distributions'], $container);
         $this->registerEncryptionConfiguration($mergedConfig['encryption'], $container);
         $this->registerMetadataConfiguration($mergedConfig['metadata'], $container);
         $this->registerPackagesConfiguration($mergedConfig['packages'], $container);
@@ -29,20 +30,26 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         } else {
             $container->setParameter('dirigent.storage.path', $mergedConfig['storage']['path']);
         }
-
-        $container->setParameter('dirigent.dist_builder.enabled', $mergedConfig['dist_builder']['enabled']);
-        $container->setParameter('dirigent.dist_builder.dev_packages', $mergedConfig['dist_builder']['dev_packages']);
-
-        $container->setParameter('dirigent.dist_mirroring.enabled', $mergedConfig['dist_mirroring']['enabled']);
-        $container->setParameter('dirigent.dist_mirroring.preferred', $mergedConfig['dist_mirroring']['preferred']);
-        $container->setParameter('dirigent.dist_mirroring.dev_packages', $mergedConfig['dist_mirroring']['dev_packages']);
     }
 
     public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
     {
         return new DirigentConfiguration();
     }
 
+    private function registerDistributionsConfiguration(array $config, ContainerBuilder $container): void
+    {
+        $distributionsEnabled = $config['enabled'];
+
+        $container->setParameter('dirigent.distributions.enabled', $distributionsEnabled);
+        $container->setParameter('dirigent.distributions.build', $distributionsEnabled && $config['build']);
+        $container->setParameter('dirigent.distributions.mirror', $distributionsEnabled && $config['mirror']);
+
+        $container->setParameter('dirigent.distributions.async_api_requests', $config['async_api_requests']);
+        $container->setParameter('dirigent.distributions.dev_versions', $config['dev_versions']);
+        $container->setParameter('dirigent.distributions.preferred_mirror', $config['preferred_mirror']);
+    }
+
     /**
      * @param array{private_key: ?string, private_key_path: ?string, public_key: ?string, public_key_path: ?string, rotated_keys: array<string>, rotated_key_paths: array<string>} $config
      */

src/DependencyInjection/DirigentExtension.php

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

src/Message/ResolveDistribution.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace CodedMonkey\Dirigent\Message;
+
+use CodedMonkey\Dirigent\Doctrine\Repository\VersionRepository;
+use CodedMonkey\Dirigent\Package\PackageDistributionResolver;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+
+#[AsMessageHandler]
+readonly class ResolveDistributionHandler
+{
+    public function __construct(
+        private VersionRepository $versionRepository,
+        private PackageDistributionResolver $distributionResolver,
+    ) {
+    }
+
+    public function __invoke(ResolveDistribution $message): void
+    {
+        $version = $this->versionRepository->find($message->versionId);
+
+        $this->distributionResolver->resolve($version, $message->reference, $message->type, async: false);
+    }
+}

src/Message/ResolveDistributionHandler.php

@@ -5,6 +5,7 @@
 use CodedMonkey\Dirigent\Composer\ComposerClient;
 use CodedMonkey\Dirigent\Composer\ConfigFactory;
 use CodedMonkey\Dirigent\Doctrine\Entity\Version;
+use CodedMonkey\Dirigent\Message\ResolveDistribution;
 use Composer\IO\NullIO;
 use Composer\Pcre\Preg;
 use Composer\Util\Filesystem as ComposerFilesystem;
@@ -13,18 +14,24 @@
 use Composer\Util\Url;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 
 readonly class PackageDistributionResolver
 {
     private Filesystem $filesystem;
     private string $distributionStoragePath;
 
     public function __construct(
+        private MessageBusInterface $messenger,
         private ComposerClient $composer,
-        #[Autowire(param: 'dirigent.dist_builder.enabled')]
+        #[Autowire(param: 'dirigent.distributions.build')]
         private bool $buildDistributions,
-        #[Autowire(param: 'dirigent.dist_builder.dev_packages')]
-        private bool $buildDevDistributions,
+        #[Autowire(param: 'dirigent.distributions.mirror')]
+        private bool $mirrorDistributions,
+        #[Autowire(param: 'dirigent.distributions.dev_versions')]
+        private bool $includeDevVersions,
         #[Autowire(param: 'dirigent.storage.path')]
         string $storagePath,
     ) {
@@ -42,7 +49,7 @@ public function path(string $packageName, string $versionName, string $reference
         return "$this->distributionStoragePath/$packageName/$versionName-$reference.$type";
     }
 
-    public function resolve(Version $version, string $reference, string $type): bool
+    public function resolve(Version $version, string $reference, string $type, bool $async): bool
     {
         $package = $version->getPackage();
         $packageName = $package->getName();
@@ -52,17 +59,27 @@ public function resolve(Version $version, string $reference, string $type): bool
             return true;
         }
 
-        if (
-            null === $version->getDist()
-            && $this->buildDistributions
-            && (!$version->isDevelopment() || $this->buildDevDistributions)
-        ) {
-            return $this->build($version, $reference, $type);
-        } elseif (null !== $version->getDist()) {
-            return $this->mirror($version, $reference, $type);
+        if ($version->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
+            $message = Envelope::wrap(new ResolveDistribution($version->getId(), $reference, $type))
+                ->with(new TransportNamesStamp('async'));
+            $this->messenger->dispatch($message);
+
+            // Still return false so the service resolving the distribution doesn't try to fetch it anyway
+            return false;
         }
 
-        return false;
+        $hasDistribution = null !== $version->getDist();
+
+        return match (true) {
+            $this->buildDistributions && !$hasDistribution => $this->build($version, $reference, $type),
+            $this->mirrorDistributions && $hasDistribution => $this->mirror($version, $reference, $type),
+            default => false,
+        };
     }
 
     private function build(Version $version, string $reference, string $type): bool