ACP2E-882: [Magento Cloud] Category permission not working with GraphQL

- fix

Author: o-dubovyk

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

@@ -10,12 +10,15 @@
 use Magento\CatalogGraphQl\Model\Category\CategoryFilter;
 use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\CategoryTree;
 use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\ExtractDataFromCategoryTree;
+use Magento\Framework\Api\Search\SearchCriteriaFactory;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Query\Resolver\ArgumentsProcessorInterface;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\Store\Api\Data\StoreInterface;
 
 /**
  * Categories resolver, used for GraphQL category data request processing.
@@ -42,22 +45,30 @@ class CategoriesQuery implements ResolverInterface
      */
     private $argsSelection;
 
+    /**
+     * @var SearchCriteriaFactory
+     */
+    private $searchCriteriaFactory;
+
     /**
      * @param CategoryTree $categoryTree
      * @param ExtractDataFromCategoryTree $extractDataFromCategoryTree
      * @param CategoryFilter $categoryFilter
      * @param ArgumentsProcessorInterface $argsSelection
+     * @param SearchCriteriaFactory $searchCriteriaFactory
      */
     public function __construct(
         CategoryTree $categoryTree,
         ExtractDataFromCategoryTree $extractDataFromCategoryTree,
         CategoryFilter $categoryFilter,
-        ArgumentsProcessorInterface $argsSelection
+        ArgumentsProcessorInterface $argsSelection,
+        SearchCriteriaFactory $searchCriteriaFactory
     ) {
         $this->categoryTree = $categoryTree;
         $this->extractDataFromCategoryTree = $extractDataFromCategoryTree;
         $this->categoryFilter = $categoryFilter;
         $this->argsSelection = $argsSelection;
+        $this->searchCriteriaFactory = $searchCriteriaFactory;
     }
 
     /**
@@ -87,7 +98,7 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
 
         $rootCategoryIds = $filterResult['category_ids'] ?? [];
 
-        $filterResult['items'] = $this->fetchCategories($rootCategoryIds, $info, (int) $store->getId());
+        $filterResult['items'] = $this->fetchCategories($rootCategoryIds, $info, $store, $context);
         return $filterResult;
     }
 
@@ -96,17 +107,28 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
      *
      * @param array $categoryIds
      * @param ResolveInfo $info
-     * @param int $storeId
+     * @param StoreInterface $store
+     * @param ContextInterface $context
      * @return array
      */
