ACP2E-3090: Handling Category Filters in GraphQL: includeDirectChildrenOnly and category_uid

Author: glo23503

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

@@ -15,6 +15,8 @@
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\Catalog\Model\Layer\Resolver;
 use Magento\CatalogGraphQl\DataProvider\Product\SearchCriteriaBuilder;
+use Magento\Framework\GraphQl\Query\Uid;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Products field resolver, used for GraphQL request processing.
@@ -31,17 +33,23 @@ class Products implements ResolverInterface
      */
     private $searchApiCriteriaBuilder;
 
+    /** @var Uid */
+    private $uidEncoder;
+
     /**
      * @param ProductQueryInterface $searchQuery
      * @param SearchCriteriaBuilder|null $searchApiCriteriaBuilder
+     * @param Uid|null $uidEncoder
      */
     public function __construct(
         ProductQueryInterface $searchQuery,
-        SearchCriteriaBuilder $searchApiCriteriaBuilder = null
+        SearchCriteriaBuilder $searchApiCriteriaBuilder = null,
+        Uid $uidEncoder = null
     ) {
         $this->searchQuery = $searchQuery;
         $this->searchApiCriteriaBuilder = $searchApiCriteriaBuilder ??
-            \Magento\Framework\App\ObjectManager::getInstance()->get(SearchCriteriaBuilder::class);
+            ObjectManager::getInstance()->get(SearchCriteriaBuilder::class);
+        $this->uidEncoder = $uidEncoder ?: ObjectManager::getInstance()->get(Uid::class);
     }
 
     /**
@@ -80,6 +88,10 @@ public function resolve(
             'layer_type' => isset($args['search']) ? Resolver::CATALOG_LAYER_SEARCH : Resolver::CATALOG_LAYER_CATEGORY,
         ];
 
+        if (isset($args['filter']['category_uid'])) {
+            $args['filter']['category_id'] = $this->getFilterCategoryIdFromCategoryUid($args['filter']['category_uid']);
+        }
+
         if (isset($args['filter']['category_id'])) {
             $data['categories'] = $args['filter']['category_id']['eq'] ?? $args['filter']['category_id']['in'];
             $data['categories'] = is_array($data['categories']) ? $data['categories'] : [$data['categories']];
@@ -88,6 +100,26 @@ public function resolve(
         return $data;
     }
 
+    /**
+     * Get filter category_id by category_uid
+     *
+     * @param array $filterCategoryUid
+     * @return array|null
+     */
+    private function getFilterCategoryIdFromCategoryUid(array $filterCategoryUid): ?array
+    {
+        $filterCategoryId = null;
+        if (isset($filterCategoryUid['eq'])) {
+            $filterCategoryId['eq'] = $this->uidEncoder
+                ->decode((string)$filterCategoryUid['eq']);
+        } elseif (!empty($filterCategoryUid['in'])) {
+            foreach ($filterCategoryUid['in'] as $uid) {
+                $filterCategoryId['in'][] = $this->uidEncoder->decode((string) $uid);
+            }
+        }
+        return $filterCategoryId;
+    }
+
     /**
      * Validate input arguments
      *

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

@@ -7,6 +7,10 @@
 
 namespace Magento\GraphQl\Catalog\CategoriesQuery;
 
+use Magento\Catalog\Test\Fixture\Category as CategoryFixture;
+use Magento\Catalog\Test\Fixture\Product as ProductFixture;
+use Magento\TestFramework\Fixture\DataFixture;
+use Magento\TestFramework\Fixture\DataFixtureStorageManager;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
 
 /**
@@ -65,4 +69,46 @@ function ($a) {
         $this->assertEquals(2, $optionsAttribute1[1]['count']);
         $this->assertEquals(3, $optionsAttribute1[2]['count']);
     }
+
+    /**
+     * Test to return category aggregations filtered by category_uid
+     */
+    #[
+        DataFixture(CategoryFixture::class, ['name' => 'Category 1', 'parent_id' => '2'], 'c1'),
+        DataFixture(CategoryFixture::class, ['name' => 'Category 1-1', 'parent_id' => '$c1.id$'], 'c11'),
+        DataFixture(CategoryFixture::class, ['name' => 'Category 1-1-1', 'parent_id' => '$c11.id$'], 'c111'),
+        DataFixture(
+            ProductFixture::class,
+            [
+                'sku' => 'product1',
+                'category_ids' => ['$c111.id$']
+            ],
+        ),
+    ]
+    public function testCategoryAggregationFilteredByCategoryUid(): void
+    {
+        $fixtures = DataFixtureStorageManager::getStorage();
+        $categoryId = $fixtures->get('c1')->getId();
+        $categoryUid = base64_encode((string) $categoryId);
+        $query = <<<QUERY
+{
+  products(filter: {category_uid: {eq: "{$categoryUid}"}}) {
+    aggregations{
+      label
+      attribute_code
+      count
+      options{
+        label
+        value
+        count
+      }
+    }
+  }
+}
+QUERY;
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $this->assertArrayHasKey('products', $response);
+        $this->assertArrayHasKey('aggregations', $response['products']);
+    }
 }