MAGE-838 Add reversion for bad sorting config

Author: cammonro

Helper/ConfigHelper.php

@@ -443,6 +443,10 @@ public function getAutocompleteSections($storeId = null)
         return [];
     }
 
+    protected function serialize(array $value): string {
+        return $this->serializer->serialize($value);
+    }
+
     /**
      * @param $value
      * @return array|bool|float|int|mixed|string|null
@@ -1119,6 +1123,22 @@ public function getRawSortingValue($storeId = null)
         );
     }
 
+    /**
+     * @param array $sorting
+     * @param string|null $scope
+     * @param int|null $scopeId
+     * @return void
+     */
+    public function setSorting(array $sorting, ?string $scope = null, ?int $scopeId = null): void
+    {
+        $this->configWriter->save(
+            self::SORTING_INDICES,
+            $this->serialize($sorting),
+            $scope,
+            $scopeId
+        );
+    }
+
     /**
      * @param $storeId
      * @return string

Model/Backend/Sorts.php

@@ -48,6 +48,10 @@ public function __construct(
      */
     public function afterSave(): \Magento\Framework\App\Config\Value
     {
+        // Save context of the admin operation for possible state reversion
+        $this->replicaState->setParentScope($this->getScope());
+        $this->replicaState->setParentScopeId($this->getScopeId());
+
         $storeIds = $this->configChecker->getAffectedStoreIds(
             $this->getPath(),
             $this->getScope(),

Model/Product/ReplicaManager.php

@@ -275,8 +275,10 @@ protected function isReplicaConfigurationValid(string $primaryIndexName, int $st
         $sortingIndices = $this->configHelper->getSortingIndices($primaryIndexName, $storeId);
         $validator = $this->validatorFactory->create();
         if (!$validator->isReplicaConfigurationValid($sortingIndices)) {
-            $postfix = "Please note that there can be no more than " . $this->getMaxVirtualReplicasPerIndex() . " virtual replicas per index. Reverting to previous configuration.";
-            // TODO: Implement revert settings via ReplicaState
+            $postfix = "Please note that there can be no more than " . $this->getMaxVirtualReplicasPerIndex() . " virtual replicas per index.";
+            if ($this->revertReplicaConfig($storeId)) {
+                $postfix .= ' Reverting to previous configuration.';
+            }
             if ($validator->isTooManyCustomerGroups()) {
                 throw (new TooManyCustomerGroupsAsReplicasException(__("You have too many customer groups to enable virtual replicas on the pricing sort. $postfix")))
                     ->withReplicaCount($validator->getReplicaCount())
@@ -290,6 +292,20 @@ protected function isReplicaConfigurationValid(string $primaryIndexName, int $st
         return true;
     }
 
+    protected function revertReplicaConfig(int $storeId): bool
+    {
+        if ($ogConfig = $this->replicaState->getOriginalSortConfiguration($storeId)) {
+            $this->configHelper->setSorting(
+                $ogConfig,
+                $this->replicaState->getParentScope(),
+                $this->replicaState->getParentScopeId()
+            );
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * @param string[] $replicas
      * @return string[]

Registry/ReplicaState.php

@@ -13,7 +13,28 @@ class ReplicaState
     private array $_scopeConfigurationOld = [];
 
     private array $_scopeConfigurationNew = [];
-    
+
+    private ?string $_parentScope = null;
+    private ?int $_parentScopeId = null;
+
+    public function getParentScope(): ?string
+    {
+        return $this->_parentScope;
+    }
+
+    public function setParentScope(string $scope) {
+        $this->_parentScope = $scope;
+    }
+
+    public function getParentScopeId(): ?int
+    {
+        return $this->_parentScopeId;
+    }
+
+    public function setParentScopeId(int $scopeId) {
+        $this->_parentScopeId = $scopeId;
+    }
+
     public function getOriginalSortConfiguration(int $storeId): array
     {
         return $this->_scopeConfigurationOld[$storeId] ?? [];