ACP2E-694: [Magento Cloud] REST API intermittently over writes the results of shipping results

glo23503 · glo23503 · commit cac6fcd6045c · 2022-04-11T18:42:17.000+05:30
diff --git a/app/code/Magento/Sales/Model/RefundOrder.php b/app/code/Magento/Sales/Model/RefundOrder.php
@@ -6,6 +6,7 @@
 
 namespace Magento\Sales\Model;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ResourceConnection;
 use Magento\Sales\Api\CreditmemoRepositoryInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
@@ -19,7 +20,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * Class RefundOrder
+ * Class RefundOrder for an order
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class RefundOrder implements RefundOrderInterface
@@ -74,6 +75,11 @@ class RefundOrder implements RefundOrderInterface
      */
     private $logger;
 
+    /**
+     * @var OrderMutexInterface
+     */
+    private $orderMutex;
+
     /**
      * RefundOrder constructor.
      *
@@ -87,6 +93,7 @@ class RefundOrder implements RefundOrderInterface
      * @param NotifierInterface $notifier
      * @param OrderConfig $config
      * @param LoggerInterface $logger
+     * @param OrderMutex|null $orderMutex
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -99,7 +106,8 @@ public function __construct(
         RefundOrderValidator $validator,
         NotifierInterface $notifier,
         OrderConfig $config,
-        LoggerInterface $logger
+        LoggerInterface $logger,
+        ?OrderMutexInterface $orderMutex = null
     ) {
         $this->resourceConnection = $resourceConnection;
         $this->orderStateResolver = $orderStateResolver;
@@ -111,6 +119,7 @@ public function __construct(
         $this->notifier = $notifier;
         $this->config = $config;
         $this->logger = $logger;
+        $this->orderMutex = $orderMutex ?: ObjectManager::getInstance()->get(OrderMutexInterface::class);
     }
 
     /**
@@ -124,7 +133,45 @@ public function execute(
         \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface $comment = null,
         \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface $arguments = null
     ) {
-        $connection = $this->resourceConnection->getConnection('sales');
+        return $this->orderMutex->execute(
+            (int) $orderId,
+            \Closure::fromCallable([$this, 'createRefund']),
+            [
+                $orderId,
+                $items,
+                $notify,
+                $appendComment,
+                $comment,
+                $arguments
+            ]
+        );
+    }
+
+    /**
+     * Creates refund for provided order ID
+     *
+     * @param int $orderId
+     * @param array $items
+     * @param bool $notify
+     * @param bool $appendComment
+     * @param \Magento\Sales\Api\Data\InvoiceCommentCreationInterface|null $comment
+     * @param \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface|null $arguments
+     * @return int
+     * @throws \Magento\Sales\Api\Exception\DocumentValidationExceptionInterface
+     * @throws \Magento\Sales\Api\Exception\CouldNotRefundException
+     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @throws \DomainException
+     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
+     */
+    private function createRefund(
+        $orderId,
+        array $items = [],
+        $notify = false,
+        $appendComment = false,
+        \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface $comment = null,
+        \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface $arguments = null
+    ) {
         $order = $this->orderRepository->get($orderId);
         $creditmemo = $this->creditmemoDocumentFactory->createFromOrder(
             $order,
@@ -147,7 +194,6 @@ public function execute(
                 __("Creditmemo Document Validation Error(s):\n" . implode("\n", $validationMessages->getMessages()))
             );
         }
-        $connection->beginTransaction();
         try {
             $creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
             $order->setCustomerNoteNotify($notify);
@@ -162,10 +208,8 @@ public function execute(
 
             $order = $this->orderRepository->save($order);
             $creditmemo = $this->creditmemoRepository->save($creditmemo);
-            $connection->commit();
         } catch (\Exception $e) {
             $this->logger->critical($e);
-            $connection->rollBack();
             throw new \Magento\Sales\Exception\CouldNotRefundException(
                 __('Could not save a Creditmemo, see error log for details')
             );
diff --git a/app/code/Magento/Sales/Model/ShipOrder.php b/app/code/Magento/Sales/Model/ShipOrder.php
@@ -5,6 +5,7 @@
  */
 namespace Magento\Sales\Model;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ResourceConnection;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Api\ShipmentRepositoryInterface;
@@ -75,6 +76,11 @@ class ShipOrder implements ShipOrderInterface
      */
     private $orderRegistrar;
 
+    /**
+     * @var OrderMutexInterface
+     */
+    private $orderMutex;
+
     /**
      * @param ResourceConnection $resourceConnection
      * @param OrderRepositoryInterface $orderRepository
@@ -86,6 +92,7 @@ class ShipOrder implements ShipOrderInterface
      * @param NotifierInterface $notifierInterface
      * @param OrderRegistrarInterface $orderRegistrar
      * @param LoggerInterface $logger
+     * @param OrderMutex|null $orderMutex
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -98,7 +105,8 @@ public function __construct(
         ShipOrderValidator $shipOrderValidator,
         NotifierInterface $notifierInterface,
         OrderRegistrarInterface $orderRegistrar,
-        LoggerInterface $logger
+        LoggerInterface $logger,
+        ?OrderMutexInterface $orderMutex = null
     ) {
         $this->resourceConnection = $resourceConnection;
         $this->orderRepository = $orderRepository;
@@ -110,6 +118,7 @@ public function __construct(
         $this->notifierInterface = $notifierInterface;
         $this->logger = $logger;
         $this->orderRegistrar = $orderRegistrar;
+        $this->orderMutex = $orderMutex ?: ObjectManager::getInstance()->get(OrderMutexInterface::class);
     }
 
     /**
@@ -139,8 +148,53 @@ public function execute(
         array $tracks = [],
         array $packages = [],
         \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface $arguments = null
+    )
+    {
+        return $this->orderMutex->execute(
+            (int)$orderId,
+            \Closure::fromCallable([$this, 'createShipment']),
+            [
+                $orderId,
+                $items,
+                $notify,
+                $appendComment,
+                $comment,
+                $tracks,
+                $packages,
+                $arguments
+            ]
+        );
+    }
+
+    /**
+     * Creates shipment for provided order ID
+     *
+     * @param int $orderId
+     * @param \Magento\Sales\Api\Data\ShipmentItemCreationInterface[] $items
+     * @param bool $notify
+     * @param bool $appendComment
+     * @param \Magento\Sales\Api\Data\ShipmentCommentCreationInterface|null $comment
+     * @param \Magento\Sales\Api\Data\ShipmentTrackCreationInterface[] $tracks
+     * @param \Magento\Sales\Api\Data\ShipmentPackageCreationInterface[] $packages
+     * @param \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface|null $arguments
+     * @return int
+     * @throws \Magento\Sales\Api\Exception\DocumentValidationExceptionInterface
+     * @throws \Magento\Sales\Api\Exception\CouldNotShipExceptionInterface
+     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @throws \DomainException
+     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
+     */
+    private function createShipment(
+        $orderId,
+        array $items = [],
+        $notify = false,
+        $appendComment = false,
+        \Magento\Sales\Api\Data\ShipmentCommentCreationInterface $comment = null,
+        array $tracks = [],
+        array $packages = [],
+        \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface $arguments = null
     ) {
-        $connection = $this->resourceConnection->getConnection('sales');
         $order = $this->orderRepository->get($orderId);
         $shipment = $this->shipmentDocumentFactory->create(
             $order,
@@ -166,9 +220,20 @@ public function execute(
                 __("Shipment Document Validation Error(s):\n" . implode("\n", $validationMessages->getMessages()))
             );
         }
-        $connection->beginTransaction();
         try {
             $this->orderRegistrar->register($order, $shipment);
+            /*foreach ($shipment->getItems() as $item) {
+                if ($item->getQty() > 0) {
+                    $orderItem = $item->getOrderItem();
+                }
+                $orderItem = $item->getOrderItem();
+                $orderItem->setQtyShipped( $item->getQty() );
+                $orderItem->setQtyShipped( $orderItem->getQtyShipped() + $item->getQty() );
+                $orderItem->save();
+            }
+            $order = $shipment->getOrder()->load( $shipment->getOrder()->getId() );
+            $order->save();*/
+
             $shipment = $this->shipmentRepository->save($shipment);
             if ($order->getState() === Order::STATE_NEW) {
                 $order->setState(
@@ -177,10 +242,8 @@ public function execute(
                 $order->setStatus($this->config->getStateDefaultStatus($order->getState()));
             }
             $this->orderRepository->save($order);
-            $connection->commit();
         } catch (\Exception $e) {
             $this->logger->critical($e);
-            $connection->rollBack();
             throw new \Magento\Sales\Exception\CouldNotShipException(
                 __('Could not save a shipment, see error log for details')
             );
