Merge pull request #1031 from magento-falcons/MAGETWO-67357

[Falcons] Delivery of deployment improvements

Author: Yaroslav Onischenko

app/code/Magento/Config/Console/Command/ConfigSet/DefaultProcessor.php

@@ -7,12 +7,11 @@
 
 use Magento\Config\App\Config\Type\System;
 use Magento\Config\Console\Command\ConfigSetCommand;
-use Magento\Config\Model\Config;
-use Magento\Config\Model\ConfigFactory;
 use Magento\Framework\App\Config\ConfigPathResolver;
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Exception\CouldNotSaveException;
-use Magento\Store\Model\ScopeInterface;
+use Magento\Config\Model\PreparedValueFactory;
+use Magento\Framework\App\Config\Value;
 
 /**
  * Processes default flow of config:set command.
@@ -22,14 +21,6 @@
  */
 class DefaultProcessor implements ConfigSetProcessorInterface
 {
-    /**
-     * The factory that creates config model instances.
-     *
-     * @see Config
-     * @var ConfigFactory
-     */
-    private $configFactory;
-
     /**
      * The deployment configuration reader.
      *
@@ -45,16 +36,23 @@ class DefaultProcessor implements ConfigSetProcessorInterface
     private $configPathResolver;
 
     /**
-     * @param ConfigFactory $configFactory The factory that creates config model instances
+     * The factory for prepared value.
+     *
+     * @var PreparedValueFactory
+     */
+    private $preparedValueFactory;
+
+    /**
+     * @param PreparedValueFactory $preparedValueFactory The factory for prepared value
      * @param DeploymentConfig $deploymentConfig The deployment configuration reader
      * @param ConfigPathResolver $configPathResolver The resolver for configuration paths according to source type
      */
     public function __construct(
-        ConfigFactory $configFactory,
+        PreparedValueFactory $preparedValueFactory,
         DeploymentConfig $deploymentConfig,
         ConfigPathResolver $configPathResolver
     ) {
-        $this->configFactory = $configFactory;
+        $this->preparedValueFactory = $preparedValueFactory;
         $this->deploymentConfig = $deploymentConfig;
         $this->configPathResolver = $configPathResolver;
     }
@@ -87,17 +85,12 @@ public function process($path, $value, $scope, $scopeCode)
         }
 
         try {
-            /** @var Config $config */
-            $config = $this->configFactory->create();
-            $config->setDataByPath($path, $value);
-
-            if (in_array($scope, [ScopeInterface::SCOPE_WEBSITE, ScopeInterface::SCOPE_WEBSITES])) {
-                $config->setWebsite($scopeCode);
-            } elseif (in_array($scope, [ScopeInterface::SCOPE_STORE, ScopeInterface::SCOPE_STORES])) {
-                $config->setStore($scopeCode);
+            /** @var Value $backendModel */
+            $backendModel = $this->preparedValueFactory->create($path, $value, $scope, $scopeCode);
+            if ($backendModel instanceof Value) {
+                $resourceModel = $backendModel->getResource();
+                $resourceModel->save($backendModel);
             }
-
-            $config->save();
         } catch (\Exception $exception) {
             throw new CouldNotSaveException(__('%1', $exception->getMessage()), $exception);
         }

app/code/Magento/Config/Console/Command/ConfigSet/LockProcessor.php

@@ -22,28 +22,28 @@
 class LockProcessor implements ConfigSetProcessorInterface
 {
     /**
-     * The factory for prepared value.
+     * The factory for prepared value
      *
      * @var PreparedValueFactory
      */
     private $preparedValueFactory;
 
     /**
-     * The deployment configuration writer.
+     * The deployment configuration writer
      *
      * @var DeploymentConfig\Writer
      */
     private $deploymentConfigWriter;
 
     /**
-     * An array manager for different manipulations with arrays.
+     * An array manager for different manipulations with arrays
      *
      * @var ArrayManager
      */
     private $arrayManager;
 
     /**
-     * The resolver for configuration paths according to source type.
+     * The resolver for configuration paths according to source type
      *
      * @var ConfigPathResolver
      */

app/code/Magento/Config/Console/Command/ConfigShow/ValueProcessor.php

@@ -13,6 +13,7 @@
 use Magento\Framework\App\Config\Value;
 use Magento\Framework\App\Config\ValueFactory;
 use Magento\Framework\Config\ScopeInterface;
+use Magento\Framework\Serialize\Serializer\Json as JsonSerializer;
 
 /**
  * Class processes values using backend model which declared in system.xml.
@@ -46,18 +47,29 @@ class ValueProcessor
     private $scope;
 
     /**
-     * @param ScopeInterface $scope
-     * @param StructureFactory $structureFactory
-     * @param ValueFactory $valueFactory
+     * The json serializer.
+     *
+     * @var JsonSerializer
+     */
+    private $jsonSerializer;
+
+    /**
+     * @param ScopeInterface $scope The object for managing configuration scope
+     * @param StructureFactory $structureFactory The system configuration structure factory.
+     * @param ValueFactory $valueFactory The factory of object that
+     *        implement \Magento\Framework\App\Config\ValueInterface
+     * @param JsonSerializer $jsonSerializer The json serializer
      */
     public function __construct(
         ScopeInterface $scope,
         StructureFactory $structureFactory,
-        ValueFactory $valueFactory
+        ValueFactory $valueFactory,
+        JsonSerializer $jsonSerializer
     ) {
         $this->scope = $scope;
         $this->configStructureFactory = $structureFactory;
         $this->configValueFactory = $valueFactory;
+        $this->jsonSerializer = $jsonSerializer;
     }
 
     /**
@@ -78,7 +90,7 @@ public function process($scope, $scopeCode, $value, $path)
         $this->scope->setCurrentScope($areaScope);
 
         /** @var Field $field */
-        $field = $configStructure->getElement($path);
+        $field = $configStructure->getElementByConfigPath($path);
 
         /** @var Value $backendModel */
         $backendModel = $field && $field->hasBackendModel()
@@ -94,7 +106,12 @@ public function process($scope, $scopeCode, $value, $path)
         $backendModel->setScopeId($scopeCode);
         $backendModel->setValue($value);
         $backendModel->afterLoad();
+        $processedValue = $backendModel->getValue();
 
-        return $backendModel->getValue();
+        /**
+         * If $processedValue is array it means that $value is json array (string).
+         * It should be converted to string for displaying.
+         */
+        return is_array($processedValue) ? $this->jsonSerializer->serialize($processedValue) : $processedValue;
     }
 }

