Merge pull request #7985 from magento-gl/comm_78764_32435

sidolov · web-flow · commit c6122675b875 · 2022-12-19T12:45:39.000-06:00
[GL Bluetooth] Community Pull Requests delivery
diff --git a/app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders.php b/app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders.php
@@ -19,6 +19,7 @@
 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;
 use Magento\Store\Model\StoreManagerInterface;
 
@@ -49,6 +50,11 @@ class CustomerOrders implements ResolverInterface
      */
     private $orderFormatter;
 
+    /**
+     * @var OrderSort
+     */
+    private $orderSort;
+
     /**
      * @var StoreManagerInterface|mixed|null
      */
@@ -59,19 +65,22 @@ class CustomerOrders implements ResolverInterface
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param OrderFilter $orderFilter
      * @param OrderFormatter $orderFormatter
+     * @param OrderSort $orderSort
      * @param StoreManagerInterface|null $storeManager
      */
     public function __construct(
         OrderRepositoryInterface $orderRepository,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         OrderFilter $orderFilter,
         OrderFormatter $orderFormatter,
+        OrderSort $orderSort,
         ?StoreManagerInterface $storeManager = null
     ) {
         $this->orderRepository = $orderRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->orderFilter = $orderFilter;
         $this->orderFormatter = $orderFormatter;
+        $this->orderSort = $orderSort;
         $this->storeManager = $storeManager ?? ObjectManager::getInstance()->get(StoreManagerInterface::class);
     }
 
@@ -144,6 +153,10 @@ private function getSearchResult(array $args, int $userId, int $storeId, array $
         if (isset($args['pageSize'])) {
             $this->searchCriteriaBuilder->setPageSize($args['pageSize']);
         }
+        if (isset($args['sort'])) {
+            $sortOrders = $this->orderSort->createSortOrders($args);
+            $this->searchCriteriaBuilder->setSortOrders($sortOrders);
+        }
         return $this->orderRepository->getList($this->searchCriteriaBuilder->create());
     }
 
diff --git a/app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders/Query/OrderSort.php b/app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders/Query/OrderSort.php
@@ -0,0 +1,74 @@
+<?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;
+
+/**
+ * Order sort allows to sort the collection by the specified field and direction
+ */
+class OrderSort
+{
+    /**
+     * The sortable field mapper name
+     */
+    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;
+    }
+
+    /**
+     * Create an array of sort orders for sorting customer orders by the specified field and direction
+     *
+     * @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];
+    }
+
+    /**
+     * Get sort field
+     *
+     * @param string $field
+     * @return string
+     */
+    private function getField(string $field): string
+    {
+        $enums = $this->enumDataMapper->getMappedEnums(self::SORTABLE_FIELD_MAP);
+
+        return $enums[strtolower($field)];
+    }
+}
diff --git a/app/code/Magento/SalesGraphQl/etc/graphql/di.xml b/app/code/Magento/SalesGraphQl/etc/graphql/di.xml
@@ -42,4 +42,14 @@
             </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="number" xsi:type="string">increment_id</item>
+                    <item name="created_at" xsi:type="string">created_at</item>
+                </item>
+            </argument>
+        </arguments>
+    </type>
 </config>
diff --git a/app/code/Magento/SalesGraphQl/etc/schema.graphqls b/app/code/Magento/SalesGraphQl/etc/schema.graphqls
@@ -25,6 +25,7 @@ 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."),
+        sort: CustomerOrderSortInput @doc(description: "Specifies which field to sort on, and whether to return the results in ascending or descending order.")
         scope: ScopeTypeEnum @doc(description: "Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores."),
     ): CustomerOrders @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\CustomerOrders") @cache(cacheable: false)
 }
@@ -33,6 +34,16 @@ input CustomerOrdersFilterInput @doc(description: "Identifies the filter to use
     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") {
+    NUMBER @doc(description: "Sorts customer orders by number")
+    CREATED_AT @doc(description: "Sorts customer orders by created_at field")
+}
+
 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: "Contains pagination metadata.")
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/RetrieveOrdersByOrderNumberTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Sales/RetrieveOrdersByOrderNumberTest.php
@@ -16,6 +16,18 @@
 use Magento\Sales\Model\ResourceModel\Order\Collection;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
+use Magento\Catalog\Test\Fixture\Product as ProductFixture;
+use Magento\TestFramework\Fixture\DataFixture;
+use Magento\Checkout\Test\Fixture\SetDeliveryMethod;
+use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddress;
+use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddress;
+use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethod;
+use Magento\Checkout\Test\Fixture\PlaceOrder as PlaceOrder;
+use Magento\Customer\Test\Fixture\Customer;
+use Magento\Quote\Test\Fixture\AddProductToCart as AddProductToCartFixture;
+use Magento\Quote\Test\Fixture\CustomerCart;
+use Magento\TestFramework\Fixture\DataFixtureStorage;
+use Magento\TestFramework\Fixture\DataFixtureStorageManager;
 
 /**
  * Class RetrieveOrdersTest
@@ -34,6 +46,11 @@ class RetrieveOrdersByOrderNumberTest extends GraphQlAbstract
     /** @var ProductRepositoryInterface */
     private $productRepository;
 
