Merge remote-tracking branch 'l3/ACP2E-2055' into PR-Tier3-04-29-2024-olga

Author: veloraven

app/code/Magento/Quote/Model/CartLockedException.php

@@ -0,0 +1,29 @@
+<?php
+/************************************************************************
+ *
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ************************************************************************
+ */
+declare(strict_types=1);
+
+namespace Magento\Quote\Model;
+
+use Magento\Framework\Exception\StateException;
+
+/**
+ * Thrown when the cart is locked for processing.
+ */
+class CartLockedException extends StateException
+{
+
+}

app/code/Magento/Quote/Model/CartMutex.php

@@ -0,0 +1,75 @@
+<?php
+/************************************************************************
+ *
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ************************************************************************
+ */
+declare(strict_types=1);
+
+namespace Magento\Quote\Model;
+
+use Magento\Framework\Lock\LockManagerInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @inheritDoc
+ */
+class CartMutex implements CartMutexInterface
+{
+    /**
+     * @var LockManagerInterface
+     */
+    private $lockManager;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param LockManagerInterface $lockManager
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        LockManagerInterface $lockManager,
+        LoggerInterface $logger
+    ) {
+        $this->lockManager = $lockManager;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function execute(int $id, callable $callable, array $args = [])
+    {
+        $lockName = 'cart_lock_' . $id;
+
+        if (!$this->lockManager->lock($lockName, 0)) {
+            $this->logger->critical(
+                'The cart is locked for processing, the request has been aborted. Quote ID: ' . $id
+            );
+            throw new CartLockedException(
+                __('The cart is locked for processing. Please try again later.')
+            );
+        }
+
+        try {
+            $result = $callable(...$args);
+        } finally {
+            $this->lockManager->unlock($lockName);
+        }
+
+        return $result;
+    }
+}

app/code/Magento/Quote/Model/CartMutexInterface.php

@@ -0,0 +1,36 @@
+<?php
+/************************************************************************
+ *
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ************************************************************************
+ */
+declare(strict_types=1);
+
+namespace Magento\Quote\Model;
+
+/**
+ * Intended to prevent race conditions during quote processing by concurrent requests.
+ */
+interface CartMutexInterface
+{
+    /**
+     * Acquires a lock for quote, executes callable and releases the lock after.
+     *
+     * @param int $id
+     * @param callable $callable
+     * @param array $args
+     * @return mixed
+     * @throws CartLockedException
+     */
+    public function execute(int $id, callable $callable, array $args = []);
+}

app/code/Magento/Quote/Model/QuoteManagement.php

@@ -53,10 +53,6 @@
  */
 class QuoteManagement implements CartManagementInterface, ResetAfterRequestInterface
 {
-    private const LOCK_PREFIX = 'PLACE_ORDER_';
-
-    private const LOCK_TIMEOUT = 0;
-
     /**
      * @var EventManager
      */
@@ -157,11 +153,6 @@ class QuoteManagement implements CartManagementInterface, ResetAfterRequestInter
      */
     protected $quoteFactory;
 
-    /**
-     * @var LockManagerInterface
-     */
-    private $lockManager;
-
     /**
      * @var QuoteIdMaskFactory
      */
@@ -187,6 +178,11 @@ class QuoteManagement implements CartManagementInterface, ResetAfterRequestInter
      */
     private $remoteAddress;
 
+    /**
+     * @var CartMutexInterface
+     */
+    private $cartMutex;
+
     /**
      * @param EventManager $eventManager
      * @param SubmitQuoteValidator $submitQuoteValidator
@@ -211,9 +207,11 @@ class QuoteManagement implements CartManagementInterface, ResetAfterRequestInter
      * @param QuoteIdMaskFactory|null $quoteIdMaskFactory
      * @param AddressRepositoryInterface|null $addressRepository
      * @param RequestInterface|null $request
-     * @param RemoteAddress $remoteAddress
+     * @param RemoteAddress|null $remoteAddress
      * @param LockManagerInterface $lockManager
+     * @param CartMutexInterface|null $cartMutex
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         EventManager $eventManager,
@@ -240,7 +238,8 @@ public function __construct(
         AddressRepositoryInterface $addressRepository = null,
         RequestInterface $request = null,
         RemoteAddress $remoteAddress = null,
-        LockManagerInterface $lockManager = null
+        LockManagerInterface $lockManager = null,
+        ?CartMutexInterface $cartMutex = null
     ) {
         $this->eventManager = $eventManager;
         $this->submitQuoteValidator = $submitQuoteValidator;
@@ -270,8 +269,8 @@ public function __construct(
             ->get(RequestInterface::class);
         $this->remoteAddress = $remoteAddress ?: ObjectManager::getInstance()
             ->get(RemoteAddress::class);
-        $this->lockManager = $lockManager ?: ObjectManager::getInstance()
-            ->get(LockManagerInterface::class);
+        $this->cartMutex = $cartMutex
+            ?? ObjectManager::getInstance()->get(CartMutexInterface::class);
     }
 
     /**
@@ -397,10 +396,28 @@ protected function createCustomerCart($customerId, $storeId)
 
     /**
      * @inheritdoc
+     */
+    public function placeOrder($cartId, PaymentInterface $paymentMethod = null)
+    {
+        return $this->cartMutex->execute(
+            (int)$cartId,
+            \Closure::fromCallable([$this, 'placeOrderRun']),
+            [$cartId, $paymentMethod]
+        );
+    }
+
+    /**
+     * Places an order for a specified cart.
+     *
+     * @param int $cartId The cart ID.
+     * @param PaymentInterface|null $paymentMethod
+     * @throws CouldNotSaveException
+     * @return int Order ID.
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
      */
-    public function placeOrder($cartId, PaymentInterface $paymentMethod = null)
+    private function placeOrderRun($cartId, PaymentInterface $paymentMethod = null)
     {
         $quote = $this->quoteRepository->getActive($cartId);
         $customer = $quote->getCustomer();
@@ -614,12 +631,6 @@ protected function submitQuote(QuoteEntity $quote, $orderData = [])
             ]
         );
 
