LYNX-51: Added ability to extend definition of active cart

sivaschenko · web-flow · commit 02b6903e88b7 · 2022-10-28T12:08:07.000+01:00
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForCheckout.php b/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForCheckout.php
@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\QuoteGraphQl\Model\Cart;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
+use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
+use Magento\Quote\Api\CartManagementInterface;
+use Magento\Quote\Model\Quote;
+
+/**
+ * Get cart
+ */
+class GetCartForCheckout
+{
+    /**
+     * @var CheckCartCheckoutAllowance
+     */
+    private CheckCartCheckoutAllowance $checkoutAllowance;
+
+    /**
+     * @var GetCartForUser
+     */
+    private GetCartForUser $getCartForUser;
+
+    /**
+     * @param CheckCartCheckoutAllowance $checkoutAllowance
+     * @param GetCartForUser $getCartForUser
+     */
+    public function __construct(
+        CheckCartCheckoutAllowance $checkoutAllowance,
+        GetCartForUser $getCartForUser
+    ) {
+        $this->checkoutAllowance = $checkoutAllowance;
+        $this->getCartForUser = $getCartForUser;
+    }
+
+    /**
+     * Gets the cart for the user validated and configured for guest checkout if applicable
+     *
+     * @param string $cartHash
+     * @param int|null $customerId
+     * @param int $storeId
+     * @return Quote
+     * @throws GraphQlAuthorizationException
+     * @throws GraphQlInputException
+     * @throws GraphQlNoSuchEntityException
+     */
+    public function execute(string $cartHash, ?int $customerId, int $storeId): Quote
+    {
+        try {
+            $cart = $this->getCartForUser->execute($cartHash, $customerId, $storeId);
+        } catch (NoSuchEntityException $e) {
+            throw new GraphQlNoSuchEntityException(__($e->getMessage()), $e);
+        }
+        $this->checkoutAllowance->execute($cart);
+
+        if (null === $customerId || 0 === $customerId) {
+            if (!$cart->getCustomerEmail()) {
+                throw new GraphQlInputException(__("Guest email for cart is missing."));
+            }
+            $cart->setCheckoutMethod(CartManagementInterface::METHOD_GUEST);
+        }
+
+        return $cart;
+    }
+}
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForUser.php b/app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForUser.php
@@ -7,16 +7,13 @@
 
 namespace Magento\QuoteGraphQl\Model\Cart;
 
-use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
-use Magento\Quote\Api\CartManagementInterface;
 use Magento\Quote\Api\CartRepositoryInterface;
 use Magento\Quote\Model\MaskedQuoteIdToQuoteIdInterface;
 use Magento\Quote\Model\Quote;
-use Magento\Store\Api\StoreRepositoryInterface;
 
 /**
  * Get cart
@@ -34,31 +31,31 @@ class GetCartForUser
     private $cartRepository;
 
     /**
-     * @var CheckCartCheckoutAllowance
+     * @var IsActive
      */
-    private $checkoutAllowance;
+    private $isActive;
 
     /**
-     * @var StoreRepositoryInterface
+     * @var UpdateCartCurrency
      */
-    private $storeRepository;
+    private $updateCartCurrency;
 
     /**
      * @param MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId
      * @param CartRepositoryInterface $cartRepository
-     * @param CheckCartCheckoutAllowance $checkoutAllowance
-     * @param StoreRepositoryInterface $storeRepository
+     * @param IsActive $isActive
+     * @param UpdateCartCurrency $updateCartCurrency
      */
     public function __construct(
         MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId,
         CartRepositoryInterface $cartRepository,
-        CheckCartCheckoutAllowance $checkoutAllowance,
-        StoreRepositoryInterface $storeRepository = null
+        IsActive $isActive,
+        UpdateCartCurrency $updateCartCurrency
     ) {
         $this->maskedQuoteIdToQuoteId = $maskedQuoteIdToQuoteId;
         $this->cartRepository = $cartRepository;
-        $this->checkoutAllowance = $checkoutAllowance;
-        $this->storeRepository = $storeRepository ?: ObjectManager::getInstance()->get(StoreRepositoryInterface::class);
+        $this->isActive = $isActive;
+        $this->updateCartCurrency = $updateCartCurrency;
     }
 
     /**
@@ -77,26 +74,19 @@ public function execute(string $cartHash, ?int $customerId, int $storeId): Quote
     {
         try {
             $cartId = $this->maskedQuoteIdToQuoteId->execute($cartHash);
-        } catch (NoSuchEntityException $exception) {
-            throw new GraphQlNoSuchEntityException(
-                __('Could not find a cart with ID "%masked_cart_id"', ['masked_cart_id' => $cartHash])
-            );
-        }
-
-        try {
             /** @var Quote $cart */
             $cart = $this->cartRepository->get($cartId);
