#665: Add support for sort in documents api

Author: kashifsoofi

.env

@@ -1,3 +1,3 @@
-MEILISEARCH_VERSION=v1.10.0
+MEILISEARCH_VERSION=v1.16
 PROXIED_MEILISEARCH=http://nginx/api/
 MEILISEARCH_URL=http://meilisearch:7700

README.md

@@ -260,6 +260,17 @@ if (results is PaginatedSearchResult<T> paginatedResults)
 }
 ```
 
+#### Search with sort
+
+To get results sorted by attributes and preferred sorting order, the [Sort](https://www.meilisearch.com/docs/reference/api/search#sort) property must be defined.
+
+```c#
+var results = await index.SearchAsync<T>(query, new SearchQuery()
+{
+    Sort = new List<string> { "genre:asc", "name:desc" }
+});
+```
+
 ## 🤖 Compatibility with Meilisearch
 
 This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-dotnet/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.

src/Meilisearch/QueryParameters/DocumentsQuery.cs

@@ -31,5 +31,11 @@ public class DocumentsQuery
         /// </summary>
         [JsonPropertyName("filter")]
         public object Filter { get; set; }
+
+        /// <summary>
+        /// An optional sort to apply
+        /// </summary>
+        [JsonPropertyName("sort")]
+        public List<string> Sort { get; set; }
     }
 }

tests/Meilisearch.Tests/DocumentTests.cs

@@ -643,6 +643,70 @@ await index.GetDocumentsAsync<Movie>(new DocumentsQuery()
             documents.Results.Last().Id.Should().Be("11");
         }
 
+        [Fact]
+        public async Task GetMultipleExistingDocumentWithAscSort()
+        {
+            var index = await _fixture.SetUpBasicIndexWithIntId("GetOneExistingDocumentWithIntegerIdTest");
+            var updateSortable = await index.UpdateSortableAttributesAsync(new[] { "id" });
+            updateSortable.TaskUid.Should().BeGreaterOrEqualTo(0);
+            await index.WaitForTaskAsync(updateSortable.TaskUid);
+
+            var documents =
+                await index.GetDocumentsAsync<MovieWithIntId>(new DocumentsQuery()
+                {
+                    Sort = new List<string> { "id:asc" }
+                });
+
+            Assert.Equal(7, documents.Results.Count());
+            documents.Results.Should().BeInAscendingOrder(x => x.Id);
+        }
+
+        [Fact]
+        public async Task GetMultipleExistingDocumentWithDescSort()
+        {
+            var index = await _fixture.SetUpBasicIndexWithIntId("GetOneExistingDocumentWithIntegerIdTest");
+            var updateSortable = await index.UpdateSortableAttributesAsync(new[] { "id" });
+            updateSortable.TaskUid.Should().BeGreaterOrEqualTo(0);
+            await index.WaitForTaskAsync(updateSortable.TaskUid);
+
+            var documents =
+                await index.GetDocumentsAsync<MovieWithIntId>(new DocumentsQuery()
+                {
+                    Sort = new List<string> { "id:desc" }
+                });
+
+            Assert.Equal(7, documents.Results.Count());
+            documents.Results.Should().BeInDescendingOrder(x => x.Id);
+        }
+
+        [Fact]
+        public async Task GetMultipleExistingDocumentWithMultiSort()
+        {
+            var index = await _fixture.SetUpBasicIndexWithIntId("GetOneExistingDocumentWithIntegerIdTest");
+            var updateFilterable = await index.UpdateFilterableAttributesAsync(new[] { "genre" });
+            updateFilterable.TaskUid.Should().BeGreaterOrEqualTo(0);
+            await index.WaitForTaskAsync(updateFilterable.TaskUid);
+
+            var updateSortable = await index.UpdateSortableAttributesAsync(new[] { "genre", "name" });
+            updateSortable.TaskUid.Should().BeGreaterOrEqualTo(0);
+            await index.WaitForTaskAsync(updateSortable.TaskUid);
+
+            var documents =
+                await index.GetDocumentsAsync<MovieWithIntId>(new DocumentsQuery()
+                {
+                    Filter = "genre IN ['SF','Action']",
+                    Sort = new List<string> { "genre:asc", "name:desc" }
+                });
+
+            Assert.Equal(4, documents.Results.Count());
+            var first = documents.Results.First();
+            first.Genre.Should().Be("Action");
+            first.Name.Should().Be("Spider-Man");
+            var last = documents.Results.Last();
+            last.Genre.Should().Be("SF");
+            last.Name.Should().Be("Harry Potter");
+        }
+
         [Fact]
         public async Task DeleteOneExistingDocumentWithStringId()
         {

tests/Meilisearch.Tests/ObjectExtensionsTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 using Meilisearch.Extensions;
 using Meilisearch.QueryParameters;
@@ -157,5 +158,19 @@ public void QueryStringsWithListAreEqualsForDocumentsQuery(int? offset, int? lim
                 Assert.Contains(String.Join(",", dq.Fields), actualQuery);
             }
         }
+
+        [Theory]
+        [InlineData(null, new string[] { "id:asc", "title:desc" })]
+        public void QueryStringsWithSortAreEqualForDocumentsQuery(int? limit, string[] sort)
+        {
+            var uri = "indexes/myindex/documents";
+            var dq = new DocumentsQuery { Limit = limit, Sort = sort.ToList() };
+            var actualQuery = dq.ToQueryString(uri: uri);
+
+            Assert.NotEmpty(actualQuery);
+            Assert.NotNull(actualQuery);
+            Assert.Contains("sort", actualQuery);
+            Assert.Contains(String.Join(",", dq.Sort), actualQuery);
+        }
     }
 }