NEXT-34030 - ES exact hit

src/Core/Content/Test/Product/ProductBuilder.php

@@ -180,6 +180,13 @@ public function __construct(
         $this->tax($taxKey);
     }
 
+    public function number(string $number): self
+    {
+        $this->productNumber = $number;
+
+        return $this;
+    }
+
     /**
      * @return array<mixed>
      */

src/Elasticsearch/DependencyInjection/Configuration.php

@@ -47,6 +47,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->children()
                         ->scalarNode('timeout')->end()
                         ->integerNode('term_max_length')->end()
+                        ->scalarNode('search_type')->end()
                     ->end()
                 ->end()
                 ->arrayNode('administration')
@@ -62,6 +63,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->children()
                                 ->scalarNode('timeout')->end()
                                 ->integerNode('term_max_length')->end()
+                                ->scalarNode('search_type')->end()
                             ->end()
                         ->end()
                     ->end()

src/Elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntityAggregator.php

@@ -29,7 +29,8 @@ public function __construct(
         private readonly EntityAggregatorInterface $decorated,
         private readonly AbstractElasticsearchAggregationHydrator $hydrator,
         private readonly EventDispatcherInterface $eventDispatcher,
-        private readonly string $timeout = '5s'
+        private readonly string $timeout,
+        private readonly string $searchType
     ) {
     }
 
@@ -52,6 +53,7 @@ public function aggregate(EntityDefinition $definition, Criteria $criteria, Cont
             $result = $this->client->search([
                 'index' => $this->helper->getIndexName($definition),
                 'body' => $searchArray,
+                'search_type' => $this->searchType,
             ]);
 
             $result = $this->hydrator->hydrate($definition, $criteria, $context, $result);

src/Elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntitySearcher.php

@@ -36,7 +36,8 @@ public function __construct(
         private readonly CriteriaParser $criteriaParser,
         private readonly AbstractElasticsearchSearchHydrator $hydrator,
         private readonly EventDispatcherInterface $eventDispatcher,
-        private readonly string $timeout = '5s'
+        private readonly string $timeout,
+        private readonly string $searchType
     ) {
     }
 
@@ -68,6 +69,7 @@ public function search(EntityDefinition $definition, Criteria $criteria, Context
                 'index' => $this->helper->getIndexName($definition),
                 'track_total_hits' => true,
                 'body' => $search,
+                'search_type' => $this->searchType,
             ]);
 
             $result = $this->hydrator->hydrate($definition, $criteria, $context, $result);

src/Elasticsearch/Product/ProductSearchQueryBuilder.php

@@ -55,6 +55,10 @@ public function build(Criteria $criteria, Context $context): BoolQuery
 
         $tokens = $this->tokenizer->tokenize((string) $criteria->getTerm());
         $tokens = $this->tokenFilter->filter($tokens, $context);
+        $term = strtolower((string) $criteria->getTerm());
+        if (!\in_array($term, $tokens, true)) {
+            $tokens[] = $term;
+        }
 
         foreach ($tokens as $originalToken) {
             $tokenBool = new BoolQuery();

src/Elasticsearch/Resources/config/packages/elasticsearch.yaml

@@ -8,6 +8,7 @@ elasticsearch:
     search:
         timeout: 5s
         term_max_length: 300
+        search_type: "query_then_fetch"
     administration:
         hosts: "%env(string:ADMIN_OPENSEARCH_URL)%"
         enabled: "%env(bool:SHOPWARE_ADMIN_ES_ENABLED)%"
@@ -16,6 +17,7 @@ elasticsearch:
         search:
             timeout: 5s
             term_max_length: 300
+            search_type: "query_then_fetch"
         index_settings:
             number_of_shards: 3
             number_of_replicas: 3

src/Elasticsearch/Resources/config/packages/test/elasticsearch.yaml

@@ -0,0 +1,5 @@
+elasticsearch:
+    index_settings:
+        number_of_shards: 1
+        number_of_replicas: 0
+

src/Elasticsearch/Resources/config/services.xml

@@ -160,6 +160,7 @@
             <argument type="service" id="Shopware\Elasticsearch\Framework\DataAbstractionLayer\AbstractElasticsearchSearchHydrator"/>
             <argument type="service" id="event_dispatcher"/>
             <argument>%elasticsearch.search.timeout%</argument>
+            <argument>%elasticsearch.search.search_type%</argument>
         </service>
 
         <service id="Shopware\Elasticsearch\Framework\DataAbstractionLayer\ElasticsearchEntityAggregator"
@@ -172,6 +173,7 @@
             <argument type="service" id="Shopware\Elasticsearch\Framework\DataAbstractionLayer\AbstractElasticsearchAggregationHydrator"/>
             <argument type="service" id="event_dispatcher"/>
             <argument>%elasticsearch.search.timeout%</argument>
+            <argument>%elasticsearch.search.search_type%</argument>
         </service>
 
         <service id="Shopware\Elasticsearch\Product\SearchKeywordReplacement"

src/Elasticsearch/Test/ElasticsearchTestTestBehaviour.php

@@ -71,7 +71,9 @@ protected function createEntityAggregator(): ElasticsearchEntityAggregator
             $this->getDiContainer()->get(Client::class),
             $decorated,
             $this->getDiContainer()->get(AbstractElasticsearchAggregationHydrator::class),
-            $this->getDiContainer()->get('event_dispatcher')
+            $this->getDiContainer()->get('event_dispatcher'),
+            '5s',
+            'dfs_query_then_fetch'
         );
     }
 