-        } catch (NoSuchEntityException $e) {
+        } catch (NoSuchEntityException $exception) {
             throw new GraphQlNoSuchEntityException(
                 __('Could not find a cart with ID "%masked_cart_id"', ['masked_cart_id' => $cartHash])
             );
         }
 
-        if (false === (bool)$cart->getIsActive()) {
+        if (false === (bool)$this->isActive->execute($cart)) {
             throw new GraphQlNoSuchEntityException(__('The cart isn\'t active.'));
         }
 
-        $cart = $this->updateCartCurrency($cart, $storeId);
+        $cart = $this->updateCartCurrency->execute($cart, $storeId);
 
         $cartCustomerId = (int)$cart->getCustomerId();
 
@@ -115,68 +105,4 @@ public function execute(string $cartHash, ?int $customerId, int $storeId): Quote
         }
         return $cart;
     }
-
-    /**
-     * Gets the cart for the user validated and configured for guest checkout if applicable
-     *
-     * @param string $cartHash
-     * @param int|null $customerId
-     * @param int $storeId
-     * @return Quote
-     * @throws GraphQlAuthorizationException
-     * @throws GraphQlInputException
-     * @throws GraphQlNoSuchEntityException
-     */
-    public function getCartForCheckout(string $cartHash, ?int $customerId, int $storeId): Quote
-    {
-        try {
-            $cart = $this->execute($cartHash, $customerId, $storeId);
-        } catch (NoSuchEntityException $e) {
-            throw new GraphQlNoSuchEntityException(__($e->getMessage()), $e);
-        }
-        $this->checkoutAllowance->execute($cart);
-
-        if ((null === $customerId || 0 === $customerId)) {
-            if (!$cart->getCustomerEmail()) {
-                throw new GraphQlInputException(__("Guest email for cart is missing."));
-            }
-            $cart->setCheckoutMethod(CartManagementInterface::METHOD_GUEST);
-        }
-
-        return $cart;
-    }
-
-    /**
-     * Sets cart currency based on specified store.
-     *
-     * @param Quote $cart
-     * @param int $storeId
-     * @return Quote
-     * @throws GraphQlInputException
-     * @throws NoSuchEntityException
-     */
-    private function updateCartCurrency(Quote $cart, int $storeId): Quote
-    {
-        $cartStore = $this->storeRepository->getById($cart->getStoreId());
-        $currentCartCurrencyCode = $cartStore->getCurrentCurrency()->getCode();
-        if ((int)$cart->getStoreId() !== $storeId) {
-            $newStore = $this->storeRepository->getById($storeId);
-            if ($cartStore->getWebsite() !== $newStore->getWebsite()) {
-                throw new GraphQlInputException(
-                    __('Can\'t assign cart to store in different website.')
-                );
-            }
-            $cart->setStoreId($storeId);
-            $cart->setStoreCurrencyCode($newStore->getCurrentCurrency());
-            $cart->setQuoteCurrencyCode($newStore->getCurrentCurrency());
-        } elseif ($cart->getQuoteCurrencyCode() !== $currentCartCurrencyCode) {
-            $cart->setQuoteCurrencyCode($cartStore->getCurrentCurrency());
-        } else {
-            return $cart;
-        }
-        $this->cartRepository->save($cart);
-        $cart = $this->cartRepository->get($cart->getId());
-
-        return $cart;
-    }
 }
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/IsActive.php b/app/code/Magento/QuoteGraphQl/Model/Cart/IsActive.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\QuoteGraphQl\Model\Cart;
+
+use Magento\Quote\Api\Data\CartInterface;
+
+/**
+ * Is cart active (can it be retrieved and updated). Requires for extensions that require to work with inactive cart.
+ */
+class IsActive
+{
+    /**
+     * Is cart active
+     *
+     * @param CartInterface $cart
+     * @return bool
+     */
+    public function execute(CartInterface $cart): bool
+    {
+        return (bool) $cart->getIsActive();
+    }
+}
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/UpdateCartCurrency.php b/app/code/Magento/QuoteGraphQl/Model/Cart/UpdateCartCurrency.php
@@ -0,0 +1,74 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\QuoteGraphQl\Model\Cart;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
+use Magento\Quote\Api\CartRepositoryInterface;
+use Magento\Quote\Model\Quote;
+use Magento\Store\Api\StoreRepositoryInterface;
+
+/**
+ * Update currency
+ */
+class UpdateCartCurrency
+{
+    /**
+     * @var CartRepositoryInterface
+     */
+    private CartRepositoryInterface $cartRepository;
+
+    /**
+     * @var StoreRepositoryInterface
+     */
+    private StoreRepositoryInterface $storeRepository;
+
+    /**
+     * @param CartRepositoryInterface $cartRepository
+     * @param StoreRepositoryInterface $storeRepository
+     */
+    public function __construct(
+        CartRepositoryInterface $cartRepository,
+        StoreRepositoryInterface $storeRepository
+    ) {
+        $this->cartRepository = $cartRepository;
+        $this->storeRepository = $storeRepository;
+    }
+
+    /**
+     * Sets cart currency based on specified store.
+     *
+     * @param Quote $cart
+     * @param int $storeId
+     * @return Quote
+     * @throws GraphQlInputException|NoSuchEntityException|LocalizedException
+     */
+    public function execute(Quote $cart, int $storeId): Quote
+    {
+        $cartStore = $this->storeRepository->getById($cart->getStoreId());
+        $currentCartCurrencyCode = $cartStore->getCurrentCurrency()->getCode();
+        if ((int)$cart->getStoreId() !== $storeId) {
+            $newStore = $this->storeRepository->getById($storeId);
+            if ($cartStore->getWebsite() !== $newStore->getWebsite()) {
+                throw new GraphQlInputException(
+                    __('Can\'t assign cart to store in different website.')
+                );
+            }
+            $cart->setStoreId($storeId);
+            $cart->setStoreCurrencyCode($newStore->getCurrentCurrency());
+            $cart->setQuoteCurrencyCode($newStore->getCurrentCurrency());
+        } elseif ($cart->getQuoteCurrencyCode() !== $currentCartCurrencyCode) {
+            $cart->setQuoteCurrencyCode($cartStore->getCurrentCurrency());
+        } else {
+            return $cart;
+        }
+        $this->cartRepository->save($cart);
+        return $this->cartRepository->get($cart->getId());
+    }
+}
diff --git a/app/code/Magento/QuoteGraphQl/Model/Resolver/PlaceOrder.php b/app/code/Magento/QuoteGraphQl/Model/Resolver/PlaceOrder.php
@@ -13,7 +13,7 @@
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\GraphQl\Helper\Error\AggregateExceptionMessageFormatter;
-use Magento\QuoteGraphQl\Model\Cart\GetCartForUser;
+use Magento\QuoteGraphQl\Model\Cart\GetCartForCheckout;
 use Magento\QuoteGraphQl\Model\Cart\PlaceOrder as PlaceOrderModel;
 use Magento\Sales\Api\OrderRepositoryInterface;
 