+    /**
+     * @var DataFixtureStorage
+     */
+    private $fixtures;
+
     protected function setUp():void
     {
         parent::setUp();
@@ -42,6 +59,7 @@ protected function setUp():void
         $this->orderRepository = $objectManager->get(OrderRepositoryInterface::class);
         $this->searchCriteriaBuilder = $objectManager->get(SearchCriteriaBuilder::class);
         $this->productRepository = $objectManager->get(ProductRepositoryInterface::class);
+        $this->fixtures = $objectManager->get(DataFixtureStorageManager::class)->getStorage();
     }
 
     /**
@@ -404,6 +422,155 @@ public function testGetMatchingOrdersForLowerQueryLength()
         $this->assertCount($response['customer']['orders']['total_count'], $response['customer']['orders']['items']);
     }
 
+    /**
+     * @return void
+     * @throws AuthenticationException
+     */
+    #[
+        DataFixture(Customer::class, ['email' => 'customer@example.com'], 'customer'),
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart2'),
+        DataFixture(ProductFixture::class, ['sku' => '100000002', 'price' => 10], 'p2'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart2.id$', 'product_id' => '$p2.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart2.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart2.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart2.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart2.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart2.id$'], 'or2'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart3'),
+        DataFixture(ProductFixture::class, ['sku' => '100000003', 'price' => 10], 'p3'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart3.id$', 'product_id' => '$p3.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart3.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart3.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart3.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart3.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart3.id$'], 'or3'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart4'),
+        DataFixture(ProductFixture::class, ['sku' => '100000004', 'price' => 10], 'p4'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart4.id$', 'product_id' => '$p4.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart4.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart4.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart4.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart4.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart4.id$'], 'or4'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart5'),
+        DataFixture(ProductFixture::class, ['sku' => '100000005', 'price' => 10], 'p5'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart5.id$', 'product_id' => '$p5.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart5.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart5.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart5.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart5.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart5.id$'], 'or5'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart6'),
+        DataFixture(ProductFixture::class, ['sku' => '100000006', 'price' => 10], 'p6'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart6.id$', 'product_id' => '$p6.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart6.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart6.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart6.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart6.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart6.id$'], 'or6'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart7'),
+        DataFixture(ProductFixture::class, ['sku' => '100000007', 'price' => 10], 'p7'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart7.id$', 'product_id' => '$p7.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart7.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart7.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart7.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart7.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart7.id$'], 'or7'),
+    ]
+
+    #[
+        DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart8'),
+        DataFixture(ProductFixture::class, ['sku' => '100000008', 'price' => 10], 'p8'),
+        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart8.id$', 'product_id' => '$p8.id$']),
+        DataFixture(SetBillingAddress::class, ['cart_id' => '$cart8.id$']),
+        DataFixture(SetShippingAddress::class, ['cart_id' => '$cart8.id$']),
+        DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart8.id$']),
+        DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart8.id$']),
+        DataFixture(PlaceOrder::class, ['cart_id' => '$cart8.id$'], 'or8'),
+    ]
+    public function testGetCustomerDescendingSortedOrders()
+    {
+        $query = <<<QUERY
+{
+  customer {
+    orders(
+      sort: {
+        sort_field: CREATED_AT,
+        sort_direction: DESC
+      }
+    ) {
+      items {
+        id
+        number
+         status
+         order_date
+      }
+    }
+  }
+}
+QUERY;
+
+        $currentEmail = 'customer@example.com';
+        $currentPassword = 'password';
+        $response = $this->graphQlQuery(
+            $query,
+            [],
+            '',
+            $this->customerAuthenticationHeader->execute($currentEmail, $currentPassword)
+        );
+        $this->assertArrayHasKey('orders', $response['customer']);
+        $this->assertArrayHasKey('items', $response['customer']['orders']);
+        $customerOrderItemsInResponse = $response['customer']['orders']['items'];
+
+        $order2 = $this->fixtures->get('or2')->getIncrementId();
+        $order3 = $this->fixtures->get('or3')->getIncrementId();
+        $order4 = $this->fixtures->get('or4')->getIncrementId();
+        $order5 = $this->fixtures->get('or5')->getIncrementId();
+        $order6 = $this->fixtures->get('or6')->getIncrementId();
+        $order7 = $this->fixtures->get('or7')->getIncrementId();
+        $order8 = $this->fixtures->get('or8')->getIncrementId();
+
+        $expectedOrderNumbersOptions = [$order8, $order7, $order6, $order5, $order4, $order3, $order2 ];
+        $expectedOrderNumbers = $scalarTemp = [];
+        $compDate = $prevComKey = '';
+        foreach ($expectedOrderNumbersOptions as $comKey => $comData) {
+            if ($compDate == $customerOrderItemsInResponse[$comKey]['order_date']) {
+                $expectedOrderNumbers[] = $expectedOrderNumbers[$prevComKey];
+                $scalarTemp = (array)$comData;
+                $expectedOrderNumbers[$prevComKey] = $scalarTemp[0];
+            } else {
+                $scalarTemp = (array)$comData;
+                $expectedOrderNumbers[] = $scalarTemp[0];
+            }
+            $prevComKey = $comKey;
+            $compDate = $customerOrderItemsInResponse[$comKey]['order_date'];
+        }
+
+        foreach ($expectedOrderNumbers as $key => $data) {
+            $orderItemInResponse = $customerOrderItemsInResponse[$key];
+            $this->assertEquals(
+                $data,
+                $orderItemInResponse['number'],
+                "The order number is different than the expected for order - {$data}"
+            );
+        }
+    }
+
     /**
      * @magentoApiDataFixture Magento/Customer/_files/customer.php
      * @magentoApiDataFixture Magento/GraphQl/Sales/_files/orders_with_customer.php
