ACP2E-4117: Duplicate order found for same customer in Multishipping

Author: bubasuma

app/code/Magento/Multishipping/Model/Checkout/Type/Multishipping.php

@@ -10,6 +10,7 @@
 use Magento\Customer\Api\AddressRepositoryInterface;
 use Magento\Framework\Exception\NotFoundException;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
+use Magento\Quote\Model\CartMutexInterface;
 use Magento\Quote\Model\Quote;
 use Magento\Quote\Model\Quote\Address;
 use Magento\Quote\Model\Quote\Item;
@@ -180,6 +181,11 @@ class Multishipping extends \Magento\Framework\DataObject
      */
     private $dataObjectHelper;
 
+    /**
+     * @var CartMutexInterface
+     */
+    private $cartMutex;
+
     /**
      * @param Session $checkoutSession
      * @param \Magento\Customer\Model\Session $customerSession
@@ -208,6 +214,7 @@ class Multishipping extends \Magento\Framework\DataObject
      * @param Multishipping\PlaceOrderFactory|null $placeOrderFactory
      * @param LoggerInterface|null $logger
      * @param \Magento\Framework\Api\DataObjectHelper|null $dataObjectHelper
+     * @param CartMutexInterface|null $cartMutex
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -237,7 +244,8 @@ public function __construct(
         ?AllowedCountries $allowedCountryReader = null,
         ?Multishipping\PlaceOrderFactory $placeOrderFactory = null,
         ?LoggerInterface $logger = null,
-        ?\Magento\Framework\Api\DataObjectHelper $dataObjectHelper = null
+        ?\Magento\Framework\Api\DataObjectHelper $dataObjectHelper = null,
+        ?CartMutexInterface $cartMutex = null
     ) {
         $this->_eventManager = $eventManager;
         $this->_scopeConfig = $scopeConfig;
@@ -270,6 +278,8 @@ public function __construct(
             ->get(LoggerInterface::class);
         $this->dataObjectHelper = $dataObjectHelper ?: ObjectManager::getInstance()
             ->get(\Magento\Framework\Api\DataObjectHelper::class);
+        $this->cartMutex = $cartMutex ?: ObjectManager::getInstance()
+            ->get(CartMutexInterface::class);
         parent::__construct($data);
         $this->_init();
     }
@@ -855,6 +865,18 @@ protected function _validate()
      * @throws \Exception
      */
     public function createOrders()
+    {
+        return $this->cartMutex->execute((int)$this->getQuote()->getId(), $this->createOrdersMutexCallback(...));
+    }
+
+    /**
+     * Mutex callback for createOrders()
+     *
+     * @see createOrders
+     * @return Multishipping
+     * @throws \Exception
+     */
+    private function createOrdersMutexCallback()
     {
         $orderIds = [];
         $this->_validate();

app/code/Magento/Multishipping/Test/Unit/Model/Checkout/Type/MultishippingTest.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2015 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
@@ -189,6 +189,11 @@ class MultishippingTest extends TestCase
      */
     private $scopeConfigMock;
 
+    /**
+     * @var \Magento\Quote\Model\CartMutexInterface::class
+     */
+    private $cartMutex;
+
     /**
      * @inheritDoc
      */
@@ -243,6 +248,8 @@ protected function setUp(): void
             ->getMock();
         $logger = $this->createSimpleMock(LoggerInterface::class);
 
+        $this->cartMutex = $this->createMock(\Magento\Quote\Model\CartMutexInterface::class);
+
         $this->model = new Multishipping(
             $this->checkoutSessionMock,
             $this->customerSessionMock,
@@ -270,7 +277,8 @@ protected function setUp(): void
             $allowedCountryReaderMock,
             $this->placeOrderFactoryMock,
             $logger,
-            $this->dataObjectHelperMock
+            $this->dataObjectHelperMock,
+            $this->cartMutex
         );
 
         $this->shippingAssignmentProcessorMock = $this->createSimpleMock(ShippingAssignmentProcessor::class);
@@ -593,6 +601,8 @@ function ($arg1, $arg2) use ($orderAddressMock, $billingAddressMock, $shippingAd
         $this->placeOrderFactoryMock->method('create')->with($paymentProviderCode)->willReturn($placeOrderServiceMock);
         $this->quoteRepositoryMock->method('save')->with($this->quoteMock);
 
+        $this->assertMutexIsInvoked();
+
         $this->model->createOrders();
     }
 
@@ -696,6 +706,8 @@ function ($arg1, $arg2) use ($orderAddressMock, $billingAddressMock, $shippingAd
 
         $this->expectExceptionMessage('Quote address for failed order ID "1" not found.');
 
+        $this->assertMutexIsInvoked();
+
         $this->model->createOrders();
     }
 
@@ -986,6 +998,8 @@ public function testCreateOrdersCountryNotPresentInAllowedListException(): void
             ->willReturn([$shippingAddressMock]);
         $this->expectExceptionMessage($exceptionMessage);
 
+        $this->assertMutexIsInvoked();
+
         $this->model->createOrders();
     }
 
@@ -1213,4 +1227,23 @@ public static function getConfigCreateOrders(): array
             ]
         ];
     }
+
+    private function assertMutexIsInvoked(): void
+    {
+        $this->cartMutex
+            ->expects($this->once())
+            ->method('execute')
+            ->with(
+                $this->quoteMock->getId(),
+                $this->callback(is_callable(...))
+            )
+            ->willReturnCallback(
+                function ($arg1, $callback) {
+                    if ($arg1 != $this->quoteMock->getId()) {
+                        throw new \Exception('Quote ID does not match.');
+                    }
+                    return $callback();
+                }
+            );
+    }
 }