Merge branch 'update-command'

Author: codedmonkey

src/Command/PackagesUpdateCommand.php

@@ -3,7 +3,9 @@
 namespace CodedMonkey\Dirigent\Command;
 
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
+use CodedMonkey\Dirigent\Entity\PackageUpdateSource;
 use CodedMonkey\Dirigent\Message\SchedulePackageUpdate;
+use CodedMonkey\Dirigent\Message\UpdatePackage;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -16,6 +18,32 @@
 #[AsCommand(
     name: 'packages:update',
     description: 'Schedules packages for update',
+    help: <<<'TXT'
+        The <info>%command.name%</info> command schedules packages in the registry for update:
+
+          <info>%command.full_name%</info>
+
+        <fg=black;bg=yellow>                                                          </>
+        <fg=black;bg=yellow> Make sure a worker is running, or use the --sync option. </>
+        <fg=black;bg=yellow>                                                          </>
+
+        By default, only packages that have passed the periodic update interval will be scheduled for update.
+
+        Use the <comment>--all</comment> option to schedule all packages for update instead:
+
+          <info>%command.full_name% --all</info>
+
+        Package updates are scheduled somewhere in the next 12 minutes, except when specifying package names, then they are
+        scheduled immediately. Check the worker's message queue if updates are not being executed.
+
+        It's possible to update specific packages by passing their name as arguments:
+
+          <info>%command.full_name% psr/cache psr/log</info>
+
+        Use the <comment>--sync</comment> option to skip the worker and update packages synchronously:
+
+          <info>%command.full_name% psr/cache psr/log --sync</info>
+        TXT,
 )]
 class PackagesUpdateCommand extends Command
 {
@@ -30,48 +58,67 @@ protected function configure(): void
     {
         $this
             ->addArgument('package', InputArgument::OPTIONAL, 'Package to update')
-            ->addOption('force', null, InputOption::VALUE_NONE, 'Forces a re-crawl of all packages');
+            ->addOption('all', null, InputOption::VALUE_NONE, 'Update all packages')
+            ->addOption('sync', null, InputOption::VALUE_NONE, 'Updates packages synchronously');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $force = $input->getOption('force');
-        $packageName = $input->getArgument('package');
+        $all = $input->getOption('all');
+        $packageNames = (array) ($input->getArgument('package') ?? []);
+        $sync = $input->getOption('sync');
 
-        $randomTimes = true;
-        $reschedule = false;
+        if ($sync && !count($packageNames)) {
+            $io->error('Specify a package to update when using the --sync option.');
 
-        if ($packageName) {
-            if (null === $package = $this->packageRepository->findOneByName($packageName)) {
-                $io->error("Package $packageName not found");
+            return Command::FAILURE;
+        }
 
-                return Command::FAILURE;
-            }
+        $randomTimes = true; // Randomize time of updates
+        $source = PackageUpdateSource::Stale;
+
+        if (count($packageNames)) {
+            $packageIds = [];
+            foreach ($packageNames as $packageName) {
+                if (null === $package = $this->packageRepository->findOneByName($packageName)) {
+                    $io->error("Package $packageName not found");
 
-            $io->writeln("Scheduling package $packageName for update...");
+                    return Command::FAILURE;
+                }
 
-            $packages = [['id' => $package->getId()]];
+                $io->writeln("Scheduling package $packageName for update...");
+                $packageIds[] = $package->getId();
+            }
 
             $randomTimes = false;
-            $reschedule = true;
-        } elseif ($force) {
+            $source = PackageUpdateSource::Manual;
+        } elseif ($all) {
             $io->writeln('Scheduling all packages for update...');
-            $packages = $this->packageRepository->getAllPackageIds();
+            $packageIds = $this->packageRepository->getAllPackageIds();
 
-            $reschedule = true;
+            $source = PackageUpdateSource::Manual;
         } else {
             $io->writeln('Scheduling stale packages for update...');
-            $packages = $this->packageRepository->getStalePackageIds();
+            $packageIds = $this->packageRepository->getStalePackageIds();
         }
 
-        foreach ($packages as $package) {
-            $this->messenger->dispatch(new SchedulePackageUpdate($package['id'], randomTime: $randomTimes, reschedule: $reschedule, forceRefresh: $force));
-        }
+        $packageCount = count($packageIds);
+
+        if ($sync) {
+            foreach ($packageIds as $packageId) {
+                $this->messenger->dispatch(new UpdatePackage($packageId, $source));
+            }
 
-        $packageCount = count($packages);
-        $io->success("Scheduled $packageCount package(s) for update.");
+            $io->success("Updated $packageCount package(s).");
+        } else {
+            foreach ($packageIds as $packageId) {
+                $this->messenger->dispatch(new SchedulePackageUpdate($packageId, $source, $randomTimes));
+            }
+
+            $io->success("Scheduled $packageCount package(s) for update.");
+        }
 
         return Command::SUCCESS;
     }

src/Controller/ApiController.php

@@ -8,11 +8,13 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\PackageFetchStrategy;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
 use CodedMonkey\Dirigent\Doctrine\Repository\VersionRepository;
+use CodedMonkey\Dirigent\Entity\PackageUpdateSource;
 use CodedMonkey\Dirigent\Message\TrackInstallations;
 use CodedMonkey\Dirigent\Message\UpdatePackage;
 use CodedMonkey\Dirigent\Package\PackageDistributionResolver;
 use CodedMonkey\Dirigent\Package\PackageMetadataResolver;
 use CodedMonkey\Dirigent\Package\PackageProviderManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
@@ -30,12 +32,15 @@
 class ApiController extends AbstractController
 {
     public function __construct(
+        private readonly EntityManagerInterface $entityManager,
         private readonly PackageRepository $packageRepository,
         private readonly VersionRepository $versionRepository,
         private readonly PackageMetadataResolver $metadataResolver,
         private readonly PackageDistributionResolver $distributionResolver,
         private readonly PackageProviderManager $providerManager,
         private readonly MessageBusInterface $messenger,
+        #[Autowire(param: 'dirigent.packages.dynamic_updates')]
+        private readonly bool $dynamicUpdatesEnabled,
         #[Autowire(param: 'dirigent.metadata.mirror_vcs_repositories')]
         private readonly bool $mirrorVcsRepositories = false,
     ) {
@@ -80,15 +85,13 @@ public function root(RouterInterface $router): JsonResponse
     #[IsGrantedAccess]
     public function packageMetadata(Request $request): Response
     {
-        $packageName = $request->attributes->get('package');
+        $packageName = $request->attributes->getString('package');
         $basePackageName = u($packageName)->trimSuffix('~dev')->toString();
 
-        if (null === $package = $this->findPackage($basePackageName)) {
+        if (null === $this->findPackage($basePackageName)) {
             throw $this->createNotFoundException();
         }
 
-        $this->messenger->dispatch(new UpdatePackage($package->getId()));
-
         if (!$this->providerManager->exists($packageName)) {
             throw $this->createNotFoundException();
         }
@@ -125,8 +128,6 @@ public function packageDistribution(Request $request, string $reference, string
                 throw $this->createNotFoundException();
             }
 
-            $this->messenger->dispatch(new UpdatePackage($package->getId()));
-
             if (null === $version = $this->versionRepository->findOneByNormalizedVersion($package, $versionName)) {
                 throw $this->createNotFoundException();
             }
@@ -166,24 +167,41 @@ public function trackInstallations(Request $request): Response
         return new JsonResponse(['status' => 'success'], Response::HTTP_CREATED);
     }
 
-    private function findPackage(string $packageName): ?Package
+    private function findPackage(string $packageName, ?bool $create = false): ?Package
     {
-        // Search for the package in the database
-        if (null !== $package = $this->packageRepository->findOneByName($packageName)) {
-            return $package;
-        }
+        $this->entityManager->beginTransaction();
+
+        try {
+            // Search for the package in the database
+            if (null === $package = $this->packageRepository->findOneByName($packageName)) {
+                if (!$create || !$this->dynamicUpdatesEnabled) {
+                    // It doesn't exist in the database and we can't create it dynamically
+                    return null;
+                }
+
+                // Search for the package in external registries
+                if (null === $registry = $this->metadataResolver->findPackageProvider($packageName)) {
+                    return null;
+                }
+
+                $package = new Package();
+                $package->setName($packageName);
+                $package->setMirrorRegistry($registry);
+                $package->setFetchStrategy($this->mirrorVcsRepositories ? PackageFetchStrategy::Vcs : PackageFetchStrategy::Mirror);
+
+                $this->packageRepository->save($package, true);
+            }
 
-        // Attempt to find a package from external registries
-        if (null === $registry = $this->metadataResolver->findPackageProvider($packageName)) {
-            return null;
-        }
+            if ($this->dynamicUpdatesEnabled) {
+                $this->messenger->dispatch(new UpdatePackage($package->getId(), PackageUpdateSource::Dynamic));
+            }
+        } catch (\Throwable $exception) {
+            $this->entityManager->rollback();
 
-        $package = new Package();
-        $package->setName($packageName);
-        $package->setMirrorRegistry($registry);
-        $package->setFetchStrategy($this->mirrorVcsRepositories ? PackageFetchStrategy::Vcs : PackageFetchStrategy::Mirror);
+            throw $exception;
+        }
 
-        $this->packageRepository->save($package, true);
+        $this->entityManager->commit();
 
         return $package;
     }

src/Controller/Dashboard/DashboardPackagesController.php

@@ -8,6 +8,7 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\PackageFetchStrategy;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
 use CodedMonkey\Dirigent\EasyAdmin\PackagePaginator;
+use CodedMonkey\Dirigent\Entity\PackageUpdateSource;
 use CodedMonkey\Dirigent\Form\PackageAddMirroringFormType;
 use CodedMonkey\Dirigent\Form\PackageAddVcsFormType;
 use CodedMonkey\Dirigent\Form\PackageFormType;
@@ -112,7 +113,7 @@ public function addMirroring(Request $request): Response
 
                 $this->packageRepository->save($package, true);
 
-                $this->messenger->dispatch(new UpdatePackage($package->getId()));
+                $this->messenger->dispatch(new UpdatePackage($package->getId(), PackageUpdateSource::Manual));
 
                 $results[] = [
                     'packageName' => $packageName,
@@ -148,7 +149,7 @@ public function addVcsRepository(Request $request): Response
             $package = $form->getData();
             $this->packageRepository->save($package, true);
 
-            $this->messenger->dispatch(new UpdatePackage($package->getId()));
+            $this->messenger->dispatch(new UpdatePackage($package->getId(), PackageUpdateSource::Manual));
 
             return $this->redirectToRoute('dashboard_packages');
         }
@@ -171,7 +172,7 @@ public function edit(Request $request, #[MapPackage] Package $package): Response
             $package = $form->getData();
             $this->packageRepository->save($package, true);
 
-            $this->messenger->dispatch(new UpdatePackage($package->getId()));
+            $this->messenger->dispatch(new UpdatePackage($package->getId(), PackageUpdateSource::Manual));
 
             return $this->redirectToRoute('dashboard_packages_info', ['package' => $package->getName()]);
         }
@@ -186,7 +187,7 @@ public function edit(Request $request, #[MapPackage] Package $package): Response
     #[IsGranted('ROLE_ADMIN')]
     public function update(#[MapPackage] Package $package): Response
     {
-        $this->messenger->dispatch(new UpdatePackage($package->getId(), forceRefresh: true));
+        $this->messenger->dispatch(new UpdatePackage($package->getId(), PackageUpdateSource::Manual));
 
         return $this->redirectToRoute('dashboard_packages_info', ['package' => $package->getName()]);
     }

src/DependencyInjection/DirigentConfiguration.php

@@ -69,15 +69,6 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->scalarNode('path')->defaultValue('%kernel.project_dir%/storage')->end()
                 ->end()
             ->end()
-            ->arrayNode('packages')
-                ->addDefaultsIfNotSet()
-                ->children()
-                    ->booleanNode('dynamic_updates')->defaultTrue()->end()
-                    ->scalarNode('dynamic_update_delay')->defaultValue('PT4H')->end()
-                    ->booleanNode('periodic_updates')->defaultTrue()->end()
-                    ->scalarNode('periodic_update_interval')->defaultValue('P1W')->end()
-                ->end()
-            ->end()
             ->arrayNode('dist_mirroring')
                 ->canBeEnabled()
                 ->children()
@@ -87,6 +78,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->end();
 
         $this->addMetadataSection($rootNode);
+        $this->addPackagesSection($rootNode);
 
         return $treeBuilder;
     }
@@ -104,4 +96,32 @@ private function addMetadataSection(ArrayNodeDefinition|NodeDefinition $rootNode
                 ->end()
             ->end();
     }
+
+    private function addPackagesSection(ArrayNodeDefinition|NodeDefinition $rootNode): void
+    {
+        $rootNode->children()
+            ->arrayNode('packages')
+                ->addDefaultsIfNotSet()
+                ->children()
+                    ->booleanNode('dynamic_updates')
+                        ->defaultTrue()
+                        ->info('Whether to automatically update packages when using the (Composer) API')
+                    ->end()
+                    ->stringNode('dynamic_update_delay')
+                        ->cannotBeEmpty()
+                        ->defaultValue('PT4H')
+                        ->info('The delay between package updates when using the API, in ISO 8601 duration format')
+                    ->end()
+                    ->booleanNode('periodic_updates')
+                        ->defaultTrue()
+                        ->info('Whether to automatically update packages periodically')
+                    ->end()
+                    ->stringNode('periodic_update_interval')
+                        ->cannotBeEmpty()
+                        ->defaultValue('P1W')
+                        ->info('The interval between periodic package updates, in ISO 8601 duration format')
+                    ->end()
+                ->end()
+            ->end();
+    }
 }