Add dedicated distribution mirroring route

Author: codedmonkey

config/packages/security.yaml

@@ -19,7 +19,7 @@ security:
             pattern: ^/(_profiler|_wdt|assets|build)/
             security: false
         api:
-            pattern: ^/(packages.json|downloads|p2/|dist/)
+            pattern: ^/(packages.json|downloads|p2/|dist/|dist-mirror/)
             provider: database_users
             http_basic:
                 realm: api

src/Controller/ApiController.php

@@ -42,6 +42,8 @@ public function __construct(
         private readonly PackageDistributionResolver $distributionResolver,
         private readonly PackageProviderManager $providerManager,
         private readonly MessageBusInterface $messenger,
+        #[Autowire(param: 'dirigent.distributions.async_api_requests')]
+        private readonly bool $asyncApiRequests,
         #[Autowire(param: 'dirigent.packages.dynamic_updates')]
         private readonly bool $dynamicUpdatesEnabled,
         #[Autowire(param: 'dirigent.metadata.default_mirror_fetch_strategy')]
@@ -64,7 +66,7 @@ public function root(RouterInterface $router): JsonResponse
         ];
 
         if ($this->getParameter('dirigent.distributions.mirror')) {
-            $distributionUrlPattern = u($router->getRouteCollection()->get('api_package_distribution')->getPath())
+            $distributionUrlPattern = u($router->getRouteCollection()->get('api_package_distribution_mirror')->getPath())
                 ->replace('{package}', '%package%')
                 ->replace('{version}', '%version%')
                 ->replace('{reference}', '%reference%')
@@ -106,18 +108,19 @@ public function packageMetadata(Request $request): Response
         return $response;
     }
 
-    #[Route('/dist/{package}/{version}-{reference}.{type}',
+    #[Route('/dist/{package}/{version}-r{revision}-{reference}.{type}',
         name: 'api_package_distribution',
         requirements: [
             'package' => MapPackage::PACKAGE_REGEX,
             'version' => Requirement::CATCH_ALL,
+            'revision' => Requirement::POSITIVE_INT,
             'reference' => '[a-z0-9]+',
             'type' => '(zip)',
         ],
         methods: ['GET'],
     )]
     #[IsGrantedAccess]
-    public function packageDistribution(Request $request, string $reference, string $type): Response
+    public function packageDistribution(Request $request, int $revision, string $reference, string $type): Response
     {
         if (!$this->getParameter('dirigent.distributions.enabled')) {
             throw $this->createNotFoundException();
@@ -130,11 +133,55 @@ public function packageDistribution(Request $request, string $reference, string
             throw $this->createNotFoundException();
         }
 
-        if (null === $metadata = $this->metadataRepository->findOneByNormalizedNameAndReference($package, $versionName, $reference)) {
+        if (null === $metadata = $this->metadataRepository->findOneByNormalizedNameAndRevision($package, $versionName, $revision)) {
             throw $this->createNotFoundException();
         }
 
-        if (!$this->distributionResolver->resolve($metadata, $type, async: $this->getParameter('dirigent.distributions.async_api_requests'))) {
+        if (!$this->distributionResolver->resolve($metadata, $type, $this->asyncApiRequests)) {
+            throw $this->createNotFoundException();
+        }
+
+        $path = $this->distributionResolver->path($metadata, $reference);
+        $filename = u("$packageName-$versionName-r$revision-$reference.$type")->replace('/', '-')->toString();
+
+        return $this->file($path, $filename);
+    }
+
+    /**
+     * Fetch mirrored package distributions through the API.
+     *
+     * The endpoint to fetch mirrored distributions is separate because when Composer requests a mirror, it doesn't
+     * know which revision to fetch, so we default to the latest revision with the specified reference.
+     */
+    #[Route('/dist-mirror/{package}/{version}-{reference}.{type}',
+        name: 'api_package_distribution_mirror',
+        requirements: [
+            'package' => MapPackage::PACKAGE_REGEX,
+            'version' => Requirement::CATCH_ALL,
+            'reference' => '[a-z0-9]+',
+            'type' => '(zip)',
+        ],
+        methods: ['GET'],
+    )]
+    #[IsGrantedAccess]
+    public function packageDistributionMirror(Request $request, string $reference, string $type): Response
+    {
+        if (!$this->getParameter('dirigent.distributions.enabled')) {
+            throw $this->createNotFoundException();
+        }
+
+        $packageName = $request->attributes->get('package');
+        $versionName = $request->attributes->get('version');
+
+        if (null === $package = $this->findPackage($packageName)) {
+            throw $this->createNotFoundException();
+        }
+
+        if (null === $metadata = $this->metadataRepository->findOneByNormalizedNameAndDistributionReference($package, $versionName, $reference)) {
+            throw $this->createNotFoundException();
+        }
+
+        if (!$this->distributionResolver->resolve($metadata, $type, $this->asyncApiRequests)) {
             throw $this->createNotFoundException();
         }
 

src/Doctrine/Repository/MetadataRepository.php

@@ -73,16 +73,38 @@ public function findAllMetadataForVersion(Version $version): array
         );
     }
 
-    public function findOneByNormalizedNameAndReference(Package $package, string $normalizedVersionName, string $reference): ?Metadata
+    /**
+     * Finds the latest metadata for a given package by the distribution reference.
+     *
+     * Note that this method may return a different metadata revision than the one that was used to generate the
+     * initial reference if there are any shenanigans going on with revisions that have the same reference.
+     */
+    public function findOneByNormalizedNameAndDistributionReference(Package $package, string $normalizedVersionName, string $distributionReference): ?Metadata
+    {
+        $builder = $this->createQueryBuilder('metadata')
+            ->leftJoin('metadata.version', 'version')
+            ->andWhere('metadata.package = :package')
+            ->andWhere('version.normalizedName = :versionName')
+            ->andWhere('metadata.distributionReference = :reference')
+            ->orderBy('metadata.revision', 'DESC')
+            ->setParameter('package', $package)
+            ->setParameter('versionName', $normalizedVersionName)
+            ->setParameter('reference', $distributionReference)
+            ->setMaxResults(1);
+
+        return $builder->getQuery()->getOneOrNullResult();
+    }
+
+    public function findOneByNormalizedNameAndRevision(Package $package, string $normalizedVersionName, int $revision): ?Metadata
     {
         $builder = $this->createQueryBuilder('metadata')
             ->leftJoin('metadata.version', 'version')
             ->andWhere('metadata.package = :package')
             ->andWhere('version.normalizedName = :versionName')
-            ->andWhere('metadata.sourceReference = :reference OR (metadata.sourceReference IS NULL AND metadata.distributionReference = :reference)')
+            ->andWhere('metadata.revision = :revision')
             ->setParameter('package', $package)
             ->setParameter('versionName', $normalizedVersionName)
-            ->setParameter('reference', $reference)
+            ->setParameter('revision', $revision)
             ->setMaxResults(1);
 
         return $builder->getQuery()->getOneOrNullResult();