Merge remote-tracking branch 'origin/MAGETWO-60538' into 2.1.8-develop-pr19

Author: zakdma

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

@@ -10,12 +10,12 @@
 use Magento\Framework\Message\MessageInterface;
 
 /**
- * Plugin for putting messages to cookies
+ * Plugin for putting messages to cookies.
  */
 class MessagePlugin
 {
     /**
-     * Cookies name for messages
+     * Cookies name for messages.
      */
     const MESSAGES_COOKIES_NAME = 'mage-messages';
 
@@ -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,22 +80,52 @@ 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;
     }
 
     /**
-     * Return messages array and clean message manager messages
+     * Return messages array and clean message manager messages.
      *
      * @return array
      */
@@ -104,11 +139,12 @@ protected function getMessages()
                 'text' => $this->interpretationStrategy->interpret($message),
             ];
         }
+        
         return $messages;
     }
 
     /**
-     * Return messages stored in cookies
+     * Return messages stored in cookies.
      *
      * @return array
      */
@@ -124,6 +160,7 @@ protected function getCookiesMessages()
         } catch (\Zend_Json_Exception $e) {
             $messages = [];
         }
+        
         return $messages;
     }
 }

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

@@ -18,6 +18,8 @@
 use Magento\Theme\Controller\Result\MessagePlugin;
 
 /**
+ * Test for Magento\Theme\Controller\Result\MessagePlugin.
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class MessagePluginTest extends \PHPUnit_Framework_TestCase
@@ -79,7 +81,6 @@ public function testAfterRenderResultJson()
 
     public function testAfterRenderResult()
     {
-        
         $existingMessages = [
             [
                 'type' => 'message0type',
@@ -125,14 +126,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 +169,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';