Refactor distribution configuration

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

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
 ```
 
 ## dirigent (root)
@@ -107,18 +110,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
+
 [iso-8601-durations]: https://en.wikipedia.org/wiki/ISO_8601#Durations
 [symfony]: https://symfony.com
 [symfony-docs-config]: https://symfony.com/doc/current/configuration.html

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

@@ -10,14 +10,10 @@ parameters:
     excludePaths:
         - tests/bootstrap.php
     ignoreErrors:
+        - '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'
         - '#CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractVersionLink given\.#'
         - '#^PHPDoc tag @var with type CodedMonkey\\Dirigent\\Doctrine\\Entity\\AbstractVersionLink is not subtype of native type#'
         - '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\|null\) is never assigned int so it can be removed from the property type\.$#'
-        -
-            message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'
-            identifier: method.notFound
-            count: 1
-            path: src/DependencyInjection/DirigentConfiguration.php
         -
             message: '#^Class CodedMonkey\\Dirigent\\Doctrine\\Entity\\TrackedEntity has an uninitialized readonly property \$createdAt\. Assign it in the constructor\.$#'
             identifier: property.uninitializedReadonly

phpstan.dist.neon

@@ -50,7 +50,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('{packageName}', '%package%')
                 ->replace('{packageVersion}', '%version%')
@@ -60,7 +60,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'),
             ]];
         }
 
@@ -103,7 +103,7 @@ public function packageMetadata(string $packageName): Response
     #[IsGrantedAccess]
     public function packageDistribution(string $packageName, string $packageVersion, string $reference, string $type): Response
     {
-        if (!$this->getParameter('dirigent.dist_mirroring.enabled')) {
+        if (!$this->getParameter('dirigent.distributions.enabled')) {
             throw $this->createNotFoundException();
         }
 
@@ -112,17 +112,13 @@ public function packageDistribution(string $packageName, string $packageVersion,
                 throw $this->createNotFoundException();
             }
 
-            if (null === $version = $this->versionRepository->findOneBy(['package' => $package, 'normalizedVersion' => $packageVersion])) {
-                throw $this->createNotFoundException();
-            }
+            $this->messenger->dispatch(new UpdatePackage($package->getId()));
 
-            if ($version->isDevelopment() && !$this->getParameter('dirigent.dist_mirroring.dev_packages')) {
+            if (null === $version = $this->versionRepository->findOneBy(['package' => $package, 'normalizedVersion' => $packageVersion])) {
                 throw $this->createNotFoundException();
             }
 
-            $this->messenger->dispatch(new UpdatePackage($package->getId()));
-
-            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

@@ -2,6 +2,8 @@
 
 namespace CodedMonkey\Dirigent\DependencyInjection;
 
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use function Symfony\Component\String\u;
@@ -75,21 +77,25 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->booleanNode('periodic_updates')->defaultTrue()->end()
                     ->scalarNode('periodic_update_interval')->defaultValue('P1W')->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);
+
         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();
+    }
 }

src/DependencyInjection/DirigentConfiguration.php

@@ -19,6 +19,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);
 
         $container->setParameter('dirigent.security.public_access', $mergedConfig['security']['public']);
@@ -34,20 +35,26 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $container->setParameter('dirigent.packages.dynamic_update_delay', $mergedConfig['packages']['dynamic_update_delay']);
         $container->setParameter('dirigent.packages.periodic_updates', $mergedConfig['packages']['periodic_updates']);
         $container->setParameter('dirigent.packages.periodic_update_interval', $mergedConfig['packages']['periodic_update_interval']);
-
-        $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);
+    }
+}