Merge remote-tracking branch 'origin/MAGETWO-59966' into BUGS

Author: VladimirZaets

app/code/Magento/Theme/Controller/Result/MessagePlugin.php

@@ -66,6 +66,11 @@ public function __construct(
     }
 
     /**
+     * Set 'mage-messages' cookie
+     *
+     * Checks the result that controller actions must return. If result is not JSON type, then
+     * sets 'mage-messages' cookie.
+     *
      * @param ResultInterface $subject
      * @param ResultInterface $result
      * @return ResultInterface
@@ -75,18 +80,48 @@ public function afterRenderResult(
         ResultInterface $result
     ) {
         if (!($subject instanceof Json)) {
+            $this->setCookie($this->getMessages());
+        }
+        return $result;
+    }
+
+    /**
+     * Set 'mage-messages' cookie with 'messages' array
+     *
+     * Checks the $messages argument. If $messages is not an empty array, then
+     * sets 'mage-messages' public cookie:
+     *
+     *   Cookie Name: 'mage-messages';
+     *   Cookie Duration: 1 year;
+     *   Cookie Path: /;
+     *   Cookie HTTP Only flag: FALSE. Cookie can be accessed by client-side APIs.
+     *
+     * The 'messages' list has format:
+     * [
+     *   [
+     *     'type' => 'type_value',
+     *     'text' => 'cookie_value',
+     *   ],
+     * ]
+     *
+     *
+     * @param array $messages List of Magento messages that must be set as 'mage-messages' cookie.
+     * @return void
+     */
+    private function setCookie(array $messages)
+    {
+        if (!empty($messages)) {
             $publicCookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata();
             $publicCookieMetadata->setDurationOneYear();
             $publicCookieMetadata->setPath('/');
             $publicCookieMetadata->setHttpOnly(false);
+
             $this->cookieManager->setPublicCookie(
                 self::MESSAGES_COOKIES_NAME,
-                $this->jsonHelper->jsonEncode($this->getMessages()),
+                $this->jsonHelper->jsonEncode($messages),
                 $publicCookieMetadata
             );
         }
-
-        return $result;
     }
 
     /**

app/code/Magento/Theme/Test/Unit/Controller/Result/MessagePluginTest.php

@@ -79,7 +79,6 @@ public function testAfterRenderResultJson()
 
     public function testAfterRenderResult()
     {
-        
         $existingMessages = [
             [
                 'type' => 'message0type',
@@ -125,14 +124,14 @@ public function testAfterRenderResult()
             )
             ->willReturn(\Zend_Json::encode($existingMessages));
 
-        $this->dataMock->expects($this->any())
+        $this->dataMock->expects($this->once())
             ->method('jsonDecode')
             ->willReturnCallback(
                 function ($data) {
                     return \Zend_Json::decode($data);
                 }
             );
-        $this->dataMock->expects($this->any())
+        $this->dataMock->expects($this->exactly(2))
             ->method('jsonEncode')
             ->willReturnCallback(
                 function ($data) {
@@ -168,6 +167,56 @@ function ($data) {
         $this->assertEquals($resultMock, $this->model->afterRenderResult($resultMock, $resultMock));
     }
 
+    public function testAfterRenderResultWithNoMessages()
+    {
+        /** @var Redirect|\PHPUnit_Framework_MockObject_MockObject $resultMock */
+        $resultMock = $this->getMockBuilder(Redirect::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->cookieManagerMock->expects($this->once())
+            ->method('getCookie')
+            ->with(
+                MessagePlugin::MESSAGES_COOKIES_NAME,
+                \Zend_Json::encode([])
+            )
+            ->willReturn(\Zend_Json::encode([]));
+
+        $this->dataMock->expects($this->once())
+            ->method('jsonDecode')
+            ->willReturnCallback(
+                function ($data) {
+                    return \Zend_Json::decode($data);
+                }
+            );
+        $this->dataMock->expects($this->once())
+            ->method('jsonEncode')
+            ->willReturnCallback(
+                function ($data) {
+                    return \Zend_Json::encode($data);
+                }
+            );
+
+        /** @var Collection|\PHPUnit_Framework_MockObject_MockObject $collectionMock */
+        $collectionMock = $this->getMockBuilder(Collection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $collectionMock->expects($this->once())
+            ->method('getItems')
+            ->willReturn([]);
+
+        $this->managerMock->expects($this->once())
+            ->method('getMessages')
+            ->with(true, null)
+            ->willReturn($collectionMock);
+
+        $this->cookieMetadataFactoryMock->expects($this->never())
+            ->method('createPublicCookieMetadata')
+            ->willReturn(null);
+
+        $this->assertEquals($resultMock, $this->model->afterRenderResult($resultMock, $resultMock));
+    }
+
     public function testAfterRenderResultWithoutExisting()
     {
         $messageType = 'message1type';