Multisearch + dynamic filters V2

src/Document/Metadata/Facet.php

@@ -6,7 +6,9 @@
 
 final class Facet
 {
-    public function __construct(public readonly string $name)
-    {
+    public function __construct(
+        public readonly string $name,
+        public readonly string $type,
+    ) {
     }
 }

src/Document/Metadata/Metadata.php

@@ -72,7 +72,7 @@ private function loadAttributes(\ReflectionProperty|\ReflectionMethod $attribute
             }
 
             if ($attribute instanceof FacetAttribute) {
-                $this->facetableAttributes[$name] = new Facet($name);
+                $this->facetableAttributes[$name] = new Facet($name, self::getFacetType($attributesAware));
             }
 
             if ($attribute instanceof SearchableAttribute) {
@@ -167,4 +167,13 @@ private static function resolveName(\ReflectionProperty|\ReflectionMethod $refle
 
         return null;
     }
+
+    private static function getFacetType(\ReflectionProperty|\ReflectionMethod $attributesAware): string
+    {
+        if ($attributesAware instanceof \ReflectionProperty) {
+            return str_replace('?', '', (string) $attributesAware->getType());
+        }
+
+        return str_replace('?', '', (string) $attributesAware->getReturnType());
+    }
 }

src/Engine/SearchEngine.php

@@ -5,41 +5,68 @@
 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\Builder\FilterBuilderInterface;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Filter\FilterBuilderInterface;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\MainQueryBuilderInterface;
+use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\SubQueriesBuilderInterface;
 use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
 
 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 int $hitsPerPage,
+        private readonly MainQueryBuilderInterface $mainQueryBuilder,
+        private readonly SubQueriesBuilderInterface $subQueriesBuilder,
     ) {
     }
 
     public function execute(?string $query, array $parameters = []): SearchResult
     {
-        $page = max(1, (int) ($parameters['p'] ?? 1));
-        $sort = (string) ($parameters['sort'] ?? '');
-
+        $indexName = $this->indexNameResolver->resolve($this->index);
         $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
+        $facetsNames = $metadata->getFacetableAttributeNames();
+        $facets = $metadata->getFacetableAttributes();
+
+        /** @var array<string, mixed> $facetsFilter */
+        $facetsFilter = (array) ($parameters['facets'] ?? []);
+        /** @var array<string, mixed> $filters */
+        $filters = $this->filterBuilder->build($facets, $facetsFilter);
+
+        $mainQuery = $this->mainQueryBuilder->build(
+            $indexName,
+            $query ?? '',
+            $facetsNames,
+            $filters,
+            max(1, (int) ($parameters['p'] ?? 1)),
+            (string) ($parameters['sort'] ?? ''),
+        );
+
+        /** @var list<SearchQuery> $queries */
+        $queries = array_merge(
+            [$mainQuery],
+            $this->subQueriesBuilder->build($indexName, $query ?? '', $facets, $facetsFilter),
+        );
+
+        /** @var array<SearchResult> $results */
+        $results = $this->client->multiSearch($queries)['results'] ?? [];
+
+        return $this->provideSearchResult($results);
+    }
+
+    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'));
 
-        $searchParams = [
-            'facets' => $metadata->getFacetableAttributeNames(),
-            'filter' => $this->filterBuilder->build($parameters),
-            'hitsPerPage' => $this->hitsPerPage,
-            'page' => $page,
-        ];
-        if ('' !== $sort) {
-            $searchParams['sort'] = [$sort];
-        }
-
-        return $this->client->index($this->indexNameResolver->resolve($this->index))->search($query, $searchParams);
+        return new SearchResult($firstResult);
     }
 }

src/Form/Builder/CheckboxFacetFormBuilder.php