@@ -89,7 +91,9 @@ protected function createEntitySearcher(): ElasticsearchEntitySearcher
             $this->getDiContainer()->get(ElasticsearchHelper::class),
             $this->getDiContainer()->get(CriteriaParser::class),
             $this->getDiContainer()->get(AbstractElasticsearchSearchHydrator::class),
-            $this->getDiContainer()->get('event_dispatcher')
+            $this->getDiContainer()->get('event_dispatcher'),
+            '5s',
+            'dfs_query_then_fetch'
         );
     }
 

tests/integration/Elasticsearch/Product/SearchCasesTest.php

@@ -0,0 +1,109 @@
+<?php declare(strict_types=1);
+
+namespace Shopware\Tests\Integration\Elasticsearch\Product;
+
+use Doctrine\DBAL\Connection;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Shopware\Core\Content\Product\ProductDefinition;
+use Shopware\Core\Content\Test\Product\ProductBuilder;
+use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
+use Shopware\Core\Framework\Test\IdsCollection;
+use Shopware\Core\Framework\Test\TestCaseBase\DatabaseTransactionBehaviour;
+use Shopware\Core\Framework\Test\TestCaseBase\KernelTestBehaviour;
+use Shopware\Elasticsearch\Framework\DataAbstractionLayer\ElasticsearchEntitySearcher;
+use Shopware\Elasticsearch\Test\ElasticsearchTestTestBehaviour;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * @internal
+ */
+#[CoversClass(ElasticsearchEntitySearcher::class)]
+class SearchCasesTest extends TestCase
+{
+    use DatabaseTransactionBehaviour;
+    use ElasticsearchTestTestBehaviour;
+    use KernelTestBehaviour;
+
+    private static IdsCollection $ids;
+
+    /**
+     * @param array<mixed> $products
+     */
+    #[DataProvider('numbersProvider')]
+    public function testSearch(array $products, string $term, string $best): void
+    {
+        $this->clearElasticsearch();
+
+        $this->getContainer()->get(Connection::class)->executeStatement('DELETE FROM product');
+
+        $this->getContainer()->get('product.repository')->create(array_values($products), Context::createDefaultContext());
+
+        $this->indexElasticSearch();
+
+        $searcher = $this->createEntitySearcher();
+
+        $criteria = new Criteria();
+        $criteria->addState(Criteria::STATE_ELASTICSEARCH_AWARE);
+        $criteria->setTerm($term);
+
+        $definition = $this->getContainer()->get(ProductDefinition::class);
+
+        $result = $searcher->search($definition, $criteria, Context::createDefaultContext());
+
+        $scores = [];
+        foreach ($result->getData() as $item) {
+            $scores[self::$ids->getKey((string) $item['id'])] = $item['_score'];
+        }
+
+        static::assertEquals(
+            $best,
+            self::$ids->getKey((string) $result->firstId()),
+            print_r($scores, true)
+        );
+    }
+
+    public static function numbersProvider(): \Generator
+    {
+        self::$ids = $ids = new IdsCollection();
+
+        $products = [
+            'p1' => self::product($ids, 'p1', 'DE-031668-B', 'HP LaserJet Enterprise M608x Inkl. Stapelfach und Papierfach'),
+            'p2' => self::product($ids, 'p2', 'DE-031677-B', 'HP LaserJet Enterprise M608x Inkl. Stapelfach'),
+            'p3' => self::product($ids, 'p3', 'DE-031687-B', 'HP LaserJet Enterprise M608x'),
+            'p4' => self::product($ids, 'p4', 'DE-13.116-B', 'LG 24MB35PM-B - 1920 x 1080 - FHD'),
+            'p5' => self::product($ids, 'p5', 'DE-15.174-N', 'Crucial DDR4 Desktop Speicher - DIMM - DDR4 - 2400 MHz - CL17'),
+            'p6' => self::product($ids, 'p6', 'DE-17.028-A', 'Fujitsu Display B24-8 TE - 1920 x 1080 - FHD'),
+            'p7' => self::product($ids, 'p7', 'DE-17.028-B', 'Fujitsu Display B24-8 TE - 1920 x 1080 - FHD'),
+            'p8' => self::product($ids, 'p8', 'DE-17.346-B', 'LG 24BK550Y-B - 1920 x 1080 - FHD'),
+            'p9' => self::product($ids, 'p9', 'DE-17.353-B', 'Eizo FlexScan EV2416W-BK - 1920 x 1200 - WUXGA'),
+            'p10' => self::product($ids, 'p10', 'DE-17.447-N', 'SOLID DDR3 Desktop Speicher - DIMM 240-PIN - DDR3 - 1600 MHz - CL 11'),
+        ];
+
+        yield 'Exact number match' => [$products, 'DE-031668-B', 'p1'];
+    }
+
+    protected function getDiContainer(): ContainerInterface
+    {
+        return $this->getContainer();
+    }
+
+    protected function runWorker(): void
+    {
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    private static function product(IdsCollection $ids, string $key, string $number, string $name): array
+    {
+        return (new ProductBuilder($ids, $key))
+            ->number($number)
+            ->price(100)
+            ->visibility()
+            ->name($name)
+            ->build();
+    }
+}

tests/unit/Elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntityAggregatorTest.php

@@ -43,7 +43,9 @@ public function testEmptyQueryExceptionIsCatched(): void
             $client,
             $this->createMock(EntityAggregatorInterface::class),
             $this->createMock(AbstractElasticsearchAggregationHydrator::class),
-            new EventDispatcher()
+            new EventDispatcher(),
+            '10s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();
@@ -73,6 +75,7 @@ public function testAggregateWithTimeout(): void
                     'timeout' => '10s',
                     'size' => 0,
                 ],
