MAGE-848 Clearly identify legacy virtual replica configuration path

Author: cammonro

Console/Command/ReplicaDisableVirtualCommand.php

@@ -111,7 +111,7 @@ protected function disableVirtualReplicasForStore(int $storeId): bool
         $isStoreScoped = false;
 
         if ($this->configChecker->isSettingAppliedForScopeAndCode(
-            ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED,
+            ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED,
             ScopeInterface::SCOPE_STORES,
             $storeId)
         ) {
@@ -138,7 +138,7 @@ protected function disableVirtualReplicasForStore(int $storeId): bool
 
     protected function disableVirtualReplicasForAllStores(): void
     {
-        $this->configChecker->checkAndApplyAllScopes(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, [$this, 'removeLegacyVirtualReplicaConfig']);
+        $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, [$this, 'removeLegacyVirtualReplicaConfig']);
 
         $this->configChecker->checkAndApplyAllScopes(ConfigHelper::SORTING_INDICES, [$this, 'disableVirtualReplicaSortConfig']);
 
@@ -149,12 +149,12 @@ protected function disableVirtualReplicasForAllStores(): void
 
     public function removeLegacyVirtualReplicaConfig(string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, int $scopeId = 0): void
     {
-        $value = $this->scopeConfig->getValue(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
+        $value = $this->scopeConfig->getValue(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
         if (is_null($value)) {
             return;
         }
-        $this->output->writeln("<info>Removing legacy configuration " . ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED . " for $scope scope" . ($scope != ScopeConfigInterface::SCOPE_TYPE_DEFAULT ? " (ID=$scopeId)" : "") . "</info>");
-        $this->configWriter->delete(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
+        $this->output->writeln("<info>Removing legacy configuration " . ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED . " for $scope scope" . ($scope != ScopeConfigInterface::SCOPE_TYPE_DEFAULT ? " (ID=$scopeId)" : "") . "</info>");
+        $this->configWriter->delete(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
     }
 
     public function disableVirtualReplicaSortConfig(string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, int $scopeId = 0): void

Helper/ConfigHelper.php

@@ -141,7 +141,7 @@ class ConfigHelper
     protected const IS_LOOKING_SIMILAR_ENABLED_IN_PDP = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_pdp';
     protected const IS_LOOKING_SIMILAR_ENABLED_IN_SHOPPING_CART = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_cart_page';
     protected const LOOKING_SIMILAR_TITLE = 'algoliasearch_recommend/recommend/looking_similar/title';
-    public const USE_VIRTUAL_REPLICA_ENABLED = 'algoliasearch_instant/instant/use_virtual_replica'; //legacy config
+    public const LEGACY_USE_VIRTUAL_REPLICA_ENABLED = 'algoliasearch_instant/instant/use_virtual_replica'; 
     protected const AUTOCOMPLETE_KEYBORAD_NAVIAGATION = 'algoliasearch_autocomplete/autocomplete/navigator';
     protected const FREQUENTLY_BOUGHT_TOGETHER_TITLE = 'algoliasearch_recommend/recommend/frequently_bought_together/title';
     protected const RELATED_PRODUCTS_TITLE = 'algoliasearch_recommend/recommend/related_product/title';

Setup/Patch/Data/MigrateVirtualReplicaConfigPatch.php

@@ -47,7 +47,7 @@ public function apply(): PatchInterface
     {
         $this->moduleDataSetup->getConnection()->startSetup();
 
-        $this->configChecker->checkAndApplyAllScopes(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, [$this, 'migrateSetting']);
+        $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, [$this, 'migrateSetting']);
 
         $this->moduleDataSetup->getConnection()->endSetup();
 
@@ -65,14 +65,14 @@ public function apply(): PatchInterface
     public function migrateSetting(string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, int $scopeId = 0): void
     {
         // If not enabled - delete this old setting and move on...
-        if (!$this->scopeConfig->isSetFlag(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId)) {
+        if (!$this->scopeConfig->isSetFlag(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId)) {
             $this->deleteLegacyConfig($scope, $scopeId);
             return;
         }
 
         // Get all stores affected by this configuration
         $storeIds = $this->configChecker->getAffectedStoreIds(
-            ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED,
+            ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED,
             $scope,
             $scopeId
         );
@@ -126,7 +126,7 @@ public function migrateSetting(string $scope = ScopeConfigInterface::SCOPE_TYPE_
 
     protected function deleteLegacyConfig($scope, $scopeId): void
     {
-        $this->configWriter->delete(ConfigHelper::USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
+        $this->configWriter->delete(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $scope, $scopeId);
     }
 
     protected function simulateFullVirtualReplicas(string $scope, int $scopeId): array