LYNX-788 Enhance Gift Options handling during cart merge

Author: cod40403

app/code/Magento/QuoteGraphQl/Model/Resolver/MergeCarts.php

@@ -1,103 +1,53 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2019 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
 namespace Magento\QuoteGraphQl\Model\Resolver;
 
-use Magento\CatalogInventory\Api\StockRegistryInterface;
-use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\CouldNotSaveException;
-use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\GraphQl\Model\Query\ContextInterface;
-use Magento\Quote\Api\CartItemRepositoryInterface;
 use Magento\Quote\Api\CartRepositoryInterface;
-use Magento\Quote\Api\Data\CartInterface;
-use Magento\Quote\Api\Data\CartItemInterface;
 use Magento\Quote\Model\Cart\CustomerCartResolver;
+use Magento\Quote\Model\Quote;
 use Magento\Quote\Model\QuoteIdToMaskedQuoteIdInterface;
 use Magento\QuoteGraphQl\Model\Cart\GetCartForUser;
 use Magento\QuoteGraphQl\Model\Cart\MergeCarts\CartQuantityValidatorInterface;
 
-/**
- * Merge Carts Resolver
- *
- * @SuppressWarnings(PHPMD.LongVariable)
- */
 class MergeCarts implements ResolverInterface
 {
     /**
-     * @var GetCartForUser
-     */
-    private $getCartForUser;
-
-    /**
-     * @var CartRepositoryInterface
-     */
-    private $cartRepository;
-
-    /**
-     * @var CustomerCartResolver
-     */
-    private $customerCartResolver;
-
-    /**
-     * @var QuoteIdToMaskedQuoteIdInterface
-     */
-    private $quoteIdToMaskedQuoteId;
-
-    /**
-     * @var CartItemRepositoryInterface
-     */
-    private $cartItemRepository;
-
-    /**
-     * @var StockRegistryInterface
-     */
-    private $stockRegistry;
-
-    /**
-     * @var CartQuantityValidatorInterface
+     * @var array
      */
-    private $cartQuantityValidator;
+    private array $fields;
 
     /**
+     * MergeCarts Constructor
+     *
      * @param GetCartForUser $getCartForUser
      * @param CartRepositoryInterface $cartRepository
-     * @param CustomerCartResolver|null $customerCartResolver
-     * @param QuoteIdToMaskedQuoteIdInterface|null $quoteIdToMaskedQuoteId
-     * @param CartItemRepositoryInterface|null $cartItemRepository
-     * @param StockRegistryInterface|null $stockRegistry
+     * @param CustomerCartResolver $customerCartResolver
+     * @param QuoteIdToMaskedQuoteIdInterface $quoteIdToMaskedQuoteId
+     * @param CartQuantityValidatorInterface $cartQuantityValidator
+     * @param array $fields
      */
     public function __construct(
-        GetCartForUser $getCartForUser,
-        CartRepositoryInterface $cartRepository,
-        ?CustomerCartResolver $customerCartResolver = null,
-        ?QuoteIdToMaskedQuoteIdInterface $quoteIdToMaskedQuoteId = null,
-        ?CartItemRepositoryInterface $cartItemRepository = null,
-        ?StockRegistryInterface $stockRegistry = null,
-        ?CartQuantityValidatorInterface $cartQuantityValidator = null
+        private readonly GetCartForUser $getCartForUser,
+        private readonly CartRepositoryInterface $cartRepository,
+        private readonly CustomerCartResolver $customerCartResolver,
+        private readonly QuoteIdToMaskedQuoteIdInterface $quoteIdToMaskedQuoteId,
+        private readonly CartQuantityValidatorInterface $cartQuantityValidator,
+        array $fields
     ) {
-        $this->getCartForUser = $getCartForUser;
-        $this->cartRepository = $cartRepository;
-        $this->customerCartResolver = $customerCartResolver
-            ?: ObjectManager::getInstance()->get(CustomerCartResolver::class);
-        $this->quoteIdToMaskedQuoteId = $quoteIdToMaskedQuoteId
-            ?: ObjectManager::getInstance()->get(QuoteIdToMaskedQuoteIdInterface::class);
-        $this->cartItemRepository = $cartItemRepository
-            ?: ObjectManager::getInstance()->get(CartItemRepositoryInterface::class);
-        $this->stockRegistry = $stockRegistry
-            ?: ObjectManager::getInstance()->get(StockRegistryInterface::class);
-        $this->cartQuantityValidator = $cartQuantityValidator
-            ?: ObjectManager::getInstance()->get(CartQuantityValidatorInterface::class);
+        $this->fields = $fields;
     }
 
     /**
@@ -109,69 +59,75 @@ public function resolve(
         ResolveInfo $info,
         ?array $value = null,
         ?array $args = null
-    ) {
+    ): array {
         if (empty($args['source_cart_id'])) {
-            throw new GraphQlInputException(__(
-                'Required parameter "source_cart_id" is missing'
-            ));
+            throw new GraphQlInputException(__('Required parameter "source_cart_id" is missing'));
+        }
+
+        if (isset($args['destination_cart_id']) && empty($args['destination_cart_id'])) {
+            throw new GraphQlInputException(__('The parameter "destination_cart_id" cannot be empty'));
         }
 
         /** @var ContextInterface $context */
-        if (false === $context->getExtensionAttributes()->getIsCustomer()) {
-            throw new GraphQlAuthorizationException(__(
-                'The current customer isn\'t authorized.'
-            ));
+        if (!$context->getExtensionAttributes()->getIsCustomer()) {
+            throw new GraphQlAuthorizationException(__('The current customer isn\'t authorized.'));
         }
+
         $currentUserId = $context->getUserId();
+        $storeId = (int)$context->getExtensionAttributes()->getStore()->getId();
+        $guestMaskedCartId = $args['source_cart_id'];
+
+        // Resolve destination cart ID
+        $customerMaskedCartId = $args['destination_cart_id'] ?? null;
 
-        if (!isset($args['destination_cart_id'])) {
+        if (!$customerMaskedCartId) {
             try {
                 $cart = $this->customerCartResolver->resolve($currentUserId);
+                $customerMaskedCartId = $this->quoteIdToMaskedQuoteId->execute((int) $cart->getId());
             } catch (CouldNotSaveException $exception) {
                 throw new GraphQlNoSuchEntityException(
                     __('Could not create empty cart for customer'),
                     $exception
                 );
             }
-            $customerMaskedCartId = $this->quoteIdToMaskedQuoteId->execute(
-                (int) $cart->getId()
-            );
-        } else {
-            if (empty($args['destination_cart_id'])) {
-                throw new GraphQlInputException(__(
-                    'The parameter "destination_cart_id" cannot be empty'
-                ));
-            }
         }
 
-        $guestMaskedCartId = $args['source_cart_id'];
-        $customerMaskedCartId = $customerMaskedCartId ?? $args['destination_cart_id'];
+        // Fetch guest and customer carts
+        $customerCart = $this->getCartForUser->execute($customerMaskedCartId, $currentUserId, $storeId);
+        $guestCart = $this->getCartForUser->execute($guestMaskedCartId, null, $storeId);
 
-        $storeId = (int)$context->getExtensionAttributes()->getStore()->getId();
-        // passing customerId as null enforces source cart should always be a guestcart
-        $guestCart = $this->getCartForUser->execute(
-            $guestMaskedCartId,
-            null,
-            $storeId
-        );
-        $customerCart = $this->getCartForUser->execute(
-            $customerMaskedCartId,
-            $currentUserId,
-            $storeId
-        );
+        // Validate cart quantities before merging
         if ($this->cartQuantityValidator->validateFinalCartQuantities($customerCart, $guestCart)) {
-            $guestCart = $this->getCartForUser->execute(
-                $guestMaskedCartId,
-                null,
-                $storeId
-            );
+            $guestCart = $this->getCartForUser->execute($guestMaskedCartId, null, $storeId);
         }
+
+        // Merge carts and save
         $customerCart->merge($guestCart);
         $guestCart->setIsActive(false);
+        // Check and update gift options from guest cart to customer cart
+        $customerCart = $this->updateGiftOptions($guestCart, $customerCart);
+
         $this->cartRepository->save($customerCart);
         $this->cartRepository->save($guestCart);
-        return [
-            'model' => $customerCart,
-        ];
+
+        return ['model' => $customerCart];
+    }
+
+    /**
+     * Check and update gift options in customer cart from guest cart
+     *
+     * @param Quote $guestCart
+     * @param Quote $customerCart
+     * @return Quote
+     */
+    private function updateGiftOptions(Quote $guestCart, Quote $customerCart): Quote
+    {
+        foreach ($this->fields as $field) {
+            if (!empty($guestCart->getData($field)) && empty($customerCart->getData($field))) {
+                $customerCart->setData($field, $guestCart->getData($field));
+            }
+        }
+
+        return $customerCart;
     }
 }

app/code/Magento/QuoteGraphQl/etc/graphql/di.xml

@@ -99,4 +99,11 @@
     <type name="Magento\Payment\Model\MethodList">
         <plugin name="restrict_payment_methods_graphql" type="Magento\QuoteGraphQl\Plugin\Model\RestrictPaymentMethods"/>
     </type>
+    <type name="Magento\QuoteGraphQl\Model\Resolver\MergeCarts">
+        <arguments>
+            <argument name="fields" xsi:type="array">
+                <item name="gift_message_id" xsi:type="string">gift_message_id</item>
+            </argument>
+        </arguments>
+    </type>
 </config>