[GraphQl] 29168 TierPrices filtering #29675

Usik2203 · 2020-08-19T11:55:10Z

Description (*)

This PR fixes issue with TierPrices filtering

Result Before
We see all prices for each quantity

Result After
We see lower price for each quantity

Related Pull Requests

Fixed Issues (if relevant)

Fixes Tier prices filtering in GraphQl - prices for different customer group but same quantity are not filtered out #29168>

Manual testing scenarios (*)

...
...

Questions or comments

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 are green)

m2-assistant · 2020-08-19T11:55:13Z

Hi @Usik2203. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

Usik2203 · 2020-08-19T11:57:57Z

@magento run all tests

rogyar

Hi @Usik2203. Please, check my recommendations below.
Also, do you have covering this case by API-functional test in your plans?

rogyar · 2020-08-19T12:59:27Z

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

+     *
+     * @return bool
+     */
+    private function isFirstPriceBetter(float $firstPrice, float $secondPrice): bool


I would not suggest creating a separate method for such a simple comparison. It makes code harder to read and introduces semantical complexity. In the future, if we will need more complex comparison we can always create a separate method. But on this stage, I would keep things simple

rogyar · 2020-08-19T13:01:07Z

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

+    private function filterTierPrices(array $tierPrices): array
+    {
+        $qtyCache = [];
+        foreach ($tierPrices as $item => &$price) {


We are passing the &$price variable by reference but it does not seem like we modify it somehow in the loop below. But I may miss something.

@Usik2203
Both methods, filterTierPrices and formatProductTierPrices, which are called one after another, are using foreach to loop through the tier prices.

Given that this code executes when a query searches for products, please consider a situation where we might have large b2b catalog with plenty tiers for different customer groups and a relatively short search phrase, yielding plenty of results.
Having to loop twice through all tier prices in all search results, might lead to performance degradation.

I am wondering, could these two methods be somehow combined, so that we get the same results using foreach only once?

@pmarjan Done

@Usik2203
From "clarity of intent" perspective, when one reads through the "resolve" function alone, it seems as though formatProductTierPrices function does only what its name says. In fact this function's comment seems to support that.
But, that is misleading.

So, I am wondering can we have a function named like filterAndFormatProductTierPrices, that invokes a foreach loop, and inside this loop, one below the other filterTierPrices and formatProductTierPrices are called?

Check for example, when an unfortunate situation like we have, calls for two different things to be done in the same method:
League\Flysystem\Filesystem::readAndDelete()
internally first calls
$this->read()
and later
$this->delete()

@pmarjan Done

Usik2203 · 2020-08-19T13:55:20Z

@magento run all tests

Usik2203 · 2020-08-19T16:26:19Z

Hi @rogyar
I have applied your code review recommendations and added API test.
Thanks

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

dev/tests/api-functional/testsuite/Magento/GraphQl/CatalogCustomer/PriceTiersTest.php

Usik2203 · 2020-08-21T15:01:15Z

@magento run all tests

Usik2203 · 2020-08-21T19:18:28Z

@magento run all tests

Usik2203 · 2020-08-21T19:58:13Z

@magento run all tests

magento-engcom-team · 2020-08-29T13:41:46Z

Hi @rogyar, thank you for the review.
ENGCOM-8099 has been created to process this Pull Request

cpartica · 2020-11-11T01:59:46Z

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

@@ -120,42 +120,89 @@ function () use ($productId, $context) {



can you fix types on $this->tiers->addProductFilter($productId) ? \Magento\CatalogCustomerGraphQl\Model\Resolver\Product\Price\Tiers::addProductFilter has no strict types
public function addProductFilter($productId): void
would be
public function addProductFilter(int $productId): void

cpartica · 2020-11-11T02:17:56Z

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

+     * @param ProductTierPriceInterface $tierPrice
+     * @param array $tiers
+     */
+    private function formatTierPrices(float $productPrice, StoreInterface $store, &$tierPrice, &$tiers)


we kind of prohibit passing params by reference &$tierPrice, &$tiers
You better want a function that returns something. You rarely want a function that returns 2 things.
formatTierPrices can return $tiers for example.
Objects are passed by reference by default so you don't need &$tierPrice to do $tierPrice->setValue
You can also do that outside formatTierPrices and don't set anything in tierPrice, just get
Plus you only need getValue and getQty and getPercentageValue from it. You can use those params directly not by passing the whole tierPrice.
From store you only need CurrencyCode not store.
Suddenly your method becomes: formatTierPricesValues(productPrice, tierPriceValue, TierPricePercentage, tierPriceQty): array (where array is $tiers)

cpartica · 2020-11-11T02:24:33Z

app/code/Magento/CatalogCustomerGraphQl/Model/Resolver/PriceTiers.php

+        array $tierPrices,
+        int $key,
+        ProductTierPriceInterface $tierPriceItem,
+        array &$qtyCache,


$qtyCache doesn't need to be passed by reference
it can be part of your object \Magento\CatalogCustomerGraphQl\Model\Resolver\PriceTiers
by declaring a private $productTiersByQuanity[] //you can dcument that this acts like a cache
it can hold prices like $productTiersByQuanity[customerGroup][productId][qty] so it can be used for multiple products and if called multiple times for the same product, you can just fetch it and not even need to recalculate it.
not sure if customerGroup is required. probably not. you'l only get the relevant tiers for current customerGroup
of course filterTierPrices : array which is the filtered tiers, and you can pass formatted tiers from previous function return

Usik2203 · 2020-11-11T11:10:28Z

@magento run all tests

o-iegorov · 2020-11-11T20:28:12Z

@magento run Functional Tests CE, Integration Tests

o-iegorov · 2020-11-11T23:23:47Z

@magento run Functional Tests EE

o-iegorov · 2020-11-12T14:55:49Z

@magento run Functional Tests EE

m2-assistant · 2020-11-13T21:38:40Z

Hi @Usik2203, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

add filter for tier price value

017c44e

ghost added the Progress: pending review label Aug 19, 2020

magento-engcom-team added Component: CatalogCustomerGraphQl Release Line: 2.4 Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner labels Aug 19, 2020

rogyar self-assigned this Aug 19, 2020

rogyar requested changes Aug 19, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending review labels Aug 19, 2020

Usik2203 added 2 commits August 19, 2020 16:54

add test coverage and some changes

603bc9f

Merge branch '2.4-develop' into 29168-graphql-tier-price

257ba74

sidolov added the Project: GraphQL label Aug 19, 2020

pmarjan self-requested a review August 21, 2020 11:34

pmarjan suggested changes Aug 21, 2020

View reviewed changes

add some changes to test

4f978a4

remove redundant foreach

2cfd8a0

minor fix

2d9740d

rogyar added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Aug 29, 2020

rogyar approved these changes Aug 29, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Aug 29, 2020

ghost added the Progress: ready for testing label Sep 23, 2020

nrkapoor requested review from cpartica, rogyar, cspruiell and prabhuram93 October 29, 2020 08:45

nrkapoor added this to the 2.4.2 milestone Oct 29, 2020

nrkapoor requested review from pmarjan, mauragcyrus and dthampy and removed request for pmarjan October 29, 2020 08:45

cpartica requested changes Nov 11, 2020

View reviewed changes

m2-community-project bot assigned cpartica Nov 11, 2020

m2-community-project bot added Progress: needs update and removed Progress: ready for testing labels Nov 11, 2020

Usik2203 added 2 commits November 11, 2020 11:22

Merge branch '2.4-develop' into 29168-graphql-tier-price

b2021d5

CR recommendations

30901be

m2-community-project bot added Progress: review and removed Progress: needs update labels Nov 11, 2020

minor changes

6b4383b

Revert changes

58eaf18

Merge branch '2.4-develop' into 29168-graphql-tier-price

9f9164f

cpartica approved these changes Nov 12, 2020

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: review labels Nov 12, 2020

magento-engcom-team merged commit 884e87e into magento:2.4-develop Nov 13, 2020

		@@ -120,42 +120,89 @@ function () use ($productId, $context) {

[GraphQl] 29168 TierPrices filtering #29675

[GraphQl] 29168 TierPrices filtering #29675

Uh oh!

Conversation

Usik2203 commented Aug 19, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Aug 19, 2020

Uh oh!

Usik2203 commented Aug 19, 2020

Uh oh!

rogyar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Usik2203 commented Aug 19, 2020

Uh oh!

Usik2203 commented Aug 19, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Usik2203 commented Aug 21, 2020

Uh oh!

Usik2203 commented Aug 21, 2020

Uh oh!

Usik2203 commented Aug 21, 2020

Uh oh!

magento-engcom-team commented Aug 29, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Usik2203 commented Nov 11, 2020

Uh oh!

o-iegorov commented Nov 11, 2020

Uh oh!

o-iegorov commented Nov 11, 2020

Uh oh!

o-iegorov commented Nov 12, 2020

Uh oh!

m2-assistant bot commented Nov 13, 2020

Uh oh!

Uh oh!