Refactor the Search Engine & Filter Builder

composer.json

@@ -91,7 +91,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Setono\\SyliusMeilisearchPlugin\\Tests\\": "tests/"
+            "Setono\\SyliusMeilisearchPlugin\\Tests\\": "tests/",
+            "TestApp\\": "tests/Application/src/"
         },
         "classmap": [
             "tests/Application/Kernel.php"

src/Engine/SearchEngine.php

@@ -5,8 +5,10 @@
 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\Facet;
 use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
 use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
 use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
@@ -27,19 +29,69 @@
     {
         $page = max(1, (int) ($parameters['p'] ?? 1));
         $sort = (string) ($parameters['sort'] ?? '');
+        $facetsFilter = $parameters['facets'] ?? [];
 
         $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
+        $indexUid = $this->indexNameResolver->resolve($this->index);
+        $query = $query ?? '';
+        $facets = array_map(static fn (Facet $facet) => $facet->name, $metadata->getFacets());
+        $filter = $this->filterBuilder->build($facetsFilter);
+
+        $mainQuery = $this->buildSearchQuery($indexUid, $query, $facets, $filter)
+            ->setHitsPerPage($this->hitsPerPage)
+            ->setPage($page)
+        ;
 
-        $searchParams = [
-            'facets' => $metadata->getFacetableAttributeNames(),
-            'filter' => $this->filterBuilder->build($parameters),
-            'hitsPerPage' => $this->hitsPerPage,
-            'page' => $page,
-        ];
         if ('' !== $sort) {
-            $searchParams['sort'] = [$sort];
+            $mainQuery->setSort([$sort]);
+        }
+
+        $results = $this->client->multiSearch([
+            $mainQuery,
+            ...$this->createSearchQueries($indexUid, $facets, $query),
+        ])['results'] ?? [];
+        /** @var array{facetDistribution: array<string, int>} $firstResult */
+        $firstResult = current($results);
+        $firstResult['facetDistribution'] = array_merge(...array_column($results, 'facetDistribution'));
+
+        return new SearchResult($firstResult);
+    }
+
+    /**
+     * @param array<string> $facets
+     *
+     * @return array<SearchQuery>
+     */
+    private function createSearchQueries(string $indexUid, array $facets, ?string $query): array
+    {
+        $searchQueries = [];
+
+        foreach ($facets as $facet) {
+            $facets = [$facet];
+            $filteredFacets = array_filter(
+                $parameters['facets'] ?? [],
+                static fn ($value) => $value !== $facet,
+                \ARRAY_FILTER_USE_KEY,
+            );
+            $filter = $this->filterBuilder->build($filteredFacets);
+
+            $searchQueries[] = $this->buildSearchQuery($indexUid, $query, $facets, $filter)->setLimit(1);
         }
 
-        return $this->client->index($this->indexNameResolver->resolve($this->index))->search($query, $searchParams);
+        return $searchQueries;
+    }
+
+    /**
+     * @param array<string> $facets
+     * @param array<string, mixed> $filter
+     */
+    private function buildSearchQuery(string $indexUid, ?string $query, array $facets, array $filter): SearchQuery
+    {
+        return (new SearchQuery())
+            ->setIndexUid($indexUid)
+            ->setQuery($query ?? '')
+            ->setFacets($facets)
+            ->setFilter($filter)
+        ;
     }
 }

src/Meilisearch/Builder/CompositeFilterBuilder.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Builder;
+
+final class CompositeFilterBuilder implements FilterBuilderInterface
+{
+    /**
+     * @param iterable<FilterBuilderInterface> $filterBuilders
+     */
+    public function __construct(
+        private readonly iterable $filterBuilders,
+    ) {
+    }
+
+    public function build(array $facets): string|array
+    {
+        $filters = [];
+
+        foreach ($this->filterBuilders as $filterBuilder) {
+            if ($filterBuilder->supports($facets)) {
+                $filters[] = $filterBuilder->build($facets);
+            }
+        }
+
+        return $filters;
+    }
+
+    public function supports(array $facets): bool
+    {
+        return true;
+    }
+}

src/Meilisearch/Builder/FilterBuilderInterface.php

@@ -4,7 +4,9 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Builder;
 
 interface FilterBuilderInterface
 {
-    public function build(array $parameters): array;
+    public function build(array $facets): string|array;
+
+    public function supports(array $facets): bool;
 }

src/Resources/config/services/meilisearch.xml

@@ -4,9 +4,11 @@
     <services>
         <!-- Builder -->
         <service id="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface"
-                 alias="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilder"/>
+                 alias="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\CompositeFilterBuilder"/>
 
-        <service id="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilder"/>
+        <service id="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\CompositeFilterBuilder">
+            <argument type="tagged_iterator" tag="setono_sylius_meilisearch.filter_builder"/>
+        </service>
 
         <!-- Synonym resolver -->
         <service id="Setono\SyliusMeilisearchPlugin\Meilisearch\SynonymResolverInterface"

