feat: sort documents

Author: Benoit POLASZEK

src/Contracts/DocumentsQuery.php

@@ -33,6 +33,11 @@ class DocumentsQuery
      */
     private ?array $ids = null;
 
+    /**
+     * @var list<non-empty-string>|null
+     */
+    private ?array $sort = null;
+
     /**
      * @param non-negative-int $offset
      *
@@ -117,46 +122,34 @@ public function hasFilter(): bool
         return null !== $this->filter;
     }
 
+    public function setSort(array $sort): self
+    {
+        $this->sort = $sort;
+
+        return $this;
+    }
+
     /**
      * @return array{
      *     offset?: non-negative-int,
      *     limit?: non-negative-int,
      *     fields?: non-empty-list<string>|non-empty-string,
      *     filter?: list<non-empty-string|list<non-empty-string>>,
      *     retrieveVectors?: 'true'|'false',
-     *     ids?: string
+     *     ids?: string,
+     *     sort?: non-empty-list<string>,
      * }
      */
     public function toArray(): array
     {
         return array_filter([
             'offset' => $this->offset,
             'limit' => $this->limit,
-            'fields' => $this->getFields(),
+            'fields' => $this->fields,
             'filter' => $this->filter,
             'retrieveVectors' => (null !== $this->retrieveVectors ? ($this->retrieveVectors ? 'true' : 'false') : null),
             'ids' => ($this->ids ?? []) !== [] ? implode(',', $this->ids) : null,
+            'sort' => $this->sort,
         ], static function ($item) { return null !== $item; });
     }
-
-    /**
-     * Prepares fields for request
-     * Fix for 1.2 document/fetch.
-     *
-     * @see https://github.com/meilisearch/meilisearch-php/issues/522
-     *
-     * @return array|string|null
-     */
-    private function getFields()
-    {
-        if (null === $this->fields) {
-            return null;
-        }
-
-        if (null !== $this->filter) {
-            return $this->fields;
-        }
-
-        return implode(',', $this->fields);
-    }
 }

src/Endpoints/Delegates/HandlesDocuments.php

@@ -29,6 +29,12 @@ public function getDocuments(?DocumentsQuery $options = null): DocumentsResults
             if ($options->hasFilter()) {
                 $response = $this->http->post(self::PATH.'/'.$this->uid.'/documents/fetch', $query);
             } else {
+                if (isset($query['sort'])) {
+                    $query['sort'] = implode(',', $query['sort']);
+                }
+                if (isset($query['fields'])) {
+                    $query['fields'] = implode(',', $query['fields']);
+                }
                 $response = $this->http->get(self::PATH.'/'.$this->uid.'/documents', $query);
             }
 

tests/Contracts/DocumentsQueryTest.php

@@ -20,7 +20,7 @@ public function testSetFields(): void
     {
         $data = (new DocumentsQuery())->setLimit(10)->setFields(['abc', 'xyz']);
 
-        self::assertSame(['limit' => 10, 'fields' => 'abc,xyz'], $data->toArray());
+        self::assertSame(['limit' => 10, 'fields' => ['abc', 'xyz']], $data->toArray());
     }
 
     public function testSetLimit(): void

tests/Endpoints/DocumentsTest.php

@@ -666,30 +666,31 @@ public function testGetDocumentsWithFilter(): void
         self::assertCount(3, $response);
     }
 
-    public function testGetDocumentsWithFilterCorrectFieldFormat(): void
+    public function testGetDocumentsWithSort(): void
     {
-        $fields = ['the', 'clash'];
+        $index = $this->createEmptyIndex($this->safeIndexName('movies'));
+        $index->updateSortableAttributes(['id', 'genre']);
+        $index->updateFilterableAttributes(['id', 'genre']);
+        $promise = $index->addDocuments(self::DOCUMENTS);
+        $index->waitForTask($promise['taskUid']);
 
-        $queryFields = (new DocumentsQuery())
-            ->setFields($fields)
-            ->setFilter(['id > 100'])
-            ->toArray()['fields'];
+        $response = $index->getDocuments((new DocumentsQuery())->setSort(['genre:desc', 'id:asc']));
+        self::assertSame(2, $response[0]['id']);
 
-        self::assertSame($fields, $queryFields);
+        $response = $index->getDocuments((new DocumentsQuery())->setSort(['genre:desc', 'id:desc']));
+        self::assertSame(1344, $response[0]['id']);
     }
 
-    public function testGetDocumentsWithoutFilterCorrectFieldsFormat(): void
+    public function testGetDocumentsWithFilterCorrectFieldFormat(): void
     {
-        $fields = ['anti', 'flag'];
+        $fields = ['the', 'clash'];
 
         $queryFields = (new DocumentsQuery())
             ->setFields($fields)
+            ->setFilter(['id > 100'])
             ->toArray()['fields'];
 
-        self::assertSame(
-            implode(',', $fields),
-            $queryFields
-        );
+        self::assertSame($fields, $queryFields);
     }
 
     public function testGetDocumentsWithVector(): void