ACP2E-3399: GraphQL Response for Order placement does not include the exception message

Author: aplapana

app/code/Magento/GraphQl/Helper/Error/AggregateExceptionMessageFormatter.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2021 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
@@ -14,7 +14,6 @@
 use Magento\Framework\GraphQl\Query\Resolver\ContextInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Framework\Phrase;
-use Magento\QuoteGraphQl\Model\ErrorMapper;
 
 /**
  * Class for formatting internally-thrown errors if they match allowed exception types or using a default message if not
@@ -24,7 +23,7 @@ class AggregateExceptionMessageFormatter
     /**
      * @var ExceptionMessageFormatterInterface[]
      */
-    private $messageFormatters;
+    private array $messageFormatters;
 
     /**
      * @param ExceptionMessageFormatterInterface[] $messageFormatters
@@ -55,19 +54,11 @@ public function getFormatted(
         ResolveInfo $info
     ): ClientAware {
         foreach ($this->messageFormatters as $formatter) {
-            $formatted = $formatter->getFormatted($e, $messagePrefix, $field, $context, $info);
-            if ($formatted && !$e->getCode() && ($errorId = ErrorMapper::getErrorMessageId($e->getMessage()))) {
-                $exceptionType = get_class($e);
-                $formatted = new $exceptionType(
-                    __($e->getMessage()),
-                    $e,
-                    $errorId
-                );
-            }
-            if ($formatted) {
+            if ($formatted = $formatter->getFormatted($e, $messagePrefix, $field, $context, $info)) {
                 return $formatted;
             }
         }
+
         $message = $e->getCode() ? __($e->getMessage()) : $defaultMessage;
         return new GraphQlInputException($message, $e, $e->getCode());
     }

app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForCheckout.php

@@ -13,6 +13,7 @@
 use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
 use Magento\Quote\Api\CartManagementInterface;
 use Magento\Quote\Model\Quote;
+use Magento\QuoteGraphQl\Model\ErrorMapper;
 
 /**
  * Get cart
@@ -29,16 +30,24 @@ class GetCartForCheckout
      */
     private GetCartForUser $getCartForUser;
 
+    /**
+     * @var ErrorMapper
+     */
+    private ErrorMapper $errorMapper;
+
     /**
      * @param CheckCartCheckoutAllowance $checkoutAllowance
      * @param GetCartForUser $getCartForUser
+     * @param ErrorMapper $errorMapper
      */
     public function __construct(
         CheckCartCheckoutAllowance $checkoutAllowance,
-        GetCartForUser $getCartForUser
+        GetCartForUser $getCartForUser,
+        ErrorMapper $errorMapper
     ) {
         $this->checkoutAllowance = $checkoutAllowance;
         $this->getCartForUser = $getCartForUser;
+        $this->errorMapper = $errorMapper;
     }
 
     /**
@@ -66,7 +75,7 @@ public function execute(string $cartHash, ?int $customerId, int $storeId): Quote
                 throw new GraphQlInputException(
                     __("Guest email for cart is missing."),
                     null,
-                    ErrorMapper::getErrorMessageId('Guest email for cart is missing')
+                    $this->errorMapper->getErrorMessageId('Guest email for cart is missing')
                 );
             }
             $cart->setCheckoutMethod(CartManagementInterface::METHOD_GUEST);

app/code/Magento/QuoteGraphQl/Model/Cart/GetCartForUser.php

@@ -24,39 +24,47 @@ class GetCartForUser
     /**
      * @var MaskedQuoteIdToQuoteIdInterface
      */
-    private $maskedQuoteIdToQuoteId;
+    private MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId;
 
     /**
      * @var CartRepositoryInterface
      */
-    private $cartRepository;
+    private CartRepositoryInterface $cartRepository;
 
     /**
      * @var IsActive
      */
-    private $isActive;
+    private IsActive $isActive;
 
     /**
      * @var UpdateCartCurrency
      */
