Skip to content

Commit 47acd2f

Browse files
IndraniksIndraniks
committed
Merge remote-tracking branch 'khrystynastolbova/graphQl/32370-sort_customer_orders' into comm_78764_32435
2 parents bb1c882 + 1b83e1a commit 47acd2f

File tree

5 files changed

+233
-0
lines changed

5 files changed

+233
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
use Magento\Sales\Api\OrderRepositoryInterface;
2020
use Magento\SalesGraphQl\Model\Formatter\Order as OrderFormatter;
2121
use Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query\OrderFilter;
22+
use Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query\OrderSort;
2223
use Magento\Store\Api\Data\StoreInterface;
2324
use Magento\Store\Model\StoreManagerInterface;
2425

@@ -49,6 +50,11 @@ class CustomerOrders implements ResolverInterface
4950
*/
5051
private $orderFormatter;
5152

53+
/**
54+
* @var OrderSort
55+
*/
56+
private $orderSort;
57+
5258
/**
5359
* @var StoreManagerInterface|mixed|null
5460
*/
@@ -59,19 +65,22 @@ class CustomerOrders implements ResolverInterface
5965
* @param SearchCriteriaBuilder $searchCriteriaBuilder
6066
* @param OrderFilter $orderFilter
6167
* @param OrderFormatter $orderFormatter
68+
* @param OrderSort $orderSort
6269
* @param StoreManagerInterface|null $storeManager
6370
*/
6471
public function __construct(
6572
OrderRepositoryInterface $orderRepository,
6673
SearchCriteriaBuilder $searchCriteriaBuilder,
6774
OrderFilter $orderFilter,
6875
OrderFormatter $orderFormatter,
76+
OrderSort $orderSort,
6977
?StoreManagerInterface $storeManager = null
7078
) {
7179
$this->orderRepository = $orderRepository;
7280
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
7381
$this->orderFilter = $orderFilter;
7482
$this->orderFormatter = $orderFormatter;
83+
$this->orderSort = $orderSort;
7584
$this->storeManager = $storeManager ?? ObjectManager::getInstance()->get(StoreManagerInterface::class);
7685
}
7786

@@ -144,6 +153,10 @@ private function getSearchResult(array $args, int $userId, int $storeId, array $
144153
if (isset($args['pageSize'])) {
145154
$this->searchCriteriaBuilder->setPageSize($args['pageSize']);
146155
}
156+
if (isset($args['sort'])) {
157+
$sortOrders = $this->orderSort->createSortOrders($args);
158+
$this->searchCriteriaBuilder->setSortOrders($sortOrders);
159+
}
147160
return $this->orderRepository->getList($this->searchCriteriaBuilder->create());
148161
}
149162

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

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query;
9+
10+
use Magento\Framework\Api\SortOrder;
11+
use Magento\Framework\Api\SortOrderBuilder;
12+
use Magento\Framework\GraphQl\Schema\Type\Enum\DataMapperInterface;
13+
14+
/**
15+
* Order sort allows to sort the collection by the specified field and direction
16+
*/
17+
class OrderSort
18+
{
19+
/**
20+
* The sortable field mapper name
21+
*/
22+
private const SORTABLE_FIELD_MAP = 'CustomerOrderSortableField';
23+
24+
/**
25+
* @var DataMapperInterface
26+
*/
27+
private $enumDataMapper;
28+
29+
/**
30+
* @var SortOrderBuilder
31+
*/
32+
private $sortOrderBuilder;
33+
34+
/**
35+
* @param DataMapperInterface $enumDataMapper
36+
* @param SortOrderBuilder $sortOrderBuilder
37+
*/
38+
public function __construct(
39+
DataMapperInterface $enumDataMapper,
40+
SortOrderBuilder $sortOrderBuilder
41+
) {
42+
$this->enumDataMapper = $enumDataMapper;
43+
$this->sortOrderBuilder = $sortOrderBuilder;
44+
}
45+
46+
/**
47+
* Create an array of sort orders for sorting customer orders by the specified field and direction
48+
*
49+
* @param array $args
50+
* @return SortOrder[]
51+
*/
52+
public function createSortOrders(array $args): array
53+
{
54+
$sortField = $this->getField($args['sort']['sort_field']);
55+
$sortOrder = $this->sortOrderBuilder
56+
->setField($sortField)
57+
->setDirection($args['sort']['sort_direction'])
58+
->create();
59+
return [$sortOrder];
60+
}
61+
62+
/**
63+
* Get sort field
64+
*
65+
* @param string $field
66+
* @return string
67+
*/
68+
private function getField(string $field): string
69+
{
70+
$enums = $this->enumDataMapper->getMappedEnums(self::SORTABLE_FIELD_MAP);
71+
72+
return $enums[strtolower($field)];
73+
}
74+
}

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,14 @@
4242
</argument>
4343
</arguments>
4444
</type>
45+
<type name="Magento\Framework\GraphQl\Schema\Type\Enum\DefaultDataMapper">
46+
<arguments>
47+
<argument name="map" xsi:type="array">
48+
<item name="CustomerOrderSortableField" xsi:type="array">
49+
<item name="number" xsi:type="string">increment_id</item>
50+
<item name="created_at" xsi:type="string">created_at</item>
51+
</item>
52+
</argument>
53+
</arguments>
54+
</type>
4555
</config>

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ type Customer {
2525
filter: CustomerOrdersFilterInput @doc(description: "Defines the filter to use for searching customer orders."),
2626
currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."),
2727
pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. The default value is 20."),
28+
sort: CustomerOrderSortInput @doc(description: "Specifies which field to sort on, and whether to return the results in ascending or descending order.")
2829
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."),
2930
): CustomerOrders @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\CustomerOrders") @cache(cacheable: false)
3031
}
@@ -33,6 +34,16 @@ input CustomerOrdersFilterInput @doc(description: "Identifies the filter to use
3334
number: FilterStringTypeInput @doc(description: "Filters by order number.")
3435
}
3536