app/code/Magento/Config/Model/Config/Structure.php

@@ -7,6 +7,37 @@
 
 /**
  * System configuration structure.
+ *
+ * All paths are declared in module's system.xml.
+ *
+ * ```xml
+ * <section id="section_id">
+ *      <group id="group_id" ...>
+ *          <field id="field_one_id" ...>
+ *              <label>Field One</label>
+ *              ...
+ *          </field>
+ *          <field id="field_two_id" ...>
+ *              <label>Field Two</label>
+ *              <config_path>section/group/field</config_path>
+ *              ...
+ *          </field>
+ *      </group>
+ * </section>
+ * ```
+ *
+ * Structure path is the nested path of node ids (section, group, field).
+ *
+ * Config path is the path which is declared in <config_path> node.
+ * If this node is not provided then config path is the same as structure path.
+ *
+ * With the example above you can see that the field <field id="field_one_id"> has the next paths:
+ *  - the structure path section_id/group_id/field_one_id
+ *  - the configuration path section_id/group_id/field_one_id
+ *
+ * Also you can see that the field <field id="field_two_id"> has the next paths:
+ * - the structure path section_id/group_id/field_two_id
+ * - the configuration path section/group/field
  */
 class Structure implements \Magento\Config\Model\Config\Structure\SearchInterface
 {
@@ -57,6 +88,24 @@ class Structure implements \Magento\Config\Model\Config\Structure\SearchInterfac
      */
     protected $sectionList;
 
+    /**
+     * Collects config paths and their structure paths from configuration files
+     *
+     * For example:
+     * ```php
+     * [
+     *  'section_id/group_id/field_one_id' => [
+     *      'section_id/group_id/field_one_id'
+     *  ],
+     * 'section/group/field' => [
+     *      'section_id/group_id/field_two_id'
+     * ]
+     * ```
+     *
+     * @var array
+     */
+    private $mappedPaths;
+
     /**
      * @param \Magento\Config\Model\Config\Structure\Data $structureData
      * @param \Magento\Config\Model\Config\Structure\Element\Iterator\Tab $tabIterator
@@ -114,16 +163,33 @@ public function getSectionList()
     }
 
     /**
-     * Find element by path
+     * Find element by structure path
      *
-     * @param string $path
+     * @param string $path The structure path
      * @return \Magento\Config\Model\Config\Structure\ElementInterface|null
      */
     public function getElement($path)
     {
         return $this->getElementByPathParts(explode('/', $path));
     }
 
+    /**
+     * Find element by config path
+     *
+     * @param string $path The configuration path
+     * @return \Magento\Config\Model\Config\Structure\ElementInterface|null
+     */
+    public function getElementByConfigPath($path)
+    {
+        $allPaths = $this->getFieldPaths();
+
+        if (isset($allPaths[$path])) {
+            $path = array_shift($allPaths[$path]);
+        }
+
+        return $this->getElementByPathParts(explode('/', $path));
+    }
+
     /**
      * Retrieve first available section in config structure
      *
@@ -291,7 +357,11 @@ public function getFieldPaths()
     {
         $sections = !empty($this->_data['sections']) ? $this->_data['sections'] : [];
 
-        return $this->getFieldsRecursively($sections);
+        if (!$this->mappedPaths) {
+            $this->mappedPaths = $this->getFieldsRecursively($sections);
+        }
+
+        return $this->mappedPaths;
     }
 
     /**

app/code/Magento/Config/Model/PreparedValueFactory.php

@@ -12,6 +12,7 @@
 use Magento\Framework\App\Config\ValueInterface;
 use Magento\Framework\App\Config\Value;
 use Magento\Framework\App\ScopeInterface;
+use Magento\Store\Model\ScopeInterface as StoreScopeInterface;
 use Magento\Framework\App\ScopeResolverPool;
 use Magento\Framework\Exception\RuntimeException;
 
@@ -87,7 +88,7 @@ public function create($path, $value, $scope, $scopeCode = null)
             /** @var Structure $structure */
             $structure = $this->structureFactory->create();
             /** @var Structure\ElementInterface $field */
-            $field = $structure->getElement($path);
+            $field = $structure->getElementByConfigPath($path);
             $configPath = $path;
             /** @var string $backendModelName */
             if ($field instanceof Structure\Element\Field && $field->hasBackendModel()) {
@@ -105,6 +106,12 @@ public function create($path, $value, $scope, $scopeCode = null)
             if ($backendModel instanceof Value) {
                 $scopeId = 0;
 
+                if (in_array($scope, [StoreScopeInterface::SCOPE_WEBSITE, StoreScopeInterface::SCOPE_WEBSITES])) {
+                    $scope = StoreScopeInterface::SCOPE_WEBSITES;
+                } elseif (in_array($scope, [StoreScopeInterface::SCOPE_STORE, StoreScopeInterface::SCOPE_STORES])) {
+                    $scope = StoreScopeInterface::SCOPE_STORES;
+                }
+
                 if ($scope !== ScopeInterface::SCOPE_DEFAULT) {
                     $scopeResolver = $this->scopeResolverPool->get($scope);
                     $scopeId = $scopeResolver->getScope($scopeCode)->getId();