Rename 'sort' query parameter to 's'

src/Engine/SearchRequest.php

@@ -8,6 +8,14 @@
 
 final class SearchRequest
 {
+    public const QUERY_PARAMETER_SEARCH = 'q';
+
+    public const QUERY_PARAMETER_PAGE = 'p';
+
+    public const QUERY_PARAMETER_SORT = 's';
+
+    public const QUERY_PARAMETER_FILTER = 'facets';
+
     // todo we need the hits per page here
     public function __construct(
         public readonly ?string $query,
@@ -20,15 +28,14 @@ public function __construct(
 
     public static function fromRequest(Request $request): self
     {
-        $q = $request->query->get('q');
+        $q = $request->query->get(self::QUERY_PARAMETER_SEARCH);
         if (!is_string($q)) {
             $q = null;
         }
 
-        $page = max(1, (int) $request->query->get('p', 1));
+        $page = max(1, (int) $request->query->get(self::QUERY_PARAMETER_PAGE, 1));
 
-        // todo rename sort to s?
-        $sort = $request->query->get('sort');
+        $sort = $request->query->get(self::QUERY_PARAMETER_SORT);
         if (!is_string($sort)) {
             $sort = null;
         }

src/Form/Builder/SearchFormBuilder.php

@@ -7,6 +7,7 @@
 use Meilisearch\Search\SearchResult;
 use Setono\SyliusMeilisearchPlugin\Config\Index;
 use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
+use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -118,7 +119,7 @@
 
         $searchFormBuilder->add($facetsFormBuilder);
 
-        $searchFormBuilder->add('sort', ChoiceType::class, [
+        $searchFormBuilder->add(SearchRequest::QUERY_PARAMETER_SORT, ChoiceType::class, [
             'choices' => [
                 'Cheapest first' => 'price:asc',
                 'Biggest discount' => 'discount:desc',

src/Resources/public/js/search.js

@@ -70,7 +70,7 @@ class SearchManager {
                 field.dispatchEvent(new CustomEvent('search:facet-changed', { bubbles: true }));
             } else if(field.name === 'p') {
                 field.dispatchEvent(new CustomEvent('search:page-changed', { bubbles: true }));
-            } else if(field.name.startsWith('sort')) {
+            } else if(field.classList.contains('sort')) {
                 field.dispatchEvent(new CustomEvent('search:sort-changed', { bubbles: true }));
             }
         });

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

@@ -1 +1 @@
-{{ form_widget(searchForm.sort) }}
+{{ form_widget(searchForm.s, { 'attr': { 'class': 'sort' } }) }}

tests/Application/templates/bundles/SetonoSyliusMeilisearchPlugin/search/index.html.twig

@@ -84,13 +84,13 @@
         /**
          * Sort
          */
-        #sort {
+        .sort {
             padding: 0 !important;
             margin: 0 !important;
             text-align-last: right;
         }
 
-        #sort option {
+        .sort option {
             direction: rtl;
         }
     </style>

tests/Unit/Engine/SearchRequestTest.php

@@ -33,7 +33,7 @@ public function it_creates_search_request(): void
      */
     public function it_creates_from_request(): void
     {
-        $request = Request::create('/search', 'GET', ['q' => 'jeans', 'facets' => ['brand' => ['Celsius small', 'You are breathtaking'], 'price' => ['min' => '30', 'max' => '45']], 'p' => 2, 'sort' => 'price:asc']);
+        $request = Request::create('/search', 'GET', ['q' => 'jeans', 'facets' => ['brand' => ['Celsius small', 'You are breathtaking'], 'price' => ['min' => '30', 'max' => '45']], 'p' => 2, 's' => 'price:asc']);
         $searchRequest = SearchRequest::fromRequest($request);
 
         self::assertSame('jeans', $searchRequest->query);