GraphQL - Added sort by options to Products GraphQL type #12

zbigniewkuras · 2018-05-12T13:12:44Z

Description

Added available sort options and default sort option for product listing to page_info object of Products GraphQL object.

Fixed Issues (if relevant)

Return 'Available sort options' for product listing #3: Return 'Available sort options' for product listing

Manual testing scenarios

Add following object to query object page_info and run:
sort_fields { default options { key label } }
Magento should returns object sort_fields contains default and options

Contribution checklist

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds on Travis CI are green)

ishakhsuvarov · 2018-05-12T13:13:49Z

app/code/Magento/CatalogGraphQl/Model/Resolver/Products.php

-        \Magento\CatalogGraphQl\Model\Resolver\Layer\DataProvider\Filters $filtersDataProvider
+        \Magento\CatalogGraphQl\Model\Resolver\Layer\DataProvider\Filters $filtersDataProvider,
+        \Magento\Catalog\Model\Config $catalogConfig,
+        \Magento\Store\Model\StoreManagerInterface $storeManager


Please add constructor doc block type hint for StoreManagerInterface

…terface

magento-engcom-team · 2018-05-13T08:17:38Z

Closed and Re Opened PR to trigger Travis CI builds.

paliarush · 2018-05-14T15:13:51Z

app/code/Magento/CatalogGraphQl/Model/Resolver/Products.php

@@ -118,14 +134,28 @@ public function resolve(
            );
        }

+        $options = $this->catalogConfig->getAttributeUsedForSortByArray();


Please create a separate resolver for sort_fields. There are 2 main reasons for that:

Performance. In case sort_fields is not requested, all this logic will not be executed in case of separate resolver

Following single responsibility and object decomposition simplifies maintenance and understanding

Roger, i will fix it, thanks for your feedback

magento-cicd2 · 2018-05-15T19:30:39Z

All committers have signed the CLA.

magento-engcom-team · 2018-05-15T19:31:16Z

Hi @zbigniewkuras
Please sign Contributor License Agreement for this Pull Request so that we could accept this Pull Request. Thank you.

paliarush

@zbigniewkuras thank you for making additional changes, please see new comments. As soon as those are addressed, we can merge the PR.

paliarush · 2018-05-17T15:36:38Z

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

