Refactor query builders

src/Config/Index.php

@@ -7,8 +7,11 @@
 use Psr\Container\ContainerInterface;
 use Setono\SyliusMeilisearchPlugin\DataProvider\IndexableDataProviderInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataInterface;
 use Setono\SyliusMeilisearchPlugin\Indexer\IndexerInterface;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
 
 final class Index implements \Stringable
 {
@@ -90,6 +93,26 @@ public function dataProvider(): IndexableDataProviderInterface
         return $this->locator->get(IndexableDataProviderInterface::class);
     }
 
+    /**
+     * Will return the index uid in Meilisearch based on the current context.
+     * This means you should not call this when you're not in a request/response context
+     */
+    public function uid(): string
+    {
+        /** @var IndexNameResolverInterface $indexNameResolver */
+        $indexNameResolver = $this->locator->get(IndexNameResolverInterface::class);
+
+        return $indexNameResolver->resolve($this);
+    }
+
+    public function metadata(): MetadataInterface
+    {
+        /** @var MetadataFactoryInterface $metadataFactory */
+        $metadataFactory = $this->locator->get(MetadataFactoryInterface::class);
+
+        return $metadataFactory->getMetadataFor($this->document);
+    }
+
     public function __toString(): string
     {
         return $this->name;

src/DependencyInjection/SetonoSyliusMeilisearchExtension.php

@@ -20,6 +20,7 @@
 use Setono\SyliusMeilisearchPlugin\Indexer\DefaultIndexer;
 use Setono\SyliusMeilisearchPlugin\Indexer\IndexerInterface;
 use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScopeProviderInterface;
+use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
 use Setono\SyliusMeilisearchPlugin\Twig\AutocompleteRuntime;
 use Setono\SyliusMeilisearchPlugin\UrlGenerator\EntityUrlGeneratorInterface;
 use Sylius\Bundle\ResourceBundle\DependencyInjection\Extension\AbstractResourceExtension;
@@ -279,6 +280,8 @@ private static function registerIndexesConfiguration(array $config, ContainerBui
                 ServiceLocatorTagPass::register($container, [
                     IndexableDataProviderInterface::class => new Reference($index['data_provider']),
                     IndexerInterface::class => new Reference($indexerServiceId),
+                    IndexNameResolverInterface::class => new Reference('setono_sylius_meilisearch.resolver.index_name'),
+                    MetadataFactoryInterface::class => new Reference(MetadataFactoryInterface::class),
                 ]),
                 $index['prefix'],
             ]));

src/Engine/SearchEngine.php

@@ -5,52 +5,22 @@
 namespace Setono\SyliusMeilisearchPlugin\Engine;
 
 use Meilisearch\Client;
