Refactor distribution configuration

Author: codedmonkey

config/reference.php

@@ -1657,11 +1657,19 @@
  *     storage?: array{
  *         path?: scalar|Param|null, // Default: "%kernel.project_dir%/storage"
  *     },
- *     dist_mirroring?: bool|array{
+ *     dist_mirroring?: bool|array{ // Deprecated: The node "dist_mirroring" at path "dirigent.dist_mirroring" is deprecated. Use the "distributions" section instead.
  *         enabled?: bool|Param, // Default: false
  *         preferred?: bool|Param, // Default: true
  *         dev_packages?: bool|Param, // Default: false
  *     },
+ *     distributions?: bool|array{
+ *         enabled?: bool|Param, // Host the distributions of packages // Default: false
+ *         build?: bool|Param, // Build distributions from the source code (if not already provided) // Default: true
+ *         mirror?: bool|Param, // Mirror distributions from the original source (if provided) // Default: false
+ *         async_api_requests?: bool|Param, // Fetch distributions asynchronously instead of during execution (from the API) // Default: false
+ *         dev_versions?: bool|Param, // Include distributions of development versions // Default: false
+ *         preferred_mirror?: bool|Param, // Force Composer to download distributions from this registry first // Default: false
+ *     },
  *     metadata?: array{
  *         default_fetch_strategy?: value-of<\CodedMonkey\Dirigent\Entity\PackageFetchStrategy>|\CodedMonkey\Dirigent\Entity\PackageFetchStrategy|Param, // Available values are "mirror" (default, fetch from the mirror), "source" (fetch from the VCS source) and "vcs" (fetch complete VCS repository) // Default: "mirror"
  *         mirror_vcs_repositories?: bool|Param, // Deprecated: The node "mirror_vcs_repositories" at path "dirigent.metadata.mirror_vcs_repositories" is deprecated. Use the "default_fetch_strategy" option instead. // Fetch mirrored packages from their VCS repositories by default when possible. // Default: false

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
-    dev_packages: false
+    build: true
+    mirror: false
+    async_api_requests: false
+    dev_versions: false
+    preferred_mirror: false
   metadata:
     default_fetch_strategy: 'mirror'
     retain_pruned_versions:
@@ -117,17 +120,27 @@ 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
 
-### dev_packages
+Type: `boolean` | Default: `true`
+
+Enable building distribution from the source.
+
+### mirror
+
+### async_api_requests
+
+### dev_versions
+
+### preferred_mirror
 
 ## metadata
 

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

@@ -63,7 +63,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%')
@@ -73,7 +73,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'),
             ]];
         }
 
@@ -119,7 +119,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();
         }
 
@@ -135,7 +135,7 @@ public function packageDistribution(Request $request, string $reference, string
                 throw $this->createNotFoundException();
             }
 
-            if ($version->isDevelopment() && !$this->getParameter('dirigent.dist_mirroring.dev_packages')) {
+            if ($version->isDevelopment() && !$this->getParameter('dirigent.distributions.dev_versions')) {
                 throw $this->createNotFoundException();
             }
 

src/Controller/ApiController.php

@@ -74,18 +74,39 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->end()
             ->arrayNode('dist_mirroring')
                 ->canBeEnabled()
+                ->setDeprecated(
+                    package: 'codedmonkey/dirigent',
+                    version: '0.8.0',
+                    message: 'The node "%node%" at path "%path%" is deprecated. Use the "distributions" section instead.'
+                )
                 ->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

@@ -20,6 +20,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $container->setParameter('dirigent.title', $mergedConfig['title']);
         $container->setParameter('dirigent.slug', $slug);
 
+        $this->registerDistributionsConfiguration($mergedConfig['distributions'], $mergedConfig['dist_mirroring'], $container);
         $this->registerEncryptionConfiguration($mergedConfig['encryption'], $container);
         $this->registerMetadataConfiguration($mergedConfig['metadata'], $container);
         $this->registerPackagesConfiguration($mergedConfig['packages'], $container);
@@ -32,10 +33,6 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         } else {
             $container->setParameter('dirigent.storage.path', $mergedConfig['storage']['path']);
         }
-
-        $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']);
     }
 
     #[\Override]
@@ -44,6 +41,19 @@ public function getConfiguration(array $config, ContainerBuilder $container): Co
         return new DirigentConfiguration();
     }
 
+    private function registerDistributionsConfiguration(array $config, array $distMirroringConfig, ContainerBuilder $container): void
+    {
+        $distributionsEnabled = $config['enabled'] || $distMirroringConfig['enabled'];
+
+        $container->setParameter('dirigent.distributions.enabled', $distributionsEnabled);
+        $container->setParameter('dirigent.distributions.build', $config['enabled'] && $config['build']);
+        $container->setParameter('dirigent.distributions.mirror', $distributionsEnabled && ($config['mirror'] || $distMirroringConfig['enabled']));
+
+        $container->setParameter('dirigent.distributions.async_api_requests', $config['async_api_requests']);
+        $container->setParameter('dirigent.distributions.dev_versions', $config['dev_versions'] || ($distMirroringConfig['enabled'] && $distMirroringConfig['dev_packages']));
+        $container->setParameter('dirigent.distributions.preferred_mirror', $config['preferred_mirror'] || ($distMirroringConfig['enabled'] && $distMirroringConfig['preferred']));
+    }
+
     /**
      * @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
      */