28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument #28757

pmarjan · 2020-06-17T12:24:37Z

Description (*)

Consider catalog permissions when searchng for products - approach by passing context as parameter

Related Pull Requests

https://github.com/magento/partners-magento2ee/pull/271
https://github.com/magento/partners-magento2-infrastructure/pull/5

Fixed Issues (if relevant)

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)

…n catalog permissions

m2-assistant · 2020-06-17T12:24:40Z

Hi @pmarjan. 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.

pmarjan · 2020-06-17T12:27:02Z

@magento run all tests

cpartica · 2020-06-18T03:58:41Z

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

     * @return SearchResultsInterface
     */
    public function getList(
        SearchCriteriaInterface $searchCriteria,
        SearchResultInterface $searchResult,
-        array $attributes = []
+        array $attributes = [],
+        ContextInterface $context


We have to make this optional, or put it before attributes, because attributes is optional.
\Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\Product\CollectionProcessorInterface::process has attributes mandatory and we also have to make it optional

...phQl/Model/Resolver/Products/DataProvider/Product/CollectionProcessor/AttributeProcessor.php

cpartica · 2020-06-18T04:04:33Z

...del/Resolver/Products/DataProvider/Product/CollectionProcessor/ExtensibleEntityProcessor.php

     */
    public function process(
        Collection $collection,
        SearchCriteriaInterface $searchCriteria,
-        array $attributeNames
+        array $attributeNames,
+        ContextInterface $context


I think it's best to do here attributes and context optional, because not all implementations use it
also code becomes very complicated to pass all this around then not use it
Plus adding suppress unused params later..it all points optional is better

…n/2.4-develop

pmarjan · 2020-06-18T11:12:29Z

@cpartica context parameter is now optional, as per your request. the PR is updated, please let me know if further adjustments are needed.

pmarjan · 2020-06-18T11:12:42Z

@magento run all tests

pmarjan · 2020-06-18T14:56:53Z

@magento run all tests

cpartica · 2020-06-18T16:42:15Z

app/code/Magento/CatalogGraphQl/composer.json

@@ -11,7 +11,8 @@
        "magento/module-store": "*",
        "magento/module-eav-graph-ql": "*",
        "magento/module-catalog-search": "*",
-        "magento/framework": "*"
+        "magento/framework": "*",
+        "magento/module-graph-ql": "*"
    },
    "suggest": {
        "magento/module-graph-ql": "*",


we can remove graphql from suggest

cpartica · 2020-06-18T16:49:37Z

app/code/Magento/CustomerGraphQl/Model/Context/AddUserInfoToContext.php

+
+        if ($this->isCustomer($currentUserId, $currentUserType)) {
+            try {
+                $customerGroupId = $this->customerRepository->getById($currentUserId)->getGroupId();


is this request cached when the previous Context sets the user id?
it is weird how we do do this check for group but not for the currentUserId

I would say no (although not entirely sure). As far as I can tell, if FPC does not return a result (Magento\PageCache\Model\App\FrontController\BuiltinPlugin::aroundDispatch, line 73) processing of the authorization token will always flow in the same way. Otherwise, it would not run at all.

Therefore, line 62 here if ($this->isCustomer...) is probably trying to avoid unnecessary calls to customerRepository->getById(). Reasoning is there may be many requests that are not bearing any tokens, or are bearing invalid ones, and for them we do not want to allocate resources to load entity that we know for sure will not be loaded.

I still think this is problematic, and it will probably trigger a significant degradation in query time
it should be called somewhere else when used like getExtensionAttribute->getCustomerGroupId

@cpartica the check for the customer group is now removed.

pmarjan · 2020-07-11T09:08:13Z

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

     * @param FieldSelection $fieldSelection
     * @param SearchCriteriaBuilder $searchCriteriaBuilder
     * @param ScopeConfigInterface $scopeConfig
     */
    public function __construct(
        SearchResultFactory $searchResultFactory,
        ProductProvider $productDataProvider,
-        LayerResolver $layerResolver,


@cpartica, @danielrenaud
when scanning with PHPMD for design issues, I got
The class Filter has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.

To solve for that, LayerResolver is removed, since anyway is not used anymore in this class.

But, is this a backward incompatible change? If so, please advice, what might be a good way to proceed?

As a background, the MD test fails after adding the use of the ContextInterface, so the $context to the getResult() can be properly passed with specifying its type

@param ContextInterface $context

If the dependency is not used at all, it should be ok to remove it. In GraphQl area, we only treat schema as our public api, so we can make changes like this to code that is not marked @api

It's not so bad to remove it actually
Do this change and we'll get it approved. Since this implements an interface, the class was not meant to be extended anyway.

cpartica · 2020-07-13T14:48:44Z

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

     * @param FieldSelection $fieldSelection
     * @param SearchCriteriaBuilder $searchCriteriaBuilder
     * @param ScopeConfigInterface $scopeConfig
     */
    public function __construct(
        SearchResultFactory $searchResultFactory,
        ProductProvider $productDataProvider,
-        LayerResolver $layerResolver,


It's not so bad to remove it actually
Do this change and we'll get it approved. Since this implements an interface, the class was not meant to be extended anyway.

… Permissions configuration - Pass the context as argument #28757

m2-assistant · 2020-07-15T16:45:12Z

Hi @pmarjan, 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.

pmarjan added 2 commits June 17, 2020 14:12

Make Customer Group Id available to Context

308ef0e

magento#28563: Pass the context to get product search results based o…

332369d

…n catalog permissions

ghost added the Progress: pending review label Jun 17, 2020

magento-engcom-team added Component: CatalogGraphQl Component: CustomerGraphQl Component: RelatedProductGraphQl Release Line: 2.4 Partner: Comwrap partners-contribution Pull Request is created by Magento Partner labels Jun 17, 2020

pmarjan linked an issue Jun 17, 2020 that may be closed by this pull request

GraphQL product search does not consider Category Permissions configuration #28563

Closed

pmarjan changed the title ~~Graphql 28563~~ 28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument Jun 17, 2020

danielrenaud added the Project: GraphQL label Jun 17, 2020

danielrenaud added this to the 2.4.1 milestone Jun 17, 2020

danielrenaud assigned pmarjan Jun 17, 2020

danielrenaud requested a review from cpartica June 17, 2020 13:57

cpartica requested changes Jun 18, 2020

View reviewed changes

ghost assigned cpartica Jun 18, 2020

ghost added Progress: needs update and removed Progress: pending review labels Jun 18, 2020

pmarjan added 2 commits June 18, 2020 13:06

Merge remote-tracking branch 'open/2.4-develop' into local/forked-ope…

966aeba

…n/2.4-develop

magento#28563: Make the pass of the context optional argument

191b758

magento#28563: Edits addressing static tests

a5e978e

cpartica requested changes Jun 18, 2020

View reviewed changes

ghost added Progress: accept and removed Progress: testing in progress labels Jul 9, 2020

pmarjan requested a review from cpartica July 13, 2020 13:47

pmarjan commented Jul 13, 2020

View reviewed changes

ghost assigned danielrenaud Jul 13, 2020

cpartica requested changes Jul 13, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: accept labels Jul 13, 2020

cpartica approved these changes Jul 13, 2020

View reviewed changes

ghost added Progress: waiting related PRs and removed Progress: needs update labels Jul 13, 2020

pmarjan requested review from danielrenaud and cpartica July 13, 2020 14:50

cpartica approved these changes Jul 14, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: waiting related PRs labels Jul 14, 2020

ghost removed the Progress: ready for testing label Jul 14, 2020

ghost added Progress: testing in progress Progress: accept and removed Progress: testing in progress labels Jul 14, 2020

magento-engcom-team mentioned this pull request Jul 15, 2020

GraphQL product search does not consider Category Permissions configuration #28563

Closed

magento-engcom-team pushed a commit that referenced this pull request Jul 15, 2020

ENGCOM-7732: 28563: GraphQL product search does not consider Category…

3e6222e

… Permissions configuration - Pass the context as argument #28757

magento-engcom-team merged commit fa101ac into magento:2.4-develop Jul 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument #28757

28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument #28757

pmarjan commented Jun 17, 2020 •

edited by cpartica

Loading

m2-assistant bot commented Jun 17, 2020

pmarjan commented Jun 17, 2020

cpartica Jun 18, 2020

cpartica Jun 18, 2020

pmarjan commented Jun 18, 2020

pmarjan commented Jun 18, 2020

pmarjan commented Jun 18, 2020

cpartica Jun 18, 2020

cpartica Jun 18, 2020

pmarjan Jun 21, 2020

cpartica Jun 22, 2020 •

edited

Loading

pmarjan Jun 23, 2020

pmarjan Jul 11, 2020

danielrenaud Jul 13, 2020 •

edited

Loading

cpartica Jul 13, 2020

cpartica Jul 13, 2020

m2-assistant bot commented Jul 15, 2020

28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument #28757

28563: GraphQL product search does not consider Category Permissions configuration - Pass the context as argument #28757

Conversation

pmarjan commented Jun 17, 2020 • edited by cpartica Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Jun 17, 2020

pmarjan commented Jun 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmarjan commented Jun 18, 2020

pmarjan commented Jun 18, 2020

pmarjan commented Jun 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cpartica Jun 22, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielrenaud Jul 13, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m2-assistant bot commented Jul 15, 2020

pmarjan commented Jun 17, 2020 •

edited by cpartica

Loading

cpartica Jun 22, 2020 •

edited

Loading

danielrenaud Jul 13, 2020 •

edited

Loading