32370 Change the schema

Author: khrystynastolbova

app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders.php

@@ -8,18 +8,16 @@
 namespace Magento\SalesGraphQl\Model\Resolver;
 
 use Magento\Framework\Api\SearchCriteriaBuilder;
-use Magento\Framework\Api\SortOrder;
-use Magento\Framework\Api\SortOrderBuilder;
 use Magento\Framework\Exception\InputException;
 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\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\SalesGraphQl\Model\Formatter\Order as OrderFormatter;
 use Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query\OrderFilter;
+use Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query\OrderSort;
 use Magento\Store\Api\Data\StoreInterface;
 
 /**
@@ -48,29 +46,29 @@ class CustomerOrders implements ResolverInterface
     private $orderFormatter;
 
     /**
-     * @var SortOrderBuilder
+     * @var OrderSort
      */
-    private $sortOrderBuilder;
+    private $orderSort;
 
     /**
      * @param OrderRepositoryInterface $orderRepository
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param OrderFilter $orderFilter
      * @param OrderFormatter $orderFormatter
-     * @param SortOrderBuilder $sortOrderBuilder
+     * @param OrderSort $orderSort
      */
     public function __construct(
         OrderRepositoryInterface $orderRepository,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         OrderFilter $orderFilter,
         OrderFormatter $orderFormatter,
-        SortOrderBuilder $sortOrderBuilder
+        OrderSort $orderSort
     ) {
         $this->orderRepository = $orderRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->orderFilter = $orderFilter;
         $this->orderFormatter = $orderFormatter;
-        $this->sortOrderBuilder = $sortOrderBuilder;
+        $this->orderSort = $orderSort;
     }
 
     /**
@@ -137,12 +135,9 @@ private function getSearchResult(array $args, int $userId, int $storeId)
         if (isset($args['pageSize'])) {
             $this->searchCriteriaBuilder->setPageSize($args['pageSize']);
         }
-        if (isset($args['changeSortDirection']) && $args['changeSortDirection']) {
-            $sortOrder = $this->sortOrderBuilder
-                ->setField(OrderInterface::ENTITY_ID)
-                ->setDirection(SortOrder::SORT_DESC)
-                ->create();
-            $this->searchCriteriaBuilder->setSortOrders([$sortOrder]);
+        if (isset($args['sort'])) {
+            $sortOrders = $this->orderSort->createSortOrders($args);
+            $this->searchCriteriaBuilder->setSortOrders($sortOrders);
         }
         return $this->orderRepository->getList($this->searchCriteriaBuilder->create());
     }

app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders/Query/OrderSort.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query;
+
+use Magento\Framework\Api\SortOrder;
+use Magento\Framework\Api\SortOrderBuilder;
+use Magento\Framework\GraphQl\Schema\Type\Enum\DataMapperInterface;
+use Magento\GiftRegistryGraphQl\Mapper\GiftRegistryDataMapper;
+
+/**
+ *
+ */
+class OrderSort
+{
+    private const SORTABLE_FIELD_MAP = 'CustomerOrderSortableField';
+
+    /**
+     * @var DataMapperInterface
+     */
+    private $enumDataMapper;
+
+    /**
+     * @var SortOrderBuilder
+     */
+    private $sortOrderBuilder;
+
+    /**
+     * @param DataMapperInterface $enumDataMapper
+     * @param SortOrderBuilder $sortOrderBuilder
+     */
+    public function __construct(
+        DataMapperInterface $enumDataMapper,
+        SortOrderBuilder $sortOrderBuilder
+    ) {
+        $this->enumDataMapper = $enumDataMapper;
+        $this->sortOrderBuilder = $sortOrderBuilder;
+    }
+
+    /**
+     *
+     *
+     * @param array $args
+     * @return SortOrder[]
+     */
+    public function createSortOrders(array $args): array
+    {
+        $sortField = $this->getField($args['sort']['sort_field']);
+        $sortOrder = $this->sortOrderBuilder
+            ->setField($sortField)
+            ->setDirection($args['sort']['sort_direction'])
+            ->create();
+        return [$sortOrder];
+    }
+
+    /**
+     *
+     *
+     * @param string $field
+     * @return string
+     */
+    private function getField(string $field): string
+    {
+        $enums = $this->enumDataMapper->getMappedEnums(self::SORTABLE_FIELD_MAP);
+
+        return $enums[strtolower($field)];
+    }
+}

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

@@ -42,4 +42,13 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Framework\GraphQl\Schema\Type\Enum\DefaultDataMapper">
+        <arguments>
+            <argument name="map" xsi:type="array">
+                <item name="CustomerOrderSortableField" xsi:type="array">
+                    <item name="order_id" xsi:type="string">entity_id</item>
+                </item>
+            </argument>
+        </arguments>
+    </type>
 </config>

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

@@ -25,14 +25,23 @@ type Customer {
         filter: CustomerOrdersFilterInput @doc(description: "Defines the filter to use for searching customer orders"),
         currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1"),
         pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. The default value is 20"),
-        changeSortDirection: Boolean = false @doc(description: "Changes sort direction by entity_id to DESC. The default value is false"),
+        sort: CustomerOrderSortInput @doc(description: "Specifies which field to sort on, and whether to return the results in ascending or descending order.")
     ): CustomerOrders @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\CustomerOrders") @cache(cacheable: false)
 }
 
 input CustomerOrdersFilterInput @doc(description: "Identifies the filter to use for filtering orders.") {
     number: FilterStringTypeInput @doc(description: "Filters by order number.")
 }
 
+input CustomerOrderSortInput @doc(description: "CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.") {
+    sort_field: CustomerOrderSortableField! @doc(description: "Specifies the field to use for sorting")
+    sort_direction: SortEnum! @doc(description: "This enumeration indicates whether to return results in ascending or descending order")
+}
+
+enum CustomerOrderSortableField @doc(description: "Specifies the field to use for sorting") {
+    ORDER_ID @doc(description: "Sorts customer order by ID")
+}
+
 type CustomerOrders @doc(description: "The collection of orders that match the conditions defined in the filter") {
     items: [CustomerOrder]! @doc(description: "An array of customer orders")
     page_info: SearchResultPageInfo @doc(description: "An object that includes the current_page, page_info, and page_size values specified in the query")

dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/RetrieveOrdersByOrderNumberTest.php

@@ -414,16 +414,21 @@ public function testGetCustomerDescendingSortedOrders()
     {
         $query = <<<QUERY
 {
-    customer {
-        orders(changeSortDirection:true) {
-            items {
-                id
-                number
-                status
-                order_date
-            }
-        }
+  customer {
+    orders(
+      sort: {
+        sort_field: ORDER_ID,
+        sort_direction: DESC
+      }
+    ) {
+      items {
+        id
+        number
+         status
+         order_date
+      }
     }
+  }
 }
 QUERY;