MAGETWO-94819: Swatch validation breaks the whole attribute form

fascinosum · fascinosum · commit b33c4b2ccfb7 · 2018-09-18T13:56:47.000-05:00
diff --git a/app/code/Magento/Catalog/Controller/Adminhtml/Product/Attribute/Save.php b/app/code/Magento/Catalog/Controller/Adminhtml/Product/Attribute/Save.php
@@ -14,7 +14,7 @@
 use Magento\Catalog\Controller\Adminhtml\Product\Attribute;
 use Magento\Catalog\Helper\Product;
 use Magento\Catalog\Model\Product\Attribute\Frontend\Inputtype\Presentation;
-use Magento\Catalog\Model\Product\Attribute\Option\OptionsDataSerializer;
+use Magento\Framework\Serialize\Serializer\FormData;
 use Magento\Catalog\Model\Product\AttributeSet\BuildFactory;
 use Magento\Catalog\Model\ResourceModel\Eav\AttributeFactory;
 use Magento\Eav\Model\Adminhtml\System\Config\Source\Inputtype\Validator;
@@ -80,9 +80,9 @@ class Save extends Attribute implements HttpPostActionInterface
     private $presentation;
 
     /**
-     * @var OptionsDataSerializer|null
+     * @var FormData|null
      */
-    private $optionsDataSerializer;
+    private $dataSerializer;
 
     /**
      * @param Context $context
@@ -97,7 +97,7 @@ class Save extends Attribute implements HttpPostActionInterface
      * @param Product $productHelper
      * @param LayoutFactory $layoutFactory
      * @param Presentation|null $presentation
-     * @param OptionsDataSerializer|null $optionsDataSerializer
+     * @param FormData|null $dataSerializer
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -113,7 +113,7 @@ public function __construct(
         Product $productHelper,
         LayoutFactory $layoutFactory,
         Presentation $presentation = null,
-        OptionsDataSerializer $optionsDataSerializer = null
+        FormData $dataSerializer = null
     ) {
         parent::__construct($context, $attributeLabelCache, $coreRegistry, $resultPageFactory);
         $this->buildFactory = $buildFactory;
@@ -124,8 +124,8 @@ public function __construct(
         $this->groupCollectionFactory = $groupCollectionFactory;
         $this->layoutFactory = $layoutFactory;
         $this->presentation = $presentation ?: ObjectManager::getInstance()->get(Presentation::class);
-        $this->optionsDataSerializer = $optionsDataSerializer
-            ?: ObjectManager::getInstance()->get(OptionsDataSerializer::class);
+        $this->dataSerializer = $dataSerializer
+            ?: ObjectManager::getInstance()->get(FormData::class);
     }
 
     /**
@@ -140,7 +140,7 @@ public function __construct(
     public function execute()
     {
         try {
-            $optionData = $this->optionsDataSerializer
+            $optionData = $this->dataSerializer
                 ->unserialize($this->getRequest()->getParam('serialized_options', '[]'));
         } catch (\InvalidArgumentException $e) {
             $message = __("The attribute couldn't be saved due to an error. Verify your information and try again. "
diff --git a/app/code/Magento/Catalog/Controller/Adminhtml/Product/Attribute/Validate.php b/app/code/Magento/Catalog/Controller/Adminhtml/Product/Attribute/Validate.php
@@ -7,7 +7,7 @@
 
 namespace Magento\Catalog\Controller\Adminhtml\Product\Attribute;
 
-use Magento\Catalog\Model\Product\Attribute\Option\OptionsDataSerializer;
+use Magento\Framework\Serialize\Serializer\FormData;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 use Magento\Framework\App\ObjectManager;
@@ -39,9 +39,9 @@ class Validate extends AttributeAction implements HttpGetActionInterface, HttpPo
     private $multipleAttributeList;
 
     /**
-     * @var OptionsDataSerializer|null
+     * @var FormData|null
      */
