MC-32388: Add url_path as a possible filter in categoryList query

Author: danielrenaud

app/code/Magento/CatalogGraphQl/Model/Category/CategoryFilter.php

@@ -12,6 +12,7 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\GraphQl\Query\Resolver\Argument\SearchCriteria\ArgumentApplier\Filter;
+use Magento\Framework\Search\Adapter\Mysql\Query\Builder\Match;
 use Magento\Search\Model\Query;
 use Magento\Store\Api\Data\StoreInterface;
 use Magento\Store\Model\ScopeInterface;
@@ -58,18 +59,14 @@ public function __construct(
      * @param array $criteria
      * @param StoreInterface $store
      * @return int[]
+     * @throws InputException
      */
-    public function getCategoryIds(array $criteria, StoreInterface $store): array
+    public function getResult(array $criteria, StoreInterface $store): array
     {
         $categoryIds = [];
-        try {
-            $criteria[Filter::ARGUMENT_NAME] = $this->formatMatchFilters($criteria['filters'], $store);
-        } catch (InputException $e) {
-            //Return empty set when match filter is too short. (matches search api behavior)
-            return $categoryIds;
-        }
-        $criteria[Filter::ARGUMENT_NAME][CategoryInterface::KEY_IS_ACTIVE] = ['eq' => 1];
 
+        $criteria[Filter::ARGUMENT_NAME] = $this->formatMatchFilters($criteria['filters'], $store);
+        $criteria[Filter::ARGUMENT_NAME][CategoryInterface::KEY_IS_ACTIVE] = ['eq' => 1];
         $searchCriteria = $this->searchCriteriaBuilder->build('categoryList', $criteria);
         $categories = $this->categoryList->getList($searchCriteria);
         foreach ($categories->getItems() as $category) {
@@ -95,16 +92,15 @@ private function formatMatchFilters(array $filters, StoreInterface $store): arra
         );
 
         foreach ($filters as $filter => $condition) {
-            $conditionType = array_keys($condition)[0];
+            $conditionType = current(array_keys($condition));
             if ($conditionType === 'match') {
-                $searchValue = $condition[$conditionType];
-                $matchLength = strlen(trim($searchValue));
+                $searchValue = trim(str_replace(Match::SPECIAL_CHARACTERS, '', $condition[$conditionType]));
+                $matchLength = strlen($searchValue);
                 if ($matchLength < $minQueryLength) {
-                    throw new InputException(__('Invalid match filter'));
+                    throw new InputException(__('Invalid match filter. Minimum length is %1.', $minQueryLength));
                 }
                 unset($filters[$filter]['match']);
                 $filters[$filter]['like'] = '%' . $searchValue . '%';
-
             }
         }
         return $filters;

app/code/Magento/CatalogGraphQl/Model/Category/CategoryFilterAttributesForAst.php

@@ -11,7 +11,7 @@
 use Magento\Framework\GraphQl\Query\Resolver\Argument\FieldEntityAttributesInterface;
 
 /**
- * Retrieves attributes for a field for the ast converter
+ * Retrieve filterable attributes for Category queries
  */
 class CategoryFilterAttributesForAst implements FieldEntityAttributesInterface
 {

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

@@ -8,13 +8,13 @@
 namespace Magento\CatalogGraphQl\Model\Resolver;
 
 use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\ExtractDataFromCategoryTree;
+use Magento\Framework\Exception\InputException;
 use Magento\Framework\GraphQl\Config\Element\Field;
-use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\CategoryTree;
 use Magento\CatalogGraphQl\Model\Category\CategoryFilter;
-use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory;
 
 /**
  * Category List resolver, used for GraphQL category data request processing.
@@ -26,11 +26,6 @@ class CategoryList implements ResolverInterface
      */
     private $categoryTree;
 
-    /**
-     * @var CollectionFactory
-     */
-    private $collectionFactory;
-
     /**
      * @var CategoryFilter
      */
@@ -45,18 +40,15 @@ class CategoryList implements ResolverInterface
      * @param CategoryTree $categoryTree
      * @param ExtractDataFromCategoryTree $extractDataFromCategoryTree
      * @param CategoryFilter $categoryFilter
-     * @param CollectionFactory $collectionFactory
      */
     public function __construct(
         CategoryTree $categoryTree,
         ExtractDataFromCategoryTree $extractDataFromCategoryTree,
-        CategoryFilter $categoryFilter,
-        CollectionFactory $collectionFactory
+        CategoryFilter $categoryFilter
     ) {
         $this->categoryTree = $categoryTree;
         $this->extractDataFromCategoryTree = $extractDataFromCategoryTree;
         $this->categoryFilter = $categoryFilter;
-        $this->collectionFactory = $collectionFactory;
     }
 
     /**
@@ -69,11 +61,13 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
         }
         $store = $context->getExtensionAttributes()->getStore();
 
-        $rootCategoryIds = [];
         if (!isset($args['filters'])) {
-            $rootCategoryIds[] = (int)$store->getRootCategoryId();
-        } else {
-            $rootCategoryIds = $this->categoryFilter->getCategoryIds($args, $store);
+            $args['filters']['ids'] = ['eq' => $store->getRootCategoryId()];
+        }
+        try {
+            $rootCategoryIds = $this->categoryFilter->getResult($args, $store);
+        } catch (InputException $e) {
+            throw new GraphQlInputException(__($e->getMessage()));
         }
 
         return $this->fetchCategories($rootCategoryIds, $info);
@@ -85,7 +79,6 @@ public function resolve(Field $field, $context, ResolveInfo $info, array $value
      * @param array $categoryIds
      * @param ResolveInfo $info
      * @return array
-     * @throws GraphQlNoSuchEntityException
      */
     private function fetchCategories(array $categoryIds, ResolveInfo $info)
     {

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

@@ -360,6 +360,8 @@ public function testEmptyFiltersReturnRootCategory()
      * Filtering with match value less than minimum query should return empty result
      *
      * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     * @expectedException \Exception
+     * @expectedExceptionMessage Invalid match filter. Minimum length is 3.
      */
     public function testMinimumMatchQueryLength()
     {
@@ -376,10 +378,7 @@ public function testMinimumMatchQueryLength()
     }
 }
 QUERY;
-        $result = $this->graphQlQuery($query);
-        $this->assertArrayNotHasKey('errors', $result);
-        $this->assertArrayHasKey('categoryList', $result);
-        $this->assertEquals([], $result['categoryList']);
+        $this->graphQlQuery($query);
     }
 
     /**