@@ -4,16 +4,17 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\FormBuilderInterface;
 use function Symfony\Component\String\u;
 
 final class CheckboxFacetFormBuilder implements FacetFormBuilderInterface
 {
-    public function build(FormBuilderInterface $builder, string $name, array $values, array $stats = null): void
+    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void
     {
-        $builder->add($name, CheckboxType::class, [
-            'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($name)->snake()),
+        $builder->add($facet->name, CheckboxType::class, [
+            'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($facet->name)->snake()),
             'label_translation_parameters' => [
                 '%count%' => $values['true'],
             ],
@@ -22,11 +23,9 @@
         ]);
     }
 
-    public function supports(string $name, array $values, array $stats = null): bool
+    public function supports(Facet $facet, array $values, array $stats = null): bool
     {
-        $c = count($values);
-
-        return match ($c) {
+        return $facet->type === 'bool' && match (count($values)) {
             1 => isset($values['true']),
             2 => isset($values['true'], $values['false']),
             default => false,

src/Form/Builder/ChoiceFacetFormBuilder.php

@@ -4,19 +4,20 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\FormBuilderInterface;
 use function Symfony\Component\String\u;
 
 final class ChoiceFacetFormBuilder implements FacetFormBuilderInterface
 {
-    public function build(FormBuilderInterface $builder, string $name, array $values, array $stats = null): void
+    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void
     {
         $keys = array_keys($values);
         $choices = array_combine($keys, $keys);
 
-        $builder->add($name, ChoiceType::class, [
-            'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($name)->snake()),
+        $builder->add($facet->name, ChoiceType::class, [
+            'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($facet->name)->snake()),
             'choices' => $choices,
             'choice_label' => fn (string $key) => sprintf('%s (%d)', $key, $values[$key]),
             'expanded' => true,
@@ -26,8 +27,12 @@
         ]);
     }
 
-    public function supports(string $name, array $values, array $stats = null): bool
+    public function supports(Facet $facet, array $values, array $stats = null): bool
     {
+        if ($facet->type !== 'array') {
+            return false;
+        }
+
         $keys = array_keys($values);
         if (count($keys) < 2) {
             return false;

src/Form/Builder/CompositeFacetFormBuilder.php

@@ -5,30 +5,31 @@
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
 use Setono\CompositeCompilerPass\CompositeService;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
 use Symfony\Component\Form\FormBuilderInterface;
 
 /**
  * @extends CompositeService<FacetFormBuilderInterface>
  */
 final class CompositeFacetFormBuilder extends CompositeService implements FacetFormBuilderInterface
 {
-    public function build(FormBuilderInterface $builder, string $name, array $values, array $stats = null): void
+    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void
     {
         foreach ($this->services as $service) {
-            if ($service->supports($name, $values, $stats)) {
-                $service->build($builder, $name, $values, $stats);
+            if ($service->supports($facet, $values, $stats)) {
+                $service->build($builder, $facet, $values, $stats);
 
                 return;
             }
         }
 
-        throw new \RuntimeException(sprintf('No facet form builder supports the facet with name "%s"', $name));
+        throw new \RuntimeException(sprintf('No facet form builder supports the facet with name "%s"', $facet->name));
     }
 
-    public function supports(string $name, array $values, array $stats = null): bool
+    public function supports(Facet $facet, array $values, array $stats = null): bool
     {
         foreach ($this->services as $service) {
-            if ($service->supports($name, $values, $stats)) {
+            if ($service->supports($facet, $values, $stats)) {
                 return true;
             }
         }

src/Form/Builder/FacetFormBuilderInterface.php

@@ -4,21 +4,20 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
 use Symfony\Component\Form\FormBuilderInterface;
 
 interface FacetFormBuilderInterface
 {
     /**
-     * @param string $name The name of the facet. This could be 'price' or 'color' for instance
      * @param array<string, int> $values The values of the facet. This could be ['red' => 10, 'blue' => 5] where the key is the facet value and the value is the number of matching documents
      * @param array{min: int|float, max: int|float}|null $stats The stats of the facet. This could be ['min' => 10, 'max' => 100] where min is the minimum value and max is the maximum value
      */
-    public function build(FormBuilderInterface $builder, string $name, array $values, array $stats = null): void;
+    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void;
 
     /**
-     * @param string $name The name of the facet. This could be 'price' or 'color' for instance
      * @param array<string, int> $values
      * @param array{min: int|float, max: int|float}|null $stats
      */
-    public function supports(string $name, array $values, array $stats = null): bool;
+    public function supports(Facet $facet, array $values, array $stats = null): bool;
 }

src/Form/Builder/RangeFacetFormBuilder.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
+
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
+use Setono\SyliusMeilisearchPlugin\Form\Type\RangeType;
+use Symfony\Component\Form\FormBuilderInterface;
+use function Symfony\Component\String\u;
+
+final class RangeFacetFormBuilder implements FacetFormBuilderInterface
+{
+    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void
+    {
+        if ($stats === null || !isset($stats['min']) && !isset($stats['max'])) {
+            return;
+        }
+
+        $builder->add($facet->name, RangeType::class, [
+            'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($facet->name)->snake()),
+            'required' => false,
+            'block_prefix' => 'setono_sylius_meilisearch_facet_range',
+        ]);
+    }
+
+    public function supports(Facet $facet, array $values, array $stats = null): bool
+    {
+        return $facet->type === 'float';
+    }
+}

src/Form/Builder/SearchFormBuilder.php

@@ -5,6 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
 use Meilisearch\Search\SearchResult;
+use Setono\SyliusMeilisearchPlugin\Config\Index;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -16,11 +18,15 @@ final class SearchFormBuilder implements SearchFormBuilderInterface
     public function __construct(
         private readonly FormFactoryInterface $formFactory,
         private readonly FacetFormBuilderInterface $facetFormBuilder,
+        private readonly MetadataFactoryInterface $metadataFactory,
+        private readonly Index $index,
     ) {
     }
 
     public function build(SearchResult $searchResult): FormInterface
     {
+        $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
+
         $searchFormBuilder = $this
             ->formFactory
             ->createNamedBuilder('', options: [
@@ -49,6 +55,8 @@ public function build(SearchResult $searchResult): FormInterface
          */
         $facetStats = $searchResult->getFacetStats();
 
+        $facets = $metadata->getFacetableAttributes();
+
         /**
          * Here is an example of the facet distribution array
          *
@@ -70,8 +78,8 @@ public function build(SearchResult $searchResult): FormInterface
          * @var array<string, int> $values
          */
         foreach ($searchResult->getFacetDistribution() as $name => $values) {
-            if ($this->facetFormBuilder->supports($name, $values, $facetStats[$name] ?? null)) {
-                $this->facetFormBuilder->build($facetsFormBuilder, $name, $values, $facetStats[$name] ?? null);
+            if ($this->facetFormBuilder->supports($facets[$name], $values, $facetStats[$name] ?? null)) {
+                $this->facetFormBuilder->build($facetsFormBuilder, $facets[$name], $values, $facetStats[$name] ?? null);
             }
         }
 

src/Form/Type/RangeType.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Type;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\NumberType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+final class RangeType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('min', NumberType::class, [
+                'label' => 'Min',
+            ])
+            ->add('max', NumberType::class, [
+                'label' => 'Max',
+            ])
+        ;
+    }
+
+    public function getBlockPrefix(): string
+    {
+        return 'setono_sylius_meilisearch_range';
+    }
+}