ENGCOM-5405: #23345: Creditmemo getOrder() method loads order incorrectly. #23358

Author: sivaschenko

app/code/Magento/Sales/Model/Order/Creditmemo.php

@@ -7,13 +7,13 @@
 namespace Magento\Sales\Model\Order;
 
 use Magento\Framework\Api\AttributeValueFactory;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Sales\Api\Data\CreditmemoInterface;
+use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\AbstractModel;
 use Magento\Sales\Model\EntityInterface;
-use Magento\Sales\Model\Order\InvoiceFactory;
-use Magento\Framework\App\Config\ScopeConfigInterface;
 
 /**
  * Order creditmemo model
@@ -126,6 +126,11 @@ class Creditmemo extends AbstractModel implements EntityInterface, CreditmemoInt
      */
     private $scopeConfig;
 
+    /**
+     * @var OrderRepositoryInterface
+     */
+    private $orderRepository;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -144,6 +149,7 @@ class Creditmemo extends AbstractModel implements EntityInterface, CreditmemoInt
      * @param array $data
      * @param InvoiceFactory $invoiceFactory
      * @param ScopeConfigInterface $scopeConfig
+     * @param OrderRepositoryInterface $orderRepository
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -163,7 +169,8 @@ public function __construct(
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = [],
         InvoiceFactory $invoiceFactory = null,
-        ScopeConfigInterface $scopeConfig = null
+        ScopeConfigInterface $scopeConfig = null,
+        OrderRepositoryInterface $orderRepository = null
     ) {
         $this->_creditmemoConfig = $creditmemoConfig;
         $this->_orderFactory = $orderFactory;
@@ -175,6 +182,7 @@ public function __construct(
         $this->priceCurrency = $priceCurrency;
         $this->invoiceFactory = $invoiceFactory ?: ObjectManager::getInstance()->get(InvoiceFactory::class);
         $this->scopeConfig = $scopeConfig ?: ObjectManager::getInstance()->get(ScopeConfigInterface::class);
+        $this->orderRepository = $orderRepository ?? ObjectManager::getInstance()->get(OrderRepositoryInterface::class);
         parent::__construct(
             $context,
             $registry,
@@ -237,8 +245,11 @@ public function setOrder(\Magento\Sales\Model\Order $order)
     public function getOrder()
     {
         if (!$this->_order instanceof \Magento\Sales\Model\Order) {
-            $this->_order = $this->_orderFactory->create()->load($this->getOrderId());
+            $this->_order = $this->getOrderId() ?
+                $this->orderRepository->get($this->getOrderId()) :
+                $this->_orderFactory->create();
         }
+
         return $this->_order->setHistoryEntityName($this->entityType);
     }
 
@@ -449,6 +460,7 @@ public function canVoid()
      * Retrieve Creditmemo states array
      *
      * @return array
+     * phpcs:disable Magento2.Functions.StaticFunction
      */
     public static function getStates()
     {
@@ -461,11 +473,12 @@ public static function getStates()
         }
         return static::$_states;
     }
+    // phpcs:enable
 
     /**
      * Retrieve Creditmemo state name by state identifier
      *
-     * @param   int $stateId
+     * @param  int $stateId
      * @return \Magento\Framework\Phrase
      */
     public function getStateName($stateId = null)

app/code/Magento/Sales/Test/Unit/Model/Order/CreditmemoTest.php

@@ -6,6 +6,7 @@
 
 namespace Magento\Sales\Test\Unit\Model\Order;
 
+use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\ResourceModel\OrderFactory;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\Sales\Model\ResourceModel\Order\Creditmemo\Item\CollectionFactory;
@@ -20,9 +21,9 @@
 class CreditmemoTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @var OrderFactory |\PHPUnit_Framework_MockObject_MockObject
+     * @var OrderRepositoryInterface |\PHPUnit_Framework_MockObject_MockObject
      */
-    protected $orderFactory;
+    protected $orderRepository;
 
     /**
      * @var \Magento\Sales\Model\Order\Creditmemo
@@ -41,7 +42,7 @@ class CreditmemoTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $this->orderFactory = $this->createPartialMock(\Magento\Sales\Model\OrderFactory::class, ['create']);
+        $this->orderRepository = $this->createMock(OrderRepositoryInterface::class);
         $this->scopeConfigMock = $this->createMock(ScopeConfigInterface::class);
 
         $objectManagerHelper = new ObjectManagerHelper($this);
@@ -61,15 +62,15 @@ protected function setUp()
             'creditmemoConfig' => $this->createMock(
                 \Magento\Sales\Model\Order\Creditmemo\Config::class
             ),
-            'orderFactory' => $this->orderFactory,
             'cmItemCollectionFactory' => $this->cmItemCollectionFactoryMock,
             'calculatorFactory' => $this->createMock(\Magento\Framework\Math\CalculatorFactory::class),
             'storeManager' => $this->createMock(\Magento\Store\Model\StoreManagerInterface::class),
             'commentFactory' => $this->createMock(\Magento\Sales\Model\Order\Creditmemo\CommentFactory::class),
             'commentCollectionFactory' => $this->createMock(
                 \Magento\Sales\Model\ResourceModel\Order\Creditmemo\Comment\CollectionFactory::class
             ),
-            'scopeConfig' => $this->scopeConfigMock
+            'scopeConfig' => $this->scopeConfigMock,
+            'orderRepository' => $this->orderRepository,
         ];
         $this->creditmemo = $objectManagerHelper->getObject(
             \Magento\Sales\Model\Order\Creditmemo::class,
@@ -91,14 +92,10 @@ public function testGetOrder()
             ->method('setHistoryEntityName')
             ->with($entityName)
             ->will($this->returnSelf());
-        $order->expects($this->atLeastOnce())
-            ->method('load')
+        $this->orderRepository->expects($this->atLeastOnce())
+            ->method('get')
             ->with($orderId)
-            ->will($this->returnValue($order));
-
-        $this->orderFactory->expects($this->atLeastOnce())
-            ->method('create')
-            ->will($this->returnValue($order));
+            ->willReturn($order);
 
         $this->assertEquals($order, $this->creditmemo->getOrder());
     }