LYNX-115: Add specific operation error codes to the "placeOrder" mutation (#203)

Co-authored-by: Sergio Vera <svera@adobe.com>

Author: eliseacornejo

app/code/Magento/Catalog/Test/Fixture/ProductStock.php

@@ -26,7 +26,8 @@ class ProductStock implements DataFixtureInterface
 {
     private const DEFAULT_DATA = [
         'prod_id' => null,
-        'prod_qty' => 1
+        'prod_qty' => 1,
+        'is_in_stock' => 1
     ];
 
     /**
@@ -67,8 +68,8 @@ public function apply(array $data = []): ?DataObject
     {
         $data = $this->dataMerger->merge(self::DEFAULT_DATA, $data);
         $stockItem = $this->stockRegistry->getStockItem($data['prod_id']);
-        $stockItem->setData('is_in_stock', 1);
-        $stockItem->setData('qty', 90);
+        $stockItem->setData('is_in_stock', $data['is_in_stock']);
+        $stockItem->setData('qty', $data['prod_qty']);
         $stockItem->setData('manage_stock', 1);
         $stockItem->save();
 

app/code/Magento/GiftMessage/Test/Fixture/GiftMessage.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright 2023 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\GiftMessage\Test\Fixture;
+
+use Magento\Framework\DataObject;
+use Magento\TestFramework\Fixture\Api\DataMerger;
+use Magento\GiftMessage\Model\ResourceModel\Message;
+use Magento\GiftMessage\Model\MessageFactory;
+use Magento\TestFramework\Fixture\RevertibleDataFixtureInterface;
+
+class GiftMessage implements RevertibleDataFixtureInterface
+{
+    private const DEFAULT_DATA = [
+        'sender' => 'Romeo',
+        'recipient' => 'Mercutio',
+        'message' => 'Fixture Test message.',
+    ];
+
+    /**
+     * @param MessageFactory $giftMessageFactory
+     * @param Message $messageResourceModel
+     * @param DataMerger $dataMerger
+     */
+    public function __construct(
+        private readonly MessageFactory $giftMessageFactory,
+        private readonly Message $messageResourceModel,
+        private readonly DataMerger $dataMerger,
+    ) {
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function apply(array $data = []): ?DataObject
+    {
+        $data = $this->dataMerger->merge(self::DEFAULT_DATA, $data);
+        $message = $this->giftMessageFactory->create();
+        $message
+            ->setSender($data['sender'])
+            ->setRecipient($data['recipient'])
+            ->setMessage($data['message']);
+
+        $this->messageResourceModel->save($message);
+
+        return $message;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function revert(DataObject $data): void
+    {
+        $this->messageResourceModel->delete($data);
+    }
+}

app/code/Magento/Quote/Test/Fixture/CustomerCart.php

@@ -15,7 +15,8 @@
 class CustomerCart implements RevertibleDataFixtureInterface
 {
     private const DEFAULT_DATA = [
-        'customer_id' => null
+        'customer_id' => null,
+        'reserved_order_id' => null
     ];
 
     /**
@@ -53,8 +54,13 @@ public function apply(array $data = []): ?DataObject
     {
         $data = array_merge(self::DEFAULT_DATA, $data);
         $cartId = $this->cartManagement->createEmptyCartForCustomer($data['customer_id']);
+        $cart = $this->cartRepository->get($cartId);
+        if (isset($data['reserved_order_id'])) {
+            $cart->setReservedOrderId($data['reserved_order_id']);
+            $this->cartRepository->save($cart);
+        }
 
-        return $this->cartRepository->get($cartId);
+        return $cart;
     }
 
     /**

app/code/Magento/Quote/Test/Fixture/GuestCart.php

@@ -71,8 +71,21 @@ public function apply(array $data = []): ?DataObject
     {
         $maskId = $this->guestCartManagement->createEmptyCart();
         $cartId = $this->maskedQuoteIdToQuoteId->execute($maskId);
+        $cart = $this->cartRepository->get($cartId);
 
-        return $this->cartRepository->get($cartId);
+        if (!isset($data['reserved_order_id']) && !isset($data['message_id'])) {
+            return $cart;
+        }
+        if (isset($data['reserved_order_id'])) {
+            $cart->setReservedOrderId($data['reserved_order_id']);
+            $this->cartRepository->save($cart);
+        }
+        if (isset($data['message_id'])) {
+            $cart->setGiftMessageId($data['message_id']);
+            $this->cartRepository->save($cart);
+        }
+
+        return $cart;
     }
 
     /**

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

@@ -9,22 +9,50 @@
 
 use Magento\Framework\Exception\AuthorizationException;
 use Magento\Framework\Exception\LocalizedException;
+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\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
-use Magento\GraphQl\Helper\Error\AggregateExceptionMessageFormatter;
+use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\QuoteGraphQl\Model\Cart\GetCartForCheckout;
-use Magento\GraphQl\Model\Query\ContextInterface;
 use Magento\QuoteGraphQl\Model\Cart\PlaceOrder as PlaceOrderModel;
 use Magento\Sales\Api\OrderRepositoryInterface;
 
 /**
  * Resolver for placing order after payment method has already been set
  */
-class PlaceOrder implements ResolverInterface
+class PlaceOrder implements ResolverInterface, ResetAfterRequestInterface
 {
+    /**#@+
+     * Error message codes
+     */
+    private const ERROR_CART_NOT_FOUND = 'CART_NOT_FOUND';
+    private const ERROR_CART_NOT_ACTIVE = 'CART_NOT_ACTIVE';
+    private const ERROR_GUEST_EMAIL_MISSING = 'GUEST_EMAIL_MISSING';
+    private const ERROR_UNABLE_TO_PLACE_ORDER = 'UNABLE_TO_PLACE_ORDER';
+    private const ERROR_UNDEFINED = 'UNDEFINED';
+    /**#@-*/
+
+    /**
+     * List of error messages and codes.
+     */
+    private const MESSAGE_CODES = [
+        'Could not find a cart with ID' => self::ERROR_CART_NOT_FOUND,
+        'The cart isn\'t active' => self::ERROR_CART_NOT_ACTIVE,
+        'Guest email for cart is missing' => self::ERROR_GUEST_EMAIL_MISSING,
+        'A server error stopped your order from being placed. Please try to place your order again' =>
+            self::ERROR_UNABLE_TO_PLACE_ORDER,
+        'Some addresses can\'t be used due to the configurations for specific countries' =>
+            self::ERROR_UNABLE_TO_PLACE_ORDER,
+        'The shipping method is missing. Select the shipping method and try again' =>
+            self::ERROR_UNABLE_TO_PLACE_ORDER,
+        'Please check the billing address information' => self::ERROR_UNABLE_TO_PLACE_ORDER,
+        'Enter a valid payment method and try again' => self::ERROR_UNABLE_TO_PLACE_ORDER,
+        'Some of the products are out of stock' => self::ERROR_UNABLE_TO_PLACE_ORDER,
+    ];
+
     /**
      * @var GetCartForCheckout
      */
@@ -41,33 +69,32 @@ class PlaceOrder implements ResolverInterface
     private $orderRepository;
 
     /**
-     * @var AggregateExceptionMessageFormatter
+     * @var \string[]
      */
-    private $errorMessageFormatter;
+    private $errors = [];
 
     /**
      * @param GetCartForCheckout $getCartForCheckout
      * @param PlaceOrderModel $placeOrder
      * @param OrderRepositoryInterface $orderRepository
-     * @param AggregateExceptionMessageFormatter $errorMessageFormatter
      */
     public function __construct(
         GetCartForCheckout $getCartForCheckout,
         PlaceOrderModel $placeOrder,
-        OrderRepositoryInterface $orderRepository,
-        AggregateExceptionMessageFormatter $errorMessageFormatter
+        OrderRepositoryInterface $orderRepository
     ) {
         $this->getCartForCheckout = $getCartForCheckout;
         $this->placeOrder = $placeOrder;
         $this->orderRepository = $orderRepository;
-        $this->errorMessageFormatter = $errorMessageFormatter;
     }
 
     /**
      * @inheritdoc
      */
     public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null)
     {
+        $this->errors = [];
+        $order = null;
         if (empty($args['input']['cart_id'])) {
             throw new GraphQlInputException(__('Required parameter "cart_id" is missing'));
         }
@@ -80,28 +107,77 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
             $cart = $this->getCartForCheckout->execute($maskedCartId, $userId, $storeId);
             $orderId = $this->placeOrder->execute($cart, $maskedCartId, $userId);
             $order = $this->orderRepository->get($orderId);
+        } catch (NoSuchEntityException $exception) {
+            $this->addError($exception->getMessage());
+        } catch (GraphQlInputException $exception) {
+            $this->addError($exception->getMessage());
         } catch (AuthorizationException $exception) {
             throw new GraphQlAuthorizationException(
                 __($exception->getMessage())
             );
         } catch (LocalizedException $e) {
-            throw $this->errorMessageFormatter->getFormatted(
-                $e,
-                __('Unable to place order: A server error stopped your order from being placed. ' .
-                    'Please try to place your order again'),
-                'Unable to place order',
-                $field,
-                $context,
-                $info
-            );
+            $this->addError($e->getMessage());
+        }
+        if ($this->errors) {
+            return [
+                'errors' =>
+                    $this->errors
+            ];
         }
-
         return [
             'order' => [
                 'order_number' => $order->getIncrementId(),
                 // @deprecated The order_id field is deprecated, use order_number instead
                 'order_id' => $order->getIncrementId(),
             ],
+            'errors' => []
+        ];
+    }
+
+    /**
+     * Add order line item error
+     *
+     * @param string $message
+     * @return void
+     */
+    private function addError(string $message): void
+    {
+        $this->errors[] = [
+            'message' => $message,
+            'code' => $this->getErrorCode($message)
         ];
     }
+
+    /**
+     * Get message error code. Ad-hoc solution based on message parsing.
+     *
+     * @param string $message
+     * @return string
+     */
+    private function getErrorCode(string $message): string
+    {
+        $code = self::ERROR_UNDEFINED;
+
+        $matchedCodes = array_filter(
+            self::MESSAGE_CODES,
+            function ($key) use ($message) {
+                return false !== strpos($message, $key);
+            },
+            ARRAY_FILTER_USE_KEY
+        );
+
+        if (!empty($matchedCodes)) {
+            $code = current($matchedCodes);
+        }
+
+        return $code;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function _resetState(): void
+    {
+        $this->errors = [];
+    }
 }

app/code/Magento/QuoteGraphQl/etc/schema.graphqls

@@ -223,7 +223,13 @@ type ApplyCouponToCartOutput @doc(description: "Contains details about the cart
 }
 
 type PlaceOrderOutput @doc(description: "Contains the results of the request to place an order.") {
-    order: Order! @doc(description: "The ID of the order.")
+    order: Order @doc(description: "The ID of the order.")
+    errors: [PlaceOrderError!]! @doc(description:"An array of place order errors.")
+}
+
+type PlaceOrderError @doc(description:"An error encountered while placing an order."){
+    message: String! @doc(description: "A localized error message.")
+    code: PlaceOrderErrorCodes! @doc(description: "An error code that is specific to place order.")
 }
 
 type Cart @doc(description: "Contains the contents and other details about a guest or customer cart.") {
@@ -456,6 +462,13 @@ enum CartUserInputErrorType {
     INSUFFICIENT_STOCK
     UNDEFINED
 }
+enum PlaceOrderErrorCodes {
+    CART_NOT_FOUND
+    CART_NOT_ACTIVE
+    GUEST_EMAIL_MISSING
+    UNABLE_TO_PLACE_ORDER
+    UNDEFINED
+}
 
 type StoreConfig {
     is_guest_checkout_enabled: Boolean @doc(description: "Extended Config Data - checkout/options/guest_checkout")