-    private $updateCartCurrency;
+    private UpdateCartCurrency $updateCartCurrency;
+
+    /**
+     * @var ErrorMapper
+     */
+    private ErrorMapper $errorMapper;
 
     /**
      * @param MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId
      * @param CartRepositoryInterface $cartRepository
      * @param IsActive $isActive
      * @param UpdateCartCurrency $updateCartCurrency
+     * @param ErrorMapper $errorMapper
      */
     public function __construct(
         MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId,
         CartRepositoryInterface $cartRepository,
         IsActive $isActive,
-        UpdateCartCurrency $updateCartCurrency
+        UpdateCartCurrency $updateCartCurrency,
+        ErrorMapper $errorMapper
     ) {
         $this->maskedQuoteIdToQuoteId = $maskedQuoteIdToQuoteId;
         $this->cartRepository = $cartRepository;
         $this->isActive = $isActive;
         $this->updateCartCurrency = $updateCartCurrency;
+        $this->errorMapper = $errorMapper;
     }
 
     /**
@@ -81,15 +89,15 @@ public function execute(string $cartHash, ?int $customerId, int $storeId): Quote
             throw new GraphQlNoSuchEntityException(
                 __('Could not find a cart with ID "%masked_cart_id"', ['masked_cart_id' => $cartHash]),
                 $exception,
-                ErrorMapper::getErrorMessageId('Could not find a cart with ID')
+                $this->errorMapper->getErrorMessageId('Could not find a cart with ID')
             );
         }
 
         if (false === (bool)$this->isActive->execute($cart)) {
             throw new GraphQlNoSuchEntityException(
                 __('The cart isn\'t active.'),
                 null,
-                ErrorMapper::getErrorMessageId('The cart isn\'t active')
+                $this->errorMapper->getErrorMessageId('The cart isn\'t active')
             );
         }
 

app/code/Magento/QuoteGraphQl/Model/ErrorMapper.php

@@ -77,7 +77,7 @@ class ErrorMapper
      * @param string $message
      * @return int
      */
-    public static function getErrorMessageId(string $message): int
+    public function getErrorMessageId(string $message): int
     {
         $code = self::ERROR_UNDEFINED_ID;
 

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

@@ -38,6 +38,7 @@ class EstimateShippingMethods implements ResolverInterface
      * @param ExtensibleDataObjectConverter $dataObjectConverter
      * @param ShippingMethodConverter $shippingMethodConverter
      * @param FormatMoneyTypeData $formatMoneyTypeData
+     * @param ErrorMapper $errorMapper
      */
     public function __construct(
         private MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId,
@@ -47,6 +48,7 @@ public function __construct(
         private ExtensibleDataObjectConverter $dataObjectConverter,
         private ShippingMethodConverter $shippingMethodConverter,
         private FormatMoneyTypeData $formatMoneyTypeData,
+        private ErrorMapper $errorMapper
     ) {
     }
 
@@ -67,7 +69,7 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
                     ]
                 ),
                 $ex,
-                ErrorMapper::getErrorMessageId('Could not find a cart with ID')
+                $this->errorMapper->getErrorMessageId('Could not find a cart with ID')
             );
         }
         return $this->getAvailableShippingMethodsForAddress($args['input']['address'], $cart);

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

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2023 Adobe
+ * Copyright 2024 Adobe
  * All Rights Reserved.
  */
 declare(strict_types=1);
@@ -33,13 +33,15 @@ class EstimateTotals implements ResolverInterface
      * @param AddressFactory $addressFactory
      * @param TotalsInformationManagementInterface $totalsInformationManagement
      * @param TotalsInformationInterfaceFactory $totalsInformationFactory
+     * @param ErrorMapper $errorMapper
      */
     public function __construct(
         private readonly MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId,
         private readonly CartRepositoryInterface $cartRepository,
         private readonly AddressFactory $addressFactory,
         private readonly TotalsInformationManagementInterface $totalsInformationManagement,
-        private readonly TotalsInformationInterfaceFactory $totalsInformationFactory
+        private readonly TotalsInformationInterfaceFactory $totalsInformationFactory,
+        private readonly ErrorMapper $errorMapper
     ) {
     }
 
@@ -65,7 +67,7 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
                     ]
                 ),
                 $exception,
-                ErrorMapper::getErrorMessageId('Could not find a cart with ID')
+                $this->errorMapper->getErrorMessageId('Could not find a cart with ID')
             );
         }
 

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