37+
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.") {
38+
sort_field: CustomerOrderSortableField! @doc(description: "Specifies the field to use for sorting")
39+
sort_direction: SortEnum! @doc(description: "This enumeration indicates whether to return results in ascending or descending order")
40+
}
41+
42+
enum CustomerOrderSortableField @doc(description: "Specifies the field to use for sorting") {
43+
NUMBER @doc(description: "Sorts customer orders by number")
44+
CREATED_AT @doc(description: "Sorts customer orders by created_at field")
45+
}
46+
3647
type CustomerOrders @doc(description: "The collection of orders that match the conditions defined in the filter.") {
3748
items: [CustomerOrder]! @doc(description: "An array of customer orders.")
3849
page_info: SearchResultPageInfo @doc(description: "Contains pagination metadata.")

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

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@
1616
use Magento\Sales\Model\ResourceModel\Order\Collection;
1717
use Magento\TestFramework\Helper\Bootstrap;
1818
use Magento\TestFramework\TestCase\GraphQlAbstract;
19+
use Magento\Catalog\Test\Fixture\Product as ProductFixture;
20+
use Magento\TestFramework\Fixture\DataFixture;
21+
use Magento\Checkout\Test\Fixture\SetDeliveryMethod;
22+
use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddress;
23+
use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddress;
24+
use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethod;
25+
use Magento\Checkout\Test\Fixture\PlaceOrder as PlaceOrder;
26+
use Magento\Customer\Test\Fixture\Customer;
27+
use Magento\Quote\Test\Fixture\AddProductToCart as AddProductToCartFixture;
28+
use Magento\Quote\Test\Fixture\CustomerCart;
1929

2030
/**
2131
* Class RetrieveOrdersTest
@@ -404,6 +414,121 @@ public function testGetMatchingOrdersForLowerQueryLength()
404414
$this->assertCount($response['customer']['orders']['total_count'], $response['customer']['orders']['items']);
405415
}
406416

417+
/**
418+
* @return void
419+
* @throws AuthenticationException
420+
*/
421+
#[
422+
DataFixture(Customer::class, ['email' => 'customer@example.com'], 'customer'),
423+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart2'),
424+
DataFixture(ProductFixture::class, ['sku' => '100000002', 'price' => 10], 'p2'),
425+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart2.id$', 'product_id' => '$p2.id$']),
426+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart2.id$']),
427+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart2.id$']),
428+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart2.id$']),
429+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart2.id$']),
430+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart2.id$']),
431+
432+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart3'),
433+
DataFixture(ProductFixture::class, ['sku' => '100000003', 'price' => 10], 'p3'),
434+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart3.id$', 'product_id' => '$p3.id$']),
435+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart3.id$']),
436+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart3.id$']),
437+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart3.id$']),
438+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart3.id$']),
439+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart3.id$']),
440+
441+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart4'),
442+
DataFixture(ProductFixture::class, ['sku' => '100000004', 'price' => 10], 'p4'),
443+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart4.id$', 'product_id' => '$p4.id$']),
444+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart4.id$']),
445+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart4.id$']),
446+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart4.id$']),
447+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart4.id$']),
448+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart4.id$']),
449+
450+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart5'),
451+
DataFixture(ProductFixture::class, ['sku' => '100000005', 'price' => 10], 'p5'),
452+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart5.id$', 'product_id' => '$p5.id$']),
453+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart5.id$']),
454+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart5.id$']),
455+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart5.id$']),
456+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart5.id$']),
457+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart5.id$']),
458+
459+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart6'),
460+
DataFixture(ProductFixture::class, ['sku' => '100000006', 'price' => 10], 'p6'),
461+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart6.id$', 'product_id' => '$p6.id$']),
462+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart6.id$']),
463+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart6.id$']),
464+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart6.id$']),
465+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart6.id$']),
466+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart6.id$']),
467+
468+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart7'),
469+
DataFixture(ProductFixture::class, ['sku' => '100000007', 'price' => 10], 'p7'),
470+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart7.id$', 'product_id' => '$p7.id$']),
471+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart7.id$']),
472+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart7.id$']),
473+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart7.id$']),
474+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart7.id$']),
475+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart7.id$']),
476+
477+
DataFixture(CustomerCart::class, ['customer_id' => '$customer.id$'], 'cart8'),
478+
DataFixture(ProductFixture::class, ['sku' => '100000008', 'price' => 10], 'p8'),
479+
DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart8.id$', 'product_id' => '$p8.id$']),
480+
DataFixture(SetBillingAddress::class, ['cart_id' => '$cart8.id$']),
481+
DataFixture(SetShippingAddress::class, ['cart_id' => '$cart8.id$']),
482+
DataFixture(SetDeliveryMethod::class, ['cart_id' => '$cart8.id$']),
483+
DataFixture(SetPaymentMethod::class, ['cart_id' => '$cart8.id$']),
484+
DataFixture(PlaceOrder::class, ['cart_id' => '$cart8.id$']),
485+
486+
]
487+
public function testGetCustomerDescendingSortedOrders()
488+
{
489+
$query = <<<QUERY
490+
{
491+
customer {
492+
orders(
493+
sort: {
494+
sort_field: CREATED_AT,
495+
sort_direction: DESC
496+
}
497+
) {
498+
items {
499+
id
500+
number
501+
status
502+
order_date
503+
}
504+
}
505+
}
506+
}
507+
QUERY;
508+
509+
$currentEmail = 'customer@example.com';
510+
$currentPassword = 'password';
511+
$response = $this->graphQlQuery(
512+
$query,
513+
[],
514+
'',
515+
$this->customerAuthenticationHeader->execute($currentEmail, $currentPassword)
516+
);
517+
$this->assertArrayHasKey('orders', $response['customer']);
518+
$this->assertArrayHasKey('items', $response['customer']['orders']);
519+
$customerOrderItemsInResponse = $response['customer']['orders']['items'];
520+
$expectedOrderNumbers = ['100000008', '100000007','100000006', '100000005', '100000004','100000002'];
521+
522+
foreach ($expectedOrderNumbers as $key => $data) {
523+
$orderItemInResponse = $customerOrderItemsInResponse[$key];
524+
$this->assertEquals(
525+
$orderItemInResponse['number'],
526+
$data,
527+
"The order number is different than the expected for order - {$orderItemInResponse['number']}"
528+
);
529+
}
530+
}
531+
407532
/**
408533
* @magentoApiDataFixture Magento/Customer/_files/customer.php
409534
* @magentoApiDataFixture Magento/GraphQl/Sales/_files/orders_with_customer.php

0 commit comments

Comments
 (0)