ENGCOM-6159: Replaced Model Save with Service Contract #24918

Author: VladimirZaets

app/code/Magento/Sales/Controller/Adminhtml/Invoice/AbstractInvoice/View.php

@@ -1,17 +1,22 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+declare(strict_types=1);
+
 namespace Magento\Sales\Controller\Adminhtml\Invoice\AbstractInvoice;
 
 use Magento\Backend\App\Action\Context;
+use Magento\Backend\Model\View\Result\ForwardFactory;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Registry;
 use Magento\Sales\Api\InvoiceRepositoryInterface;
-use Magento\Sales\Model\Order\InvoiceRepository;
 
+/**
+ * Class View
+ */
 abstract class View extends \Magento\Backend\App\Action
 {
     /**
@@ -27,7 +32,7 @@ abstract class View extends \Magento\Backend\App\Action
     protected $registry;
 
     /**
-     * @var \Magento\Backend\Model\View\Result\ForwardFactory
+     * @var ForwardFactory
      */
     protected $resultForwardFactory;
 
@@ -39,16 +44,20 @@ abstract class View extends \Magento\Backend\App\Action
     /**
      * @param Context $context
      * @param Registry $registry
-     * @param \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory
+     * @param ForwardFactory $resultForwardFactory
+     * @param InvoiceRepositoryInterface $invoiceRepository
      */
     public function __construct(
         Context $context,
         Registry $registry,
-        \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory
+        ForwardFactory $resultForwardFactory,
+        InvoiceRepositoryInterface $invoiceRepository = null
     ) {
-        $this->registry = $registry;
         parent::__construct($context);
+        $this->registry = $registry;
         $this->resultForwardFactory = $resultForwardFactory;
+        $this->invoiceRepository = $invoiceRepository ?:
+            ObjectManager::getInstance()->get(InvoiceRepositoryInterface::class);
     }
 
     /**
@@ -70,13 +79,14 @@ public function execute()
     }
 
     /**
+     * Get invoice using invoice Id from request params
+     *
      * @return \Magento\Sales\Model\Order\Invoice|bool
      */
     protected function getInvoice()
     {
         try {
-            $invoice = $this->getInvoiceRepository()
-                ->get($this->getRequest()->getParam('invoice_id'));
+            $invoice = $this->invoiceRepository->get($this->getRequest()->getParam('invoice_id'));
             $this->registry->register('current_invoice', $invoice);
         } catch (\Exception $e) {
             $this->messageManager->addErrorMessage(__('Invoice capturing error'));
@@ -85,19 +95,4 @@ protected function getInvoice()
 
         return $invoice;
     }
-
-    /**
-     * @return InvoiceRepository
-     *
-     * @deprecated 100.1.0
-     */
-    private function getInvoiceRepository()
-    {
-        if ($this->invoiceRepository === null) {
-            $this->invoiceRepository = ObjectManager::getInstance()
-                ->get(InvoiceRepositoryInterface::class);
-        }
-
-        return $this->invoiceRepository;
-    }
 }

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

@@ -1,23 +1,30 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\Sales\Controller\Adminhtml\Order\Invoice;
 
 use Magento\Backend\App\Action\Context;
+use Magento\Backend\Model\View\Result\ForwardFactory;
+use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Sales\Api\InvoiceRepositoryInterface;
 use Magento\Sales\Model\Order\Email\Sender\InvoiceCommentSender;
-use Magento\Sales\Model\Order\Invoice;
-use Magento\Backend\App\Action;
 use Magento\Framework\Registry;
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Framework\View\Result\PageFactory;
 use Magento\Framework\Controller\Result\RawFactory;
 
-class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInvoice\View
+/**
+ * Class AddComment
+ */
+class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInvoice\View implements
+    HttpPostActionInterface
 {
     /**
      * @var InvoiceCommentSender
@@ -39,29 +46,38 @@ class AddComment extends \Magento\Sales\Controller\Adminhtml\Invoice\AbstractInv
      */
     protected $resultRawFactory;
 
+    /**
+     * @var InvoiceRepositoryInterface
+     */
+    protected $invoiceRepository;
+
     /**
      * @param Context $context
      * @param Registry $registry
-     * @param \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory
+     * @param ForwardFactory $resultForwardFactory
      * @param InvoiceCommentSender $invoiceCommentSender
      * @param JsonFactory $resultJsonFactory
      * @param PageFactory $resultPageFactory
      * @param RawFactory $resultRawFactory
+     * @param InvoiceRepositoryInterface $invoiceRepository
      */
     public function __construct(
         Context $context,
         Registry $registry,
-        \Magento\Backend\Model\View\Result\ForwardFactory $resultForwardFactory,
+        ForwardFactory $resultForwardFactory,
         InvoiceCommentSender $invoiceCommentSender,
         JsonFactory $resultJsonFactory,
         PageFactory $resultPageFactory,
-        RawFactory $resultRawFactory
+        RawFactory $resultRawFactory,
+        InvoiceRepositoryInterface $invoiceRepository = null
     ) {
         $this->invoiceCommentSender = $invoiceCommentSender;
         $this->resultJsonFactory = $resultJsonFactory;
         $this->resultPageFactory = $resultPageFactory;
         $this->resultRawFactory = $resultRawFactory;
-        parent::__construct($context, $registry, $resultForwardFactory);
+        $this->invoiceRepository = $invoiceRepository ?:
+            ObjectManager::getInstance()->get(InvoiceRepositoryInterface::class);
+        parent::__construct($context, $registry, $resultForwardFactory, $invoiceRepository);
     }
 
     /**
@@ -90,7 +106,7 @@ public function execute()
             );
 
             $this->invoiceCommentSender->send($invoice, !empty($data['is_customer_notified']), $data['comment']);
-            $invoice->save();
+            $this->invoiceRepository->save($invoice);
 
             /** @var \Magento\Backend\Model\View\Result\Page $resultPage */
             $resultPage = $this->resultPageFactory->create();

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

@@ -3,6 +3,9 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+declare(strict_types=1);
+
 namespace Magento\Sales\Test\Unit\Controller\Adminhtml\Order\Invoice;
 
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
@@ -186,7 +189,8 @@ protected function setUp()
                 'invoiceCommentSender' => $this->commentSenderMock,
                 'resultPageFactory' => $this->resultPageFactoryMock,
                 'resultRawFactory' => $this->resultRawFactoryMock,
-                'resultJsonFactory' => $this->resultJsonFactoryMock
+                'resultJsonFactory' => $this->resultJsonFactoryMock,
+                'invoiceRepository' => $this->invoiceRepository
             ]
         );
 
@@ -230,8 +234,9 @@ public function testExecute()
         $invoiceMock->expects($this->once())
             ->method('addComment')
             ->with($data['comment'], false, false);
-        $invoiceMock->expects($this->once())
-            ->method('save');
+        $this->invoiceRepository->expects($this->once())
+            ->method('save')
+            ->with($invoiceMock);
 
         $this->invoiceRepository->expects($this->once())
             ->method('get')
@@ -307,11 +312,11 @@ public function testExecuteModelException()
     public function testExecuteException()
     {
         $response = ['error' => true, 'message' => 'Cannot add new comment.'];
-        $e = new \Exception('test');
+        $error = new \Exception('test');
 
         $this->requestMock->expects($this->once())
             ->method('getParam')
-            ->will($this->throwException($e));
+            ->will($this->throwException($error));
 
         $this->resultJsonFactoryMock->expects($this->once())
             ->method('create')