MAGE-839 Add sanity check to virtual replica flag in sort config

Author: cammonro

Helper/ConfigHelper.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Helper;
 
+use Algolia\AlgoliaSearch\Model\Product\ReplicaManager;
 use Magento;
 use Magento\Customer\Model\ResourceModel\Group\Collection as GroupCollection;
 use Magento\Directory\Model\Currency as DirCurrency;
@@ -1166,7 +1167,7 @@ public function getSortingIndices(
                 $attrsToReturn[] = $attr;
             }
         }
-        
+
         if ($useCache) {
             $this->_sortingIndices[$storeId] = $attrsToReturn;
         }
@@ -1868,7 +1869,7 @@ public function useVirtualReplica(?int $storeId = null): bool
         return (bool) count(array_filter(
             $this->getSorting($storeId),
             function ($sort) {
-                return $sort['virtualReplica'];
+                return $sort[ReplicaManager::SORT_KEY_VIRTUAL_REPLICA];
             }
         ));
     }

Helper/Entity/ProductHelper.php

@@ -15,6 +15,7 @@
 use Algolia\AlgoliaSearch\Helper\Entity\Product\PriceManager;
 use Algolia\AlgoliaSearch\Helper\Image as ImageHelper;
 use Algolia\AlgoliaSearch\Helper\Logger;
+use Algolia\AlgoliaSearch\Model\Product\ReplicaManager;
 use Magento\Bundle\Model\Product\Type as BundleProductType;
 use Magento\Catalog\Model\Product;
 use Magento\Catalog\Model\Product\Attribute\Source\Status;
@@ -1425,7 +1426,7 @@ protected function decorateReplicasSetting(array $sortingIndices): array {
         return array_map(
             function($sort) {
                 $replica = $sort['name'];
-                return !! $sort['virtualReplica']
+                return !! $sort[ReplicaManager::SORT_KEY_VIRTUAL_REPLICA]
                     ? "virtual($replica)"
                     : $replica;
             },

Model/Product/ReplicaManager.php

@@ -37,6 +37,8 @@ class ReplicaManager implements ReplicaManagerInterface
     public const REPLICA_TRANSFORM_MODE_VIRTUAL = 2;
     public const REPLICA_TRANSFORM_MODE_ACTUAL = 3;
 
+    public const SORT_KEY_VIRTUAL_REPLICA = 'virtualReplica';
+
     protected const _DEBUG = true;
 
     protected array $_algoliaReplicaConfig = [];
@@ -151,8 +153,8 @@ function ($sort) use ($mode) {
                 $replica = $sort['name'];
                 if (
                     $mode === self::REPLICA_TRANSFORM_MODE_VIRTUAL
-                    || array_key_exists('virtualReplica', $sort)
-                    && $sort['virtualReplica']
+                    || array_key_exists(self::SORT_KEY_VIRTUAL_REPLICA, $sort)
+                    && $sort[self::SORT_KEY_VIRTUAL_REPLICA]
                     && $mode === self::REPLICA_TRANSFORM_MODE_ACTUAL
                 ) {
                     $replica = "virtual($replica)";
@@ -300,7 +302,8 @@ function($replica) use ($replicas) {
         foreach ($replicaDetails as $replica) {
             $replicaName = $replica['name'];
             // Virtual replicas - relevant sort
-            if ($replica['virtualReplica']) {
+            if (array_key_exists(self::SORT_KEY_VIRTUAL_REPLICA, $replica)
+                && $replica[self::SORT_KEY_VIRTUAL_REPLICA]) {
                 $customRanking = array_key_exists('customRanking', $primaryIndexSettings)
                     ? $primaryIndexSettings['customRanking']
                     : [];

Model/Source/Sorts.php

@@ -2,6 +2,8 @@
 
 namespace Algolia\AlgoliaSearch\Model\Source;
 
+use Algolia\AlgoliaSearch\Model\Product\ReplicaManager;
+
 /**
  * Algolia custom sort order field
  */
@@ -33,7 +35,7 @@ protected function getTableData()
             'sortLabel' => [
                 'label' => 'Label',
             ],
-            'virtualReplica' => [
+            ReplicaManager::SORT_KEY_VIRTUAL_REPLICA => [
                 'label' => 'Enable Virtual Replica?',
                 'values' => ['0' => __('No'), '1' => __('Yes')],
             ],