Merge remote-tracking branch 'origin/ACP2E-30' into L3_Arrows_PR_20220301

Author: nishant04412

lib/internal/Magento/Framework/View/Element/UiComponent/Context.php

@@ -349,13 +349,16 @@ protected function setAcceptType()
     {
         $this->acceptType = 'html';
 
-        $rawAcceptType = $this->request->getHeader('Accept');
-        if (strpos($rawAcceptType, 'json') !== false) {
-            $this->acceptType = 'json';
-        } elseif (strpos($rawAcceptType, 'html') !== false) {
-            $this->acceptType = 'html';
-        } elseif (strpos($rawAcceptType, 'xml') !== false) {
-            $this->acceptType = 'xml';
+        $acceptTypes = $this->getSortedAcceptHeader();
+        foreach ($acceptTypes as $acceptType) {
+            if (strpos($acceptType, 'json') !== false) {
+                $this->acceptType = 'json';
+            } elseif (strpos($acceptType, 'html') !== false) {
+                $this->acceptType = 'html';
+            } elseif (strpos($acceptType, 'xml') !== false) {
+                $this->acceptType = 'xml';
+            }
+            break;
         }
     }
 
@@ -408,4 +411,32 @@ public function getUiComponentFactory()
     {
         return $this->uiComponentFactory;
     }
+
+    /**
+     * Returns sorted accept header based on q value
+     *
+     * @return array
+     */
+    private function getSortedAcceptHeader()
+    {
+        $acceptTypes = [];
+        $acceptHeader = $this->request->getHeader('Accept');
+        $contentTypes = explode(',', $acceptHeader);
+        foreach ($contentTypes as $contentType) {
+            // the default quality is 1.
+            $q = 1;
+            // check if there is a different quality
+            if (strpos($contentType, ';q=') !== false) {
+                list($contentType, $q) = explode(';q=', $contentType);
+            }
+
+            if (array_key_exists($q, $acceptTypes)) {
+                $acceptTypes[$q] = $acceptTypes[$q] . ',' . $contentType;
+            } else {
+                $acceptTypes[$q] = $contentType;
+            }
+        }
+        krsort($acceptTypes);
+        return array_values($acceptTypes);
+    }
 }

lib/internal/Magento/Framework/View/Test/Unit/Element/UiComponent/ContextTest.php

@@ -45,36 +45,71 @@ class ContextTest extends TestCase
      */
     private $authorization;
 
