Refactor distribution features

codedmonkey · codedmonkey · commit e3e8a4b15b51 · 2025-06-09T22:58:57.000+02:00
diff --git a/.symfony.local.yaml b/.symfony.local.yaml
@@ -3,7 +3,8 @@ http:
   port: 7015
   use_gzip: true
 
-workers:
-  messenger_consume:
-    cmd: ['symfony', 'console', 'messenger:consume', 'async', 'scheduler_packages', '--sleep', '10']
-    watch: ['config', 'src', 'templates']
+# todo the worker isn't doing anything for me at the moment
+#workers:
+#  messenger_consume:
+#    cmd: ['symfony', 'console', 'messenger:consume', '--all', '--sleep', '10']
+#    watch: ['config', 'src', 'templates']
diff --git a/docs/configuration-reference.md b/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
diff --git a/docs/dist-mirroring.md b/docs/dist-mirroring.md
diff --git a/docs/distributions.md b/docs/distributions.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. 
diff --git a/docs/readme.md b/docs/readme.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)
 
 ---
 
diff --git a/migrations/Version20250609181654.php b/migrations/Version20250609181654.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20250609181654 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add package distribution strategy';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql(<<<'SQL'
+            ALTER TABLE package ADD distribution_strategy VARCHAR(255) DEFAULT NULL
+        SQL);
+        $this->addSql(<<<'SQL'
+            UPDATE package SET distribution_strategy = 'dynamic'
+        SQL);
+        $this->addSql(<<<'SQL'
+            ALTER TABLE package ALTER distribution_strategy DROP DEFAULT
+        SQL);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql(<<<'SQL'
+            ALTER TABLE package DROP distribution_strategy
+        SQL);
+    }
+}
diff --git a/src/Controller/ApiController.php b/src/Controller/ApiController.php
@@ -51,7 +51,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%')
@@ -61,7 +61,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'),
             ]];
         }
 
@@ -104,7 +104,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 new NotFoundHttpException();
         }
 
@@ -113,17 +113,13 @@ public function packageDistribution(string $packageName, string $packageVersion,
                 throw new NotFoundHttpException();
             }
 
-            if (null === $version = $this->versionRepository->findOneBy(['package' => $package, 'normalizedVersion' => $packageVersion])) {
-                throw new NotFoundHttpException();
-            }
+            $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 new NotFoundHttpException();
             }
 
-            $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 new NotFoundHttpException();
             }
         }
diff --git a/src/Controller/Dashboard/DashboardPackagesController.php b/src/Controller/Dashboard/DashboardPackagesController.php
@@ -174,7 +174,7 @@ public function edit(Request $request, string $packageName): Response
             return $this->redirectToRoute('dashboard_packages_info', ['packageName' => $package->getName()]);
         }
 