-    private $optionsDataSerializer;
+    private $dataSerializer;
 
     /**
      * Constructor
@@ -53,7 +53,7 @@ class Validate extends AttributeAction implements HttpGetActionInterface, HttpPo
      * @param \Magento\Framework\Controller\Result\JsonFactory $resultJsonFactory
      * @param \Magento\Framework\View\LayoutFactory $layoutFactory
      * @param array $multipleAttributeList
-     * @param OptionsDataSerializer|null $optionsDataSerializer
+     * @param FormData|null $dataSerializer
      */
     public function __construct(
         \Magento\Backend\App\Action\Context $context,
@@ -63,14 +63,14 @@ public function __construct(
         \Magento\Framework\Controller\Result\JsonFactory $resultJsonFactory,
         \Magento\Framework\View\LayoutFactory $layoutFactory,
         array $multipleAttributeList = [],
-        OptionsDataSerializer $optionsDataSerializer = null
+        FormData $dataSerializer = null
     ) {
         parent::__construct($context, $attributeLabelCache, $coreRegistry, $resultPageFactory);
         $this->resultJsonFactory = $resultJsonFactory;
         $this->layoutFactory = $layoutFactory;
         $this->multipleAttributeList = $multipleAttributeList;
-        $this->optionsDataSerializer = $optionsDataSerializer ?: ObjectManager::getInstance()
-            ->get(OptionsDataSerializer::class);
+        $this->dataSerializer = $dataSerializer ?: ObjectManager::getInstance()
+            ->get(FormData::class);
     }
 
     /**
@@ -85,7 +85,7 @@ public function execute()
         $response = new DataObject();
         $response->setError(false);
         try {
-            $optionsData = $this->optionsDataSerializer
+            $optionsData = $this->dataSerializer
                 ->unserialize($this->getRequest()->getParam('serialized_options', '[]'));
         } catch (\InvalidArgumentException $e) {
             $message = __("The attribute couldn't be validated due to an error. Verify your information and try again. "
diff --git a/app/code/Magento/Catalog/Model/Product/Attribute/Option/OptionsDataSerializer.php b/app/code/Magento/Catalog/Model/Product/Attribute/Option/OptionsDataSerializer.php
diff --git a/app/code/Magento/Catalog/Test/Unit/Controller/Adminhtml/Product/Attribute/SaveTest.php b/app/code/Magento/Catalog/Test/Unit/Controller/Adminhtml/Product/Attribute/SaveTest.php
@@ -7,7 +7,7 @@
 
 use Magento\Catalog\Api\Data\ProductAttributeInterface;
 use Magento\Catalog\Controller\Adminhtml\Product\Attribute\Save;
-use Magento\Catalog\Model\Product\Attribute\Option\OptionsDataSerializer;
+use Magento\Framework\Serialize\Serializer\FormData;
 use Magento\Catalog\Test\Unit\Controller\Adminhtml\Product\AttributeTest;
 use Magento\Catalog\Model\Product\AttributeSet\BuildFactory;
 use Magento\Catalog\Model\Product\AttributeSet\Build;
@@ -85,9 +85,9 @@ class SaveTest extends AttributeTest
     protected $inputTypeValidatorMock;
 
     /**
-     * @var OptionsDataSerializer|\PHPUnit_Framework_MockObject_MockObject
+     * @var FormData|\PHPUnit_Framework_MockObject_MockObject
      */
-    private $optionsDataSerializerMock;
+    private $dataSerializerMock;
 
     /**
      * @var ProductAttributeInterface|\PHPUnit_Framework_MockObject_MockObject
@@ -135,7 +135,7 @@ protected function setUp()
         $this->inputTypeValidatorMock = $this->getMockBuilder(InputTypeValidator::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $this->optionsDataSerializerMock = $this->getMockBuilder(OptionsDataSerializer::class)
+        $this->dataSerializerMock = $this->getMockBuilder(FormData::class)
             ->disableOriginalConstructor()
             ->getMock();
         $this->productAttributeMock = $this->getMockBuilder(ProductAttributeInterface::class)
@@ -170,7 +170,7 @@ protected function getModel()
             'validatorFactory' => $this->validatorFactoryMock,
             'groupCollectionFactory' => $this->groupCollectionFactoryMock,
             'layoutFactory' => $this->layoutFactoryMock,
-            'optionsDataSerializer' => $this->optionsDataSerializerMock,
+            'dataSerializer' => $this->dataSerializerMock,
         ]);
     }
 
@@ -182,7 +182,7 @@ public function testExecuteWithEmptyData()
                 ['isAjax', null, null],
                 ['serialized_options', '[]', ''],
             ]);
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with('')
@@ -213,7 +213,7 @@ public function testExecute()
                 ['isAjax', null, null],
                 ['serialized_options', '[]', ''],
             ]);
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with('')
@@ -273,7 +273,7 @@ public function testExecuteWithOptionsDataError()
                 ['isAjax', null, true],
                 ['serialized_options', '[]', $serializedOptions],
             ]);
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with($serializedOptions)
diff --git a/app/code/Magento/Catalog/Test/Unit/Controller/Adminhtml/Product/Attribute/ValidateTest.php b/app/code/Magento/Catalog/Test/Unit/Controller/Adminhtml/Product/Attribute/ValidateTest.php
@@ -6,7 +6,7 @@
 namespace Magento\Catalog\Test\Unit\Controller\Adminhtml\Product\Attribute;
 
 use Magento\Catalog\Controller\Adminhtml\Product\Attribute\Validate;
-use Magento\Catalog\Model\Product\Attribute\Option\OptionsDataSerializer;
+use Magento\Framework\Serialize\Serializer\FormData;
 use Magento\Catalog\Model\ResourceModel\Eav\Attribute;
 use Magento\Catalog\Test\Unit\Controller\Adminhtml\Product\AttributeTest;
 use Magento\Eav\Model\Entity\Attribute\Set as AttributeSet;
@@ -63,9 +63,9 @@ class ValidateTest extends AttributeTest
     protected $layoutMock;
 
     /**
-     * @var OptionsDataSerializer|\PHPUnit_Framework_MockObject_MockObject
+     * @var FormData|\PHPUnit_Framework_MockObject_MockObject
      */
-    private $optionsDataSerializerMock;
+    private $dataSerializerMock;
 
     protected function setUp()
     {
@@ -92,7 +92,7 @@ protected function setUp()
             ->getMock();
         $this->layoutMock = $this->getMockBuilder(LayoutInterface::class)
             ->getMockForAbstractClass();
-        $this->optionsDataSerializerMock = $this->getMockBuilder(OptionsDataSerializer::class)
+        $this->dataSerializerMock = $this->getMockBuilder(FormData::class)
             ->disableOriginalConstructor()
             ->getMock();
 
@@ -116,7 +116,7 @@ protected function getModel()
                 'resultJsonFactory' => $this->resultJsonFactoryMock,
                 'layoutFactory' => $this->layoutFactoryMock,
                 'multipleAttributeList' => ['select' => 'option'],
-                'optionsDataSerializer' => $this->optionsDataSerializerMock,
+                'dataSerializer' => $this->dataSerializerMock,
             ]
         );
     }
