ACP2E-3211: Duplicated items in cart

Author: bubasuma

app/code/Magento/Checkout/Controller/Cart/Add.php

@@ -6,10 +6,11 @@
  */
 namespace Magento\Checkout\Controller\Cart;
 
-use Magento\Checkout\Model\Cart\RequestQuantityProcessor;
-use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Checkout\Model\AddProductToCart;
 use Magento\Checkout\Model\Cart as CustomerCart;
+use Magento\Checkout\Model\Cart\RequestQuantityProcessor;
+use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Controller\ResultInterface;
@@ -33,6 +34,11 @@ class Add extends \Magento\Checkout\Controller\Cart implements HttpPostActionInt
      */
     private $quantityProcessor;
 
+    /**
+     * @var AddProductToCart
+     */
+    private AddProductToCart $addProductToCart;
+
     /**
      * @param \Magento\Framework\App\Action\Context $context
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
@@ -42,6 +48,7 @@ class Add extends \Magento\Checkout\Controller\Cart implements HttpPostActionInt
      * @param CustomerCart $cart
      * @param ProductRepositoryInterface $productRepository
      * @param RequestQuantityProcessor|null $quantityProcessor
+     * @param AddProductToCart|null $addProductToCart
      * @codeCoverageIgnore
      */
     public function __construct(
@@ -52,7 +59,8 @@ public function __construct(
         \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator,
         CustomerCart $cart,
         ProductRepositoryInterface $productRepository,
-        ?RequestQuantityProcessor $quantityProcessor = null
+        ?RequestQuantityProcessor $quantityProcessor = null,
+        ?AddProductToCart $addProductToCart = null
     ) {
         parent::__construct(
             $context,
@@ -65,6 +73,8 @@ public function __construct(
         $this->productRepository = $productRepository;
         $this->quantityProcessor = $quantityProcessor
             ?? ObjectManager::getInstance()->get(RequestQuantityProcessor::class);
+        $this->addProductToCart = $addProductToCart
+            ?? ObjectManager::getInstance()->get(AddProductToCart::class);
     }
 
     /**
@@ -123,11 +133,7 @@ public function execute()
                 return $this->goBack();
             }
 
-            $this->cart->addProduct($product, $params);
-            if (!empty($related)) {
-                $this->cart->addProductsByIds(explode(',', $related));
-            }
-            $this->cart->save();
+            $this->addProductToCart->execute($this->cart, $product, $params, $related ? explode(',', $related) : []);
 
             /**
              * @todo remove wishlist observer \Magento\Wishlist\Observer\AddToCart

app/code/Magento/Checkout/Model/AddProductToCart.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ */
+declare(strict_types=1);
+
+namespace Magento\Checkout\Model;
+
+use Magento\Catalog\Model\Product;
+use Magento\Framework\Stdlib\DateTime\DateTime;
+use Magento\Quote\Api\CartRepositoryInterfaceFactory;
+use Magento\Quote\Api\Data\CartInterface;
+use Magento\Quote\Model\QuoteMutexInterface;
+
+class AddProductToCart
+{
+    /**
+     * @param QuoteMutexInterface $quoteMutex
+     * @param CartRepositoryInterfaceFactory $quoteRepositoryFactory
+     * @param DateTime $dateTime
+     */
+    public function __construct(
+        private readonly QuoteMutexInterface $quoteMutex,
+        private readonly CartRepositoryInterfaceFactory $quoteRepositoryFactory,
+        private readonly DateTime $dateTime
+    ) {
+    }
+
+    /**
+     * Add product to cart
+     *
+     * @param Cart $cart
+     * @param Product $product
+     * @param array $buyRequest Buy request info
+     * @param array $related Product IDs to add to the cart along with the main product
+     * @return bool
+     * @throws \Throwable
+     */
+    public function execute(Cart $cart, Product $product, array $buyRequest = [], array $related = []): bool
+    {
+        if (!$cart->getQuote()->getId()) {
+            return $this->add($cart, $product, $buyRequest, $related);
+        }
+
+        return $this->quoteMutex->execute(
+            [(int) $cart->getQuote()->getId()],
+            function (array $quotes = []) use ($cart, $product, $buyRequest, $related) {
+                $reload = true;
+                // check if the mutex provided the quote
+                if (!empty($quotes)) {
+                    // check if the quote was updated since the last load
+                    // if not, we can use the quote in memory to avoid full reload which is expensive and unnecessary
+                    $lastUpdatedAt = $cart->getQuote()->getUpdatedAt()
+                        ?: $cart->getQuote()->getOrigData(CartInterface::KEY_UPDATED_AT);
+                    $quote = current($quotes);
+                    $updatedAt = $quote->getUpdatedAt();
+                    $reload = $updatedAt
+                        && $lastUpdatedAt
+                        && $this->dateTime->timestamp($updatedAt) > $this->dateTime->timestamp($lastUpdatedAt);
+                }
+                if ($reload) {
+                    // bypass repository cache by creating a new repository instead of using the shared repository
+                    $quote = $this->quoteRepositoryFactory->create()->getActive($cart->getQuote()->getId());
+                    $cart->setQuote($quote);
+                    $cart->getCheckoutSession()->replaceQuote($quote);
+                }
+                return $this->add($cart, $product, $buyRequest, $related);
+            },
+        );
+    }
+
+    /**
+     * Add product to cart
+     *
+     * @param Cart $cart
+     * @param Product $product
+     * @param array $buyRequest
+     * @param array $related
+     * @return bool
+     */
+    private function add(Cart $cart, Product $product, array $buyRequest, array $related = []): bool
+    {
+        $cart->addProduct($product, $buyRequest);
+        if (!empty($related)) {
+            $cart->addProductsByIds($related);
+        }
+        $cart->save();
+        return true;
+    }
+}

app/code/Magento/Checkout/Test/Unit/Controller/Cart/AddTest.php

@@ -7,16 +7,31 @@
 
 namespace Magento\Checkout\Test\Unit\Controller\Cart;
 
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Catalog\Model\Product;
 use Magento\Checkout\Controller\Cart\Add;
+use Magento\Checkout\Model\AddProductToCart;
+use Magento\Checkout\Model\Cart;
+use Magento\Checkout\Model\Cart\RequestQuantityProcessor;
+use Magento\Framework\App\Request\Http;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Controller\Result\Redirect;
 use Magento\Framework\Controller\Result\RedirectFactory;
 use Magento\Framework\Data\Form\FormKey\Validator;
+use Magento\Framework\Json\Helper\Data as JsonSerializer;
+use Magento\Framework\Locale\ResolverInterface;
 use Magento\Framework\Message\ManagerInterface;
+use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
+use Magento\Quote\Model\Quote;
+use Magento\Store\Model\Store;
+use Magento\Store\Model\StoreManagerInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class AddTest extends TestCase
 {
     /**
@@ -44,6 +59,36 @@ class AddTest extends TestCase
      */
     private $messageManager;
 
+    /**
+     * @var ProductRepositoryInterface&MockObject
+     */
+    private $productRepository;
+
+    /**
+     * @var ObjectManagerInterface&MockObject
+     */
+    private $objectManagerMock;
+
+    /**
+     * @var RequestQuantityProcessor&MockObject
+     */
+    private $quantityProcessor;
+
+    /**
+     * @var AddProductToCart&MockObject
+     */
+    private $addProductToCart;
+
+    /**
+     * @var Cart&MockObject
+     */
+    private $cart;
+
+    /**
+     * @var \Magento\Framework\App\Response\Http&MockObject
+     */
+    private $response;
+
     /**
      * @var Add|MockObject
      */
@@ -63,21 +108,34 @@ protected function setUp(): void
             $this->getMockBuilder(RedirectFactory::class)
                 ->disableOriginalConstructor()
                 ->getMock();
-        $this->request = $this->getMockBuilder(RequestInterface::class)
+        $this->request = $this->getMockBuilder(Http::class)
             ->disableOriginalConstructor()
             ->getmock();
         $this->messageManager = $this->getMockBuilder(ManagerInterface::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
 
+        $this->productRepository = $this->createMock(ProductRepositoryInterface::class);
+        $this->objectManagerMock = $this->createMock(ObjectManagerInterface::class);
+        $this->quantityProcessor = $this->createMock(RequestQuantityProcessor::class);
+        $this->addProductToCart = $this->createMock(AddProductToCart::class);
+        $this->cart = $this->createMock(Cart::class);
+        $this->response = $this->createMock(\Magento\Framework\App\Response\Http::class);
+
         $this->objectManagerHelper = new ObjectManagerHelper($this);
         $this->cartAdd = $this->objectManagerHelper->getObject(
             Add::class,
             [
                 '_formKeyValidator' => $this->formKeyValidator,
                 'resultRedirectFactory' => $this->resultRedirectFactory,
                 '_request' => $this->request,
-                'messageManager' => $this->messageManager
+                'messageManager' => $this->messageManager,
+                'productRepository' => $this->productRepository,
+                '_objectManager' => $this->objectManagerMock,
+                'quantityProcessor' => $this->quantityProcessor,
+                'addProductToCart' => $this->addProductToCart,
+                'cart' => $this->cart,
+                '_response' => $this->response
             ]
         );
     }
@@ -87,7 +145,7 @@ protected function setUp(): void
      *
      * @return void
      */
-    public function testExecute()
+    public function testExecuteWhenFormKeyValidatorFails(): void
     {
         $redirect = $this->getMockBuilder(Redirect::class)
             ->disableOriginalConstructor()
@@ -100,4 +158,62 @@ public function testExecute()
         $redirect->expects($this->once())->method('setPath')->with($path)->willReturnSelf();
         $this->assertEquals($redirect, $this->cartAdd->execute());
     }
+
+    public function testExecuteWithValidData(): void
+    {
+        $productId = 1;
+        $storeId = 1;
+        $params = ['qty' => 1];
+        $product = $this->createMock(Product::class);
+        $quote = $this->createMock(Quote::class);
+        $storeManager = $this->createMock(StoreManagerInterface::class);
+        $store = $this->createMock(Store::class);
+        $localeResolver = $this->createMock(ResolverInterface::class);
+        $storeManager->expects($this->once())
+            ->method('getStore')
+            ->willReturn($store);
+        $store->expects($this->once())
+            ->method('getId')
+            ->willReturn($storeId);
+        $this->request->method('getParam')
+            ->willReturnMap([
+                ['product', null, $productId],
+                ['related_product', null, '2,3'],
+                ['return_url', null, '/sku.html']
+            ]);
+        $this->request->expects($this->once())
+            ->method('getParams')
+            ->willReturn($params);
+        $this->request->expects($this->once())
+            ->method('isAjax')
+            ->willReturn(true);
+        $this->productRepository->expects($this->once())
+            ->method('getById')
+            ->with($productId, false, $storeId)
+            ->willReturn($product);
+        $this->objectManagerMock->method('get')
+            ->with()
+            ->willReturnMap([
+                [StoreManagerInterface::class, $storeManager],
+                [ResolverInterface::class, $localeResolver],
+                [JsonSerializer::class, $this->createMock(JsonSerializer::class)],
+            ]);
+        $this->addProductToCart->expects($this->once())
+            ->method('execute')
+            ->with($this->cart, $product, $params, [2, 3])
+            ->willReturn(true);
+        $this->quantityProcessor->expects($this->once())
+            ->method('prepareQuantity')
+            ->with($params['qty'])
+            ->willReturn($params['qty']);
+        $this->cart->expects($this->once())
+            ->method('getQuote')
+            ->willReturn($quote);
+        $this->formKeyValidator->expects($this->once())
+            ->method('validate')
+            ->with($this->request)
+            ->willReturn(true);
+
+        $this->assertEquals($this->response, $this->cartAdd->execute());
+    }
 }