+    /**
+     * @var LayoutInterface
+     */
+    private $pageLayout;
+
+    /**
+     * @var ButtonProviderFactory
+     */
+    private $buttonProviderFactory;
+
+    /**
+     * @var ActionPoolFactory
+     */
+    private $actionPoolFactory;
+
+    /**
+     * @var ContentTypeFactory
+     */
+    private $contentTypeFactory;
+
+    /**
+     * @var UrlInterface
+     */
+    private $urlBuilder;
+
+    /**
+     * @var Processor
+     */
+    private $processor;
+
+    /**
+     * @var UiComponentFactory
+     */
+    private $uiComponentFactory;
+
     protected function setUp(): void
     {
-        $pageLayout = $this->getMockBuilder(LayoutInterface::class)
+        $this->pageLayout = $this->getMockBuilder(LayoutInterface::class)
             ->getMock();
         $request = $this->getMockBuilder(Http::class)
             ->disableOriginalConstructor()
             ->onlyMethods(['getHeader'])
             ->getMock();
         $request->method('getHeader')->willReturn('');
-        $buttonProviderFactory =
+        $this->buttonProviderFactory =
             $this->getMockBuilder(ButtonProviderFactory::class)
                 ->disableOriginalConstructor()
                 ->getMock();
-        $actionPoolFactory =
+        $this->actionPoolFactory =
             $this->getMockBuilder(ActionPoolFactory::class)
                 ->disableOriginalConstructor()
                 ->getMock();
         $this->actionPool = $this->getMockBuilder(ActionPoolInterface::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
-        $actionPoolFactory->method('create')->willReturn($this->actionPool);
-        $contentTypeFactory =
+        $this->actionPoolFactory->method('create')->willReturn($this->actionPool);
+        $this->contentTypeFactory =
             $this->getMockBuilder(ContentTypeFactory::class)
                 ->disableOriginalConstructor()
                 ->getMock();
-        $urlBuilder = $this->getMockBuilder(UrlInterface::class)
+        $this->urlBuilder = $this->getMockBuilder(UrlInterface::class)
             ->getMock();
-        $processor = $this->getMockBuilder(Processor::class)
+        $this->processor = $this->getMockBuilder(Processor::class)
             ->getMock();
-        $uiComponentFactory =
+        $this->uiComponentFactory =
             $this->getMockBuilder(UiComponentFactory::class)
                 ->disableOriginalConstructor()
                 ->getMock();
@@ -86,14 +121,14 @@ protected function setUp(): void
         $this->context = $objectManagerHelper->getObject(
             Context::class,
             [
-                'pageLayout'            => $pageLayout,
+                'pageLayout'            => $this->pageLayout,
                 'request'               => $request,
-                'buttonProviderFactory' => $buttonProviderFactory,
-                'actionPoolFactory'     => $actionPoolFactory,
-                'contentTypeFactory'    => $contentTypeFactory,
-                'urlBuilder'            => $urlBuilder,
-                'processor'             => $processor,
-                'uiComponentFactory'    => $uiComponentFactory,
+                'buttonProviderFactory' => $this->buttonProviderFactory,
+                'actionPoolFactory'     => $this->actionPoolFactory,
+                'contentTypeFactory'    => $this->contentTypeFactory,
+                'urlBuilder'            => $this->urlBuilder,
+                'processor'             => $this->processor,
+                'uiComponentFactory'    => $this->uiComponentFactory,
                 'authorization'         => $this->authorization,
             ]
         );
@@ -162,6 +197,60 @@ public function testAddComponentDefinition($components, $expected)
         $this->assertEquals($expected, $this->context->getComponentsDefinitions());
     }
 
+    /**
+     * @param string $headerAccept
+     * @param string $acceptType
+     *
+     * @dataProvider getAcceptTypeDataProvider
+     */
+    public function testGetAcceptType($headerAccept, $acceptType)
+    {
+        $request = $this->getMockBuilder(Http::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['getHeader'])
+            ->getMock();
+        $request->method('getHeader')
+            ->with('Accept')
+            ->willReturn($headerAccept);
+
+        $objectManagerHelper = new ObjectManagerHelper($this);
+        $context = $objectManagerHelper->getObject(
+            Context::class,
+            [
+                'pageLayout'            => $this->pageLayout,
+                'request'               => $request,
+                'buttonProviderFactory' => $this->buttonProviderFactory,
+                'actionPoolFactory'     => $this->actionPoolFactory,
+                'contentTypeFactory'    => $this->contentTypeFactory,
+                'urlBuilder'            => $this->urlBuilder,
+                'processor'             => $this->processor,
+                'uiComponentFactory'    => $this->uiComponentFactory,
+                'authorization'         => $this->authorization,
+            ]
+        );
+
+        $this->assertEquals($acceptType, $context->getAcceptType());
+    }
+
+    /**
+     * @return array
+     */
+    public function getAcceptTypeDataProvider()
+    {
+        return [
+            ['json', 'json'],
+            ['text/html,application/xhtml+xml,application/json;q=0.9,
+            application/javascript;q=0.9,text/javascript;q=0.9,application/xml;q=0.9,
+            text/plain;q=0.8,*/*;q=0.7', 'html'],
+            ['application/json, text/javascript, */*;q=0.01', 'json'],
+            ['text/html, application/xhtml+xml, application/xml;q=0.9,
+            image/avif, image/webp, image/apng, */*;q=0.8,
+            application/signed-exchange;v=b3;q=0.9', 'html'],
+            ['xml', 'xml'],
+            ['text/html, application/json', 'json']
+        ];
+    }
+
     /**
      * @return array
      */