@@ -23,9 +23,9 @@
 class PlaceOrder implements ResolverInterface
 {
     /**
-     * @var GetCartForUser
+     * @var GetCartForCheckout
      */
-    private $getCartForUser;
+    private $getCartForCheckout;
 
     /**
      * @var PlaceOrderModel
@@ -43,18 +43,18 @@ class PlaceOrder implements ResolverInterface
     private $errorMessageFormatter;
 
     /**
-     * @param GetCartForUser $getCartForUser
+     * @param GetCartForCheckout $getCartForCheckout
      * @param PlaceOrderModel $placeOrder
      * @param OrderRepositoryInterface $orderRepository
      * @param AggregateExceptionMessageFormatter $errorMessageFormatter
      */
     public function __construct(
-        GetCartForUser $getCartForUser,
+        GetCartForCheckout $getCartForCheckout,
         PlaceOrderModel $placeOrder,
         OrderRepositoryInterface $orderRepository,
         AggregateExceptionMessageFormatter $errorMessageFormatter
     ) {
-        $this->getCartForUser = $getCartForUser;
+        $this->getCartForCheckout = $getCartForCheckout;
         $this->placeOrder = $placeOrder;
         $this->orderRepository = $orderRepository;
         $this->errorMessageFormatter = $errorMessageFormatter;
@@ -73,7 +73,7 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
         $storeId = (int)$context->getExtensionAttributes()->getStore()->getId();
 
         try {
-            $cart = $this->getCartForUser->getCartForCheckout($maskedCartId, $userId, $storeId);
+            $cart = $this->getCartForCheckout->execute($maskedCartId, $userId, $storeId);
             $orderId = $this->placeOrder->execute($cart, $maskedCartId, $userId);
             $order = $this->orderRepository->get($orderId);
         } catch (LocalizedException $e) {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Resolver/SetPaymentAndPlaceOrder.php b/app/code/Magento/QuoteGraphQl/Model/Resolver/SetPaymentAndPlaceOrder.php