+                'search_type' => 'dfs_query_then_fetch',
             ])->willReturn([]);
 
         $helper = $this->createMock(ElasticsearchHelper::class);
@@ -86,7 +89,8 @@ public function testAggregateWithTimeout(): void
             $this->createMock(EntityAggregatorInterface::class),
             $this->createMock(AbstractElasticsearchAggregationHydrator::class),
             new EventDispatcher(),
-            '10s'
+            '10s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();

tests/unit/Elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntitySearcherTest.php

@@ -50,6 +50,8 @@ public function testEmptyQueryExceptionIsCatched(): void
             $this->createMock(CriteriaParser::class),
             $this->createMock(AbstractElasticsearchSearchHydrator::class),
             new EventDispatcher(),
+            '10s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();
@@ -87,6 +89,8 @@ public function testWithCriteriaLimitOfZero(): void
             $this->createMock(CriteriaParser::class),
             $this->createMock(AbstractElasticsearchSearchHydrator::class),
             new EventDispatcher(),
+            '5s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();
@@ -118,6 +122,7 @@ public function testSearchWithTimeout(): void
                     'from' => 0,
                     'size' => 10,
                 ],
+                'search_type' => 'dfs_query_then_fetch',
             ])->willReturn([]);
 
         $helper = $this->createMock(ElasticsearchHelper::class);
@@ -132,7 +137,8 @@ public function testSearchWithTimeout(): void
             $this->createMock(CriteriaParser::class),
             $this->createMock(AbstractElasticsearchSearchHydrator::class),
             new EventDispatcher(),
-            '10s'
+            '10s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();
@@ -168,6 +174,8 @@ public function testExceptionsGetLogged(): void
             new CriteriaParser(new EntityDefinitionQueryHelper(), $this->createMock(CustomFieldService::class)),
             $this->createMock(AbstractElasticsearchSearchHydrator::class),
             new EventDispatcher(),
+            '5s',
+            'dfs_query_then_fetch'
         );
 
         $context = Context::createDefaultContext();