Merge pull request #1469 from magento-engcom/develop-prs

[EngCom] Public Pull Requests - MAGETWO-72390: Remove the usage of the DataObject for response management #10808 - MAGETWO-71545: Added 'application/json' Content-Type to Ajax responses in the Magento_UI module. #10521 - MAGETWO-72388: Fix spelling mistake in AddressTest.php #10806 - MAGETWO-72283: Code generate: support variadic parameter #10771
magento · Sep 8, 2017 · 7b6e2a0 · 7b6e2a0
2 parents 5973d67 + aa2915b
commit 7b6e2a0
Show file tree

Hide file tree

Showing 15 changed files with 295 additions and 12 deletions.
diff --git a/app/code/Magento/Catalog/Controller/Adminhtml/Category/Validate.php b/app/code/Magento/Catalog/Controller/Adminhtml/Category/Validate.php
@@ -36,11 +36,8 @@ public function __construct(
      */
     public function execute()
     {
-        $response = new \Magento\Framework\DataObject();
-        $response->setError(0);
-
         $resultJson = $this->resultJsonFactory->create();
-        $resultJson->setData($response);
+        $resultJson->setData(['error' => 0]);
 
         return $resultJson;
     }

diff --git a/app/code/Magento/Customer/Test/Unit/Model/AddressTest.php b/app/code/Magento/Customer/Test/Unit/Model/AddressTest.php
@@ -82,7 +82,7 @@ public function testCustomerId()
 
     public function testCustomer()
     {
-        $this->address->unsetData('cusomer_id');
+        $this->address->unsetData('customer_id');
         $this->assertFalse($this->address->getCustomer());
 
         $this->address->setCustomerId(self::ORIG_CUSTOMER_ID);

diff --git a/app/code/Magento/Ui/Controller/Adminhtml/Index/Render.php b/app/code/Magento/Ui/Controller/Adminhtml/Index/Render.php
@@ -9,12 +9,32 @@
 use Magento\Ui\Controller\Adminhtml\AbstractAction;
 use Magento\Framework\View\Element\UiComponentFactory;
 use Magento\Framework\View\Element\UiComponentInterface;
+use Magento\Ui\Model\UiComponentTypeResolver;
 
 /**
  * Class Render
  */
 class Render extends AbstractAction
 {
+    /**
+     * @var \Magento\Ui\Model\UiComponentTypeResolver
+     */
+    private $contentTypeResolver;
+
+    /**
+     * @param Context $context
+     * @param UiComponentFactory $factory
+     * @param UiComponentTypeResolver $contentTypeResolver
+     */
+    public function __construct(
+        Context $context,
+        UiComponentFactory $factory,
+        UiComponentTypeResolver $contentTypeResolver
+    ) {
+        parent::__construct($context, $factory);
+        $this->contentTypeResolver = $contentTypeResolver;
+    }
+
     /**
      * Action for AJAX request
      *
@@ -27,9 +47,12 @@ public function execute()
             return;
         }
 
-        $component = $this->factory->create($this->_request->getParam('namespace'));
+        $component = $this->factory->create($this->getRequest()->getParam('namespace'));
         $this->prepareComponent($component);
-        $this->_response->appendBody((string) $component->render());
+        $this->getResponse()->appendBody((string) $component->render());
+
+        $contentType = $this->contentTypeResolver->resolve($component->getContext());
+        $this->getResponse()->setHeader('Content-Type', $contentType, true);
     }
 
     /**

diff --git a/app/code/Magento/Ui/Model/UiComponentTypeResolver.php b/app/code/Magento/Ui/Model/UiComponentTypeResolver.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Ui\Model;
+
+use Magento\Framework\View\Element\UiComponent\ContextInterface as UiComponentContext;
+
+/**
+ * Provides correct Content-Type header value for the Ui Component renderer based on the Accept Type of
+ * the Component Context. Additional types may be added to the type map via di.xml configuration for this resolver.
+ *
+ * This is a workaround for the lacking Content-Type processing in
+ * \Magento\Framework\View\Element\UiComponent\ContentType\ContentTypeInterface
+ */
+class UiComponentTypeResolver
+{
+    /**
+     * @var string
+     */
+    const DEFAULT_CONTENT_TYPE = 'text/html';
+
+    /**
+     * @var array
+     */
+    private $uiComponentTypeMap = [];
+
+    /**
+     * @param array $uiComponentTypeMap
+     */
+    public function __construct(array $uiComponentTypeMap)
+    {
+        $this->uiComponentTypeMap = $uiComponentTypeMap;
+    }
+
+    /**
+     * @param UiComponentContext $componentContext
+     * @return string
+     */
+    public function resolve(UiComponentContext $componentContext): string
+    {
+        $acceptType = $componentContext->getAcceptType();
+        return $this->uiComponentTypeMap[$acceptType] ?? static::DEFAULT_CONTENT_TYPE;
+    }
+}
diff --git a/app/code/Magento/Ui/Test/Unit/Controller/Adminhtml/Index/RenderTest.php b/app/code/Magento/Ui/Test/Unit/Controller/Adminhtml/Index/RenderTest.php
@@ -5,7 +5,9 @@
  */
 namespace Magento\Ui\Test\Unit\Controller\Adminhtml\Index;
 
-use \Magento\Ui\Controller\Adminhtml\Index\Render;
+use Magento\Ui\Controller\Adminhtml\Index\Render;
+use Magento\Ui\Model\UiComponentTypeResolver;
+use Magento\Framework\View\Element\UiComponent\ContextInterface;
 
 /**
  * Class RenderTest
@@ -32,6 +34,11 @@ class RenderTest extends \PHPUnit\Framework\TestCase
      */
     protected $uiFactoryMock;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject|UiComponentTypeResolver
+     */
+    private $uiComponentTypeResolverMock;
+
     protected function setUp()
     {
         $this->requestMock = $this->getMockBuilder(\Magento\Framework\App\Request\Http::class)
@@ -53,7 +60,11 @@ protected function setUp()
         $this->uiFactoryMock = $this->getMockBuilder(\Magento\Framework\View\Element\UiComponentFactory::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $this->render = new Render($contextMock, $this->uiFactoryMock);
+
+        $this->uiComponentTypeResolverMock = $this->getMockBuilder(UiComponentTypeResolver::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->render = new Render($contextMock, $this->uiFactoryMock, $this->uiComponentTypeResolverMock);
     }
 
     public function testExecuteAjaxRequest()
@@ -84,15 +95,22 @@ public function testExecuteAjaxRequest()
             true,
             ['render']
         );
+        $contextMock = $this->createMock(ContextInterface::class);
+
         $viewMock->expects($this->once())
             ->method('render')
             ->willReturn($renderedData);
         $viewMock->expects($this->once())
             ->method('getChildComponents')
             ->willReturn([]);
+        $viewMock->expects($this->atLeastOnce())->method('getContext')->willReturn($contextMock);
         $this->uiFactoryMock->expects($this->once())
             ->method('create')
             ->willReturn($viewMock);
+        $this->uiComponentTypeResolverMock->expects($this->once())->method('resolve')->with($contextMock)
+            ->willReturn('application/json');
+        $this->responseMock->expects($this->once())->method('setHeader')
+            ->with('Content-Type', 'application/json', true);
 
         $this->render->executeAjaxRequest();
     }

diff --git a/app/code/Magento/Ui/Test/Unit/Model/UiComponentTypeResolverTest.php b/app/code/Magento/Ui/Test/Unit/Model/UiComponentTypeResolverTest.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Ui\Test\Unit\Model;
+
+use Magento\Ui\Model\UiComponentTypeResolver;
+use Magento\Framework\View\Element\UiComponent\ContextInterface;
+
+class UiComponentTypeResolverTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var UiComponentTypeResolver
+     */
+    private $model;
+
+    /**
+     * @var array
+     */
+    private $contentTypeMap = [];
+
+    protected function setUp()
+    {
+        $this->contentTypeMap = [
+            'xml' => 'application/xml',
+            'json' => 'application/json',
+            'html' => 'text/html'
+        ];
+        $this->model = new UiComponentTypeResolver($this->contentTypeMap);
+    }
+
+    /**
+     * @param string $acceptType
+     * @param string $contentType
+     * @dataProvider resolveDataProvider
+     */
+    public function testResolve(string $acceptType, string $contentType)
+    {
+        $uiComponentContextMock = $this->createMock(ContextInterface::class);
+        $uiComponentContextMock->expects($this->atLeastOnce())->method('getAcceptType')->willReturn($acceptType);
+
+        $this->assertEquals($contentType, $this->model->resolve($uiComponentContextMock));
+    }
+
+    /**
+     * @return array
+     */
+    public function resolveDataProvider(): array
+    {
+        return [
+            ['json', 'application/json'],
+            ['xml', 'application/xml'],
+            ['html', 'text/html'],
+            ['undefined', UiComponentTypeResolver::DEFAULT_CONTENT_TYPE]
+        ];
+    }
+}
diff --git a/app/code/Magento/Ui/etc/di.xml b/app/code/Magento/Ui/etc/di.xml
@@ -426,4 +426,13 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Ui\Model\UiComponentTypeResolver">
+        <arguments>
+            <argument name="uiComponentTypeMap" xsi:type="array">
+                <item name="html" xsi:type="string">text/html</item>
+                <item name="json" xsi:type="string">application/json</item>
+                <item name="xml" xsi:type="string">application/xml</item>
+            </argument>
+        </arguments>
+    </type>
 </config>
diff --git a/lib/internal/Magento/Framework/Code/Generator/ClassGenerator.php b/lib/internal/Magento/Framework/Code/Generator/ClassGenerator.php
@@ -59,6 +59,7 @@ class ClassGenerator extends \Zend\Code\Generator\ClassGenerator implements
         'type' => 'setType',
         'defaultValue' => 'setDefaultValue',
         'passedByReference' => 'setPassedByReference',
+        'variadic' => 'setVariadic',
     ];
 
     /**

diff --git a/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php b/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php
@@ -313,7 +313,8 @@ protected function _getMethodParameterInfo(\ReflectionParameter $parameter)
         $parameterInfo = [
             'name' => $parameter->getName(),
             'passedByReference' => $parameter->isPassedByReference(),
-            'type' => $parameter->getType()
+            'type' => $parameter->getType(),
+            'variadic' => $parameter->isVariadic()
         ];
 
         if ($parameter->isArray()) {

diff --git a/lib/internal/Magento/Framework/Code/Test/Unit/Generator/ClassGeneratorTest.php b/lib/internal/Magento/Framework/Code/Test/Unit/Generator/ClassGeneratorTest.php
@@ -20,6 +20,8 @@ class ClassGeneratorTest extends \PHPUnit\Framework\TestCase
 
     const FLAG_REFERENCE = 'passedByReference';
 
+    const FLAG_VARIADIC = 'variadic';
+
     /**#@-*/
 
     /**
@@ -38,6 +40,7 @@ class ClassGeneratorTest extends \PHPUnit\Framework\TestCase
         self::FLAG_FINAL => 'isFinal',
         self::FLAG_ABSTRACT => 'isAbstract',
         self::FLAG_REFERENCE => 'getPassedByReference',
+        self::FLAG_VARIADIC => 'getVariadic',
     ];
 
     /**
@@ -65,7 +68,13 @@ class ClassGeneratorTest extends \PHPUnit\Framework\TestCase
             'final' => true,
             'static' => true,
             'parameters' => [
-                ['name' => 'data', 'type' => 'array', 'defaultValue' => [], 'passedByReference' => true],
+                [
+                    'name' => 'data',
+                    'type' => 'array',
+                    'defaultValue' => [],
+                    'passedByReference' => true,
+                    'variadic' => false
+                ],
             ],
             'body' => 'return 1;',
             'docblock' => ['shortDescription' => 'test short description'],
@@ -205,6 +214,9 @@ public function testAddMethods()
                         $actualDefaultValue = $actualParameter->getDefaultValue();
                         $this->assertEquals($parameterData['defaultValue'], $actualDefaultValue->getValue());
                     }
+
+                    // assert variadic flag
+                    $this->_assertFlag(self::FLAG_VARIADIC, $parameterData, $actualParameter);
                 }
             }
 

diff --git a/lib/internal/Magento/Framework/Interception/Code/Generator/Interceptor.php b/lib/internal/Magento/Framework/Interception/Code/Generator/Interceptor.php
@@ -130,7 +130,13 @@ protected function _getParameterList(array $parameters)
             ', ',
             array_map(
                 function ($item) {
-                    return "$" . $item['name'];
+                    $output = '';
+                    if ($item['variadic']) {
+                        $output .= '... ';
+                    }
+
+                    $output .= "\${$item['name']}";
+                    return $output;
                 },
                 $parameters
             )

diff --git a/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Interceptor.txt b/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Interceptor.txt
@@ -50,4 +50,43 @@ class Interceptor extends \Magento\Framework\Interception\Code\Generator\Sample
             return $this->___callPlugins('getReference', func_get_args(), $pluginInfo);
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function firstVariadicParameter(... $variadicValue)
+    {
+        $pluginInfo = $this->pluginList->getNext($this->subjectType, 'firstVariadicParameter');
+        if (!$pluginInfo) {
+            return parent::firstVariadicParameter(... $variadicValue);
+        } else {
+            return $this->___callPlugins('firstVariadicParameter', func_get_args(), $pluginInfo);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function secondVariadicParameter($value, ... $variadicValue)
+    {
+        $pluginInfo = $this->pluginList->getNext($this->subjectType, 'secondVariadicParameter');
+        if (!$pluginInfo) {
+            return parent::secondVariadicParameter($value, ... $variadicValue);
+        } else {
+            return $this->___callPlugins('secondVariadicParameter', func_get_args(), $pluginInfo);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function byRefVariadic(&... $variadicValue)
+    {
+        $pluginInfo = $this->pluginList->getNext($this->subjectType, 'byRefVariadic');
+        if (!$pluginInfo) {
+            return parent::byRefVariadic(... $variadicValue);
+        } else {
+            return $this->___callPlugins('byRefVariadic', func_get_args(), $pluginInfo);
+        }
+    }
 }
diff --git a/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Sample.php b/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Sample.php
@@ -8,6 +8,7 @@
 class Sample
 {
     private $attribute;
+    private $variadicAttribute;
 
     public function getValue()
     {
@@ -22,4 +23,20 @@ public function setValue($value)
     public function & getReference()
     {
     }
+
+    public function firstVariadicParameter(...$variadicValue)
+    {
+        $this->variadicAttribute = $variadicValue;
+    }
+
+    public function secondVariadicParameter($value, ...$variadicValue)
+    {
+        $this->attribute = $value;
+        $this->variadicAttribute = $variadicValue;
+    }
+
+    public function byRefVariadic(& ...$variadicValue)
+    {
+        $this->variadicAttribute = $variadicValue;
+    }
 }