@@ -28,39 +28,47 @@ class RemoveItemFromCart implements ResolverInterface
     /**
      * @var GetCartForUser
      */
-    private $getCartForUser;
+    private GetCartForUser $getCartForUser;
 
     /**
      * @var CartItemRepositoryInterface
      */
-    private $cartItemRepository;
+    private CartItemRepositoryInterface $cartItemRepository;
 
     /**
      * @var MaskedQuoteIdToQuoteId
      */
-    private $maskedQuoteIdToQuoteId;
+    private MaskedQuoteIdToQuoteId $maskedQuoteIdToQuoteId;
 
     /**
      * @var ArgumentsProcessorInterface
      */
-    private $argsSelection;
+    private ArgumentsProcessorInterface $argsSelection;
+
+    /**
+     * @var ErrorMapper
+     */
+    private ErrorMapper $errorMapper;
 
     /**
      * @param GetCartForUser $getCartForUser
      * @param CartItemRepositoryInterface $cartItemRepository
      * @param MaskedQuoteIdToQuoteId $maskedQuoteIdToQuoteId
      * @param ArgumentsProcessorInterface $argsSelection
+     * @param ErrorMapper $errorMapper
      */
     public function __construct(
         GetCartForUser $getCartForUser,
         CartItemRepositoryInterface $cartItemRepository,
         MaskedQuoteIdToQuoteId $maskedQuoteIdToQuoteId,
-        ArgumentsProcessorInterface $argsSelection
+        ArgumentsProcessorInterface $argsSelection,
+        ErrorMapper $errorMapper
     ) {
         $this->getCartForUser = $getCartForUser;
         $this->cartItemRepository = $cartItemRepository;
         $this->maskedQuoteIdToQuoteId = $maskedQuoteIdToQuoteId;
         $this->argsSelection = $argsSelection;
+        $this->errorMapper = $errorMapper;
     }
 
     /**
@@ -79,7 +87,7 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
             throw new GraphQlNoSuchEntityException(
                 __('Could not find a cart with ID "%masked_cart_id"', ['masked_cart_id' => $maskedCartId]),
                 $exception,
-                ErrorMapper::getErrorMessageId('Could not find a cart with ID')
+                $this->errorMapper->getErrorMessageId('Could not find a cart with ID')
             );
         }
 

app/code/Magento/QuoteGraphQl/Plugin/ExceptionMessageDecorator.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright 2024 Adobe
+ * All Rights Reserved.
+ */
+declare(strict_types=1);
+
+namespace Magento\QuoteGraphQl\Plugin;
+
+use Magento\GraphQl\Helper\Error\AggregateExceptionMessageFormatter;
+use Magento\QuoteGraphQl\Model\ErrorMapper;
+
+class ExceptionMessageDecorator
+{
+    /**
+     * @param ErrorMapper $errorDecorator
+     */
+    public function __construct(readonly ErrorMapper $errorDecorator)
+    {
+    }
+
+    /**
+     * @param AggregateExceptionMessageFormatter $subject
+     * @param mixed $result
+     * @return mixed
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterGetFormatted(AggregateExceptionMessageFormatter $subject, mixed $result): mixed
+    {
+        if (!$result->getCode() && ($errorId = $this->errorDecorator->getErrorMessageId($result->getMessage()))) {
+            $exceptionType = get_class($result);
+            $result = new $exceptionType(
+                __($result->getMessage()),
+                $result,
+                $errorId
+            );
+        }
+
+        return $result;
+    }
+}

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

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <!--
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2018 Adobe
+ * All Rights Reserved.
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
@@ -91,4 +91,7 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\GraphQl\Helper\Error\AggregateExceptionMessageFormatter">
+        <plugin name="exception_message_decorator" type="Magento\QuoteGraphQl\Plugin\ExceptionMessageDecorator" sortOrder="1"/>
+    </type>
 </config>

dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/Customer/PlaceOrderTest.php

@@ -448,10 +448,6 @@ private function getQuery(string $maskedQuoteId): string
     order {
       order_number
     }
-    errors {
-      message
-      code
-    }
   }
 }
 QUERY;