ACP2E-23: [Magento Cloud] Error message in PDP disappearing quickly - Code refactoring applied.

Author: pradeep1819

app/code/Magento/Catalog/Model/Theme/CustomerData/MessageService.php renamed to app/code/Magento/Catalog/Model/Theme/CustomerData/MessageProvider.php

@@ -10,10 +10,11 @@
 use Magento\Catalog\Model\Product\ProductFrontendAction\Synchronizer;
 use Magento\Framework\App\Config;
 use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Message\Collection;
 use Magento\Framework\Message\ManagerInterface as MessageManager;
-use Magento\Theme\CustomerData\MessageServiceInterface;
+use Magento\Theme\CustomerData\MessagesProviderInterface;
 
-class MessageService implements MessageServiceInterface
+class MessageProvider implements MessagesProviderInterface
 {
     /**
      *
@@ -53,9 +54,9 @@ public function __construct(
     /**
      * Verify flag value for synchronize product actions with backend or not
      *
-     * @return object
+     * @return Collection
      */
-    public function getMessages(): object
+    public function getMessages(): Collection
     {
         $clearSessionMessages = true;
 

app/code/Magento/Catalog/etc/di.xml

@@ -76,7 +76,7 @@
     <preference for="Magento\Catalog\Api\Data\MassActionInterface" type="Magento\Catalog\Model\MassAction" />
     <preference for="Magento\Catalog\Model\ProductLink\Data\ListCriteriaInterface" type="Magento\Catalog\Model\ProductLink\Data\ListCriteria" />
     <preference for="Magento\Catalog\Api\CategoryListDeleteBySkuInterface" type="Magento\Catalog\Model\CategoryLinkRepository"/>
-    <preference for="Magento\Theme\CustomerData\MessageServiceInterface" type="Magento\Catalog\Model\Theme\CustomerData\MessageService"/>
+    <preference for="Magento\Theme\CustomerData\MessagesProviderInterface" type="Magento\Catalog\Model\Theme\CustomerData\MessageProvider"/>
     <type name="Magento\Customer\Model\ResourceModel\Visitor">
         <plugin name="catalogLog" type="Magento\Catalog\Model\Plugin\Log" />
     </type>

app/code/Magento/Theme/CustomerData/MessageService.php renamed to app/code/Magento/Theme/CustomerData/MessageProvider.php

@@ -7,9 +7,10 @@
 
 namespace Magento\Theme\CustomerData;
 
+use Magento\Framework\Message\Collection;
 use Magento\Framework\Message\ManagerInterface as MessageManager;
 
-class MessageService implements MessageServiceInterface
+class MessageProvider implements MessagesProviderInterface
 {
     /**
      * Manager messages
@@ -30,9 +31,9 @@ public function __construct(
     }
 
     /**
-     * @inheritdoc
+     * @return Collection
      */
-    public function getMessages()
+    public function getMessages() : Collection
     {
         return $this->messageManager->getMessages(true);
     }

app/code/Magento/Theme/CustomerData/Messages.php

@@ -7,6 +7,7 @@
 namespace Magento\Theme\CustomerData;
 
 use Magento\Customer\CustomerData\SectionSourceInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Message\ManagerInterface as MessageManager;
 use Magento\Framework\Message\MessageInterface;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
@@ -29,33 +30,33 @@ class Messages implements SectionSourceInterface
     private $interpretationStrategy;
 
     /**
-     * @var MessageServiceInterface
+     * @var MessagesProviderInterface
      */
-    private $messageService;
+    private $messageProvider;
 
     /**
      * Constructor
      *
      * @param MessageManager $messageManager
      * @param InterpretationStrategyInterface $interpretationStrategy
-     * @param MessageServiceInterface $messageService
+     * @param MessagesProviderInterface $messageProvider
      */
     public function __construct(
         MessageManager $messageManager,
         InterpretationStrategyInterface $interpretationStrategy,
-        MessageServiceInterface $messageService
+        ?MessagesProviderInterface $messageProvider = null
     ) {
         $this->messageManager = $messageManager;
         $this->interpretationStrategy = $interpretationStrategy;
-        $this->messageService = $messageService;
+        $this->messageProvider = $messageProvider ?? ObjectManager::getInstance()->get(MessagesProviderInterface::class);
     }
 
     /**
      * @inheritdoc
      */
     public function getSectionData()
     {
-        $messages = $this->messageService->getMessages();
+        $messages = $this->messageProvider->getMessages();
         $messageResponse = array_reduce(
             $messages->getItems(),
             function (array $result, MessageInterface $message) {

app/code/Magento/Theme/CustomerData/MessageServiceInterface.php renamed to app/code/Magento/Theme/CustomerData/MessagesProviderInterface.php

@@ -7,12 +7,14 @@
 
 namespace Magento\Theme\CustomerData;
 
-interface MessageServiceInterface
+use Magento\Framework\Message\Collection;
+
+interface MessagesProviderInterface
 {
     /**
      *  Get the messages stored in session before session clear
      *
-     * @return object
+     * @return Collection
      */
-    public function getMessages();
+    public function getMessages(): Collection;
 }

app/code/Magento/Theme/Test/Unit/CustomerData/MessagesTest.php

@@ -12,7 +12,7 @@
 use Magento\Framework\Message\MessageInterface;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
 use Magento\Theme\CustomerData\Messages;
-use Magento\Theme\CustomerData\MessageServiceInterface;
+use Magento\Theme\CustomerData\MessagesProviderInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
@@ -24,9 +24,9 @@ class MessagesTest extends TestCase
     protected $messageManager;
 
     /**
-     * @var MessageServiceInterface|MockObject
+     * @var MessagesProviderInterface|MockObject
      */
-    private $messageService;
+    private $messageProvider;
 
     /**
      * @var InterpretationStrategyInterface|MockObject
@@ -42,12 +42,12 @@ protected function setUp(): void
     {
         $this->messageManager = $this->getMockBuilder(ManagerInterface::class)
             ->getMock();
-        $this->messageService = $this->getMockBuilder(MessageServiceInterface::class)
+        $this->messageProvider = $this->getMockBuilder(MessagesProviderInterface::class)
             ->getMock();
         $this->messageInterpretationStrategy = $this->createMock(
             InterpretationStrategyInterface::class
         );
-        $this->object = new Messages($this->messageManager, $this->messageInterpretationStrategy, $this->messageService);
+        $this->object = new Messages($this->messageManager, $this->messageInterpretationStrategy, $this->messageProvider);
     }
 
     public function testGetSectionData()
@@ -67,7 +67,7 @@ public function testGetSectionData()
             ->method('interpret')
             ->with($msg)
             ->willReturn($msgText);
-        $this->messageService->expects($this->once())
+        $this->messageProvider->expects($this->once())
             ->method('getMessages')
             ->willReturn($msgCollection);
         $msgCollection->expects($this->once())

app/code/Magento/Theme/etc/di.xml

@@ -19,7 +19,7 @@
     <preference for="Magento\Framework\View\Model\PageLayout\Config\BuilderInterface" type="Magento\Theme\Model\PageLayout\Config\Builder"/>
     <preference for="Magento\Theme\Model\Design\Config\MetadataProviderInterface" type="Magento\Theme\Model\Design\Config\MetadataProvider"/>
     <preference for="Magento\Theme\Model\Theme\StoreThemesResolverInterface" type="Magento\Theme\Model\Theme\StoreThemesResolver"/>
-    <preference for="Magento\Theme\CustomerData\MessageServiceInterface" type="Magento\Theme\CustomerData\MessageService"/>
+    <preference for="Magento\Theme\CustomerData\MessagesProviderInterface" type="Magento\Theme\CustomerData\MessageProvider"/>
     <type name="Magento\Theme\Model\Config">
         <arguments>
             <argument name="configCache" xsi:type="object">Magento\Framework\App\Cache\Type\Config</argument>