-use Meilisearch\Contracts\SearchQuery;
 use Meilisearch\Search\SearchResult;
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
-use Setono\SyliusMeilisearchPlugin\Meilisearch\Filter\FilterBuilderInterface;
-use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\MainQueryBuilderInterface;
-use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\SubQueriesBuilderInterface;
-use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\MultiSearchBuilderInterface;
 
 final class SearchEngine implements SearchEngineInterface
 {
     public function __construct(
-        private readonly MetadataFactoryInterface $metadataFactory,
-        private readonly FilterBuilderInterface $filterBuilder,
         private readonly Index $index,
-        private readonly IndexNameResolverInterface $indexNameResolver,
         private readonly Client $client,
-        private readonly MainQueryBuilderInterface $mainQueryBuilder,
-        private readonly SubQueriesBuilderInterface $subQueriesBuilder,
+        private readonly MultiSearchBuilderInterface $multiSearchBuilder,
     ) {
     }
 
     public function execute(SearchRequest $searchRequest): SearchResult
     {
-        $indexName = $this->indexNameResolver->resolve($this->index);
-        $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
-        $facetsNames = $metadata->getFacetableAttributeNames();
-        $facets = $metadata->getFacetableAttributes();
-
-        /** @var array<string, mixed> $filters */
-        $filters = $this->filterBuilder->build($facets, $searchRequest->filters);
-
-        $mainQuery = $this->mainQueryBuilder->build(
-            $indexName,
-            $searchRequest->query ?? '',
-            $facetsNames,
-            $filters,
-            $searchRequest->page,
-            $searchRequest->sort ?? '',
-        );
-
-        /** @var list<SearchQuery> $queries */
-        $queries = array_merge(
-            [$mainQuery],
-            $this->subQueriesBuilder->build($indexName, $searchRequest->query ?? '', $facets, $searchRequest->filters),
-        );
+        $queries = $this->multiSearchBuilder->build($this->index, $searchRequest);
 
         /** @var array<SearchResult> $results */
         $results = $this->client->multiSearch($queries)['results'] ?? [];
@@ -62,6 +32,7 @@ private function provideSearchResult(array $results): SearchResult
     {
         /** @var array{facetDistribution: array<string, int>} $firstResult */
         $firstResult = current($results);
+
         /** @psalm-suppress MixedArgument (just for now) */
         $firstResult['facetDistribution'] = array_merge(...array_column($results, 'facetDistribution'));
 

src/Engine/SearchRequest.php

@@ -8,6 +8,7 @@
 
 final class SearchRequest
 {
+    // todo we need the hits per page here
     public function __construct(
         public readonly ?string $query,
         /** @var array<string, mixed> $filters */

src/Meilisearch/Filter/FilterBuilderInterface.php

@@ -12,7 +12,7 @@ interface FilterBuilderInterface
      * @param array<string, Facet> $facets
      * @param array<string, mixed> $facetsValues
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function build(array $facets, array $facetsValues): array;
 }

src/Meilisearch/Query/MultiSearchBuilder.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Query;
+
+use Meilisearch\Contracts\SearchQuery;
+use Setono\SyliusMeilisearchPlugin\Config\Index;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Filter\FilterBuilderInterface;
+
+final class MultiSearchBuilder implements MultiSearchBuilderInterface
+{
+    public function __construct(
+        private readonly SearchQueryBuilderInterface $searchQueryBuilder,
+        private readonly FilterBuilderInterface $filterBuilder,
+        private readonly int $hitsPerPage,
+    ) {
+    }
+
+    public function build(Index $index, SearchRequest $searchRequest): array
+    {
+        $metadata = $index->metadata();
+        $facetsNames = $metadata->getFacetableAttributeNames();
+        $facets = $metadata->getFacetableAttributes();
+
+        $filters = $this->filterBuilder->build($facets, $searchRequest->filters);
+
+        return array_merge(
+            [$this->buildSearchQuery($index, $searchRequest, $facetsNames, $filters)],
+            $this->buildFacetQueries($index, $searchRequest, $facets, $searchRequest->filters),
+        );
+    }
+
+    /**
+     * @param list<string> $facetNames
+     * @param list<string> $filters
+     */
+    private function buildSearchQuery(Index $index, SearchRequest $searchRequest, array $facetNames, array $filters): SearchQuery
+    {
+        $query = $this->searchQueryBuilder
+            ->build($index->uid(), $searchRequest->query, $facetNames, $filters)
+            ->setHitsPerPage($this->hitsPerPage)
+            ->setPage($searchRequest->page)
+        ;
+
+        if (null !== $searchRequest->sort) {
+            $query->setSort([$searchRequest->sort]);
+        }
+
+        return $query;
+    }
+
+    /**
+     * @param array<string, Facet> $facets
+     * @param array<string, mixed> $filters
+     *
+     * @return list<SearchQuery>
+     */
+    private function buildFacetQueries(Index $index, SearchRequest $searchRequest, array $facets, array $filters): array
+    {
+        $searchQueries = [];
+
+        foreach ($facets as $facet) {
+            /** @var array<string, mixed> $filteredFacets */
+            $filteredFacets = array_filter($filters, static fn ($value) => $value !== $facet->name, \ARRAY_FILTER_USE_KEY);
+
+            $searchQueries[] = $this->searchQueryBuilder->build(
+                indexName: $index->uid(),
+                query: $searchRequest->query,
+                facets: [$facet->name],
+                filter: $this->filterBuilder->build($facets, $filteredFacets),
+            )
+                ->setLimit(1)
+            ;
+        }
+
+        return $searchQueries;
+    }
+}

src/Meilisearch/Query/MultiSearchBuilderInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Query;
+
+use Meilisearch\Contracts\SearchQuery;
+use Setono\SyliusMeilisearchPlugin\Config\Index;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
+
+interface MultiSearchBuilderInterface
+{
+    /**
+     * Will build a multi search query that handles the search and the facets
+     *
+     * todo explain somewhere why this is necessary
+     *
+     * @return list<SearchQuery>
+     */
+    public function build(Index $index, SearchRequest $searchRequest): array;
+}

src/Meilisearch/Query/SearchQueryBuilder.php

@@ -8,13 +8,19 @@
 
 final class SearchQueryBuilder implements SearchQueryBuilderInterface
 {
-    public function build(string $indexName, string $query, array $facets, array $filter): SearchQuery
+    public function build(string $indexName, ?string $query, array $facets, array $filter): SearchQuery
     {
-        return (new SearchQuery())
+        $searchQuery = new SearchQuery();
+        $searchQuery
             ->setIndexUid($indexName)
-            ->setQuery($query)
             ->setFacets($facets)
             ->setFilter($filter)
         ;
+
+        if (null !== $query) {
+            $searchQuery->setQuery($query);
+        }
+
+        return $searchQuery;
     }
 }

src/Meilisearch/Query/SearchQueryBuilderInterface.php

@@ -10,7 +10,7 @@ interface SearchQueryBuilderInterface
 {
     /**
      * @param array<string> $facets
-     * @param array<string, mixed> $filter
+     * @param list<string> $filter
      */
-    public function build(string $indexName, string $query, array $facets, array $filter): SearchQuery;
+    public function build(string $indexName, ?string $query, array $facets, array $filter): SearchQuery;
 }