MAGE-1113 Switch to AlgoliaConnector for 3.15+

Author: cammonro

Api/Builder/EntityIndexOptionsBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Builder;
+
+use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface;
+
+interface EntityIndexOptionsBuilderInterface
+{
+    public function buildEntityIndexOptions(int $storeId, ?bool $isTmp = false): IndexOptionsInterface;
+}

Console/Command/SynonymDeduplicateCommand.php

@@ -2,8 +2,8 @@
 
 namespace Algolia\AlgoliaSearch\Console\Command;
 
-use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
-use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
+use Algolia\AlgoliaSearch\Service\AlgoliaConnector;
+use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder;
 use Algolia\AlgoliaSearch\Service\StoreNameFetcher;
 use Magento\Framework\App\State;
 use Magento\Framework\Console\Cli;
@@ -15,11 +15,11 @@
 class SynonymDeduplicateCommand extends AbstractStoreCommand
 {
     public function __construct(
-        protected AlgoliaHelper         $algoliaHelper,
-        protected IndexNameFetcher      $indexNameFetcher,
+        protected AlgoliaConnector      $algoliaConnector,
         protected State                 $state,
         protected StoreNameFetcher      $storeNameFetcher,
         protected StoreManagerInterface $storeManager,
+        protected IndexOptionsBuilder   $indexOptionsBuilder,
         ?string                         $name = null
     ) {
         parent::__construct($state, $storeNameFetcher, $name);
@@ -111,8 +111,9 @@ public function dedupeSynonyms(array $storeIds = []): void
     public function dedupeSynonymsForStore(int $storeId): void
     {
         $this->output->writeln('<info>De-duplicating synonyms for ' . $this->storeNameFetcher->getStoreName($storeId) . '...</info>');
-        $indexName = $this->indexNameFetcher->getProductIndexName($storeId);
-        $settings = $this->algoliaHelper->getSettings($indexName);
+
+        $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId);
+        $settings = $this->algoliaConnector->getSettings($indexOptions);
         $deduped = $this->dedupeSpecificSettings(['synonyms', 'altCorrections'], $settings);
 
         //bring over as is (no de-dupe necessary)
@@ -123,9 +124,9 @@ public function dedupeSynonymsForStore(int $storeId): void
         // Updating the synonyms requires a separate endpoint which is not currently not exposed in the PHP API client
         // See https://www.algolia.com/doc/rest-api/search/#tag/Synonyms/operation/saveSynonyms
         // This method will clear and then overwrite ... (does not handle one way synonyms which are not exposed in settings)
-        $this->algoliaHelper->clearSynonyms($indexName);
-        $this->algoliaHelper->setSettings($indexName, $deduped, false, false);
-        $this->algoliaHelper->waitLastTask($indexName);
+        $this->algoliaConnector->clearSynonyms($indexOptions);
+        $this->algoliaConnector->setSettings($indexOptions, $deduped, false, false);
+        $this->algoliaConnector->waitLastTask($storeId);
     }
 
     /**

Helper/AlgoliaHelper.php

@@ -248,9 +248,13 @@ public function deleteRule(
         $this->algoliaConnector->deleteRule($indexOptions, $objectID, $forwardToReplicas);
     }
 
-    public function clearSynonyms(string $indexName, bool $forwardToReplicas = false): void
+    /**
+     * @throws AlgoliaException|NoSuchEntityException
+     */
+    public function clearSynonyms(string $indexName, bool $forwardToReplicas = false, ?int $storeId = null): void
     {
-        $this->client->clearSynonyms($indexName, $forwardToReplicas);
+        $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId);
+        $this->algoliaConnector->clearSynonyms($indexOptions, $forwardToReplicas);
     }
 
     /**

Model/IndexOptions.php

@@ -45,9 +45,9 @@ public function isTemporaryIndex(): bool
     /**
      * Returns the final index name computed by the IndexNameFetcher
      *
-     * @return string
+     * @return string|null
      */
-    public function getIndexName(): string
+    public function getIndexName(): ?string
     {
         return $this->getData(IndexOptionsInterface::INDEX_NAME);
     }

Service/AlgoliaConnector.php

@@ -587,6 +587,14 @@ public function copySynonyms(IndexOptionsInterface $fromIndexOptions, IndexOptio
         $this->setLastOperationInfo($fromIndexOptions, $response);
     }
 
+    /**
+     * @throws AlgoliaException
+     */
+    public function clearSynonyms(IndexOptionsInterface $indexOptions, bool $forwardToReplicas = false): void
+    {
+        $this->getClient($indexOptions->getStoreId())->clearSynonyms($indexOptions->getIndexName(), $forwardToReplicas);
+    }
+
     /**
      * Warning: This method can't be performed across two different applications
      *

Service/Product/IndexOptionsBuilder.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Service\Product;
+
+use Algolia\AlgoliaSearch\Api\Builder\EntityIndexOptionsBuilderInterface;
+use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface;
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
+use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder as BaseIndexOptionsBuilder;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+class IndexOptionsBuilder extends BaseIndexOptionsBuilder implements EntityIndexOptionsBuilderInterface
+{
+    /**
+     * @throws NoSuchEntityException
+     * @throws AlgoliaException
+     */
+    public function buildEntityIndexOptions(int $storeId, ?bool $isTmp = false): IndexOptionsInterface
+    {
+        return $this->buildWithComputedIndex(ProductHelper::INDEX_NAME_SUFFIX, $storeId, $isTmp);
+    }
+}