Add sorting of results

composer.json

@@ -67,6 +67,7 @@
         "psalm/plugin-phpunit": "^0.18.4",
         "setono/code-quality-pack": "^2.8.2",
         "sylius/sylius": "~1.12.18",
+        "symfony/browser-kit": "^5.4 || ^6.4 || ^7.0",
         "symfony/debug-bundle": "^5.4 || ^6.4 || ^7.0",
         "symfony/dotenv": "^5.4 || ^6.4 || ^7.0",
         "symfony/http-client": "^5.4 || ^6.4 || ^7.0",
@@ -107,7 +108,7 @@
         "analyse": "psalm",
         "check-style": "ecs check",
         "fix-style": "ecs check --fix",
-        "phpunit": "phpunit",
+        "phpunit": "phpunit --exclude-group=functional",
         "rector": "rector"
     }
 }

src/Controller/Action/SearchAction.php

@@ -5,15 +5,10 @@
 namespace Setono\SyliusMeilisearchPlugin\Controller\Action;
 
 use Doctrine\Persistence\ManagerRegistry;
-use Meilisearch\Client;
 use Setono\Doctrine\ORMTrait;
-use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
-use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchEngineInterface;
 use Setono\SyliusMeilisearchPlugin\Form\Builder\SearchFormBuilderInterface;
