MC-42799: [Magento Cloud] Premiere Support - Layered Navigation setting for price range is not working with our custom attributes

- Removed caching of aggregation algorithm instance as data provider instance is tied to a specific field name. Previously data provider used "price" field to aggregate the data regardless of the bucket field name. Now bucket field name is passed to the data provider constructor to avoid BiC changes.

Author: bubasuma

app/code/Magento/CatalogSearch/Model/Layer/Filter/Decimal.php

@@ -112,6 +112,7 @@ protected function _getItemsData()
         $facets = $productCollection->getFacetedData($attribute->getAttributeCode());
 
         $data = [];
+        $lastFacet = array_key_last($facets);
         foreach ($facets as $key => $aggregation) {
             $count = $aggregation['count'];
             if (!$this->isOptionReducesResults($count, $productSize)) {
@@ -124,7 +125,7 @@ protected function _getItemsData()
             if ($to == '*') {
                 $to = null;
             }
-            $label = $this->renderRangeLabel(empty($from) ? 0 : $from, $to);
+            $label = $this->renderRangeLabel(empty($from) ? 0 : $from, $lastFacet === $key ? null : $to);
             $value = $from . '-' . $to;
 
             $data[] = [

app/code/Magento/CatalogSearch/Model/Search/RequestGenerator/Decimal.php

@@ -16,6 +16,16 @@
  */
 class Decimal implements GeneratorInterface
 {
+    /**
+     * Price attribute aggregation algorithm
+     */
+    private const AGGREGATION_ALGORITHM_VARIABLE = 'price_dynamic_algorithm';
+
+    /**
+     * Default decimal attribute aggregation algorithm
+     */
+    private const DEFAULT_AGGREGATION_ALGORITHM = 'manual';
+
     /**
      * @inheritdoc
      */
@@ -39,7 +49,9 @@ public function getAggregationData(Attribute $attribute, $bucketName)
             'type' => BucketInterface::TYPE_DYNAMIC,
             'name' => $bucketName,
             'field' => $attribute->getAttributeCode(),
-            'method' => 'manual',
+            'method' => $attribute->getFrontendInput() === 'price'
+                ? '$' . self::AGGREGATION_ALGORITHM_VARIABLE . '$'
+                : self::DEFAULT_AGGREGATION_ALGORITHM,
             'metric' => [['type' => 'count']],
         ];
     }

app/code/Magento/Elasticsearch/SearchAdapter/Aggregation/Builder.php

@@ -79,11 +79,12 @@ public function build(RequestInterface $request, array $queryResult)
         $aggregations = [];
         $buckets = $request->getAggregation();
 
-        $dataProvider = $this->dataProviderFactory->create(
-            $this->dataProviderContainer[$request->getIndex()],
-            $this->query
-        );
         foreach ($buckets as $bucket) {
+            $dataProvider = $this->dataProviderFactory->create(
+                $this->dataProviderContainer[$request->getIndex()],
+                $this->query,
+                $bucket->getField()
+            );
             $bucketAggregationBuilder = $this->aggregationContainer[$bucket->getType()];
             $aggregations[$bucket->getName()] = $bucketAggregationBuilder->build(
                 $bucket,

app/code/Magento/Elasticsearch/SearchAdapter/Aggregation/DataProviderFactory.php

@@ -48,12 +48,16 @@ public function __construct(ObjectManagerInterface $objectManager)
      * which will be recreated with its default configuration.
      *
      * @param DataProviderInterface $dataProvider
-     * @param QueryContainer $query
+     * @param QueryContainer|null $query
+     * @param string|null $aggregationFieldName
      * @return DataProviderInterface
      * @throws \LogicException when the query is missing but it required according to the QueryAwareInterface
      */
-    public function create(DataProviderInterface $dataProvider, QueryContainer $query = null)
-    {
+    public function create(
+        DataProviderInterface $dataProvider,
+        QueryContainer $query = null,
+        ?string $aggregationFieldName = null
+    ) {
         $result = $dataProvider;
         if ($dataProvider instanceof QueryAwareInterface) {
             if (null === $query) {
@@ -64,7 +68,13 @@ public function create(DataProviderInterface $dataProvider, QueryContainer $quer
             }
 
             $className = get_class($dataProvider);
-            $result = $this->objectManager->create($className, ['queryContainer' => $query]);
+            $result = $this->objectManager->create(
+                $className,
+                [
+                    'queryContainer' => $query,
+                    'aggregationFieldName' => $aggregationFieldName
+                ]
+            );
         }
 
         return $result;

app/code/Magento/Elasticsearch/SearchAdapter/Dynamic/DataProvider.php

@@ -8,6 +8,7 @@
 use Magento\Elasticsearch\SearchAdapter\QueryAwareInterface;
 use Magento\Elasticsearch\SearchAdapter\QueryContainer;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Search\Dynamic\EntityStorage;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -18,6 +19,11 @@
  */
 class DataProvider implements \Magento\Framework\Search\Dynamic\DataProviderInterface, QueryAwareInterface
 {
+    /**
+     * Default field name used to aggregate data
+     */
+    private const DEFAULT_AGGREGATION_FIELD = 'price';
+
     /**
      * @var \Magento\Elasticsearch\SearchAdapter\ConnectionManager
      * @since 100.1.0
@@ -90,6 +96,11 @@ class DataProvider implements \Magento\Framework\Search\Dynamic\DataProviderInte
      */
     private $logger;
 
+    /**
+     * @var string
+     */
+    private $aggregationFieldName;
+
     /**
      * @param \Magento\Elasticsearch\SearchAdapter\ConnectionManager $connectionManager
      * @param \Magento\Elasticsearch\Model\Adapter\FieldMapperInterface $fieldMapper
@@ -102,6 +113,7 @@ class DataProvider implements \Magento\Framework\Search\Dynamic\DataProviderInte
      * @param \Magento\Framework\App\ScopeResolverInterface $scopeResolver
      * @param QueryContainer|null $queryContainer
      * @param LoggerInterface|null $logger
+     * @param string|null $aggregationFieldName
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -115,7 +127,8 @@ public function __construct(
         $indexerId,
         \Magento\Framework\App\ScopeResolverInterface $scopeResolver,
         QueryContainer $queryContainer = null,
-        LoggerInterface $logger = null
+        LoggerInterface $logger = null,
+        ?string $aggregationFieldName = null
     ) {
         $this->connectionManager = $connectionManager;
         $this->fieldMapper = $fieldMapper;
@@ -128,6 +141,7 @@ public function __construct(
         $this->scopeResolver = $scopeResolver;
         $this->queryContainer = $queryContainer;
         $this->logger = $logger ?? ObjectManager::getInstance()->get(LoggerInterface::class);
+        $this->aggregationFieldName = $aggregationFieldName ?? self::DEFAULT_AGGREGATION_FIELD;
     }
 
     /**
@@ -143,7 +157,7 @@ public function getRange()
      * @inheritdoc
      * @since 100.1.0
      */
-    public function getAggregations(\Magento\Framework\Search\Dynamic\EntityStorage $entityStorage)
+    public function getAggregations(EntityStorage $entityStorage)
     {
         $aggregations = [
             'count' => 0,
@@ -154,7 +168,7 @@ public function getAggregations(\Magento\Framework\Search\Dynamic\EntityStorage
 
         $query = $this->getBasicSearchQuery($entityStorage);
 
-        $fieldName = $this->fieldMapper->getFieldName('price');
+        $fieldName = $this->fieldMapper->getFieldName($this->aggregationFieldName);
         $query['body']['aggregations'] = [
             'prices' => [
                 'extended_stats' => [
@@ -188,10 +202,10 @@ public function getAggregations(\Magento\Framework\Search\Dynamic\EntityStorage
     public function getInterval(
         \Magento\Framework\Search\Request\BucketInterface $bucket,
         array $dimensions,
-        \Magento\Framework\Search\Dynamic\EntityStorage $entityStorage
+        EntityStorage $entityStorage
     ) {
         $entityIds = $entityStorage->getSource();
-        $fieldName = $this->fieldMapper->getFieldName('price');
+        $fieldName = $this->fieldMapper->getFieldName($this->aggregationFieldName);
         $dimension = current($dimensions);
         $storeId = $this->scopeResolver->getScope($dimension->getValue())->getId();
 
@@ -212,7 +226,7 @@ public function getAggregation(
         \Magento\Framework\Search\Request\BucketInterface $bucket,
         array $dimensions,
         $range,
-        \Magento\Framework\Search\Dynamic\EntityStorage $entityStorage
+        EntityStorage $entityStorage
     ) {
         $query = $this->getBasicSearchQuery($entityStorage);
 
@@ -277,12 +291,12 @@ public function prepareData($range, array $dbRanges)
      * but for now it's a question of backward compatibility as this class may be used somewhere else
      * by extension developers and we can't guarantee that they'll pass a query into constructor.
      *
-     * @param \Magento\Framework\Search\Dynamic\EntityStorage $entityStorage
+     * @param EntityStorage $entityStorage
      * @param array $dimensions
      * @return array
      */
     private function getBasicSearchQuery(
-        \Magento\Framework\Search\Dynamic\EntityStorage $entityStorage,
+        EntityStorage $entityStorage,
         array $dimensions = []
     ) {
         if (null !== $this->queryContainer) {

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

@@ -111,6 +111,35 @@ function ($a) {
         $this->assertEquals($expectedOptions, $priceAggregation['options']);
     }
 
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/products_for_search_with_custom_price_attribute.php
+     */
+    public function testAggregationCustomPriceAttribute()
+    {
+        $query = $this->getGraphQlQuery(
+            '"search_product_1", "search_product_2", "search_product_3", "search_product_4" ,"search_product_5"'
+        );
+        $result = $this->graphQlQuery($query);
+
+        $this->assertArrayNotHasKey('errors', $result);
+        $this->assertArrayHasKey('aggregations', $result['products']);
+
+        $priceAggregation = array_filter(
+            $result['products']['aggregations'],
+            function ($a) {
+                return $a['attribute_code'] == 'product_price_attribute_bucket';
+            }
+        );
+        $this->assertNotEmpty($priceAggregation);
+        $priceAggregation = reset($priceAggregation);
+        $this->assertEquals(2, $priceAggregation['count']);
+        $expectedOptions = [
+            ['label' => '0_1000', 'value'=> '0_1000', 'count' => '3'],
+            ['label' => '1000_2000', 'value'=> '1000_2000', 'count' => '2']
+        ];
+        $this->assertEquals($expectedOptions, $priceAggregation['options']);
+    }
+
     private function getGraphQlQuery(string $skus)
     {
         return <<<QUERY

dev/tests/integration/testsuite/Magento/Catalog/_files/product_price_attribute.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Catalog\Api\Data\ProductAttributeInterface;
+use Magento\Catalog\Api\ProductAttributeRepositoryInterface;
+use Magento\Catalog\Model\ResourceModel\Eav\AttributeFactory;
+use Magento\Catalog\Setup\CategorySetup;
+use Magento\TestFramework\Helper\Bootstrap;
+
+$objectManager = Bootstrap::getObjectManager();
+$installer = $objectManager->create(CategorySetup::class);
+$attribute = $objectManager->create(AttributeFactory::class)->create();
+$attributeRepository = $objectManager->create(ProductAttributeRepositoryInterface::class);
+$entityType = $installer->getEntityTypeId(ProductAttributeInterface::ENTITY_TYPE_CODE);
+$attributeCode = 'product_price_attribute';
+if (!$attribute->loadByCode($entityType, $attributeCode)->getAttributeId()) {
+    $attribute->setData(
+        [
+            'attribute_code' => $attributeCode,
+            'entity_type_id' => $entityType,
+            'is_global' => 0,
+            'is_user_defined' => 1,
+            'frontend_input' => 'price',
+            'is_unique' => 0,
+            'is_required' => 0,
+            'is_searchable' => 1,
+            'is_visible_in_advanced_search' => 0,
+            'is_comparable' => 0,
+            'is_filterable' => 1,
+            'is_filterable_in_search' => 1,
+            'is_used_for_promo_rules' => 0,
+            'is_html_allowed_on_front' => 1,
+            'is_visible_on_front' => 0,
+            'used_in_product_listing' => 1,
+            'used_for_sort_by' => 0,
+            'frontend_label' => ['Product Price Attribute'],
+            'backend_type' => 'decimal',
+        ]
+    );
+    $attribute->save();
+    /* Assign attribute to attribute set */
+    $installer->addAttributeToGroup(
+        ProductAttributeInterface::ENTITY_TYPE_CODE,
+        'Default',
+        'General',
+        $attribute->getId()
+    );
+}

dev/tests/integration/testsuite/Magento/Catalog/_files/product_price_attribute_rollback.php

@@ -0,0 +1,20 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+/* Delete attribute with text_attribute code */
+$registry = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(\Magento\Framework\Registry::class);
+$registry->unregister('isSecureArea');
+$registry->register('isSecureArea', true);
+
+/** @var $attribute \Magento\Catalog\Model\ResourceModel\Eav\Attribute */
+$attribute = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
+    \Magento\Catalog\Model\ResourceModel\Eav\Attribute::class
+);
+$attribute->load('product_price_attribute', 'attribute_code');
+$attribute->delete();
+
+$registry->unregister('isSecureArea');
+$registry->register('isSecureArea', false);

dev/tests/integration/testsuite/Magento/Catalog/_files/products_for_search_with_custom_price_attribute.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\Helper\CacheCleaner;
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/product_price_attribute.php');
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/products_for_search.php');
+
+$objectManager = Bootstrap::getObjectManager();
+/** @var ProductRepositoryInterface $productRepository */
+$productRepository = $objectManager->get(ProductRepositoryInterface::class);
+$productSkus = [
+    'search_product_1' => 55,
+    'search_product_2' => 110,
+    'search_product_3' => 515,
+    'search_product_4' => 1020,
+    'search_product_5' => 1225
+];
+foreach ($productSkus as $sku => $price) {
+    $product = $productRepository->get($sku, true, null, true);
+    $product->setProductPriceAttribute($price);
+    $productRepository->save($product);
+}
+
+CacheCleaner::cleanAll();
+/** @var \Magento\Indexer\Model\Indexer\Collection $indexerCollection */
+$indexerCollection = $objectManager->get(\Magento\Indexer\Model\Indexer\Collection::class);
+$indexerCollection->load();
+/** @var \Magento\Indexer\Model\Indexer $indexer */
+foreach ($indexerCollection->getItems() as $indexer) {
+    $indexer->reindexAll();
+}

dev/tests/integration/testsuite/Magento/Catalog/_files/products_for_search_with_custom_price_attribute_rollback.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\TestFramework\Workaround\Override\Fixture\Resolver;
+
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/products_for_search_rollback.php');
+Resolver::getInstance()->requireDataFixture('Magento/Catalog/_files/product_price_attribute_rollback.php');