-    private function fetchCategories(array $categoryIds, ResolveInfo $info, int $storeId)
-    {
+    private function fetchCategories(
+        array $categoryIds,
+        ResolveInfo $info,
+        StoreInterface $store,
+        ContextInterface $context
+    ) {
         $fetchedCategories = [];
         foreach ($categoryIds as $categoryId) {
-            $categoryTree = $this->categoryTree->getTree($info, $categoryId, $storeId);
-            if (empty($categoryTree)) {
-                continue;
-            }
+            /* Search Criteria is created for compatibility */
+            $searchCriteria = $this->searchCriteriaFactory->create();
+            $categoryTree = $this->categoryTree->getFilteredTree(
+                $info,
+                $categoryId,
+                $searchCriteria,
+                $store,
+                [],
+                $context
+            );
             $fetchedCategories[] = current($this->extractDataFromCategoryTree->execute($categoryTree));
         }
 

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

@@ -7,6 +7,7 @@
 
 namespace Magento\CatalogGraphQl\Model\Resolver;
 
+use Magento\CatalogGraphQl\Model\Category\Filter\SearchCriteria;
 use Magento\Store\Api\Data\StoreInterface;
 use Magento\GraphQl\Model\Query\ContextInterface;
 use Magento\CatalogGraphQl\Model\Category\CategoryFilter;
@@ -45,22 +46,30 @@ class CategoryList implements ResolverInterface
      */
     private $argsSelection;
 
+    /**
+     * @var SearchCriteria
+     */
+    private $searchCriteria;
+
     /**
      * @param CategoryTree $categoryTree
      * @param ExtractDataFromCategoryTree $extractDataFromCategoryTree
      * @param CategoryFilter $categoryFilter
      * @param ArgumentsProcessorInterface $argsSelection
+     * @param SearchCriteria $searchCriteria
      */
     public function __construct(
         CategoryTree $categoryTree,
         ExtractDataFromCategoryTree $extractDataFromCategoryTree,
         CategoryFilter $categoryFilter,
-        ArgumentsProcessorInterface $argsSelection
+        ArgumentsProcessorInterface $argsSelection,
+        SearchCriteria $searchCriteria
     ) {
         $this->categoryTree = $categoryTree;
         $this->extractDataFromCategoryTree = $extractDataFromCategoryTree;
         $this->categoryFilter = $categoryFilter;
         $this->argsSelection = $argsSelection;
+        $this->searchCriteria = $searchCriteria;
     }
 
     /**
@@ -105,21 +114,19 @@ private function fetchCategories(
         array $criteria,
         StoreInterface $store,
         array $attributeNames,
-        $context
+        ContextInterface $context
     ) : array {
         $fetchedCategories = [];
         foreach ($categoryIds as $categoryId) {
+            $searchCriteria = $this->searchCriteria->buildCriteria($criteria, $store);
             $categoryTree = $this->categoryTree->getFilteredTree(
                 $info,
                 $categoryId,
-                $criteria,
+                $searchCriteria,
                 $store,
                 $attributeNames,
                 $context
             );
-            if (empty($categoryTree)) {
-                continue;
-            }
             $fetchedCategories[] = current($this->extractDataFromCategoryTree->execute($categoryTree));
         }
 

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

@@ -9,7 +9,6 @@
 
 use GraphQL\Language\AST\FieldNode;
 use GraphQL\Language\AST\NodeKind;
-
 use Magento\Store\Api\Data\StoreInterface;
 use Magento\Catalog\Api\Data\CategoryInterface;
 use Magento\Catalog\Model\Category;
@@ -20,7 +19,7 @@
 use Magento\CatalogGraphQl\Model\Category\DepthCalculator;
 use Magento\CatalogGraphQl\Model\Category\LevelCalculator;
 use Magento\CatalogGraphQl\Model\Resolver\Categories\DataProvider\Category\CollectionProcessorInterface;
-use Magento\CatalogGraphQl\Model\Category\Filter\SearchCriteria;
+use Magento\Framework\Api\Search\SearchCriteria;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Framework\Exception\LocalizedException;
@@ -29,13 +28,15 @@
 
 /**
  * Category tree data provider
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class CategoryTree
 {
     /**
      * In depth we need to calculate only children nodes, so the first wrapped node should be ignored
      */
-    const DEPTH_OFFSET = 1;
+    public const DEPTH_OFFSET = 1;
 
     /**
      * @var CollectionFactory
@@ -67,19 +68,13 @@ class CategoryTree
      */
     private $collectionProcessor;
 
-    /**
-     * @var SearchCriteria
-     */
-    private $searchCriteria;
-
     /**
      * @param CollectionFactory $collectionFactory
      * @param AttributesJoiner $attributesJoiner
      * @param DepthCalculator $depthCalculator
      * @param LevelCalculator $levelCalculator
      * @param MetadataPool $metadata
      * @param CollectionProcessorInterface $collectionProcessor
-     * @param SearchCriteria $searchCriteria
      */
     public function __construct(
         CollectionFactory $collectionFactory,
@@ -88,15 +83,13 @@ public function __construct(
         LevelCalculator $levelCalculator,
         MetadataPool $metadata,
         CollectionProcessorInterface $collectionProcessor,
-        SearchCriteria $searchCriteria
     ) {
         $this->collectionFactory = $collectionFactory;
         $this->attributesJoiner = $attributesJoiner;
         $this->depthCalculator = $depthCalculator;
         $this->levelCalculator = $levelCalculator;
         $this->metadata = $metadata;
         $this->collectionProcessor = $collectionProcessor;
-        $this->searchCriteria = $searchCriteria;
     }
 
     /**
@@ -125,7 +118,8 @@ public function getTree(ResolveInfo $resolveInfo, int $rootCategoryId, int $stor
      * @throws LocalizedException
      * @throws Exception
      */
-    private function getCollection(ResolveInfo $resolveInfo, int $rootCategoryId) : Collection {
+    private function getCollection(ResolveInfo $resolveInfo, int $rootCategoryId) : Collection
+    {
         $categoryQuery = $resolveInfo->fieldNodes[0];
         $collection = $this->collectionFactory->create();
         $this->joinAttributesRecursively($collection, $categoryQuery, $resolveInfo);
@@ -196,23 +190,23 @@ private function joinAttributesRecursively(
      *
      * @param ResolveInfo $resolveInfo
      * @param int $rootCategoryId
-     * @param array $criteria
+     * @param SearchCriteria $searchCriteria
      * @param StoreInterface $store
      * @param array $attributeNames
      * @param ContextInterface $context
      * @return Iterator
      * @throws LocalizedException
      * @throws Exception
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function getFilteredTree(
         ResolveInfo $resolveInfo,
         int $rootCategoryId,
-        array $criteria,
+        SearchCriteria $searchCriteria,
         StoreInterface $store,
         array $attributeNames,
         ContextInterface $context
     ): Iterator {
-        $searchCriteria = $this->searchCriteria->buildCriteria($criteria, $store);
         $collection = $this->getCollection($resolveInfo, $rootCategoryId);
         $this->collectionProcessor->process($collection, $searchCriteria, $attributeNames, $context);
         return $collection->getIterator();