Merge remote-tracking branch 'magento-l3/ACP2E-2653' into Tier4-Kings-PR-03-19-2024

Author: glanujnehra

app/code/Magento/CatalogGraphQl/DataProvider/Product/LayeredNavigation/Builder/Aggregations/Category/IncludeDirectChildrenOnly.php

@@ -8,7 +8,9 @@
 namespace Magento\CatalogGraphQl\DataProvider\Product\LayeredNavigation\Builder\Aggregations\Category;
 
 use Magento\Catalog\Api\CategoryListInterface;
+use Magento\Catalog\Model\Config\LayerCategoryConfig;
 use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
 use Magento\Framework\Search\Response\Aggregation;
 use Magento\Framework\Search\Response\AggregationFactory;
@@ -61,25 +63,34 @@ class IncludeDirectChildrenOnly implements ResetAfterRequestInterface
      */
     private $searchCriteriaBuilder;
 
+    /**
+     * @var LayerCategoryConfig|null
+     */
+    private $layerCategoryConfig;
+
     /**
      * @param AggregationFactory $aggregationFactory
      * @param BucketFactory $bucketFactory
      * @param StoreManagerInterface $storeManager
      * @param CategoryListInterface $categoryList
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
+     * @param LayerCategoryConfig|null $layerCategoryConfig
      */
     public function __construct(
         AggregationFactory $aggregationFactory,
         BucketFactory $bucketFactory,
         StoreManagerInterface $storeManager,
         CategoryListInterface $categoryList,
-        SearchCriteriaBuilder $searchCriteriaBuilder
+        SearchCriteriaBuilder $searchCriteriaBuilder,
+        ?LayerCategoryConfig $layerCategoryConfig = null
     ) {
         $this->aggregationFactory = $aggregationFactory;
         $this->bucketFactory = $bucketFactory;
         $this->storeManager = $storeManager;
         $this->categoryList = $categoryList;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
+        $this->layerCategoryConfig = $layerCategoryConfig ?? ObjectManager::getInstance()
+                ->get(LayerCategoryConfig::class);
     }
 
     /**
@@ -91,28 +102,34 @@ public function __construct(
      */
     public function filter(AggregationInterface $aggregation, ?int $storeId): Aggregation
     {
-        $categoryIdsRequested = $this->filter['category'] ?? null;
-        if ($categoryIdsRequested === null) {
-            return $aggregation;
-        }
-        $buckets = $aggregation->getBuckets();
-        $categoryBucket = $buckets[self::CATEGORY_BUCKET] ?? null;
-        if ($categoryBucket === null || empty($categoryBucket->getValues())) {
-            return $aggregation;
+        if (!$this->layerCategoryConfig->isCategoryFilterVisibleInLayerNavigation()) {
+            $buckets = $aggregation->getBuckets();
+            unset($buckets[self::CATEGORY_BUCKET]);
+        } else {
+            $categoryIdsRequested = $this->filter['category'] ?? null;
+            if ($categoryIdsRequested === null) {
+                return $aggregation;
+            }
+            $buckets = $aggregation->getBuckets();
+            $categoryBucket = $buckets[self::CATEGORY_BUCKET] ?? null;
+            if ($categoryBucket === null || empty($categoryBucket->getValues())) {
+                return $aggregation;
+            }
+            $categoryIdsRequested = is_array($categoryIdsRequested) ? $categoryIdsRequested : [$categoryIdsRequested];
+            $bucketValuesFiltered = $this->filterBucketValues(
+                $categoryBucket->getValues(),
+                $categoryIdsRequested,
+                $storeId
+            );
+            $categoryBucketResolved = $this->bucketFactory->create(
+                [
+                    'name' => self::CATEGORY_BUCKET,
+                    'values' => $bucketValuesFiltered
+                ]
+            );
+            $buckets[self::CATEGORY_BUCKET] = $categoryBucketResolved;
         }
-        $categoryIdsRequested = is_array($categoryIdsRequested) ? $categoryIdsRequested : [$categoryIdsRequested];
-        $bucketValuesFiltered = $this->filterBucketValues(
-            $categoryBucket->getValues(),
-            $categoryIdsRequested,
-            $storeId
-        );
-        $categoryBucketResolved = $this->bucketFactory->create(
-            [
-                'name' => self::CATEGORY_BUCKET,
-                'values' => $bucketValuesFiltered
-            ]
-        );
-        $buckets[self::CATEGORY_BUCKET] = $categoryBucketResolved;
+
         return $this->aggregationFactory->create([self::BUCKETS_NAME => $buckets]);
     }
 

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

@@ -225,6 +225,92 @@ private function getGraphQlQuery(string $categoryList, string $includeDirectChil
     }
   }
 }
+QUERY;
+    }
+
+    /**
+     * Test the categories that appear in aggregation Layered Navigation > Display Category Filter => Yes (default).
+     *
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     * @throws \Exception
+     */
+    public function testFetchCategoriesWhenDisplayCategoryEnabled(): void
+    {
+        $result = $this->aggregationWithDisplayCategorySetting();
+        $aggregationAttributeCode = [];
+        foreach ($result['products']['aggregations'] as $aggregation) {
+            $this->assertArrayHasKey('attribute_code', $aggregation);
+            $aggregationAttributeCode[] = $aggregation['attribute_code'];
+        }
+        $this->assertTrue(in_array('category_uid', $aggregationAttributeCode));
+    }
+
+    /**
+     * Test the categories not in aggregation when Layered Navigation > Display Category Filter => No.
+     *
+     * @magentoConfigFixture catalog/layered_navigation/display_category 0
+     * @magentoApiDataFixture Magento/Catalog/_files/categories.php
+     * @throws \Exception
+     */
+    public function testDontFetchCategoriesWhenDisplayCategoryDisabled(): void
+    {
+        $result = $this->aggregationWithDisplayCategorySetting();
+        $aggregationAttributeCode = [];
+        foreach ($result['products']['aggregations'] as $aggregation) {
+            $this->assertArrayHasKey('attribute_code', $aggregation);
+            $aggregationAttributeCode[] = $aggregation['attribute_code'];
+        }
+        $this->assertFalse(in_array('category_uid', $aggregationAttributeCode));
+    }
+
+    /**
+     * @return array
+     * @throws \Exception
+     */
+    private function aggregationWithDisplayCategorySetting(): array
+    {
+        $query = $this->getGraphQlQueryProductSearch();
+        $result = $this->graphQlQuery($query);
+
+        $this->assertArrayNotHasKey('errors', $result);
+        $this->assertArrayHasKey('aggregations', $result['products']);
+        return $result;
+    }
+
+    /**
+     * Get graphQl query.
+     *
+     * @return string
+     */
+    private function getGraphQlQueryProductSearch(): string
+    {
+        return <<<QUERY
+{
+  products(
+    search: "simple"
+    pageSize: 20
+    currentPage: 1
+    sort: {  }
+  ) {
+    items {
+      sku
+      canonical_url
+      categories{
+        name
+        path
+      }
+}
+    aggregations (filter: {category: {includeDirectChildrenOnly: true}}) {
+      attribute_code
+      count
+      label
+      options {
+        label
+        value
+      }
+    }
+  }
+}
 QUERY;
     }
 }