-        return $this->render('dashboard/packages/package_edit.html.twig', [
+        return $this->render('dashboard/packages/edit.html.twig', [
             'package' => $package,
             'form' => $form,
         ]);
diff --git a/src/DependencyInjection/DirigentConfiguration.php b/src/DependencyInjection/DirigentConfiguration.php
@@ -76,17 +76,14 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->scalarNode('periodic_update_interval')->defaultValue('P1W')->end()
                 ->end()
             ->end()
-            ->arrayNode('dist_builder')
-                ->canBeEnabled()
+            ->arrayNode('distributions')
+                ->canBeEnabled('Host the distributions of packages')
                 ->children()
-                    ->booleanNode('dev_packages')->defaultFalse()->end()
-                ->end()
-            ->end()
-            ->arrayNode('dist_mirroring')
-                ->canBeEnabled()
-                ->children()
-                    ->booleanNode('preferred')->defaultTrue()->end()
-                    ->booleanNode('dev_packages')->defaultFalse()->end()
+                    ->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();
 
diff --git a/src/DependencyInjection/DirigentExtension.php b/src/DependencyInjection/DirigentExtension.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
      */
diff --git a/src/Doctrine/Entity/Package.php b/src/Doctrine/Entity/Package.php
@@ -59,9 +59,12 @@ class Package
     #[ORM\Column(nullable: true)]
     private ?string $remoteId = null;
 
-    #[ORM\Column(type: Types::STRING, enumType: PackageFetchStrategy::class, nullable: true)]
+    #[ORM\Column(nullable: true, enumType: PackageFetchStrategy::class)]
     private PackageFetchStrategy|string|null $fetchStrategy = null;
 
+    #[ORM\Column(enumType: PackageDistributionStrategy::class)]
+    private PackageDistributionStrategy $distributionStrategy = PackageDistributionStrategy::Dynamic;
+
     #[ORM\ManyToOne]
     private ?Registry $mirrorRegistry = null;
 
@@ -273,6 +276,16 @@ public function setFetchStrategy(PackageFetchStrategy|string $fetchStrategy): vo
         $this->fetchStrategy = $fetchStrategy;
     }
 
+    public function getDistributionStrategy(): PackageDistributionStrategy
+    {
+        return $this->distributionStrategy;
+    }
+
+    public function setDistributionStrategy(PackageDistributionStrategy $distributionStrategy): void
+    {
+        $this->distributionStrategy = $distributionStrategy;
+    }
+
     public function getMirrorRegistry(): ?Registry
     {
         return $this->mirrorRegistry;
diff --git a/src/Doctrine/Entity/PackageDistributionStrategy.php b/src/Doctrine/Entity/PackageDistributionStrategy.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace CodedMonkey\Dirigent\Doctrine\Entity;
+
+enum PackageDistributionStrategy: string
+{
+    case Disabled = 'none';
+    case Dynamic = 'dynamic';
+    case Automatic = 'auto';
+}
diff --git a/src/Form/PackageFormType.php b/src/Form/PackageFormType.php
@@ -4,6 +4,7 @@
 
 use CodedMonkey\Dirigent\Doctrine\Entity\Credentials;
 use CodedMonkey\Dirigent\Doctrine\Entity\Package;
+use CodedMonkey\Dirigent\Doctrine\Entity\PackageDistributionStrategy;
 use CodedMonkey\Dirigent\Doctrine\Entity\PackageFetchStrategy;
 use CodedMonkey\Dirigent\Doctrine\Entity\Registry;
 use CodedMonkey\Dirigent\Doctrine\Repository\RegistryRepository;
@@ -23,6 +24,7 @@ class PackageFormType extends AbstractType
 {
     public function __construct(
         private readonly PackageVcsRepositoryValidator $vcsRepositoryValidator,
+        private readonly bool $distributionsEnabled,
     ) {
     }
 
diff --git a/src/Message/ResolveDistribution.php b/src/Message/ResolveDistribution.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CodedMonkey\Dirigent\Message;
+
+readonly class ResolveDistribution
+{
+    public function __construct(
+        public string $versionId,
+        public string $reference,
+        public string $type,
+    ) {
+    }
+}
diff --git a/src/Message/ResolveDistributionHandler.php b/src/Message/ResolveDistributionHandler.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);
+    }
+}
diff --git a/src/Message/UpdatePackage.php b/src/Message/UpdatePackage.php
@@ -10,4 +10,9 @@ public function __construct(
         public bool $forceRefresh = false,
     ) {
     }
+
+    public function isDynamicRequest(): bool
+    {
+        return !$this->scheduled && !$this->forceRefresh;
+    }
 }
