Encapsulate the search result in our own object

src/Controller/Action/SearchAction.php

@@ -49,7 +49,7 @@ public function __invoke(Request $request): Response
 
         $items = [];
         /** @var array{entityClass: class-string<IndexableInterface>, entityId: mixed} $hit */
-        foreach ($searchResult->getHits() as $hit) {
+        foreach ($searchResult->hits as $hit) {
             $item = $this->getManager($hit['entityClass'])->find($hit['entityClass'], $hit['entityId']);
             if (null === $item) {
                 continue;

src/Engine/SearchEngine.php

@@ -5,7 +5,7 @@
 namespace Setono\SyliusMeilisearchPlugin\Engine;
 
 use Meilisearch\Client;
-use Meilisearch\Search\SearchResult;
+use Meilisearch\Search\SearchResult as MeilisearchSearchResult;
 use Setono\SyliusMeilisearchPlugin\Config\Index;
 use Setono\SyliusMeilisearchPlugin\Meilisearch\Query\MultiSearchBuilderInterface;
 
@@ -18,24 +18,26 @@
     ) {
     }
 
     public function execute(SearchRequest $searchRequest): SearchResult
     {
         $queries = $this->multiSearchBuilder->build($this->index, $searchRequest);
 
-        /** @var array<SearchResult> $results */
+        /** @var array<MeilisearchSearchResult> $results */
         $results = $this->client->multiSearch($queries)['results'] ?? [];
 
-        return $this->provideSearchResult($results);
+        $result = $this->provideSearchResult($results);
+
+        return SearchResult::fromMeilisearchSearchResult($this->index, $result);
     }
 
-    private function provideSearchResult(array $results): SearchResult
+    private function provideSearchResult(array $results): MeilisearchSearchResult
     {
         /** @var array{facetDistribution: array<string, int>} $firstResult */
         $firstResult = current($results);
 
         /** @psalm-suppress MixedArgument (just for now) */
         $firstResult['facetDistribution'] = array_merge(...array_column($results, 'facetDistribution'));
 
-        return new SearchResult($firstResult);
+        return new MeilisearchSearchResult($firstResult);
     }
 }

src/Engine/SearchEngineInterface.php

@@ -4,9 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Engine;
 
-use Meilisearch\Search\SearchResult;
-
 interface SearchEngineInterface
 {
     public function execute(SearchRequest $searchRequest): SearchResult;
 }

src/Engine/SearchResult.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Meilisearch\Search\SearchResult as MeilisearchSearchResult;
+use Setono\SyliusMeilisearchPlugin\Config\Index;
+use Webmozart\Assert\Assert;
+
+final class SearchResult
+{
+    public function __construct(
+        /** The index that was queried */
+        public readonly Index $index,
+
+        /** @var array<int, array> $hits */
+        public readonly array $hits,
+        public readonly int $totalHits,
+        public readonly int $page,
+        public readonly int $pageSize,
+        public readonly int $totalPages,
+
+        /** @var array<string, mixed> $facetStats */
+        public readonly array $facetStats,
+
+        /** @var array<string, mixed> $facetDistribution */
+        public readonly array $facetDistribution,
+    ) {
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    public static function fromMeilisearchSearchResult(Index $index, MeilisearchSearchResult $meilisearchSearchResult): self
+    {
+        // TODO support estimated total number of search results. See https://www.meilisearch.com/docs/reference/api/search#exhaustive-and-estimated-total-number-of-search-results
+        $page = $meilisearchSearchResult->getPage();
+        Assert::notNull($page);
+
+        $totalPages = $meilisearchSearchResult->getTotalPages();
+        Assert::notNull($totalPages);
+
+        $totalHits = $meilisearchSearchResult->getTotalHits();
+        Assert::notNull($totalHits);
+
+        $pageSize = $meilisearchSearchResult->getHitsPerPage();
+        Assert::notNull($pageSize);
+
+        return new self(
+            $index,
+            $meilisearchSearchResult->getHits(),
+            $totalHits,
+            $page,
+            $pageSize,
+            $totalPages,
+            $meilisearchSearchResult->getFacetStats(),
+            $meilisearchSearchResult->getFacetDistribution(),
+        );
+    }
+}

src/Event/Search/SearchResultReceived.php

@@ -4,11 +4,11 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Event\Search;
 
-use Meilisearch\Search\SearchResult;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchResult;
 
 final class SearchResultReceived
 {
     public function __construct(public readonly SearchResult $searchResult)
     {
     }
 }

src/Form/Builder/SearchFormBuilder.php

@@ -4,10 +4,10 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
-use Meilisearch\Search\SearchResult;
 use Setono\SyliusMeilisearchPlugin\Config\Index;
 use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
 use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchResult;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -25,7 +25,7 @@
     ) {
     }
 
     public function build(SearchResult $searchResult): FormInterface
     {
         $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
 
@@ -55,7 +55,7 @@
          *
          * @var array<string, array{min: int|float, max: int|float}> $facetStats
          */
-        $facetStats = $searchResult->getFacetStats();
+        $facetStats = $searchResult->facetStats;
 
         $facets = $metadata->getFacetableAttributes();
 
@@ -108,7 +108,7 @@
          * @var string $name
          * @var array<string, int> $values
          */
-        foreach ($searchResult->getFacetDistribution() as $name => $values) {
+        foreach ($searchResult->facetDistribution as $name => $values) {
             if (!isset($facets[$name])) {
                 continue;
             }
@@ -129,22 +129,17 @@
 
     private function buildPagination(SearchResult $searchResult, FormBuilderInterface $builder): void
     {
-        $page = $searchResult->getPage();
-        if (null === $page) {
-            return;
-        }
-
         $choices = [];
 
         // current is a special choice that we need to keep the page query parameter in the url on form submission
-        $choices['__current'] = $page;
+        $choices['__current'] = $searchResult->page;
 
-        if ($searchResult->getPage() > 1) {
-            $choices['setono_sylius_meilisearch.form.search.pagination.previous'] = $page - 1;
+        if ($searchResult->page > 1) {
+            $choices['setono_sylius_meilisearch.form.search.pagination.previous'] = $searchResult->page - 1;
         }
 
-        if ($searchResult->getPage() < $searchResult->getTotalPages()) {
-            $choices['setono_sylius_meilisearch.form.search.pagination.next'] = $page + 1;
+        if ($searchResult->page < $searchResult->totalPages) {
+            $choices['setono_sylius_meilisearch.form.search.pagination.next'] = $searchResult->page + 1;
         }
 
         $builder->add('p', ChoiceType::class, [

src/Form/Builder/SearchFormBuilderInterface.php

@@ -4,10 +4,10 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
-use Meilisearch\Search\SearchResult;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchResult;
 use Symfony\Component\Form\FormInterface;
 
 interface SearchFormBuilderInterface
 {
     public function build(SearchResult $searchResult): FormInterface;
 }

src/Resources/views/search/_hits_count.html.twig

@@ -1 +1,2 @@
-{{ searchResult.hitsCount }} results
+{# @var searchResult \Setono\SyliusMeilisearchPlugin\Engine\SearchResult #}
+{{ searchResult.totalHits }} results

tests/Functional/SearchPaginationTest.php

@@ -15,18 +15,18 @@ public function testItPaginatesSearchResults(): void
         $searchEngine = self::getContainer()->get(SearchEngine::class);
         $firstPageResult = $searchEngine->execute(new SearchRequest('jeans'));
 
-        self::assertSame(8, $firstPageResult->getTotalHits());
-        self::assertSame(3, $firstPageResult->getHitsPerPage());
-        self::assertSame(1, $firstPageResult->getPage());
-        self::assertSame(3, $firstPageResult->getTotalPages());
+        self::assertSame(8, $firstPageResult->totalHits);
+        self::assertSame(3, $firstPageResult->pageSize);
+        self::assertSame(1, $firstPageResult->page);
+        self::assertSame(3, $firstPageResult->totalPages);
 
         $secondPageResult = $searchEngine->execute(new SearchRequest('jeans', page: 2));
-        self::assertSame(2, $secondPageResult->getPage());
+        self::assertSame(2, $secondPageResult->page);
 
-        self::assertNotSame($firstPageResult->getHits(), $secondPageResult->getHits());
+        self::assertNotSame($firstPageResult->hits, $secondPageResult->hits);
 
         $thirdPageResult = $searchEngine->execute(new SearchRequest('jeans', page: 3));
-        self::assertSame(3, $thirdPageResult->getPage());
-        self::assertCount(2, $thirdPageResult->getHits());
+        self::assertSame(3, $thirdPageResult->page);
+        self::assertCount(2, $thirdPageResult->hits);
     }
 }

tests/Functional/SearchSortingTest.php

@@ -15,17 +15,17 @@ public function testItSortsSearchResultsByLowestPrice(): void
         $searchEngine = self::getContainer()->get(SearchEngine::class);
         $result = $searchEngine->execute(new SearchRequest('jeans', sort: 'price:asc'));
 
-        self::assertSame(8, $result->getTotalHits());
+        self::assertSame(8, $result->totalHits);
 
         $previousKey = null;
-        foreach ($result->getHits() as $key => $hit) {
+        foreach ($result->hits as $key => $hit) {
             if ($previousKey === null) {
                 $previousKey = $key;
 
                 continue;
             }
 
-            $previousHit = (array) $result->getHit($previousKey);
+            $previousHit = $result->hits[$previousKey];
             self::assertGreaterThanOrEqual($previousHit['price'], $hit['price']);
             $previousKey = $key;
         }
@@ -37,17 +37,17 @@ public function testItSortsSearchResultsByNewestDate(): void
         $searchEngine = self::getContainer()->get(SearchEngine::class);
         $result = $searchEngine->execute(new SearchRequest('jeans', sort: 'createdAt:desc'));
 
-        self::assertSame(8, $result->getTotalHits());
+        self::assertSame(8, $result->totalHits);
 
         $previousKey = null;
-        foreach ($result->getHits() as $key => $hit) {
+        foreach ($result->hits as $key => $hit) {
             if ($previousKey === null) {
                 $previousKey = $key;
 
                 continue;
             }
 
-            $previousHit = (array) $result->getHit($previousKey);
+            $previousHit = $result->hits[$previousKey];
             self::assertLessThanOrEqual($previousHit['createdAt'], $hit['createdAt']);
             $previousKey = $key;
         }
@@ -61,7 +61,7 @@ public function testItSortsResultsByBiggestDiscount(): void
 
         $previousDiscount = null;
         /** @var array{discount: float} $hit */
-        foreach ($result->getHits() as $hit) {
+        foreach ($result->hits as $hit) {
             if (null === $previousDiscount) {
                 $previousDiscount = $hit['discount'];
             }

tests/Functional/SearchTest.php

@@ -18,7 +18,7 @@ public function testItProvidesSearchResults(): void
         $searchEngine = self::getContainer()->get(SearchEngine::class);
         $result = $searchEngine->execute(new SearchRequest('jeans'));
 
-        self::assertSame(8, $result->getTotalHits());
+        self::assertSame(8, $result->totalHits);
     }
 
     public function testItProvidesSearchResultByMultipleCriteria(): void
@@ -34,7 +34,7 @@ public function testItProvidesSearchResultByMultipleCriteria(): void
             ]),
         );
 
-        foreach ($result->getHits() as $hit) {
+        foreach ($result->hits as $hit) {
             self::assertGreaterThanOrEqual($priceBounds[0], (int) $hit['price']);
             self::assertLessThanOrEqual($priceBounds[1], (int) $hit['price']);
             self::assertContains(((array) $hit['brand'])[0], ['Celsius small', 'You are breathtaking']);
@@ -51,8 +51,8 @@ public function testItAlwaysDisplaysFullFacetDistribution(): void
             ]),
         );
 
-        $this->assertSame(1, $result->getHitsCount());
-        $this->assertCount(4, (array) $result->getFacetDistribution()['brand']);
+        $this->assertSame(1, $result->totalHits);
+        $this->assertCount(4, (array) $result->facetDistribution['brand']);
     }
 
     /**