tests/Application/config/services.yaml

@@ -2,3 +2,16 @@
 # https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
 parameters:
     locale: en_US
+
+services:
+    _defaults:
+        autowire: true      # Automatically injects dependencies in your services.
+        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
+
+    TestApp\:
+        resource: '../src/*'
+        exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'
+
+    _instanceof:
+        Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface:
+            tags: [ 'setono_sylius_meilisearch.filter_builder' ]

tests/Application/src/FilterBuilder/BrandFilterBuilder.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TestApp\FilterBuilder;
+
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
+
+final class BrandFilterBuilder implements FilterBuilderInterface
+{
+    public function build(array $facets): string|array
+    {
+        $brandQuery = [];
+        /** @var string $size */
+        foreach ($facets['brand'] as $size) {
+            $brandQuery[] = sprintf('brand = "%s"', $size);
+        }
+
+        return '(' . implode(' OR ', $brandQuery) . ')';
+    }
+
+    public function supports(array $facets): bool
+    {
+        return isset($facets['brand']);
+    }
+}

tests/Application/src/FilterBuilder/OnSaleFilterBuilder.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Application\src\FilterBuilder;
+
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
+
+final class OnSaleFilterBuilder implements FilterBuilderInterface
+{
+    public function build(array $facets): string|array
+    {
+        return 'onSale = true';
+    }
+
+    public function supports(array $facets): bool
+    {
+        return isset($facets['onSale']);
+    }
+}

tests/Application/src/FilterBuilder/SizeFilterBuilder.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TestApp\FilterBuilder;
+
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
+
+final class SizeFilterBuilder implements FilterBuilderInterface
+{
+    public function build(array $facets): string|array
+    {
+        $sizeQuery = [];
+        /** @var string $size */
+        foreach ($facets['size'] as $size) {
+            $sizeQuery[] = sprintf('size = "%s"', $size);
+        }
+
+        return '(' . implode(' OR ', $sizeQuery) . ')';
+    }
+
+    public function supports(array $facets): bool
+    {
+        return isset($facets['size']);
+    }
+}

tests/Functional/SearchTest.php

@@ -73,4 +73,17 @@ public function testItSortsSearchResultsByNewestDate(): void
             $previousKey = $key;
         }
     }
+
+    public function testItAlwaysDisplaysFullFacetDistribution(): void
+    {
+        /** @var SearchEngine $searchEngine */
+        $searchEngine = self::getContainer()->get(SearchEngine::class);
+        $result = $searchEngine->execute(
+            'jeans',
+            ['facets' => ['brand' => ['Celsius small']]],
+        );
+
+        $this->assertSame(1, $result->getHitsCount());
+        $this->assertCount(4, $result->getFacetDistribution()['brand']);
+    }
 }

tests/Unit/Meilisearch/Builder/CompositeFilterBuilderTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Meilisearch\Builder;
+
+use PHPUnit\Framework\TestCase;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\CompositeFilterBuilder;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
+
+final class CompositeFilterBuilderTest extends TestCase
+{
+    public function test_it_returns_filters(): void
+    {
+        $brandFilterBuilder = $this->createMock(FilterBuilderInterface::class);
+        $brandFilterBuilder->method('build')->willReturn('(brand = "brand1")');
+        $brandFilterBuilder->method('supports')->willReturn(true);
+
+        $sizeFilterBuilder = $this->createMock(FilterBuilderInterface::class);
+        $sizeFilterBuilder->method('build')->willReturn('(size = "size1" OR size = "size2")');
+        $sizeFilterBuilder->method('supports')->willReturn(true);
+
+        $compositeFilterBuilder = new CompositeFilterBuilder([$brandFilterBuilder, $sizeFilterBuilder]);
+
+        $filters = $compositeFilterBuilder->build([
+            'onSale' => true,
+            'brand' => ['brand1'],
+            'size' => ['size1', 'size2'],
+        ]);
+
+        $this->assertSame([
+            '(brand = "brand1")',
+            '(size = "size1" OR size = "size2")',
+        ], $filters);
+    }
+
+    public function test_it_uses_only_supported_filter_builders(): void
+    {
+        $brandFilterBuilder = $this->createMock(FilterBuilderInterface::class);
+        $brandFilterBuilder->expects($this->never())->method('build');
+        $brandFilterBuilder->method('supports')->willReturn(false);
+
+        $sizeFilterBuilder = $this->createMock(FilterBuilderInterface::class);
+        $sizeFilterBuilder->method('build')->willReturn('(size = "size1" OR size = "size2")');
+        $sizeFilterBuilder->method('supports')->willReturn(true);
+
+        $compositeFilterBuilder = new CompositeFilterBuilder([$brandFilterBuilder, $sizeFilterBuilder]);
+
+        $filters = $compositeFilterBuilder->build([
+            'onSale' => true,
+            'size' => ['size1', 'size2'],
+        ]);
+
+        $this->assertSame([
+            '(size = "size1" OR size = "size2")',
+        ], $filters);
+    }
+}