MC-41887: Validation Messages - CustomerData messages not showing up

Author: Anna Bukatar

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

@@ -11,6 +11,7 @@
 use Magento\Framework\Message\MessageInterface;
 use Magento\Framework\Translate\Inline\ParserInterface;
 use Magento\Framework\Translate\InlineInterface;
+use Magento\Framework\Session\Config\ConfigInterface;
 
 /**
  * Plugin for putting messages to cookies
@@ -54,21 +55,28 @@ class MessagePlugin
      */
     private $inlineTranslate;
 
+    /**
+     * @var ConfigInterface
+     */
+    protected $sessionConfig;
+
     /**
      * @param \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager
      * @param \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory
      * @param \Magento\Framework\Message\ManagerInterface $messageManager
      * @param \Magento\Framework\View\Element\Message\InterpretationStrategyInterface $interpretationStrategy
      * @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
      * @param InlineInterface|null $inlineTranslate
+     * @param ConfigInterface $sessionConfig
      */
     public function __construct(
         \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager,
         \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory,
         \Magento\Framework\Message\ManagerInterface $messageManager,
         \Magento\Framework\View\Element\Message\InterpretationStrategyInterface $interpretationStrategy,
         \Magento\Framework\Serialize\Serializer\Json $serializer = null,
-        InlineInterface $inlineTranslate = null
+        InlineInterface $inlineTranslate = null,
+        ConfigInterface $sessionConfig
     ) {
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
@@ -77,6 +85,7 @@ public function __construct(
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
         $this->interpretationStrategy = $interpretationStrategy;
         $this->inlineTranslate = $inlineTranslate ?: ObjectManager::getInstance()->get(InlineInterface::class);
+        $this->sessionConfig = $sessionConfig ?: ObjectManager::getInstance()->get(ConfigInterface::class);
     }
 
     /**
@@ -132,7 +141,7 @@ private function setCookie(array $messages)
 
             $publicCookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata();
             $publicCookieMetadata->setDurationOneYear();
-            $publicCookieMetadata->setPath('/');
+            $publicCookieMetadata->setPath($this->sessionConfig->getCookiePath());
             $publicCookieMetadata->setHttpOnly(false);
             $publicCookieMetadata->setSameSite('Strict');
 

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

@@ -16,6 +16,7 @@
 use Magento\Framework\Stdlib\Cookie\PublicCookieMetadata;
 use Magento\Framework\Stdlib\CookieManagerInterface;
 use Magento\Framework\Translate\InlineInterface;
+use Magento\Framework\Session\Config\ConfigInterface;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
 use Magento\Theme\Controller\Result\MessagePlugin;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -47,6 +48,11 @@ class MessagePluginTest extends TestCase
     /** @var InlineInterface|MockObject */
     private $inlineTranslateMock;
 
+    /**
+     * @var ConfigInterface|MockObject
+     */
+    protected $sessionConfigMock;
+
     protected function setUp(): void
     {
         $this->cookieManagerMock = $this->getMockBuilder(CookieManagerInterface::class)
@@ -62,14 +68,17 @@ protected function setUp(): void
             ->getMock();
         $this->inlineTranslateMock = $this->getMockBuilder(InlineInterface::class)
             ->getMockForAbstractClass();
+        $this->sessionConfigMock = $this->getMockBuilder(ConfigInterface::class)
+            ->getMockForAbstractClass();
 
         $this->model = new MessagePlugin(
             $this->cookieManagerMock,
             $this->cookieMetadataFactoryMock,
             $this->managerMock,
             $this->interpretationStrategyMock,
             $this->serializerMock,
-            $this->inlineTranslateMock
+            $this->inlineTranslateMock,
+            $this->sessionConfigMock
         );
     }
 
@@ -549,4 +558,49 @@ function ($data) {
 
         $this->assertEquals($resultMock, $this->model->afterRenderResult($resultMock, $resultMock));
     }
+
+    public function testSetCookieWithCookiePath()
+    {
+        /** @var Redirect|MockObject $resultMock */
+        $resultMock = $this->getMockBuilder(Redirect::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        /** @var PublicCookieMetadata|MockObject $cookieMetadataMock */
+        $cookieMetadataMock = $this->getMockBuilder(PublicCookieMetadata::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->cookieMetadataFactoryMock->expects($this->once())
+            ->method('createPublicCookieMetadata')
+            ->willReturn($cookieMetadataMock);
+
+        /** @var MessageInterface|MockObject $messageMock */
+        $messageMock = $this->getMockBuilder(MessageInterface::class)
+            ->getMock();
+
+        /** @var Collection|MockObject $collectionMock */
+        $collectionMock = $this->getMockBuilder(Collection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $collectionMock->expects($this->once())
+            ->method('getItems')
+            ->willReturn([$messageMock]);
+
+        $this->managerMock->expects($this->once())
+            ->method('getMessages')
+            ->with(true, null)
+            ->willReturn($collectionMock);
+
+        /* Test that getCookiePath is called during cookie setup */
+        $this->sessionConfigMock->expects($this->once())
+            ->method('getCookiePath')
+            ->willReturn('/pub');
+        $cookieMetadataMock->expects($this->once())
+            ->method('setPath')
+            ->with('/pub')
+            ->willReturn($cookieMetadataMock);
+
+        $this->model->afterRenderResult($resultMock, $resultMock);
+    }
 }