MAGETWO-93778: "Thank you" text is broken on storefront with enabled translate-inline

Author: OlgaVasyltsun

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

@@ -5,9 +5,12 @@
  */
 namespace Magento\Theme\Controller\Result;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\Controller\ResultInterface;
 use Magento\Framework\Message\MessageInterface;
+use Magento\Framework\Translate\Inline\ParserInterface;
+use Magento\Framework\Translate\InlineInterface;
 
 /**
  * Plugin for putting messages to cookies
@@ -44,26 +47,34 @@ class MessagePlugin
      */
     private $serializer;
 
+    /**
+     * @var InlineInterface
+     */
+    private $inlineTranslate;
+
     /**
      * @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
      */
     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
+        \Magento\Framework\Serialize\Serializer\Json $serializer = null,
+        InlineInterface $inlineTranslate = null
     ) {
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->messageManager = $messageManager;
-        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
+        $this->serializer = $serializer ?: ObjectManager::getInstance()
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
         $this->interpretationStrategy = $interpretationStrategy;
+        $this->inlineTranslate = $inlineTranslate ?: ObjectManager::getInstance()->get(InlineInterface::class);
     }
 
     /**
@@ -112,6 +123,12 @@ public function afterRenderResult(
     private function setCookie(array $messages)
     {
         if (!empty($messages)) {
+            if ($this->inlineTranslate->isAllowed()) {
+                foreach ($messages as &$message) {
+                    $message['text'] = $this->convertMessageText($message['text']);
+                }
+            }
+
             $publicCookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata();
             $publicCookieMetadata->setDurationOneYear();
             $publicCookieMetadata->setPath('/');
@@ -125,6 +142,21 @@ private function setCookie(array $messages)
         }
     }
 
+    /**
+     * Replace wrapping translation with html body.
+     *
+     * @param string $text
+     * @return string
+     */
+    private function convertMessageText(string $text): string
+    {
+        if (preg_match('#' . ParserInterface::REGEXP_TOKEN . '#', $text, $matches)) {
+            $text = $matches[1];
+        }
+
+        return $text;
+    }
+
     /**
      * Return messages array and clean message manager messages
      *

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

@@ -14,6 +14,7 @@
 use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
 use Magento\Framework\Stdlib\Cookie\PublicCookieMetadata;
 use Magento\Framework\Stdlib\CookieManagerInterface;
+use Magento\Framework\Translate\InlineInterface;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
 use Magento\Theme\Controller\Result\MessagePlugin;
 
@@ -40,6 +41,9 @@ class MessagePluginTest extends \PHPUnit\Framework\TestCase
     /** @var \Magento\Framework\Serialize\Serializer\Json|\PHPUnit_Framework_MockObject_MockObject */
     private $serializerMock;
 
+    /** @var InlineInterface|\PHPUnit_Framework_MockObject_MockObject */
+    private $inlineTranslateMock;
+
     protected function setUp()
     {
         $this->cookieManagerMock = $this->getMockBuilder(CookieManagerInterface::class)
@@ -53,13 +57,15 @@ protected function setUp()
             ->getMockForAbstractClass();
         $this->serializerMock = $this->getMockBuilder(\Magento\Framework\Serialize\Serializer\Json::class)
             ->getMock();
+        $this->inlineTranslateMock = $this->getMockBuilder(InlineInterface::class)->getMockForAbstractClass();
 
         $this->model = new MessagePlugin(
             $this->cookieManagerMock,
             $this->cookieMetadataFactoryMock,
             $this->managerMock,
             $this->interpretationStrategyMock,
-            $this->serializerMock
+            $this->serializerMock,
+            $this->inlineTranslateMock
         );
     }
 
@@ -450,4 +456,93 @@ function ($data) {
 
         $this->assertEquals($resultMock, $this->model->afterRenderResult($resultMock, $resultMock));
     }
+
+    /**
+     * @return void
+     */
+    public function testAfterRenderResultWithAllowedInlineTranslate(): void
+    {
+        $messageType = 'message1type';
+        $messageText = '{{{message1text}}{{message1text}}{{message1text}}{{theme/luma}}}';
+        $expectedMessages = [
+            [
+                'type' => $messageType,
+                'text' => 'message1text',
+            ],
+        ];
+
+        /** @var Redirect|\PHPUnit_Framework_MockObject_MockObject $resultMock */
+        $resultMock = $this->getMockBuilder(Redirect::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        /** @var PublicCookieMetadata|\PHPUnit_Framework_MockObject_MockObject $cookieMetadataMock */
+        $cookieMetadataMock = $this->getMockBuilder(PublicCookieMetadata::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->cookieMetadataFactoryMock->expects($this->once())
+            ->method('createPublicCookieMetadata')
+            ->willReturn($cookieMetadataMock);
+
+        $this->cookieManagerMock->expects($this->once())
+            ->method('setPublicCookie')
+            ->with(
+                MessagePlugin::MESSAGES_COOKIES_NAME,
+                json_encode($expectedMessages),
+                $cookieMetadataMock
+            );
+        $this->cookieManagerMock->expects($this->once())
+            ->method('getCookie')
+            ->with(
+                MessagePlugin::MESSAGES_COOKIES_NAME
+            )
+            ->willReturn(json_encode([]));
+
+        $this->serializerMock->expects($this->once())
+            ->method('unserialize')
+            ->willReturnCallback(
+                function ($data) {
+                    return json_decode($data, true);
+                }
+            );
+        $this->serializerMock->expects($this->once())
+            ->method('serialize')
+            ->willReturnCallback(
+                function ($data) {
+                    return json_encode($data);
+                }
+            );
+
+        /** @var MessageInterface|\PHPUnit_Framework_MockObject_MockObject $messageMock */
+        $messageMock = $this->getMockBuilder(MessageInterface::class)
+            ->getMock();
+        $messageMock->expects($this->once())
+            ->method('getType')
+            ->willReturn($messageType);
+
+        $this->interpretationStrategyMock->expects($this->once())
+            ->method('interpret')
+            ->with($messageMock)
+            ->willReturn($messageText);
+
+        $this->inlineTranslateMock->expects($this->once())
+            ->method('isAllowed')
+            ->willReturn(true);
+
+        /** @var Collection|\PHPUnit_Framework_MockObject_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);
+
+        $this->assertEquals($resultMock, $this->model->afterRenderResult($resultMock, $resultMock));
+    }
 }