@@ -184,7 +184,7 @@ public function testUniqueValidation(array $options, $isError)
                 ['serialized_options', '[]', $serializedOptions],
             ]);
 
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with($serializedOptions)
@@ -319,7 +319,7 @@ public function testEmptyOption(array $options, $result)
                 ['serialized_options', '[]', $serializedOptions],
             ]);
 
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with($serializedOptions)
@@ -431,7 +431,7 @@ public function testExecuteWithOptionsDataError()
                 ['serialized_options', '[]', $serializedOptions],
             ]);
 
-        $this->optionsDataSerializerMock
+        $this->dataSerializerMock
             ->expects($this->once())
             ->method('unserialize')
             ->with($serializedOptions)
diff --git a/lib/internal/Magento/Framework/Serialize/Serializer/FormData.php b/lib/internal/Magento/Framework/Serialize/Serializer/FormData.php
@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Framework\Serialize\Serializer;
+
+/**
+ * Class for processing of serialized form data.
+ */
+class FormData
+{
+    /**
+     * @var Json
+     */
+    private $serializer;
+
+    /**
+     * @param Json $serializer
+     */
+    public function __construct(Json $serializer)
+    {
+        $this->serializer = $serializer;
+    }
+
+    /**
+     * Provides form data from the serialized data.
+     *
+     * @param string $serializedData
+     * @return array
+     * @throws \InvalidArgumentException
+     */
+    public function unserialize(string $serializedData): array
+    {
+        $encodedFields = $this->serializer->unserialize($serializedData);
+
+        if (!is_array($encodedFields)) {
+            throw new \InvalidArgumentException('Unable to unserialize value.');
+        }
+
+        $formData = [];
+        foreach ($encodedFields as $item) {
+            $decodedFieldData = [];
+            parse_str($item, $decodedFieldData);
+            $formData = array_replace_recursive($formData, $decodedFieldData);
+        }
+
+        return $formData;
+    }
+}