diff --git a/src/Message/UpdatePackageHandler.php b/src/Message/UpdatePackageHandler.php
@@ -26,7 +26,7 @@ public function __construct(
 
     public function __invoke(UpdatePackage $message): void
     {
-        if (!$message->scheduled && !$message->forceRefresh && !$this->dynamicUpdatesEnabled) {
+        if ($message->isDynamicRequest() && !$this->dynamicUpdatesEnabled) {
             // Dynamic updates are disabled
             return;
         }
diff --git a/src/Package/PackageDistributionResolver.php b/src/Package/PackageDistributionResolver.php
diff --git a/src/Package/PackageProviderManager.php b/src/Package/PackageProviderManager.php
diff --git a/templates/dashboard/packages/edit.html.twig b/templates/dashboard/packages/edit.html.twig
diff --git a/translations/messages.en.yaml b/translations/messages.en.yaml

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function root(RouterInterface $router): JsonResponse`
`51`	`51`	`'notify-batch' => $router->generate('api_track_installations'),`
`52`	`52`	`];`
`53`	`53`
`54`		`- if ($this->getParameter('dirigent.dist_mirroring.enabled')) {`
	`54`	`+ if ($this->getParameter('dirigent.distributions.mirror')) {`
`55`	`55`	`$distributionUrlPattern = u($router->getRouteCollection()->get('api_package_distribution')->getPath())`
`56`	`56`	`->replace('{packageName}', '%package%')`
`57`	`57`	`->replace('{packageVersion}', '%version%')`
`@@ -61,7 +61,7 @@ public function root(RouterInterface $router): JsonResponse`
`61`	`61`
`62`	`62`	`$data['mirrors'] = [[`
`63`	`63`	`'dist-url' => $distributionUrlPattern,`
`64`		`- 'preferred' => $this->getParameter('dirigent.dist_mirroring.preferred'),`
	`64`	`+ 'preferred' => $this->getParameter('dirigent.distributions.preferred_mirror'),`
`65`	`65`	`]];`
`66`	`66`	`}`
`67`	`67`
`@@ -104,7 +104,7 @@ public function packageMetadata(string $packageName): Response`
`104`	`104`	`#[IsGrantedAccess]`
`105`	`105`	`public function packageDistribution(string $packageName, string $packageVersion, string $reference, string $type): Response`
`106`	`106`	`{`
`107`		`- if (!$this->getParameter('dirigent.dist_mirroring.enabled')) {`
	`107`	`+ if (!$this->getParameter('dirigent.distributions.enabled')) {`
`108`	`108`	`throw new NotFoundHttpException();`
`109`	`109`	`}`
`110`	`110`
`@@ -113,17 +113,13 @@ public function packageDistribution(string $packageName, string $packageVersion,`
`113`	`113`	`throw new NotFoundHttpException();`
`114`	`114`	`}`
`115`	`115`
`116`		`- if (null === $version = $this->versionRepository->findOneBy(['package' => $package, 'normalizedVersion' => $packageVersion])) {`
`117`		`- throw new NotFoundHttpException();`
`118`		`- }`
	`116`	`+ $this->messenger->dispatch(new UpdatePackage($package->getId()));`
`119`	`117`
`120`		`- if ($version->isDevelopment() && !$this->getParameter('dirigent.dist_mirroring.dev_packages')) {`
	`118`	`+ if (null === $version = $this->versionRepository->findOneBy(['package' => $package, 'normalizedVersion' => $packageVersion])) {`
`121`	`119`	`throw new NotFoundHttpException();`
`122`	`120`	`}`
`123`	`121`
`124`		`- $this->messenger->dispatch(new UpdatePackage($package->getId()));`
`125`		`-`
`126`		`- if (!$this->distributionResolver->resolve($version, $reference, $type)) {`
	`122`	`+ if (!$this->distributionResolver->resolve($version, $reference, $type, async: $this->getParameter('dirigent.distributions.async_api_requests'))) {`
`127`	`123`	`throw new NotFoundHttpException();`
`128`	`124`	`}`
`129`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ public function edit(Request $request, string $packageName): Response`
`174`	`174`	`return $this->redirectToRoute('dashboard_packages_info', ['packageName' => $package->getName()]);`
`175`	`175`	`}`
`176`	`176`
`177`		`- return $this->render('dashboard/packages/package_edit.html.twig', [`
	`177`	`+ return $this->render('dashboard/packages/edit.html.twig', [`
`178`	`178`	`'package' => $package,`
`179`	`179`	`'form' => $form,`
`180`	`180`	`]);`