Fixes #3148 Replacing _term agg sort order by _key

Deprecated since Elasticsearch 6.0.0 but finally removed in 8.11
Smile-SA · Jan 15, 2024 · e0e74f0 · e0e74f0
1 parent 97efd19
commit e0e74f0
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 4 deletions.
diff --git a/src/module-elasticsuite-catalog/Model/Attribute/Source/FilterSortOrder.php b/src/module-elasticsuite-catalog/Model/Attribute/Source/FilterSortOrder.php
@@ -35,7 +35,7 @@ public function toOptionArray()
         return [
             ['value' => BucketInterface::SORT_ORDER_COUNT, 'label' => __('Result count')],
             ['value' => BucketInterface::SORT_ORDER_MANUAL, 'label' => __('Admin sort')],
-            ['value' => BucketInterface::SORT_ORDER_TERM, 'label' => __('Name')],
+            ['value' => BucketInterface::SORT_ORDER_TERM_DEPRECATED, 'label' => __('Name')],
             ['value' => BucketInterface::SORT_ORDER_RELEVANCE, 'label' => __('Relevance')],
         ];
     }

diff --git a/...module-elasticsuite-core/Search/Adapter/Elasticsuite/Request/Aggregation/Builder/Term.php b/...module-elasticsuite-core/Search/Adapter/Elasticsuite/Request/Aggregation/Builder/Term.php
@@ -48,7 +48,7 @@ public function buildBucket(BucketInterface $bucket)
             $aggregation['terms']['order'] = $bucket->getSortOrder();
         } elseif (in_array($bucket->getSortOrder(), [$bucket::SORT_ORDER_COUNT, $bucket::SORT_ORDER_MANUAL])) {
             $aggregation['terms']['order'] = [$bucket::SORT_ORDER_COUNT => SortOrderInterface::SORT_DESC];
-        } elseif ($bucket->getSortOrder() == $bucket::SORT_ORDER_TERM) {
+        } elseif (in_array($bucket->getSortOrder(), [$bucket::SORT_ORDER_TERM, $bucket::SORT_ORDER_TERM_DEPRECATED])) {
             $aggregation['terms']['order'] = [$bucket::SORT_ORDER_TERM => SortOrderInterface::SORT_ASC];
         } elseif ($bucket->getSortOrder() == $bucket::SORT_ORDER_RELEVANCE && !$bucket->isNested()) {
             $aggregation['aggregations']['termRelevance'] = ['avg' => ['script' => $bucket::SORT_ORDER_RELEVANCE]];

diff --git a/src/module-elasticsuite-core/Search/Request/BucketInterface.php b/src/module-elasticsuite-core/Search/Request/BucketInterface.php
@@ -35,9 +35,10 @@ interface BucketInterface extends \Magento\Framework\Search\Request\BucketInterf
     const TYPE_METRIC           = 'metricBucket';
 
     const SORT_ORDER_COUNT     = '_count';
-    const SORT_ORDER_TERM      = '_term';
+    const SORT_ORDER_TERM      = '_key';
     const SORT_ORDER_RELEVANCE = "_score";
     const SORT_ORDER_MANUAL    = "_manual";
+    const SORT_ORDER_TERM_DEPRECATED = '_term';
 
     /**
      * @var integer

diff --git a/...suite-core/Test/Unit/Search/Adapter/Elasticsuite/Request/Aggregation/Builder/TermTest.php b/...suite-core/Test/Unit/Search/Adapter/Elasticsuite/Request/Aggregation/Builder/TermTest.php
@@ -53,7 +53,46 @@ public function testBasicTermAggregationBuild()
     public function testAplhabeticSortOrderTermAggregationBuild()
     {
         $aggBuilder = $this->getAggregationBuilder();
-        $termBucket = new TermBucket('aggregationName', 'fieldName', [], [], [], null, null, null, 1, TermBucket::SORT_ORDER_TERM);
+        $termBucket = new TermBucket(
+            'aggregationName',
+            'fieldName',
+            [],
+            [],
+            [],
+            null,
+            null,
+            null,
+            1,
+            TermBucket::SORT_ORDER_TERM
+        );
+
+        $aggregation = $aggBuilder->buildBucket($termBucket);
+
+        $this->assertArrayHasKey('terms', $aggregation);
+        $this->assertEquals('fieldName', $aggregation['terms']['field']);
+        $this->assertEquals([TermBucket::SORT_ORDER_TERM => SortOrderInterface::SORT_ASC], $aggregation['terms']['order']);
+    }
+
+    /**
+     * Test the standard term aggregation building sorted by alphabetic order using the deprecated sort order.
+     *
+     * @return void
+     */
+    public function testAplhabeticSortOrderTermDeprecatedAggregationBuild()
+    {
+        $aggBuilder = $this->getAggregationBuilder();
+        $termBucket = new TermBucket(
+            'aggregationName',
+            'fieldName',
+            [],
+            [],
+            [],
+            null,
+            null,
+            null,
+            1,
+            TermBucket::SORT_ORDER_TERM_DEPRECATED
+        );
 
         $aggregation = $aggBuilder->buildBucket($termBucket);