#10521: Set correct Content-Type header for ajax responses in the Magento_UI module

Author: ishakhsuvarov

app/code/Magento/Ui/Controller/Adminhtml/Index/Render.php

@@ -9,13 +9,32 @@
 use Magento\Ui\Controller\Adminhtml\AbstractAction;
 use Magento\Framework\View\Element\UiComponentFactory;
 use Magento\Framework\View\Element\UiComponentInterface;
-use Magento\Framework\View\Element\UiComponent\ContentType;
+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
      *
@@ -28,10 +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->setResponseContentTypeHeader($component);
+        $this->getResponse()->appendBody((string) $component->render());
+
+        $contentType = $this->contentTypeResolver->resolve($component->getContext());
+        $this->getResponse()->setHeader('Content-Type', $contentType, true);
     }
 
     /**
@@ -47,26 +68,4 @@ protected function prepareComponent(UiComponentInterface $component)
         }
         $component->prepare();
     }
-
-    /**
-     * Set the response 'Content-Type' header based on the component's render engine
-     *
-     * @param UiComponentInterface $component
-     * @return void
-     */
-    private function setResponseContentTypeHeader(UiComponentInterface $component)
-    {
-        $contentType = 'text/html';
-
-        if ($component->getContext()) {
-            $renderEngine = $component->getContext()->getRenderEngine();
-            if ($renderEngine instanceof ContentType\Json) {
-                $contentType = 'application/json';
-            } elseif ($renderEngine instanceof ContentType\Xml) {
-                $contentType = 'application/xml';
-            }
-        }
-
-        $this->_response->setHeader('Content-Type', $contentType, true);
-    }
 }

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;
+    }
+}

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]
+        ];
+    }
+}

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>