MAGE-1281 Implement hanlder for conditional replica forwarding

Author: cammonro

Helper/Entity/ProductHelper.php

@@ -12,6 +12,7 @@
 use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder;
 use Algolia\AlgoliaSearch\Service\Product\FacetBuilder;
 use Algolia\AlgoliaSearch\Service\Product\RecordBuilder as ProductRecordBuilder;
+use Algolia\AlgoliaSearch\Service\ReplicaSettingsHandler;
 use Magento\Catalog\Api\Data\ProductInterfaceFactory;
 use Magento\Catalog\Model\Product;
 use Magento\Catalog\Model\Product\Attribute\Source\Status;
@@ -87,6 +88,7 @@ public function __construct(
         protected ProductInterfaceFactory $productFactory,
         protected ProductRecordBuilder    $productRecordBuilder,
         protected FacetBuilder            $facetBuilder,
+        protected ReplicaSettingsHandler  $replicaSettingsHandler,
     )
     {
         parent::__construct($indexNameFetcher);
@@ -316,21 +318,13 @@ public function setSettings(
     ): void {
         $indexSettings = $this->getIndexSettings($storeId);
 
-        $this->algoliaConnector->setSettings(
-            $indexOptions,
-            $indexSettings,
-            false,
-            true
-        );
+        $this->replicaSettingsHandler->setSettings($indexOptions, $indexSettings);
 
         $this->logger->log('Settings: ' . json_encode($indexSettings));
         if ($saveToTmpIndicesToo) {
-
-            $this->algoliaConnector->setSettings(
+            $this->replicaSettingsHandler->setSettings(
                 $indexTmpOptions,
                 $indexSettings,
-                false,
-                true,
                 $indexOptions->getIndexName()
             );
 

Service/ReplicaSettingsHandler.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Service;
+
+use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface;
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+/**
+ *  This class will proxy the settings save operations and forward to replicas based on user configuration
+ *  excluding attributes which should never be forwarded
+ */
+class ReplicaSettingsHandler
+{
+    /**
+     * As replicas are used for sorting we do not want to override these replicas specific configurations
+     */
+    protected const FORWARDING_EXCLUDED_ATTRIBUTES = [
+        'customRanking',
+        'ranking'
+    ];
+
+    public function __construct(
+        protected AlgoliaConnector $connector,
+        protected ConfigHelper $config,
+    ) {}
+
+    /**
+     * @throws NoSuchEntityException
+     * @throws AlgoliaException
+     */
+    public function setSettings(
+        IndexOptionsInterface $indexOptions,
+        array $indexSettings,
+        string $mergeSettingsFrom = ''
+    ): void
+    {
+        if ($this->config->shouldForwardPrimaryIndexSettingsToReplicas($indexOptions->getStoreId())) {
+            [$forward, $noForward] = $this->splitSettings($indexSettings);
+            $this->connector->setSettings(
+                $indexOptions,
+                $forward,
+                true,
+                false
+            );
+            $this->connector->setSettings(
+                $indexOptions,
+                $noForward,
+                false,
+                true,
+                $mergeSettingsFrom
+            );
+        } else {
+            $this->connector->setSettings(
+                $indexOptions,
+                $indexSettings,
+                false,
+                true,
+                $mergeSettingsFrom
+            );
+        }
+    }
+
+    /**
+     * Split settings based on whether they should be forwarded to the replicas
+     * @return array Tuple of settings (to forward and not to forward)
+     */
+    protected function splitSettings(array $settings): array
+    {
+        $excludedKeys = array_flip(self::FORWARDING_EXCLUDED_ATTRIBUTES);
+        return [
+            array_diff_key($settings, $excludedKeys),
+            array_intersect_key($settings, $excludedKeys)
+        ];
+    }
+
+}