MAGE-938 Call out exceptions in interface

Author: cammonro

Api/Product/ReplicaManagerInterface.php

@@ -28,6 +28,15 @@ interface ReplicaManagerInterface
      */
     public function syncReplicasToAlgolia(int $storeId, array $primaryIndexSettings): void;
 
+    /**
+     * Delete the replica indices on a store index
+     * @param int $storeId
+     * @param bool $unused Defaults to false - if true identifies any straggler indices and deletes those, otherwise deletes the replicas it knows aobut
+     * @return void
+     *
+     * @throws LocalizedException
+     * @throws AlgoliaException
+     */
     public function deleteReplicasFromAlgolia(int $storeId, bool $unused = false): void;
 
     /**

Console/Command/ReplicaDeleteCommand.php

@@ -3,9 +3,12 @@
 namespace Algolia\AlgoliaSearch\Console\Command;
 
 use Algolia\AlgoliaSearch\Api\Product\ReplicaManagerInterface;
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Exceptions\BadRequestException;
 use Algolia\AlgoliaSearch\Service\StoreNameFetcher;
 use Magento\Framework\Console\Cli;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\StoreManagerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -62,7 +65,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->output = $output;
         $this->input = $input;
-        
+
         $storeIds = (array) $input->getArgument(self::STORE_ARGUMENT);
         $unused = $input->getOption(self::UNUSED_OPTION);
 
@@ -136,6 +139,11 @@ protected function confirmDeleteUnused(array $unusedReplicas): bool
         return true;
     }
 
+    /**
+     * @throws NoSuchEntityException
+     * @throws AlgoliaException
+     * @throws LocalizedException
+     */
     protected function deleteReplicas(array $storeIds = [], bool $unused = false): void
     {
         if (count($storeIds)) {
@@ -147,12 +155,22 @@ protected function deleteReplicas(array $storeIds = [], bool $unused = false): v
         }
     }
 
+    /**
+     * @throws NoSuchEntityException
+     * @throws LocalizedException
+     * @throws AlgoliaException
+     */
     protected function deleteReplicasForStore(int $storeId, bool $unused = false): void
     {
         $this->output->writeln('<info>Deleting' . ($unused ? ' unused ': ' ') . 'replicas for ' . $this->storeNameFetcher->getStoreName($storeId) . '...</info>');
         $this->replicaManager->deleteReplicasFromAlgolia($storeId, $unused);
     }
 
+    /**
+     * @throws NoSuchEntityException
+     * @throws LocalizedException
+     * @throws AlgoliaException
+     */
     protected function deleteReplicasForAllStores(bool $unused = false): void
     {
         $storeIds = array_keys($this->storeManager->getStores());

Service/Product/ReplicaManager.php

@@ -423,9 +423,7 @@ protected function clearReplicasSettingInAlgolia(string $primaryIndexName): void
     }
 
     /**
-     * @throws AlgoliaException
-     * @throws NoSuchEntityException
-     * @throws LocalizedException
+     * @inheritDoc
      */
     public function deleteReplicasFromAlgolia(int $storeId, bool $unused = false): void
     {