LYNX-548 - Error codes for order cancellation based on the error message (Optimization)

Author: cod40403

app/code/Magento/OrderCancellationGraphQl/Model/CancelOrderErrorCodes.php

@@ -19,18 +19,17 @@
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
-use Magento\OrderCancellationGraphQl\Model\CancelOrderErrorCodes;
 
 /**
  * Resolver to return the description of a CancellationReason with error code
  */
 class CancelOrderError implements ResolverInterface
 {
     /**
-     * @param CancelOrderErrorCodes $cancelOrderErrorCodes
+     * @param array $errorMessageCodesMapper
      */
     public function __construct(
-        private readonly CancelOrderErrorCodes $cancelOrderErrorCodes
+        private readonly array $errorMessageCodesMapper
     ) {
     }
 
@@ -50,7 +49,7 @@ public function resolve(
 
         return [
             'message' => $value['error'],
-            'code' => $this->cancelOrderErrorCodes->getErrorCodeFromMapper((string) $value['error']),
+            'code' => $this->errorMessageCodesMapper[strtolower((string) $value['error'])] ?? 'UNDEFINED',
         ];
     }
 }

app/code/Magento/OrderCancellationGraphQl/Model/Resolver/CancelOrderError.php

@@ -23,4 +23,15 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\OrderCancellationGraphQl\Model\Resolver\CancelOrderError">
+        <arguments>
+            <argument name="errorMessageCodesMapper" xsi:type="array">
+                <item name="order cancellation is not enabled for requested store." xsi:type="string">ORDER_CANCELLATION_DISABLED</item>
+                <item name="current user is not authorized to cancel this order" xsi:type="string">UNAUTHORISED</item>
+                <item name="the entity that was requested doesn't exist. verify the entity and try again." xsi:type="string">ORDER_NOT_FOUND</item>
+                <item name="order with one or more items shipped cannot be cancelled" xsi:type="string">PARTIAL_ORDER_ITEM_SHIPPED</item>
+                <item name="order already closed, complete, cancelled or on hold" xsi:type="string">INVALID_ORDER_STATUS</item>
+            </argument>
+        </arguments>
+    </type>
 </config>

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

@@ -151,7 +151,9 @@ public function testAttemptToCancelOrderWhenCancellationFeatureDisabled()
                 reason: "Sample reason"
               }
             ){
-                error
+                errorV2 {
+                    message
+                }
                 order {
                     status
                 }
@@ -161,7 +163,9 @@ public function testAttemptToCancelOrderWhenCancellationFeatureDisabled()
         $this->assertEquals(
             [
                 'cancelOrder' => [
-                    'error' => 'Order cancellation is not enabled for requested store.',
+                    'errorV2' => [
+                        'message' => 'Order cancellation is not enabled for requested store.'
+                    ],
                     'order' => null
                 ]
             ],
@@ -199,7 +203,9 @@ public function testAttemptToCancelOrderWithSomeStatuses(string $status, string
             [
                 'cancelOrder' =>
                     [
-                        'error' => 'Order already closed, complete, cancelled or on hold',
+                        'errorV2' => [
+                            'message' => 'Order already closed, complete, cancelled or on hold'
+                        ],
                         'order' => [
                             'status' => $expectedStatus
                         ]
@@ -240,7 +246,9 @@ public function testAttemptToCancelOrderWithOfflinePaymentFullyInvoicedFullyShip
             [
                 'cancelOrder' =>
                     [
-                        'error' => 'Order already closed, complete, cancelled or on hold',
+                        'errorV2' => [
+                            'message' => 'Order already closed, complete, cancelled or on hold'
+                        ],
                         'order' => [
                             'status' => 'Complete'
                         ]
@@ -294,7 +302,9 @@ public function testAttemptToCancelOrderWithOfflinePaymentFullyInvoicedPartially
             [
                 'cancelOrder' =>
                     [
-                        'error' => 'Order with one or more items shipped cannot be cancelled',
+                        'errorV2' => [
+                            'message' => 'Order with one or more items shipped cannot be cancelled'
+                        ],
                         'order' => [
                             'status' => 'Processing'
                         ]
@@ -335,7 +345,9 @@ public function testAttemptToCancelOrderWithOfflinePaymentFullyInvoicedFullyRefu
             [
                 'cancelOrder' =>
                     [
-                        'error' => 'Order already closed, complete, cancelled or on hold',
+                        'errorV2' => [
+                            'message' => 'Order already closed, complete, cancelled or on hold'
+                        ],
                         'order' => [
                             'status' => 'Closed'
                         ]
@@ -369,7 +381,7 @@ public function testCancelOrderWithOutAnyAmountPaid()
             [
                 'cancelOrder' =>
                     [
-                        'error' => null,
+                        'errorV2' => null,
                         'order' => [
                             'status' => 'Pending'
                         ]
@@ -399,7 +411,9 @@ private function getCancelOrderMutation(OrderInterface $order): string
                 reason: "Cancel sample reason"
               }
             ){
-                error
+                errorV2 {
+                    message
+                }
                 order {
                     status
                 }