AC-10528:Fix for Order Invoice Comment

Author: Devika-GL

app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/AddComment.php

@@ -19,11 +19,9 @@
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Framework\View\Result\PageFactory;
 use Magento\Framework\Controller\Result\RawFactory;
-use Magento\Framework\Escaper;
 
 /**
- * Action Controller for adding Comment to Invoice of an order
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * Class AddComment
  */
 class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInvoice\View implements
     HttpPostActionInterface
@@ -53,11 +51,6 @@ class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInv
      */
     protected $invoiceRepository;
 
-    /**
-     * @var Escaper
-     */
-    private Escaper $escaper;
-
     /**
      * @param Context $context
      * @param Registry $registry
@@ -66,8 +59,7 @@ class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInv
      * @param JsonFactory $resultJsonFactory
      * @param PageFactory $resultPageFactory
      * @param RawFactory $resultRawFactory
-     * @param InvoiceRepositoryInterface|null $invoiceRepository
-     * @param Escaper|null $escaper
+     * @param InvoiceRepositoryInterface $invoiceRepository
      */
     public function __construct(
         Context $context,
@@ -77,17 +69,14 @@ public function __construct(
         JsonFactory $resultJsonFactory,
         PageFactory $resultPageFactory,
         RawFactory $resultRawFactory,
-        InvoiceRepositoryInterface $invoiceRepository = null,
-        Escaper $escaper = null,
+        InvoiceRepositoryInterface $invoiceRepository = null
     ) {
         $this->invoiceCommentSender = $invoiceCommentSender;
         $this->resultJsonFactory = $resultJsonFactory;
         $this->resultPageFactory = $resultPageFactory;
         $this->resultRawFactory = $resultRawFactory;
         $this->invoiceRepository = $invoiceRepository ?:
             ObjectManager::getInstance()->get(InvoiceRepositoryInterface::class);
-        $this->escaper = $escaper ?:
-            ObjectManager::getInstance()->get(Escaper::class);
         parent::__construct($context, $registry, $resultForwardFactory, $invoiceRepository);
     }
 
@@ -104,21 +93,19 @@ public function execute()
             if (empty($data['comment'])) {
                 throw new LocalizedException(__('The comment is missing. Enter and try again.'));
             }
-            $comment = $this->escaper->escapeHtml($data['comment']);
-
             $invoice = $this->getInvoice();
             if (!$invoice) {
                 /** @var \Magento\Backend\Model\View\Result\Forward $resultForward */
                 $resultForward = $this->resultForwardFactory->create();
                 return $resultForward->forward('noroute');
             }
             $invoice->addComment(
-                $comment,
+                $data['comment'],
                 isset($data['is_customer_notified']),
                 isset($data['is_visible_on_front'])
             );
 
-            $this->invoiceCommentSender->send($invoice, !empty($data['is_customer_notified']), $comment);
+            $this->invoiceCommentSender->send($invoice, !empty($data['is_customer_notified']), $data['comment']);
             $this->invoiceRepository->save($invoice);
 
             /** @var \Magento\Backend\Model\View\Result\Page $resultPage */

app/code/Magento/Sales/Test/Unit/Controller/Adminhtml/Order/Invoice/AddCommentTest.php

@@ -15,7 +15,6 @@
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Framework\Controller\Result\Raw;
 use Magento\Framework\Controller\Result\RawFactory;
-use Magento\Framework\Escaper;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Framework\View\Layout;
@@ -102,11 +101,6 @@ class AddCommentTest extends TestCase
      */
     protected $invoiceRepository;
 
-    /**
-     * @var Escaper|MockObject
-     */
-    private $escaper;
-
     /**
      * SetUp method
      *
@@ -191,8 +185,6 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
 
-        $this->escaper = $this->createPartialMock(Escaper::class, ['escapeHtml']);
-
         $this->controller = $objectManager->getObject(
             AddComment::class,
             [
@@ -201,8 +193,7 @@ protected function setUp(): void
                 'resultPageFactory' => $this->resultPageFactoryMock,
                 'resultRawFactory' => $this->resultRawFactoryMock,
                 'resultJsonFactory' => $this->resultJsonFactoryMock,
-                'escaper' => $this->escaper,
-                'invoiceRepository' => $this->invoiceRepository,
+                'invoiceRepository' => $this->invoiceRepository
             ]
         );
 
@@ -276,10 +267,6 @@ public function testExecute(): void
             ->method('send')
             ->with($invoiceMock, false, $data['comment']);
 
-        $this->escaper->expects($this->any())
-            ->method('escapeHtml')
-            ->willReturn($data['comment']);
-
         $resultRaw = $this->getMockBuilder(Raw::class)
             ->disableOriginalConstructor()
             ->getMock();

app/code/Magento/Sales/view/adminhtml/templates/order/comments/view.phtml

@@ -70,7 +70,7 @@
                     <?php endif; ?>
                 </span>
                 <div class="note-list-comment">
-                    <?= $escaper->escapeHtml($_comment->getComment(), ['b', 'br', 'strong', 'i', 'u', 'a']) ?>
+                    <?= nl2br($escaper->escapeHtml($_comment->getComment(), ['b', 'br', 'strong', 'i', 'u', 'a'])) ?>
                 </div>
             </li>
         <?php endforeach; ?>

dev/tests/integration/testsuite/Magento/Sales/Controller/Adminhtml/Order/Invoice/AddCommentTest.php

@@ -9,8 +9,6 @@
 
 use PHPUnit\Framework\Constraint\RegularExpression;
 use PHPUnit\Framework\Constraint\StringContains;
-use Magento\TestFramework\Helper\Bootstrap;
-use Magento\Framework\Escaper;
 
 /**
  * Class verifies invoice add comment functionality.
@@ -41,11 +39,7 @@ public function testSendEmailOnAddInvoiceComment(): void
         $this->dispatch('backend/sales/order_invoice/addComment');
 
         $html = $this->getResponse()->getBody();
-
-        $escaper = Bootstrap::getObjectManager()
-            ->get(Escaper::class);
-
-        $this->assertStringContainsString($escaper->escapeHtml($comment), $html);
+        $this->assertStringContainsString($comment, $html);
 
         $message = $this->transportBuilder->getSentMessage();
         $this->assertNotNull($message);