Merge pull request #9591 from magento-lynx/graphql-api-enhancements

internal-magento-queue-manager[bot] · web-flow · commit 2b17d9b62349 · 2025-02-17T16:04:29.000Z
[LYNX] Delivery PR
diff --git a/app/code/Magento/OrderCancellation/Model/Email/ConfirmationKeySender.php b/app/code/Magento/OrderCancellation/Model/Email/ConfirmationKeySender.php
@@ -51,36 +51,28 @@ public function __construct(
      * Send email to guest user with confirmation key.
      *
      * @param Order $order
-     * @param string $confirmationKey
+     * @param array $confirmationDetails
      * @return void
      * @throws LocalizedException
      */
     public function execute(
         Order $order,
-        string $confirmationKey,
+        array $confirmationDetails
     ):void {
         try {
             $storeId = (int)$order->getStoreId();
-            $guestOrderUrl = $this->url->getUrl(
-                self::ORDER_VIEW_PATH,
-                [
-                    '_query' => [
-                        'confirmation_key' => $confirmationKey,
-                        'order_id' => $order->getIncrementId()
-                    ]
-                ]
-            );
-            $templateParams = [
-                'customer_name' => $order->getCustomerName(),
-                'order_id' => $order->getIncrementId(),
-                'guest_order_url' => $guestOrderUrl,
-                'escaper' => $this->escaper,
-            ];
-
             $this->transportBuilder
                 ->setTemplateIdentifier(self::TEMPLATE_ID)
                 ->setTemplateOptions(['area' => Area::AREA_FRONTEND, 'store' => $storeId])
-                ->setTemplateVars($templateParams)
+                ->setTemplateVars([
+                    'customer_name' => $order->getCustomerName(),
+                    'order_id' => $order->getIncrementId(),
+                    'guest_order_url' => $this->url->getUrl(
+                        self::ORDER_VIEW_PATH,
+                        ['_query' => $confirmationDetails]
+                    ),
+                    'escaper' => $this->escaper,
+                ])
                 ->setFromByScope($this->orderIdentity->getEmailIdentity(), $storeId)
                 ->addTo($order->getCustomerEmail(), $order->getCustomerName())
                 ->getTransport()
diff --git a/app/code/Magento/OrderCancellation/Model/ResourceModel/SalesOrderConfirmCancel.php b/app/code/Magento/OrderCancellation/Model/ResourceModel/SalesOrderConfirmCancel.php
@@ -40,7 +40,7 @@ public function get(int $orderId): ?array
         $connection = $this->resourceConnection->getConnection();
         return $connection->fetchRow(
             $connection->select()->from(
-                self::TABLE_NAME
+                $this->resourceConnection->getTableName(self::TABLE_NAME)
             )->where(
                 'order_id = ?',
                 $orderId
@@ -60,7 +60,7 @@ public function insert(int $orderId, string $confirmationKey, string $reason): v
     {
         $connection = $this->resourceConnection->getConnection();
         $connection->insertOnDuplicate(
-            self::TABLE_NAME,
+            $this->resourceConnection->getTableName(self::TABLE_NAME),
             [
                 'order_id' => $orderId,
                 'confirmation_key' => $confirmationKey,
diff --git a/app/code/Magento/OrderCancellationGraphQl/Model/CancelOrderGuest.php b/app/code/Magento/OrderCancellationGraphQl/Model/CancelOrderGuest.php
@@ -8,6 +8,7 @@
 namespace Magento\OrderCancellationGraphQl\Model;
 
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\GraphQl\Query\Uid;
 use Magento\OrderCancellation\Model\Email\ConfirmationKeySender;
 use Magento\OrderCancellation\Model\GetConfirmationKey;
 use Magento\Sales\Api\OrderRepositoryInterface;
@@ -23,12 +24,14 @@ class CancelOrderGuest
      * @param OrderRepositoryInterface $orderRepository
      * @param ConfirmationKeySender $confirmationKeySender
      * @param GetConfirmationKey $confirmationKey
+     * @param Uid $idEncoder
      */
     public function __construct(
         private readonly OrderFormatter           $orderFormatter,
         private readonly OrderRepositoryInterface $orderRepository,
         private readonly ConfirmationKeySender    $confirmationKeySender,
         private readonly GetConfirmationKey       $confirmationKey,
+        private readonly Uid                      $idEncoder
     ) {
     }
 
@@ -65,7 +68,13 @@ public function execute(Order $order, array $input): array
      */
     private function sendConfirmationKeyEmail(Order $order, string $reason): void
     {
-        $this->confirmationKeySender->execute($order, $this->confirmationKey->execute($order, $reason));
+        $this->confirmationKeySender->execute(
+            $order,
+            [
+                'order_id' => $this->idEncoder->encode((string)$order->getEntityId()),
+                'confirmation_key' => $this->confirmationKey->execute($order, $reason)
+            ]
+        );
 
         // add comment in order about confirmation key send
         $order->addCommentToStatusHistory(
diff --git a/app/code/Magento/OrderCancellationGraphQl/Model/Resolver/CancelOrder.php b/app/code/Magento/OrderCancellationGraphQl/Model/Resolver/CancelOrder.php
@@ -11,6 +11,7 @@
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
+use Magento\Framework\GraphQl\Query\Uid;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\OrderCancellation\Model\CancelOrder as CancelOrderAction;
 use Magento\OrderCancellationGraphQl\Model\Validator\ValidateOrder;
@@ -31,13 +32,15 @@ class CancelOrder implements ResolverInterface
      * @param OrderRepositoryInterface $orderRepository
      * @param CancelOrderAction $cancelOrderAction
      * @param ValidateOrder $validateOrder
+     * @param Uid $idEncoder
      */
     public function __construct(
         private readonly ValidateRequest          $validateRequest,
         private readonly OrderFormatter           $orderFormatter,
         private readonly OrderRepositoryInterface $orderRepository,
         private readonly CancelOrderAction        $cancelOrderAction,
-        private readonly ValidateOrder            $validateOrder
+        private readonly ValidateOrder            $validateOrder,
+        private readonly Uid                      $idEncoder
     ) {
     }
 
@@ -54,7 +57,7 @@ public function resolve(
         $this->validateRequest->execute($context, $args['input'] ?? []);
 
         try {
-            $order = $this->orderRepository->get($args['input']['order_id']);
+            $order = $this->orderRepository->get($this->idEncoder->decode($args['input']['order_id']));
 
             if ((int)$order->getCustomerId() !== $context->getUserId()) {
                 throw new GraphQlAuthorizationException(__('Current user is not authorized to cancel this order'));
diff --git a/app/code/Magento/OrderCancellationGraphQl/Model/Resolver/ConfirmCancelOrder.php b/app/code/Magento/OrderCancellationGraphQl/Model/Resolver/ConfirmCancelOrder.php
@@ -10,6 +10,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
+use Magento\Framework\GraphQl\Query\Uid;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\OrderCancellationGraphQl\Model\ConfirmCancelOrder as ConfirmCancelOrderGuest;
 use Magento\OrderCancellationGraphQl\Model\Validator\ValidateOrder;
@@ -28,12 +29,14 @@ class ConfirmCancelOrder implements ResolverInterface
      * @param OrderRepositoryInterface $orderRepository
      * @param ConfirmCancelOrderGuest $confirmCancelOrder
      * @param ValidateOrder $validateOrder
+     * @param Uid $idEncoder
      */
     public function __construct(
         private readonly ValidateConfirmRequest   $validateRequest,
         private readonly OrderRepositoryInterface $orderRepository,
         private readonly ConfirmCancelOrderGuest  $confirmCancelOrder,
-        private readonly ValidateOrder            $validateOrder
+        private readonly ValidateOrder            $validateOrder,
+        private readonly Uid                      $idEncoder
     ) {
     }
 
@@ -50,7 +53,7 @@ public function resolve(
         $this->validateRequest->execute($args['input'] ?? []);
 
         try {
-            $order = $this->orderRepository->get($args['input']['order_id']);
+            $order = $this->orderRepository->get((int)$this->idEncoder->decode($args['input']['order_id']));
 
             if (!$order->getCustomerIsGuest()) {
                 return [
diff --git a/app/code/Magento/OrderCancellationGraphQl/Model/Validator/ValidateConfirmRequest.php b/app/code/Magento/OrderCancellationGraphQl/Model/Validator/ValidateConfirmRequest.php
@@ -30,7 +30,7 @@ public function execute(mixed $input): void
             );
         }
 
-        if (!$input['order_id'] || (int)$input['order_id'] === 0) {
+        if (empty($input['order_id'])) {
             throw new GraphQlInputException(
                 __(
                     'Required parameter "%field" is missing or incorrect.',
diff --git a/app/code/Magento/OrderCancellationGraphQl/Model/Validator/ValidateRequest.php b/app/code/Magento/OrderCancellationGraphQl/Model/Validator/ValidateRequest.php
@@ -38,7 +38,7 @@ public function execute(
             );
         }
 
-        if (!$input['order_id'] || (int)$input['order_id'] === 0) {
+        if (empty($input['order_id'])) {
             throw new GraphQlInputException(
                 __(
                     'Required parameter "%field" is missing or incorrect.',
diff --git a/app/code/Magento/OrderCancellationGraphQl/etc/graphql/di.xml b/app/code/Magento/OrderCancellationGraphQl/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 2025 Adobe
+ * All Rights Reserved.
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
@@ -14,8 +14,6 @@
             </argument>
         </arguments>
     </type>
-    <preference for="Magento\SalesGraphQl\Api\OrderAvailableActionProviderInterface"
-                type="Magento\OrderCancellationGraphQl\Model\GetOrderCancellationAvailableActions" />
     <type name="Magento\SalesGraphQl\Model\GetOrderAvailableActions">
         <arguments>
             <argument name="actions" xsi:type="array">
diff --git a/app/code/Magento/OrderCancellationGraphQl/etc/schema.graphqls b/app/code/Magento/OrderCancellationGraphQl/etc/schema.graphqls
@@ -17,12 +17,12 @@ type Mutation {
 }
 
 input CancelOrderInput @doc(description: "Defines the order to cancel.") {
-    order_id: ID! @doc(description: "Order ID.")
+    order_id: ID! @doc(description: "The unique ID of an `Order` type.")
     reason: String! @doc(description: "Cancellation reason.")
 }
 
 input ConfirmCancelOrderInput {
-    order_id: ID! @doc(description: "Order ID.")
+    order_id: ID! @doc(description: "The unique ID of an `Order` type.")
     confirmation_key: String! @doc(description: "Confirmation Key to cancel the order.")
 }
 
@@ -51,6 +51,6 @@ enum CancelOrderErrorCode {
     INVALID_ORDER_STATUS
 }
 
-enum OrderActionType @doc(description: "The list of available order actions.") {
+enum OrderActionType {
     CANCEL
 }
diff --git a/app/code/Magento/OrderCancellationUi/view/frontend/web/js/cancel-order-modal.js b/app/code/Magento/OrderCancellationUi/view/frontend/web/js/cancel-order-modal.js
@@ -49,7 +49,7 @@ mutation cancelOrder($order_id: ID!, $reason: String!) {
                             data: JSON.stringify({
                                 query: mutation,
                                 variables: {
-                                    'order_id': config.order_id,
+                                    'order_id': btoa(config.order_id),
                                     'reason': reason
                                 }
                             }),
diff --git a/app/code/Magento/SalesGraphQl/Model/GetReorderAvailableActions.php b/app/code/Magento/SalesGraphQl/Model/GetReorderAvailableActions.php
@@ -7,21 +7,30 @@
 
 namespace Magento\SalesGraphQl\Model;
 
+use Magento\Sales\Helper\Reorder;
+use Magento\Sales\Model\Order;
 use Magento\SalesGraphQl\Api\OrderAvailableActionProviderInterface;
 
 class GetReorderAvailableActions implements OrderAvailableActionProviderInterface
 {
+    /**
+     * GetReorderAvailableActions constructor
+     *
+     * @param Reorder $reorderHelper
+     */
+    public function __construct(
+        private readonly Reorder $reorderHelper
+    ) {
+    }
+
     /**
      * Get reorder available action
      *
-     * @param \Magento\Sales\Model\Order $order
+     * @param Order $order
      * @return array|string[]
      */
-    public function execute(\Magento\Sales\Model\Order $order): array
+    public function execute(Order $order): array
     {
-        if ($order->canReorder()) {
-            return ['REORDER'];
-        }
-        return [];
+        return $this->reorderHelper->canReorder($order->getId()) ? ['REORDER'] : [];
     }
 }
diff --git a/app/code/Magento/SalesGraphQl/etc/graphql/di.xml b/app/code/Magento/SalesGraphQl/etc/graphql/di.xml
@@ -52,8 +52,6 @@
             </argument>
         </arguments>
     </type>
-    <preference for="Magento\SalesGraphQl\Api\OrderAvailableActionProviderInterface"
-                type="Magento\SalesGraphQl\Model\GetReorderAvailableActions" />
     <type name="Magento\SalesGraphQl\Model\GetOrderAvailableActions">
         <arguments>
             <argument name="actions" xsi:type="array">
diff --git a/app/code/Magento/SalesGraphQl/etc/schema.graphqls b/app/code/Magento/SalesGraphQl/etc/schema.graphqls
@@ -318,19 +318,19 @@ enum OrderActionType @doc(description: "The list of available order actions.") {
 }
 
 type StoreConfig {
-    display_product_prices_in_catalog: Boolean! @doc(description: "Configuration data from tax/display/type")
-    display_shipping_prices: Boolean! @doc(description: "Configuration data from tax/display/shipping")
-    orders_invoices_credit_memos_display_price: Boolean! @doc(description: "Configuration data from tax/sales_display/price")
-    orders_invoices_credit_memos_display_subtotal: Boolean! @doc(description: "Configuration data from tax/sales_display/subtotal")
-    orders_invoices_credit_memos_display_shipping_amount: Boolean! @doc(description: "Configuration data from tax/sales_display/shipping")
+    display_product_prices_in_catalog: Int! @doc(description: "Configuration data from tax/display/type")
+    display_shipping_prices: Int! @doc(description: "Configuration data from tax/display/shipping")
+    orders_invoices_credit_memos_display_price: Int! @doc(description: "Configuration data from tax/sales_display/price")
+    orders_invoices_credit_memos_display_subtotal: Int! @doc(description: "Configuration data from tax/sales_display/subtotal")
+    orders_invoices_credit_memos_display_shipping_amount: Int! @doc(description: "Configuration data from tax/sales_display/shipping")
     orders_invoices_credit_memos_display_grandtotal: Boolean! @doc(description: "Configuration data from tax/sales_display/grandtotal")
     orders_invoices_credit_memos_display_full_summary: Boolean! @doc(description: "Configuration data from tax/sales_display/full_summary")
     orders_invoices_credit_memos_display_zero_tax: Boolean! @doc(description: "Configuration data from tax/sales_display/zero_tax")
     fixed_product_taxes_enable: Boolean! @doc(description: "Configuration data from tax/weee/enable")
-    fixed_product_taxes_display_prices_in_product_lists: Int @doc(description: "Configuration data from tax/weee/display_list")
-    fixed_product_taxes_display_prices_on_product_view_page: Int @doc(description: "Configuration data from tax/weee/display")
-    fixed_product_taxes_display_prices_in_sales_modules: Int @doc(description: "Configuration data from tax/weee/display_sales")
-    fixed_product_taxes_display_prices_in_emails: Int @doc(description: "Configuration data from tax/weee/display_email")
+    fixed_product_taxes_display_prices_in_product_lists: Int! @doc(description: "Configuration data from tax/weee/display_list")
+    fixed_product_taxes_display_prices_on_product_view_page: Int! @doc(description: "Configuration data from tax/weee/display")
+    fixed_product_taxes_display_prices_in_sales_modules: Int! @doc(description: "Configuration data from tax/weee/display_sales")
+    fixed_product_taxes_display_prices_in_emails: Int! @doc(description: "Configuration data from tax/weee/display_email")
     fixed_product_taxes_apply_tax_to_fpt: Boolean! @doc(description: "Configuration data from tax/weee/apply_vat")
     fixed_product_taxes_include_fpt_in_subtotal: Boolean! @doc(description: "Configuration data from tax/weee/include_in_subtotal")
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/CancelOrderErrorCodeTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/CancelOrderErrorCodeTest.php
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/CancelOrderTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/CancelOrderTest.php
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/ConfirmCancelGuestOrderTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/OrderCancellation/ConfirmCancelGuestOrderTest.php
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/OrderAvailableActionTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/OrderAvailableActionTest.php
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/SalesTaxStoreConfigTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/SalesTaxStoreConfigTest.php

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function execute(mixed $input): void`
`30`	`30`	`);`
`31`	`31`	`}`
`32`	`32`
`33`		`- if (!$input['order_id'] \|\| (int)$input['order_id'] === 0) {`
	`33`	`+ if (empty($input['order_id'])) {`
`34`	`34`	`throw new GraphQlInputException(`
`35`	`35`	`__(`
`36`	`36`	`'Required parameter "%field" is missing or incorrect.',`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function execute(`
`38`	`38`	`);`
`39`	`39`	`}`
`40`	`40`
`41`		`- if (!$input['order_id'] \|\| (int)$input['order_id'] === 0) {`
	`41`	`+ if (empty($input['order_id'])) {`
`42`	`42`	`throw new GraphQlInputException(`
`43`	`43`	`__(`
`44`	`44`	`'Required parameter "%field" is missing or incorrect.',`
Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,12 @@ type Mutation {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`input CancelOrderInput @doc(description: "Defines the order to cancel.") {`
`20`		`- order_id: ID! @doc(description: "Order ID.")`
	`20`	+ order_id: ID! @doc(description: "The unique ID of an `Order` type.")
`21`	`21`	`reason: String! @doc(description: "Cancellation reason.")`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`input ConfirmCancelOrderInput {`
`25`		`- order_id: ID! @doc(description: "Order ID.")`
	`25`	+ order_id: ID! @doc(description: "The unique ID of an `Order` type.")
`26`	`26`	`confirmation_key: String! @doc(description: "Confirmation Key to cancel the order.")`
`27`	`27`	`}`
`28`	`28`
`@@ -51,6 +51,6 @@ enum CancelOrderErrorCode {`
`51`	`51`	`INVALID_ORDER_STATUS`
`52`	`52`	`}`
`53`	`53`
`54`		`-enum OrderActionType @doc(description: "The list of available order actions.") {`
	`54`	`+enum OrderActionType {`
`55`	`55`	`CANCEL`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ mutation cancelOrder($order_id: ID!, $reason: String!) {`
`49`	`49`	`data: JSON.stringify({`
`50`	`50`	`query: mutation,`
`51`	`51`	`variables: {`
`52`		`- 'order_id': config.order_id,`
	`52`	`+ 'order_id': btoa(config.order_id),`
`53`	`53`	`'reason': reason`
`54`	`54`	`}`
`55`	`55`	`}),`