Refactor Cleanup Command to service

valantic · Oct 31, 2024 · 025846d · 025846d
1 parent 3456fee
commit 025846d
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 52 deletions.
diff --git a/src/Command/Cleanup.php b/src/Command/Cleanup.php
@@ -4,24 +4,22 @@
 
 namespace Valantic\ElasticaBridgeBundle\Command;
 
-use Elastic\Elasticsearch\Exception\ElasticsearchException;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Valantic\ElasticaBridgeBundle\Constant\CommandConstants;
-use Valantic\ElasticaBridgeBundle\Elastica\Client\ElasticsearchClient;
-use Valantic\ElasticaBridgeBundle\Repository\IndexRepository;
+use Valantic\ElasticaBridgeBundle\Service\CleanupService;
 
 class Cleanup extends BaseCommand
 {
     use NonBundleIndexTrait;
     private const OPTION_ALL_IN_CLUSTER = 'all';
+    private const OPTION_DRY_RUN = 'dry-run';
 
     public function __construct(
-        private readonly ElasticsearchClient $esClient,
-        private readonly IndexRepository $indexRepository,
+        private readonly CleanupService $cleanupService,
     ) {
         parent::__construct();
     }
@@ -30,6 +28,7 @@ protected function configure(): void
     {
         $this->setName(CommandConstants::COMMAND_CLEANUP)
             ->setDescription('Deletes Elasticsearch indices and aliases known to (i.e. created by) the bundle')
+            ->addOption(self::OPTION_DRY_RUN, 'd', InputOption::VALUE_NONE, 'Only simulate the cleanup')
             ->addOption(
                 self::OPTION_ALL_IN_CLUSTER,
                 'a',
@@ -45,63 +44,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 ? 'Deleting ALL indices in the cluster'
                 : 'Only deleting KNOWN indices'
         );
+        $verb = $this->input->getOption(self::OPTION_DRY_RUN) === true
+            ? 'simulate'
+            : 'proceed';
         /** @var QuestionHelper $helper */
         $helper = $this->getHelper('question');
-        $question = new ConfirmationQuestion('Are you sure you want to proceed deleting indices and aliases? (y/N)', false);
+        $question = new ConfirmationQuestion(sprintf('Are you sure you want to %s deleting indices and aliases? (y/N)', $verb), false);
 
         if ($helper->ask($input, $output, $question) === false) {
             return self::FAILURE;
         }
 
-        $indices = $this->getIndices();
-
-        foreach ($indices as $index) {
-            if (!$this->shouldProcessNonBundleIndex($index)) {
-                continue;
-            }
-
-            $client = $this->esClient->getIndex($index);
-
-            if ($client->getSettings()->getBool('hidden')) {
-                continue;
-            }
-
-            foreach ($client->getAliases() as $alias) {
-                $client->removeAlias($alias);
-            }
+        $messages = $this->cleanupService->cleanUp(
+            $this->input->getOption(self::OPTION_ALL_IN_CLUSTER) === true,
+            $this->input->getOption(self::OPTION_DRY_RUN) === true
+        );
 
-            try {
-                $client->delete();
-            } catch (ElasticsearchException $e) {
-                $this->output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
-            }
+        foreach ($messages as $message) {
+            $this->output->writeln($message);
         }
 
         return self::SUCCESS;
     }
-
-    /**
-     * @return string[]
-     */
-    private function getIndices(): array
-    {
-        if ($this->input->getOption(self::OPTION_ALL_IN_CLUSTER) === true) {
-            return $this->esClient->getCluster()->getIndexNames();
-        }
-
-        $indices = [];
-
-        foreach ($this->indexRepository->flattenedAll() as $indexConfig) {
-            if ($indexConfig->usesBlueGreenIndices()) {
-                $indices[] = $indexConfig->getBlueGreenActiveElasticaIndex()->getName();
-                $indices[] = $indexConfig->getBlueGreenInactiveElasticaIndex()->getName();
-
-                continue;
-            }
-
-            $indices[] = $indexConfig->getName();
-        }
-
-        return $indices;
-    }
 }
diff --git a/src/Service/CleanupService.php b/src/Service/CleanupService.php
@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Valantic\ElasticaBridgeBundle\Service;
+
+use Elastic\Elasticsearch\Exception\ClientResponseException;
+use Elastic\Elasticsearch\Exception\ElasticsearchException;
+use Elastic\Elasticsearch\Exception\MissingParameterException;
+use Elastic\Elasticsearch\Exception\ServerResponseException;
+use Valantic\ElasticaBridgeBundle\Elastica\Client\ElasticsearchClient;
+use Valantic\ElasticaBridgeBundle\Repository\IndexRepository;
+
+class CleanupService
+{
+    public function __construct(
+        private readonly ElasticsearchClient $esClient,
+        private readonly IndexRepository $indexRepository,
+    ) {}
+
+    /**
+     * @param bool $allIndices
+     *
+     * @throws ClientResponseException
+     * @throws MissingParameterException
+     * @throws ServerResponseException
+     *
+     * @return \Generator<string>
+     */
+    public function cleanUp(bool $allIndices = false, bool $dryRun = true): \Generator
+    {
+        if ($dryRun === true) {
+            yield '<info>DRY-RUN MODE</info>';
+        }
+
+        $indices = $this->getIndices($allIndices);
+
+        foreach ($indices as $index) {
+            if ($index === '.geoip_databases') {
+                continue;
+            }
+
+            $esIndex = $this->esClient->getIndex($index);
+
+            if ($esIndex->getSettings()->getBool('hidden')) {
+                continue;
+            }
+
+            foreach ($esIndex->getAliases() as $alias) {
+                if ($dryRun === true) {
+                    yield sprintf('<info>Would remove alias %s from index %s</info>', $alias, $index);
+
+                    continue;
+                }
+                $esIndex->removeAlias($alias);
+
+                yield sprintf('<info>Removed alias %s from index %s</info>', $alias, $index);
+            }
+
+            try {
+                if ($dryRun === true) {
+                    yield sprintf('<info>Would delete index %s</info>', $index);
+
+                    continue;
+                }
+                $esIndex->delete();
+
+                yield sprintf('<info>Deleted index %s</info>', $index);
+            } catch (ElasticsearchException $e) {
+                yield sprintf('<error>%s</error>', $e->getMessage());
+            }
+        }
+    }
+
+    /**
+     * @param bool $allIndices
+     *
+     * @return string[]
+     */
+    private function getIndices(bool $allIndices = false): array
+    {
+        if ($allIndices === true) {
+            return $this->esClient->getCluster()->getIndexNames();
+        }
+
+        $indices = [];
+
+        foreach ($this->indexRepository->flattenedAll() as $indexConfig) {
+            if ($indexConfig->usesBlueGreenIndices()) {
+                $indices[] = $indexConfig->getBlueGreenActiveElasticaIndex()->getName();
+                $indices[] = $indexConfig->getBlueGreenInactiveElasticaIndex()->getName();
+
+                continue;
+            }
+
+            $indices[] = $indexConfig->getName();
+        }
+
+        return $indices;
+    }
+}