LYNX-519 : Error codes for order cancellation

Author: wip44850

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

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright 2024 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\OrderCancellationGraphQl\Model;
+
+use Magento\Sales\Model\Order;
+
+/**
+ * Identify error code based on the error message
+ */
+class CancelOrderErrorCodes
+{
+    private const MESSAGE_CODES_MAPPER = [
+        "order cancellation is not enabled for requested store." => 'ORDER_CANCELLATION_DISABLED',
+        "current user is not authorized to cancel this order" => 'UNAUTHORISED',
+        "the entity that was requested doesn't exist. verify the entity and try again." => 'ORDER_NOT_FOUND',
+        "order with one or more items shipped cannot be cancelled" => 'PARTIAL_ORDER_ITEM_SHIPPED',
+        "order already closed, complete, cancelled or on hold" => 'INVALID_ORDER_STATUS',
+    ];
+
+    /**
+     * Get message error code.
+     *
+     * @param string $messageCode
+     * @return string
+     */
+    public function getErrorCodeFromMapper(string $messageCode): string
+    {
+        return self::MESSAGE_CODES_MAPPER[strtolower($messageCode)] ?? 'UNDEFINED';
+    }
+}

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

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright 2024 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\OrderCancellationGraphQl\Model\Resolver;
+
+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
+     */
+    public function __construct(
+        private readonly CancelOrderErrorCodes $cancelOrderErrorCodes
+    ) {
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function resolve(
+        Field $field,
+        $context,
+        ResolveInfo $info,
+        array $value = null,
+        array $args = null
+    ): ?array {
+        if (empty($value['error'])) {
+            return null;
+        }
+
+        return [
+            'message' => $value['error'],
+            'code' => $this->cancelOrderErrorCodes->getErrorCodeFromMapper((string) $value['error']),
+        ];
+    }
+}

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

@@ -28,6 +28,21 @@ input ConfirmCancelOrderInput {
 type CancelOrderOutput @doc(description: "Contains the updated customer order and error message if any.") {
     error: String @doc(description: "Error encountered while cancelling the order.")
     order: CustomerOrder @doc(description: "Updated customer order.")
+    errorV2: CancelOrderError @resolver(class: "Magento\\OrderCancellationGraphQl\\Model\\Resolver\\CancelOrderError")
+}
+
+type CancelOrderError {
+    message: String! @doc(description: "A localized error message.")
+    code: CancelOrderErrorCode! @doc(description: "An error code that is specific to cancel order.")
+}
+
+enum CancelOrderErrorCode {
+    ORDER_CANCELLATION_DISABLED
+    UNDEFINED
+    UNAUTHORISED
+    ORDER_NOT_FOUND
+    PARTIAL_ORDER_ITEM_SHIPPED
+    INVALID_ORDER_STATUS
 }
 
 enum OrderActionType @doc(description: "The list of available order actions.") {