-use Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
-use Setono\SyliusMeilisearchPlugin\Resolver\IndexName\IndexNameResolverInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Twig\Environment;
@@ -23,43 +18,26 @@
 {
     use ORMTrait;
 
     public function __construct(
         ManagerRegistry $managerRegistry,
         private readonly Environment $twig,
-        private readonly IndexNameResolverInterface $indexNameResolver,
-        private readonly Client $client,
-        private readonly MetadataFactoryInterface $metadataFactory,
         private readonly SearchFormBuilderInterface $searchFormBuilder,
-        private readonly FilterBuilderInterface $filterBuilder,
-        private readonly Index $index,
-        private readonly int $hitsPerPage,
+        private readonly SearchEngineInterface $searchEngine,
     ) {
         $this->managerRegistry = $managerRegistry;
     }
 
     public function __invoke(Request $request): Response
     {
-        $q = $request->query->get('q');
-        Assert::nullOrString($q);
+        $query = $request->query->get('q');
+        Assert::nullOrString($query);
 
-        $page = (int) $request->query->get('p', 1);
-        $page = max(1, $page);
-
-        $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
-
-        $searchResult = $this->client->index($this->indexNameResolver->resolve($this->index))->search($q, [
-            'facets' => array_map(static fn (Facet $facet) => $facet->name, $metadata->getFacets()),
-            'filter' => $this->filterBuilder->build($request),
-            'sort' => ['price:asc'],
-            'hitsPerPage' => $this->hitsPerPage,
-            'page' => $page,
-        ]);
+        $searchResult = $this->searchEngine->execute($query, $request->query->all());
 
         $searchForm = $this->searchFormBuilder->build($searchResult);
         $searchForm->handleRequest($request);
 
         $items = [];
-
         /** @var array{entityClass: class-string<IndexableInterface>, entityId: mixed} $hit */
         foreach ($searchResult->getHits() as $hit) {
             $items[] = $this->getManager($hit['entityClass'])->find($hit['entityClass'], $hit['entityId']);

src/Engine/SearchEngine.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Meilisearch\Client;
+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;
+
+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,
+    ) {
+    }
+
+    public function execute(?string $query, array $parameters = []): SearchResult
+    {
+        $page = max(1, (int) ($parameters['p'] ?? 1));
+        $sort = (string) ($parameters['sort'] ?? '');
+
+        $metadata = $this->metadataFactory->getMetadataFor($this->index->document);
+
+        $searchParams = [
+            'facets' => array_map(static fn (Facet $facet) => $facet->name, $metadata->getFacets()),
+            '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);
+    }
+}

src/Engine/SearchEngineInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Meilisearch\Search\SearchResult;
+
+interface SearchEngineInterface
+{
+    public function execute(?string $query, array $parameters = []): SearchResult;
+}

src/Form/Builder/SearchFormBuilder.php

@@ -79,8 +79,10 @@ public function build(SearchResult $searchResult): FormInterface
 
         $searchFormBuilder->add('sort', ChoiceType::class, [
             'choices' => [
-                'Price: Low to High' => 'price:asc',
-                'Price: High to Low' => 'price:desc',
+                'Cheapest first' => 'price:asc',
+                'Biggest discount' => 'discount:desc',
+                'Newest first' => 'createdAt:desc',
+                'Relevance' => '',
             ],
             'required' => false,
             'placeholder' => 'Sort by',

src/Meilisearch/Builder/FilterBuilder.php

@@ -4,16 +4,14 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Builder;
 
-use Symfony\Component\HttpFoundation\Request;
-
 // todo this should be refactored
 final class FilterBuilder implements FilterBuilderInterface
 {
-    public function build(Request $request): array
+    public function build(array $parameters): array
     {
         $filters = [];
 
-        $query = $request->query->has('facets') ? $request->query->all('facets') : $request->query->all();
+        $query = (array) ($parameters['facets'] ?? $parameters);
 
         if (isset($query['onSale'])) {
             $filters[] = 'onSale = true';

src/Meilisearch/Builder/FilterBuilderInterface.php

@@ -4,12 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Meilisearch\Builder;
 
-use Symfony\Component\HttpFoundation\Request;
-
 interface FilterBuilderInterface
 {
-    /**
-     * Takes a Symfony request and returns a filter ready for the Meilisearch client
-     */
-    public function build(Request $request): array;
+    public function build(array $parameters): array;
 }

src/Resources/config/services/conditional/search.xml

@@ -10,13 +10,19 @@
         <service id="Setono\SyliusMeilisearchPlugin\Controller\Action\SearchAction" public="true">
             <argument type="service" id="doctrine"/>
             <argument type="service" id="twig"/>
-            <argument type="service" id="setono_sylius_meilisearch.resolver.index_name"/>
-            <argument type="service" id="Meilisearch\Client"/>
-            <argument type="service" id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface"/>
             <argument type="service" id="Setono\SyliusMeilisearchPlugin\Form\Builder\SearchFormBuilderInterface"/>
+            <argument type="service" id="Setono\SyliusMeilisearchPlugin\Engine\SearchEngineInterface" />
+        </service>
+
+        <service id="Setono\SyliusMeilisearchPlugin\Engine\SearchEngine">
+            <argument type="service" id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface"/>
             <argument type="service" id="Setono\SyliusMeilisearchPlugin\Meilisearch\Builder\FilterBuilderInterface"/>
             <argument type="service" id="setono_sylius_meilisearch.index.search"/>
+            <argument type="service" id="setono_sylius_meilisearch.resolver.index_name"/>
+            <argument type="service" id="Meilisearch\Client"/>
             <argument>%setono_sylius_meilisearch.search.hits_per_page%</argument>
         </service>
+
+        <service id="Setono\SyliusMeilisearchPlugin\Engine\SearchEngineInterface" alias="Setono\SyliusMeilisearchPlugin\Engine\SearchEngine" />
     </services>
 </container>

tests/Functional/SearchTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Functional;
+
+use Setono\SyliusMeilisearchPlugin\Engine\SearchEngine;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/** @group functional */
+final class SearchTest extends WebTestCase
+{
+    private static KernelBrowser $client;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        self::ensureKernelShutdown();
+        self::$client = static::createClient(['environment' => 'test', 'debug' => true]);
+    }
+
+    public function testItProvidesSearchResults(): void
+    {
+        /** @var SearchEngine $searchEngine */
+        $searchEngine = self::getContainer()->get(SearchEngine::class);
+        $result = $searchEngine->execute('jeans');
+
+        self::assertSame(8, $result->getHitsCount());
+    }
+
+    public function testItSortsSearchResultsByLowestPrice(): void
+    {
+        /** @var SearchEngine $searchEngine */
+        $searchEngine = self::getContainer()->get(SearchEngine::class);
+        $result = $searchEngine->execute('jeans', ['sort' => 'price:asc']);
+
+        self::assertSame(8, $result->getHitsCount());
+
+        $previousKey = null;
+        foreach ($result->getHits() as $key => $hit) {
+            if ($previousKey === null) {
+                $previousKey = $key;
+
+                continue;
+            }
+
+            $previousHit = (array) $result->getHit($previousKey);
+            self::assertGreaterThanOrEqual($previousHit['price'], $hit['price']);
+            $previousKey = $key;
+        }
+    }
+
+    public function testItSortsSearchResultsByNewestDate(): void
+    {
+        /** @var SearchEngine $searchEngine */
+        $searchEngine = self::getContainer()->get(SearchEngine::class);
+        $result = $searchEngine->execute('jeans', ['sort' => 'createdAt:desc']);
+
+        self::assertSame(8, $result->getHitsCount());
+
+        $previousKey = null;
+        foreach ($result->getHits() as $key => $hit) {
+            if ($previousKey === null) {
+                $previousKey = $key;
+
+                continue;
+            }
+
+            $previousHit = (array) $result->getHit($previousKey);
+            self::assertLessThanOrEqual($previousHit['createdAt'], $hit['createdAt']);
+            $previousKey = $key;
+        }
+    }
+}

tests/DataMapper/Product/OptionsDataMapperTest.php → tests/Unit/DataMapper/Product/OptionsDataMapperTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Setono\SyliusMeilisearchPlugin\Tests\DataMapper\Product;
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\DataMapper\Product;
 
 use Doctrine\Common\Collections\ArrayCollection;
 use PHPUnit\Framework\TestCase;

tests/DependencyInjection/SetonoSyliusMeilisearchExtensionTest.php → tests/Unit/DependencyInjection/SetonoSyliusMeilisearchExtensionTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Setono\SyliusMeilisearchPlugin\Tests\DependencyInjection;
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\DependencyInjection;
 
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
 use Setono\SyliusMeilisearchPlugin\Controller\Action\SearchAction;

tests/Document/Metadata/MetadataTest.php → tests/Unit/Document/Metadata/MetadataTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Setono\SyliusMeilisearchPlugin\Tests\Document\Metadata;
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Document\Metadata;
 
 use PHPUnit\Framework\TestCase;
 use Setono\SyliusMeilisearchPlugin\Document\Attribute\Facet;

tests/Resolver/IndexName/IndexNameResolverTest.php → tests/Unit/Resolver/IndexName/IndexNameResolverTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Setono\SyliusMeilisearchPlugin\Tests\Resolver\IndexName;
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Resolver\IndexName;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;