Add mirror_vcs_repositories configuration option

Author: codedmonkey

docs/configuration-reference.md

@@ -33,6 +33,8 @@ dirigent:
     enabled: false
     preferred: true
     dev_packages: false
+  metadata:
+    mirror_vcs_repositories: false
 ```
 
 ## dirigent (root)
@@ -119,6 +121,16 @@ Whether to enable or disable distribution mirroring
 
 ### dev_packages
 
+## metadata
+
+### mirror_vcs_repositories
+
+Type: `boolean` | Default: `false`
+
+Fetch mirrored packages from their VCS repositories by default when possible.
+
+Sets the fetch strategy of new mirrored packages to **Fetch from VCS**.
+
 [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

phpstan.dist.neon

@@ -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: '#^Left side of \|\| is always false\.$#'
             identifier: booleanOr.leftAlwaysFalse

src/Controller/ApiController.php

@@ -13,6 +13,7 @@
 use CodedMonkey\Dirigent\Package\PackageMetadataResolver;
 use CodedMonkey\Dirigent\Package\PackageProviderManager;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -33,6 +34,8 @@ public function __construct(
         private readonly PackageDistributionResolver $distributionResolver,
         private readonly PackageProviderManager $providerManager,
         private readonly MessageBusInterface $messenger,
+        #[Autowire(param: 'dirigent.metadata.mirror_vcs_repositories')]
+        private readonly bool $mirrorVcsRepositories = false,
     ) {
     }
 
@@ -170,7 +173,7 @@ private function findPackage(string $packageName): ?Package
         $package = new Package();
         $package->setName($packageName);
         $package->setMirrorRegistry($registry);
-        $package->setFetchStrategy(PackageFetchStrategy::Mirror);
+        $package->setFetchStrategy($this->mirrorVcsRepositories ? PackageFetchStrategy::Vcs : PackageFetchStrategy::Mirror);
 
         $this->packageRepository->save($package, true);
 

src/Controller/Dashboard/DashboardPackagesController.php

@@ -14,6 +14,7 @@
 use CodedMonkey\Dirigent\Package\PackageMetadataResolver;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Messenger\MessageBusInterface;
@@ -27,6 +28,8 @@ public function __construct(
         private readonly PackageRepository $packageRepository,
         private readonly PackageMetadataResolver $metadataResolver,
         private readonly MessageBusInterface $messenger,
+        #[Autowire(param: 'dirigent.metadata.mirror_vcs_repositories')]
+        private readonly bool $mirrorVcsRepositories = false,
     ) {
     }
 
@@ -104,7 +107,7 @@ public function addMirroring(Request $request): Response
                 $package = new Package();
                 $package->setName($packageName);
                 $package->setMirrorRegistry($registry);
-                $package->setFetchStrategy(PackageFetchStrategy::Mirror);
+                $package->setFetchStrategy($this->mirrorVcsRepositories ? PackageFetchStrategy::Vcs : PackageFetchStrategy::Mirror);
 
                 $this->packageRepository->save($package, true);
 

src/Controller/Dashboard/DashboardRegistryController.php

@@ -63,7 +63,7 @@ public function configureFields(string $pageName): iterable
         yield AssociationField::new('credentials')
             ->onlyOnForms();
 
-        yield FormField::addPanel('Test');
+        yield FormField::addPanel('Packages');
 
         yield ChoiceField::new('packageMirroring')
             ->setSortable(false)

src/DependencyInjection/DirigentConfiguration.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;
@@ -84,6 +86,22 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
             ->end();
 
+        $this->addMetadataSection($rootNode);
+
         return $treeBuilder;
     }
+
+    private function addMetadataSection(ArrayNodeDefinition|NodeDefinition $rootNode): void
+    {
+        $rootNode->children()
+            ->arrayNode('metadata')
+                ->addDefaultsIfNotSet()
+                ->children()
+                    ->booleanNode('mirror_vcs_repositories')
+                        ->defaultFalse()
+                        ->info('Fetch mirrored packages from their VCS repositories by default when possible.')
+                    ->end()
+                ->end()
+            ->end();
+    }
 }

src/DependencyInjection/DirigentExtension.php

@@ -12,14 +12,14 @@ class DirigentExtension extends ConfigurableExtension
     protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void
     {
         if (null === $slug = $mergedConfig['slug']) {
-            $slug = (new AsciiSlugger())->slug($mergedConfig['title']);
-            $slug = strtolower($slug);
+            $slug = (new AsciiSlugger())->slug($mergedConfig['title'])->lower();
         }
 
         $container->setParameter('dirigent.title', $mergedConfig['title']);
         $container->setParameter('dirigent.slug', $slug);
 
         $this->registerEncryptionConfiguration($mergedConfig['encryption'], $container);
+        $this->registerMetadataConfiguration($mergedConfig['metadata'], $container);
 
         $container->setParameter('dirigent.security.public_access', $mergedConfig['security']['public']);
         $container->setParameter('dirigent.security.registration_enabled', $mergedConfig['security']['registration']);
@@ -58,4 +58,12 @@ private function registerEncryptionConfiguration(array $config, ContainerBuilder
         $container->setParameter('dirigent.encryption.public_key_path', $config['public_key_path']);
         $container->setParameter('dirigent.encryption.rotated_key_paths', $config['rotated_key_paths']);
     }
+
+    /**
+     * @param array{mirror_vcs_repositories: bool} $config
+     */
+    private function registerMetadataConfiguration(array $config, ContainerBuilder $container): void
+    {
+        $container->setParameter('dirigent.metadata.mirror_vcs_repositories', $config['mirror_vcs_repositories']);
+    }
 }

src/Form/PackageFormType.php

@@ -77,6 +77,16 @@ public function onPostSetData(PostSetDataEvent $event): void
                         return "package.fetch-strategy.{$choice->value}";
                     },
                 ]);
+
+            if (PackageFetchStrategy::Mirror === $package->getFetchStrategy()) {
+                $form
+                    ->add('repositoryCredentials', EntityType::class, [
+                        'label' => 'Credentials',
+                        'disabled' => true,
+                        'class' => Credentials::class,
+                        'placeholder' => 'No credentials',
+                    ]);
+            }
         }
     }
 

templates/dashboard/docs/admin/mirroring.md.twig

@@ -15,7 +15,8 @@ of registries, move the registries up and down in the **Registries** overview.
 To add an external registry, go to **Registries** in the sidebar and click **Add Registry**.
 
 ### Package mirroring
-When adding an external registry, you have the following options regarding package mirroring:
+The package mirroring option allows control over when a package from the mirror registry is added to the current
+registry.
 
 **Package mirroring disabled**<br>
 Package mirroring is disabled for this external registry so new packages can't be added. Existing packages already
@@ -28,3 +29,17 @@ registry will not request the package from this external registry.
 **Automatically mirror packages on request**<br>
 Packages can be added manually or will be created automatically when requested by a developer installing packages
 (through `composer update`).
+
+## Add mirrored packages
+To add a package from an external registry, go to **Packages** in the sidebar and click **Add Package** >
+**Mirror from registry**.
+
+### Fetch strategy
+It's possible to change how Dirigent fetches a mirrored package by changing the fetch strategy of the package. The
+default fetch strategy can be changed by the system administrator.
+
+**Fetch from registry** (default)<br>
+Fetch package metadata directly from the mirror registry. Only metadata from the registry is available.
+
+**Fetch from VCS**<br>
+Fetch package from VCS if possible. Metadata is compiled from the source code, including distributions and README data.

translations/messages.en.yaml

@@ -73,8 +73,8 @@ credentials:
     gitlab-pat: GitLab personal access token
 package:
   fetch-strategy:
-    mirror: Fetch from mirror registry
-    vcs: Fetch directly from VCS
+    mirror: Fetch from registry
+    vcs: Fetch from VCS
 registry:
   package-mirroring:
     none: Package mirroring disabled