MAGE-1044 Add virtual replica test

Author: cammonro

Service/Product/ReplicaManager.php

@@ -133,12 +133,14 @@ protected function clearAlgoliaReplicaSettingCache($primaryIndexName = null): vo
      * relevant to the Magento integration
      *
      * @param string $primaryIndexName
+     * @param bool $refreshCache
      * @return string[] Array of replica index names
      * @throws LocalizedException
+     * @throws NoSuchEntityException
      */
-    protected function getMagentoReplicaConfigurationFromAlgolia(string $primaryIndexName): array
+    protected function getMagentoReplicaConfigurationFromAlgolia(string $primaryIndexName, bool $refreshCache = false): array
     {
-        $algoliaReplicas = $this->getReplicaConfigurationFromAlgolia($primaryIndexName);
+        $algoliaReplicas = $this->getReplicaConfigurationFromAlgolia($primaryIndexName, $refreshCache);
         $magentoReplicas = $this->getMagentoReplicaSettings($primaryIndexName, $algoliaReplicas);
         return array_values(array_intersect($magentoReplicas, $algoliaReplicas));
     }
@@ -241,7 +243,7 @@ protected function setReplicasOnPrimaryIndex(int $storeId): array
         $indexName = $this->indexNameFetcher->getProductIndexName($storeId);
         $sortingIndices = $this->sortingTransformer->getSortingIndices($storeId);
         $newMagentoReplicasSetting = $this->sortingTransformer->transformSortingIndicesToReplicaSetting($sortingIndices);
-        $oldMagentoReplicasSetting = $this->getMagentoReplicaConfigurationFromAlgolia($indexName);
+        $oldMagentoReplicasSetting = $this->getMagentoReplicaConfigurationFromAlgolia($indexName, true);
         $nonMagentoReplicasSetting = $this->getNonMagentoReplicaConfigurationFromAlgolia($indexName);
         $oldMagentoReplicaIndices = $this->getBareIndexNamesFromReplicaSetting($oldMagentoReplicasSetting);
         $newMagentoReplicaIndices = $this->getBareIndexNamesFromReplicaSetting($newMagentoReplicasSetting);

Test/Integration/Product/ReplicaIndexingTest.php

@@ -59,10 +59,11 @@ protected function assertSortingAttribute($sortAttr, $sortDir): void
 
     protected function assertNoSortingAttribute($sortAttr, $sortDir): void
     {
-        $this->assertTrue(!$this->hasSortingAttribute($sortAttr, $sortDir));
+        $this->assertFalse($this->hasSortingAttribute($sortAttr, $sortDir));
     }
 
-    public function testReplicaLimits() {
+    public function testReplicaLimits()
+    {
         $this->assertEquals(20, $this->replicaManager->getMaxVirtualReplicasPerIndex());
     }
 
@@ -85,14 +86,8 @@ public function testStandardReplicaConfig(): void
 
         $sortIndexName = $indexName . '_' . $sortAttr . '_' . $sortDir;
 
-        $this->assertTrue(
-            (bool) array_filter(
-                $currentSettings['replicas'],
-                function($replica) use ($sortIndexName) {
-                    return str_contains($replica, $sortIndexName);
-                }
-            )
-        );
+        $this->assertTrue($this->isStandardReplica($currentSettings['replicas'], $sortIndexName));
+        $this->assertFalse($this->isVirtualReplica($currentSettings['replicas'], $sortIndexName));
 
         // Assert replica index created
         $replicaSettings = $this->algoliaHelper->getSettings($sortIndexName);
@@ -111,6 +106,11 @@ function($replica) use ($sortIndexName) {
      */
     public function testVirtualReplicaConfig(): void
     {
+        $indexName = $this->getIndexName('default_');
+        $ogAlgoliaSettings = $this->algoliaHelper->getSettings($indexName);
+
+        $this->assertFalse(array_key_exists('replicas', $ogAlgoliaSettings));
+
         $productHelper = $this->objectManager->get(ProductHelper::class);
         $sortAttr = 'color';
         $sortDir = 'asc';
@@ -121,9 +121,10 @@ public function testVirtualReplicaConfig(): void
 
         $sorting = $this->configHelper->getSorting();
         $sorting[] = [
-            'attribute' => $sortAttr,
-            'sort' => $sortDir,
-            'sortLabel' => $sortAttr
+            'attribute'      => $sortAttr,
+            'sort'           => $sortDir,
+            'sortLabel'      => $sortAttr,
+            'virtualReplica' => 1
         ];
         $this->configHelper->setSorting($sorting);
 
@@ -133,6 +134,56 @@ public function testVirtualReplicaConfig(): void
 
         $this->assertSortingAttribute($sortAttr, $sortDir);
 
+        // Cannot use config fixture because we have disabled db isolation
+        $this->setConfig('algoliasearch_instant/instant/is_instant_enabled', 1);
+
+        $this->indicesConfigurator->saveConfigurationToAlgolia(1);
+        $this->algoliaHelper->waitLastTask();
+
+        // Assert replica config created
+        $currentSettings = $this->algoliaHelper->getSettings($indexName);
+        $this->assertArrayHasKey('replicas', $currentSettings);
+
+        $sortIndexName = $indexName . '_' . $sortAttr . '_' . $sortDir;
+
+        $this->assertTrue($this->isVirtualReplica($currentSettings['replicas'], $sortIndexName));
+        $this->assertFalse($this->isStandardReplica($currentSettings['replicas'], $sortIndexName));
+
+        // Assert replica index created
+        $replicaSettings = $this->algoliaHelper->getSettings($sortIndexName);
+        $this->assertArrayHasKey('primary', $replicaSettings);
+        $this->assertEquals($indexName, $replicaSettings['primary']);
+
+        // Restore prior state (for this test only)
+        $this->algoliaHelper->setSettings($indexName, $ogAlgoliaSettings);
+        $this->setConfig('algoliasearch_instant/instant/is_instant_enabled', 0);
+
+    }
+
+    /**
+     * @param string[] $replicaSetting
+     * @param string $replicaIndexName
+     * @return bool
+     */
+    protected function isVirtualReplica(array $replicaSetting, string $replicaIndexName): bool
+    {
+        return (bool) array_filter(
+            $replicaSetting,
+            function ($replica) use ($replicaIndexName) {
+                return str_contains($replica, "virtual($replicaIndexName)");
+            }
+        );
+    }
+
+    protected function isStandardReplica(array $replicaSetting, string $replicaIndexName): bool
+    {
+        return (bool) array_filter(
+            $replicaSetting,
+            function ($replica) use ($replicaIndexName) {
+                $regex = '/^' . preg_quote($replicaIndexName) . '$/';
+                return preg_match($regex, $replica);
+            }
+        );
     }
 
     public function tearDown(): void