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

Author: danielrenaud

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

@@ -307,8 +307,9 @@ input ProductAttributeFilterInput @doc(description: "ProductAttributeFilterInput
 input CategoryFilterInput  @doc(description: "CategoryFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.")
 {
     ids: FilterEqualTypeInput @doc(description: "Filter by category ID that uniquely identifies the category.")
-    url_key: FilterEqualTypeInput @doc(description: "Filter by the part of the URL that identifies the category")
+    url_key: FilterEqualTypeInput @doc(description: "Filter by the part of the URL that identifies the category.")
     name: FilterMatchTypeInput @doc(description: "Filter by the display name of the category.")
+    url_path: FilterEqualTypeInput @doc(description: "Filter by the URL path for the category.")
 }
 
 input ProductFilterInput @doc(description: "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.") {

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

@@ -422,6 +422,114 @@ public function testCategoryImageName()
         $this->assertEquals($expectedImageUrl, $categoryList[0]['image']);
     }
 
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     */
+    public function testFilterByUrlPathTopLevelCategory()
+    {
+        $urlPath = 'category-1';
+        $query = <<<QUERY
+{
+    categoryList(filters: {url_path: {eq: "$urlPath"}}){
+        id
+        name
+        url_key
+        url_path
+        path
+        position
+    }
+}
+QUERY;
+
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $categoryList = $response['categoryList'];
+        $this->assertCount(1, $categoryList);
+        $this->assertEquals($urlPath, $categoryList[0]['url_path']);
+        $this->assertEquals('Category 1', $categoryList[0]['name']);
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     */
+    public function testFilterByUrlPathNestedCategory()
+    {
+        $urlPath = 'category-1/category-1-1/category-1-1-1';
+        $query = <<<QUERY
+{
+    categoryList(filters: {url_path: {eq: "$urlPath"}}){
+        id
+        name
+        url_key
+        url_path
+        path
+        position
+    }
+}
+QUERY;
+
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $categoryList = $response['categoryList'];
+        $this->assertCount(1, $categoryList);
+        $this->assertEquals($urlPath, $categoryList[0]['url_path']);
+        $this->assertEquals('Category 1.1.1', $categoryList[0]['name']);
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     */
+    public function testFilterByUrlPathMultipleCategories()
+    {
+        $urlPaths = ['category-1/category-1-1', 'inactive', 'movable-position-2'];
+        $urlPathsString = '"' . implode('", "', $urlPaths) . '"';
+        $query = <<<QUERY
+{
+    categoryList(filters: {url_path: {in: [$urlPathsString]}}){
+        id
+        name
+        url_key
+        url_path
+        path
+        position
+    }
+}
+QUERY;
+
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $categoryList = $response['categoryList'];
+        $this->assertCount(2, $categoryList);
+        $this->assertEquals($urlPaths[0], $categoryList[0]['url_path']);
+        $this->assertEquals('Category 1.1', $categoryList[0]['name']);
+        $this->assertEquals($urlPaths[2], $categoryList[1]['url_path']);
+        $this->assertEquals('Movable Position 2', $categoryList[1]['name']);
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     */
+    public function testFilterByUrlPathNoResults()
+    {
+        $query = <<<QUERY
+{
+    categoryList(filters: {url_path: {in: ["not-a-category url path"]}}){
+        id
+        name
+        url_key
+        url_path
+        path
+        position
+    }
+}
+QUERY;
+
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $categoryList = $response['categoryList'];
+        $this->assertCount(0, $categoryList);
+    }
+
     /**
      * @return array
      */