-        $lockedName = self::LOCK_PREFIX . $quote->getId();
-        if (!$this->lockManager->lock($lockedName, self::LOCK_TIMEOUT)) {
-            throw new LocalizedException(__(
-                'A server error stopped your order from being placed. Please try to place your order again.'
-            ));
-        }
         try {
             $order = $this->orderManagement->place($order);
             $quote->setIsActive(false);
@@ -632,7 +643,6 @@ protected function submitQuote(QuoteEntity $quote, $orderData = [])
             );
             $this->quoteRepository->save($quote);
         } catch (\Exception $e) {
-            $this->lockManager->unlock($lockedName);
             $this->rollbackAddresses($quote, $order, $e);
             throw $e;
         }

app/code/Magento/Quote/Model/QuoteRepository.php

@@ -12,6 +12,7 @@
 use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
 use Magento\Framework\Api\SearchCriteriaInterface;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\RequestSafetyInterface;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
@@ -96,6 +97,11 @@ class QuoteRepository implements CartRepositoryInterface, ResetAfterRequestInter
      */
     private $cartFactory;
 
+    /**
+     * @var RequestSafetyInterface
+     */
+    private $requestSafety;
+
     /**
      * Constructor
      *
@@ -107,6 +113,7 @@ class QuoteRepository implements CartRepositoryInterface, ResetAfterRequestInter
      * @param CollectionProcessorInterface|null $collectionProcessor
      * @param QuoteCollectionFactory|null $quoteCollectionFactory
      * @param CartInterfaceFactory|null $cartFactory
+     * @param RequestSafetyInterface|null $requestSafety
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
@@ -117,7 +124,8 @@ public function __construct(
         JoinProcessorInterface $extensionAttributesJoinProcessor,
         CollectionProcessorInterface $collectionProcessor = null,
         QuoteCollectionFactory $quoteCollectionFactory = null,
-        CartInterfaceFactory $cartFactory = null
+        CartInterfaceFactory $cartFactory = null,
+        RequestSafetyInterface $requestSafety = null
     ) {
         $this->quoteFactory = $quoteFactory;
         $this->storeManager = $storeManager;
@@ -128,6 +136,7 @@ public function __construct(
         $this->quoteCollectionFactory = $quoteCollectionFactory ?: ObjectManager::getInstance()
             ->get(QuoteCollectionFactory::class);
         $this->cartFactory = $cartFactory ?: ObjectManager::getInstance()->get(CartInterfaceFactory::class);
+        $this->requestSafety = $requestSafety ?: ObjectManager::getInstance()->get(RequestSafetyInterface::class);
     }
 
     /**
@@ -178,25 +187,70 @@ public function getForCustomer($customerId, array $sharedStoreIds = [])
      */
     public function getActive($cartId, array $sharedStoreIds = [])
     {
+        $this->validateCachedActiveQuote((int)$cartId);
         $quote = $this->get($cartId, $sharedStoreIds);
         if (!$quote->getIsActive()) {
             throw NoSuchEntityException::singleField('cartId', $cartId);
         }
         return $quote;
     }
 
+    /**
+     * Validates if cached quote is still active.
+     *
+     * @param int $cartId
+     * @return void
+     * @throws NoSuchEntityException
+     */
+    private function validateCachedActiveQuote(int $cartId): void
+    {
+        if (isset($this->quotesById[$cartId]) && !$this->requestSafety->isSafeMethod()) {
+            $quote = $this->cartFactory->create();
+            if (is_callable([$quote, 'setSharedStoreIds'])) {
+                $quote->setSharedStoreIds(['*']);
+            }
+            $quote->loadActive($cartId);
+            if (!$quote->getIsActive()) {
+                throw NoSuchEntityException::singleField('cartId', $cartId);
+            }
+        }
+    }
+
     /**
      * @inheritdoc
      */
     public function getActiveForCustomer($customerId, array $sharedStoreIds = [])
     {
+        $this->validateCachedCustomerActiveQuote((int)$customerId);
         $quote = $this->getForCustomer($customerId, $sharedStoreIds);
         if (!$quote->getIsActive()) {
             throw NoSuchEntityException::singleField('customerId', $customerId);
         }
         return $quote;
     }
 
+    /**
+     * Validates if cached customer quote is still active.
+     *
+     * @param int $customerId
+     * @return void
+     * @throws NoSuchEntityException
+     */
+    private function validateCachedCustomerActiveQuote(int $customerId): void
+    {
+        if (isset($this->quotesByCustomerId[$customerId]) && !$this->requestSafety->isSafeMethod()) {
+            $quoteId = $this->quotesByCustomerId[$customerId]->getId();
+            $quote = $this->cartFactory->create();
+            if (is_callable([$quote, 'setSharedStoreIds'])) {
+                $quote->setSharedStoreIds(['*']);
+            }
+            $quote->loadActive($quoteId);
+            if (!$quote->getIsActive()) {
+                throw NoSuchEntityException::singleField('customerId', $customerId);
+            }
+        }
+    }
+
     /**
      * @inheritdoc
      */