@@ -25,9 +25,20 @@ input FilterTypeInput @doc(description: "FilterTypeInput specifies which action
 type SearchResultPageInfo @doc(description: "SearchResultPageInfo provides navigation for the query response") {
    page_size: Int @doc(description: "Specifies the maximum number of items to return")
    current_page: Int @doc(description: "Specifies which page of results to return")
+    sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields")


There should be a single new resolver, just for sort_fields.

paliarush · 2018-05-17T15:43:34Z

app/code/Magento/CatalogGraphQl/Model/Resolver/Category/SortFieldsOptions.php

+     */
+    public function resolve(Field $field, $context, ResolveInfo $info, array $value = null, array $args = null) : Value
+    {
+        $sortFieldsOptions = [


Please use \Magento\Catalog\Model\Category\Attribute\Source\Sortby::getAllOptions. It has two benefits:

includes position, so no need to hardcode it here again

result is already properly formatted, no need to do foreach (assuming that key is renamed to value as suggested in another comment)

The reason i didn't use this function was the translation function called for labels in \Magento\Catalog\Model\Category\Attribute\Source\Sortby::getAllOptions casuses Internal server error and every value for label is equal null. I'm not sure exactly, but it looks like a bug.

How about this one \Magento\Catalog\Model\Config::getAttributeUsedForSortByArray?

It's the same, this function also contains translation function for Position option
$options = ['position' => __('Position')];

The problem is that underlying GraphQL library (webonyx) expects exact match between declared type (string) and the actual value type (Magento\Framework\Phrase), and it does not try to perform type casting.

I was able to make it work by manually casting Phrase to string before returning the result:

$sortFieldsOptions = $this->sortBy->getAllOptions(); array_walk( $sortFieldsOptions, function (&$option) { $option['label'] = (string)$option['label']; } );

paliarush · 2018-05-17T15:45:25Z

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductSearchTest.php

+            default
+            options 
+            {
+                key


Please rename key to value for consistency with naming in other places in Magento, for example \Magento\Catalog\Model\Category\Attribute\Source\Sortby::getAllOptions

paliarush · 2018-05-17T15:51:04Z

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductSearchTest.php

@@ -530,6 +539,10 @@ public function testQueryProductsInCurrentPageSortedByPriceASC()
        $this->assertProductItems($filteredChildProducts, $response);
        $this->assertEquals(4, $response['products']['page_info']['page_size']);
        $this->assertEquals(1, $response['products']['page_info']['current_page']);
+        $this->assertArrayHasKey('sort_fields', $response['products']['page_info']);
+        $this->assertArrayHasKey('options', $response['products']['page_info']['sort_fields']);


Please add assertion for options values, it is not validated at the moment.

paliarush · 2018-05-18T18:19:40Z

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

@@ -25,9 +25,20 @@ input FilterTypeInput @doc(description: "FilterTypeInput specifies which action
 type SearchResultPageInfo @doc(description: "SearchResultPageInfo provides navigation for the query response") {
    page_size: Int @doc(description: "Specifies the maximum number of items to return")
    current_page: Int @doc(description: "Specifies which page of results to return")
+    sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields")


sort_fields should be moved to Products type, as mentioned in the issue description, because SearchResultPageInfo is meant for storing paginating information.

paliarush · 2018-05-18T18:22:36Z

app/code/Magento/CatalogGraphQl/Model/Resolver/Category/SortFields.php

+        ValueFactory $valueFactory,
+        \Magento\Catalog\Model\Config $catalogConfig,
+        \Magento\Store\Model\StoreManagerInterface $storeManager,
+        \Magento\Catalog\Model\Category\Attribute\Source\Sortby $ss


Looks like an accidental change.

Yes, you are right. I was testing function \Magento\Catalog\Model\Category\Attribute\Source\Sortby::getAllOptions(). I will fix it

misha-kotov · 2018-05-21T15:27:17Z

Approved ✅

…12

paliarush · 2018-05-22T14:21:40Z

@zbigniewkuras, the PR has been merged to mainline/2.3-develop, thanks you for contribution!

keharper · 2018-05-23T17:01:12Z

Added SortFields information in the Products endpoint documentation.

[Forwardport] Corrected function comment

2.3 develop

2.3 develop update

GraphQL - Added sort by options to Products GraphQL type

dd3aa38

zbigniewkuras requested a review from ishakhsuvarov May 12, 2018 13:12

ishakhsuvarov suggested changes May 12, 2018

View reviewed changes

ishakhsuvarov added the fra-rz-cd Label for distributed contribution day between Germany and Poland label May 12, 2018

GraphQL - Added missing constructor doc block type for StoreManagerIn…

02d6a22

…terface

ishakhsuvarov approved these changes May 12, 2018

View reviewed changes

ishakhsuvarov requested a review from paliarush May 12, 2018 14:14

magento-engcom-team closed this May 13, 2018

magento-engcom-team reopened this May 13, 2018

paliarush reviewed May 14, 2018

View reviewed changes

paliarush added in-progress and removed in-progress labels May 14, 2018

magento-engcom-team closed this May 15, 2018

magento-engcom-team reopened this May 15, 2018

zbigniewkuras added 2 commits May 16, 2018 20:06

GraphQL - Created separate resolver for sort_fields

9035d29

GraphQL - Removed unnecessary empty lines.

d804bab

paliarush suggested changes May 17, 2018

View reviewed changes

GraphQL - Created one resolver for sort_fields. Added tests.

9962c66

paliarush reviewed May 18, 2018

View reviewed changes

GraphQL - moved sort_fields to Products object. Some fixes

1855062

magento-engcom-team assigned paliarush May 21, 2018

magento-engcom-team added this to the May 2018 milestone May 21, 2018

magento-engcom-team added the 2.3-develop label May 21, 2018

paliarush added the approved label May 21, 2018

paliarush approved these changes May 21, 2018

View reviewed changes

magento-engcom-team merged commit 1855062 into magento:2.3-develop May 22, 2018

magento-engcom-team pushed a commit that referenced this pull request May 22, 2018

ENGCOM-1635: GraphQL - Added sort by options to Products GraphQL type #…

e1e3fc8

…12

magento-engcom-team pushed a commit that referenced this pull request May 22, 2018

ENGCOM-1635: GraphQL - Added sort by options to Products GraphQL type #…

2a504ce

…12

paliarush mentioned this pull request May 22, 2018

Return 'Available sort options' for product listing #3

Closed

paliarush added the requires-documentation label May 22, 2018

keharper added documentation-completed and removed requires-documentation 2.3-develop labels May 23, 2018

magento-engcom-team added the Award: test coverage label Jun 28, 2018

magento-engcom-team pushed a commit that referenced this pull request Aug 9, 2018

Merge pull request #12 from sanganinamrata/2.3-develop-PR-port-16549

2456027

[Forwardport] Corrected function comment

magento-engcom-team pushed a commit that referenced this pull request Sep 11, 2018

Merge pull request #12 from magento/2.3-develop

92c1aa4

2.3 develop

magento-engcom-team pushed a commit that referenced this pull request Jul 5, 2019

Merge pull request #12 from magento/2.3-develop

c83bf54

2.3 develop update

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GraphQL - Added sort by options to Products GraphQL type #12

GraphQL - Added sort by options to Products GraphQL type #12

zbigniewkuras commented May 12, 2018

ishakhsuvarov May 12, 2018

zbigniewkuras May 12, 2018

magento-engcom-team commented May 13, 2018 •

edited

Loading

paliarush May 14, 2018

zbigniewkuras May 15, 2018

magento-cicd2 commented May 15, 2018 •

edited

Loading

magento-engcom-team commented May 15, 2018 •

edited

Loading

paliarush left a comment

paliarush May 17, 2018

paliarush May 17, 2018

zbigniewkuras May 17, 2018

paliarush May 17, 2018

zbigniewkuras May 17, 2018

paliarush May 18, 2018

paliarush May 17, 2018

paliarush May 17, 2018

paliarush May 18, 2018

zbigniewkuras May 18, 2018

paliarush May 18, 2018

zbigniewkuras May 18, 2018

misha-kotov commented May 21, 2018

paliarush commented May 22, 2018

keharper commented May 23, 2018

GraphQL - Added sort by options to Products GraphQL type #12

GraphQL - Added sort by options to Products GraphQL type #12

Conversation

zbigniewkuras commented May 12, 2018

Description

Fixed Issues (if relevant)

Manual testing scenarios

Contribution checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magento-engcom-team commented May 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magento-cicd2 commented May 15, 2018 • edited Loading

magento-engcom-team commented May 15, 2018 • edited Loading

paliarush left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

misha-kotov commented May 21, 2018

paliarush commented May 22, 2018

keharper commented May 23, 2018

magento-engcom-team commented May 13, 2018 •

edited

Loading

magento-cicd2 commented May 15, 2018 •

edited

Loading

magento-engcom-team commented May 15, 2018 •

edited

Loading