MAGE-938 Add store name fetcher service

Author: cammonro

Console/Command/ReplicaCommand.php

@@ -8,15 +8,16 @@
 use Algolia\AlgoliaSearch\Exceptions\BadRequestException;
 use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
+use Algolia\AlgoliaSearch\Service\StoreNameFetcher;
 use Magento\Framework\App\Area;
 use Magento\Framework\App\State;
 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\InputInterface;
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ReplicaCommand extends Command
@@ -25,9 +26,6 @@ class ReplicaCommand extends Command
 
     protected ?OutputInterface $output = null;
 
-    /** @var string[] */
-    protected array $_storeNames = [];
-
     /**
      * @param ProductHelper $productHelper
      * @param ReplicaManagerInterface $replicaManager
@@ -39,6 +37,7 @@ public function __construct(
         protected ProductHelper           $productHelper,
         protected ReplicaManagerInterface $replicaManager,
         protected StoreManagerInterface   $storeManager,
+        protected StoreNameFetcher        $storeNameFetcher,
         ?string                           $name = null
     )
     {
@@ -82,7 +81,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             /** @var string[] $storeNames */
             $storeNames = array_map(
                 function($storeId) {
-                    return $this->getStoreName($storeId);
+                    return $this->storeNameFetcher->getStoreName($storeId);
                 },
                 $storeIds
             );
@@ -108,17 +107,6 @@ function($storeId) {
         return Cli::RETURN_SUCCESS;
     }
 
-    /**
-     * @throws NoSuchEntityException
-     */
-    protected function getStoreName(int $storeId): string
-    {
-        if (!isset($this->_storeNames[$storeId])) {
-            $this->_storeNames[$storeId] = $this->storeManager->getStore($storeId)->getName();
-        }
-        return $this->_storeNames[$storeId];
-    }
-
     /**
      * @param int[] $storeIds
      * @return void
@@ -146,12 +134,12 @@ protected function syncReplicas(array $storeIds = []): void
      */
     protected function syncReplicasForStore(int $storeId): void
     {
-        $this->output->writeln('<info>Syncing ' . $this->getStoreName($storeId) . '...</info>');
+        $this->output->writeln('<info>Syncing ' . $this->storeNameFetcher->getStoreName($storeId) . '...</info>');
         try {
             $this->replicaManager->syncReplicasToAlgolia($storeId, $this->productHelper->getIndexSettings($storeId));
         }
         catch (BadRequestException $e) {
-            $this->output->writeln('<error>Failed syncing replicas for store "' . $this->getStoreName($storeId) . '": ' . $e->getMessage() . '</error>');
+            $this->output->writeln('<error>Failed syncing replicas for store "' . $this->storeNameFetcher->getStoreName($storeId) . '": ' . $e->getMessage() . '</error>');
             throw $e;
         }
     }

Service/Product/ReplicaManager.php

@@ -14,6 +14,7 @@
 use Algolia\AlgoliaSearch\Helper\Logger;
 use Algolia\AlgoliaSearch\Registry\ReplicaState;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
+use Algolia\AlgoliaSearch\Service\StoreNameFetcher;
 use Algolia\AlgoliaSearch\Validator\VirtualReplicaValidatorFactory;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
@@ -48,6 +49,7 @@ public function __construct(
         protected ReplicaState                   $replicaState,
         protected VirtualReplicaValidatorFactory $validatorFactory,
         protected IndexNameFetcher               $indexNameFetcher,
+        protected StoreNameFetcher               $storeNameFetcher,
         protected SortingTransformer             $sortingTransformer,
         protected Logger                         $logger
     )
@@ -251,17 +253,18 @@ protected function isReplicaConfigurationValid(int $storeId): bool
         $sortingIndices = $this->sortingTransformer->getSortingIndices($storeId);
         $validator = $this->validatorFactory->create();
         if (!$validator->isReplicaConfigurationValid($sortingIndices)) {
+            $storeName = $this->storeNameFetcher->getStoreName($storeId) . " (Store ID=$storeId)";
             $postfix = "Please note that there can be no more than " . $this->getMaxVirtualReplicasPerIndex() . " virtual replicas per index.";
             if ($this->revertReplicaConfig($storeId)) {
                 $postfix .= ' Reverting to previous configuration.';
             }
             if ($validator->isTooManyCustomerGroups()) {
-                throw (new TooManyCustomerGroupsAsReplicasException(__("You have too many customer groups to enable virtual replicas on the pricing sort for store $storeId. $postfix")))
+                throw (new TooManyCustomerGroupsAsReplicasException(__("You have too many customer groups to enable virtual replicas on the pricing sort for $storeName. $postfix")))
                     ->withReplicaCount($validator->getReplicaCount())
                     ->withPriceSortReplicaCount($validator->getPriceSortReplicaCount());
             }
             else {
-                throw (new ReplicaLimitExceededException(__("Replica limit exceeded for store ID $storeId. $postfix")))
+                throw (new ReplicaLimitExceededException(__("Replica limit exceeded for $storeName. $postfix")))
                     ->withReplicaCount($validator->getReplicaCount());
             }
         }

Service/StoreNameFetcher.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Service;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Model\StoreManagerInterface;
+
+class StoreNameFetcher
+{
+    /** @var string[] */
+    protected array $_storeNames = [];
+
+    public function __construct(
+        protected StoreManagerInterface $storeManager
+    )
+    {}
+
+    /**
+     * @throws NoSuchEntityException
+     */
+    public function getStoreName(int $storeId): string
+    {
+        if (!isset($this->_storeNames[$storeId])) {
+            $this->_storeNames[$storeId] = $this->storeManager->getStore($storeId)->getName();
+        }
+        return $this->_storeNames[$storeId];
+    }
+}