MAGE-938 Updates per code review

Author: cammonro

Console/Command/ReplicaDeleteCommand.php

@@ -75,7 +75,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln("<info>$msg</info>");
         }
 
-
         if ($unused) {
             $unusedReplicas = $this->getUnusedReplicas($storeIds);
             if (!$unusedReplicas) {
@@ -85,6 +84,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             if (!$this->confirmDeleteUnused($unusedReplicas)) {
                 return Cli::RETURN_SUCCESS;
             }
+        } else if (!$this->confirmDelete()) {
+            return Cli::RETURN_SUCCESS;
         }
 
         try {
@@ -98,6 +99,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return Cli::RETURN_SUCCESS;
     }
 
+    /**
+     * @param int[] $storeIds
+     * @return string[]
+     */
     protected function getUnusedReplicas(array $storeIds): array
     {
         return array_reduce(
@@ -119,7 +124,7 @@ function ($allUnused, $storeId) {
      * Deleting unused replica indices is potentially risky, especially if they have enabled query suggestions on their index
      * Verify with the end user first!
      *
-     * @param array $unusedReplicas
+     * @param string[] $unusedReplicas
      * @return bool
      */
     protected function confirmDeleteUnused(array $unusedReplicas): bool
@@ -138,4 +143,18 @@ protected function confirmDeleteUnused(array $unusedReplicas): bool
         return true;
     }
 
+
+    protected function confirmDelete(): bool
+    {
+        $helper = $this->getHelper('question');
+        $question = new ConfirmationQuestion('<question>Are you sure wish to proceed? (y/n)</question> ', false);
+        if (!$helper->ask($this->input, $this->output, $question)) {
+            $this->output->writeln('<comment>Operation cancelled.</comment>');
+            return false;
+        }
+
+        $this->output->writeln('<comment>Please note that you can restore these deleted replicas by running "algolia:replicas:sync".</comment>');
+        return true;
+    }
+
 }

Console/Command/ReplicaRebuildCommand.php

@@ -41,7 +41,7 @@ protected function getReplicaCommandName(): string
 
     protected function getCommandDescription(): string
     {
-        return 'Rebuild replica configuration for Magento sorting attributes';
+        return "Delete and rebuild replica configuration for Magento sorting attributes (only run this operation if errors are encountered during regular sync)";
     }
 
     protected function getStoreArgumentDescription(): string

Service/Product/ReplicaManager.php

@@ -302,6 +302,12 @@ protected function isReplicaConfigurationValid(int $storeId): bool
         return true;
     }
 
+    /**
+     * In the event of an invalid replica configuration, this provides the means to revert the
+     * configuration settings to the previous state (provided the ReplicaState has been utilized to track the change)
+     * @param int $storeId
+     * @return bool True if settings were reverted as a result of this function call
+     */
     protected function revertReplicaConfig(int $storeId): bool
     {
         if ($ogConfig = $this->replicaState->getOriginalSortConfiguration($storeId)) {