Add a command to clean up virtual packages from the search index, fixes #1029

src/Packagist/WebBundle/Command/CleanIndexCommand.php

@@ -0,0 +1,113 @@
+<?php
+
+/*
+ * This file is part of Packagist.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *     Nils Adermann <naderman@naderman.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Packagist\WebBundle\Command;
+
+use Packagist\WebBundle\Entity\Package;
+use Packagist\WebBundle\Model\DownloadManager;
+use Packagist\WebBundle\Model\FavoriteManager;
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Doctrine\DBAL\Connection;
+
+class CleanIndexCommand extends ContainerAwareCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('packagist:clean-index')
+            ->setDefinition(array(
+            ))
+            ->setDescription('Cleans up the Algolia index of stale virtual packages')
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $verbose = $input->getOption('verbose');
+        $indexName = $this->getContainer()->getParameter('algolia.index_name');
+
+        $deployLock = $this->getContainer()->getParameter('kernel.cache_dir').'/deploy.globallock';
+        if (file_exists($deployLock)) {
+            if ($verbose) {
+                $output->writeln('Aborting, '.$deployLock.' file present');
+            }
+            return;
+        }
+
+        $locker = $this->getContainer()->get('locker');
+
+        $lockAcquired = $locker->lockCommand($this->getName());
+        if (!$lockAcquired) {
+            if ($input->getOption('verbose')) {
+                $output->writeln('Aborting, another task is running already');
+            }
+            return;
+        }
+
+        $doctrine = $this->getContainer()->get('doctrine');
+        $algolia = $this->getContainer()->get('packagist.algolia.client');
+        $index = $algolia->initIndex($indexName);
+
+        $page = 0;
+        $perPage = 100;
+        do {
+            $results = $index->search('', ['facets' => "*,type,tags", 'facetFilters' => ['type:virtual-package'], 'numericFilters' => ['trendiness=100'], 'hitsPerPage' => $perPage, 'page' => $page]);
+            foreach ($results['hits'] as $result) {
+                if (0 !== strpos($result['objectID'], 'virtual:')) {
+                    $duplicate = $index->search('', ['facets' => "*,objectID,type,tags", 'facetFilters' => ['objectID:virtual:'.$result['objectID']]]);
+                    if (count($duplicate['hits']) === 1) {
+                        if ($verbose) {
+                            $output->writeln('Deleting '.$result['objectID'].' which is a duplicate of '.$duplicate['hits'][0]['objectID']);
+                        }
+                        $index->deleteObject($result['objectID']);
+                        continue;
+                    }
+                }
+
+                if (!$this->hasProviders($doctrine, $result['name'])) {
+                    if ($verbose) {
+                        $output->writeln('Deleting '.$result['objectID'].' which has no provider anymore');
+                    }
+                    $index->deleteObject($result['objectID']);
+                }
+            }
+            $page++;
+        } while (count($results['hits']) >= $perPage);
+
+        $locker->unlockCommand($this->getName());
+
+        return 0;
+    }
+
+    private function hasProviders($doctrine, string $provided): bool
+    {
+        return (bool) $doctrine->getManager()->getConnection()->fetchColumn(
+            'SELECT COUNT(p.id) as count
+                FROM package p
+                JOIN package_version pv ON p.id = pv.package_id
+                JOIN link_provide lp ON lp.version_id = pv.id
+                WHERE pv.development = true
+                AND lp.packageName = :provided',
+            ['provided' => $provided]
+        );
+    }
+}