CSHARP-4728: Add implementation for Atlas Search Sort (#1139)

Co-authored-by: Samir Boulema <[email protected]>

Author: sboulema

src/MongoDB.Driver/AggregateFluent.cs

@@ -244,10 +244,11 @@ public override IAggregateFluent<TResult> Search(
             SearchHighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TResult> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false)
         {
-            return WithPipeline(_pipeline.Search(searchDefinition, highlight, indexName, count, returnStoredSource, scoreDetails));
+            return WithPipeline(_pipeline.Search(searchDefinition, highlight, indexName, count, sort, returnStoredSource, scoreDetails));
         }
 
         public override IAggregateFluent<SearchMetaResult> SearchMeta(

src/MongoDB.Driver/AggregateFluentBase.cs

@@ -222,6 +222,7 @@ public virtual IAggregateFluent<TResult> Search(
             SearchHighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TResult> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false)
         {

src/MongoDB.Driver/IAggregateFluent.cs

@@ -361,6 +361,7 @@ IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
         /// <param name="highlight">The highlight options.</param>
         /// <param name="indexName">The index name.</param>
         /// <param name="count">The count options.</param>
+        /// <param name="sort">The sort specification.</param>
         /// <param name="returnStoredSource">
         /// Flag that specifies whether to perform a full document lookup on the backend database
         /// or return only stored source fields directly from Atlas Search.
@@ -375,6 +376,7 @@ IAggregateFluent<TResult> Search(
             SearchHighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TResult> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false);
 

src/MongoDB.Driver/Linq/MongoQueryable.cs

@@ -1145,6 +1145,7 @@ public static IMongoQueryable<TSource> Sample<TSource>(this IMongoQueryable<TSou
         /// <param name="highlight">The highlight options.</param>
         /// <param name="indexName">The index name.</param>
         /// <param name="count">The count options.</param>
+        /// <param name="sort">The sort specification.</param>
         /// <param name="returnStoredSource">
         /// Flag that specifies whether to perform a full document lookup on the backend database
         /// or return only stored source fields directly from Atlas Search.
@@ -1160,12 +1161,13 @@ public static IMongoQueryable<TSource> Search<TSource>(
             SearchHighlightOptions<TSource> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TSource> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false)
         {
             return AppendStage(
                 source,
-                PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, returnStoredSource, scoreDetails));
+                PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, sort, returnStoredSource, scoreDetails));
         }
 
         /// <summary>

src/MongoDB.Driver/PipelineDefinitionBuilder.cs

@@ -1175,6 +1175,7 @@ public static PipelineDefinition<TInput, TOutput> ReplaceWith<TInput, TIntermedi
         /// <param name="highlight">The highlight options.</param>
         /// <param name="indexName">The index name.</param>
         /// <param name="count">The count options.</param>
+        /// <param name="sort">The sort specification.</param>
         /// <param name="returnStoredSource">
         /// Flag that specifies whether to perform a full document lookup on the backend database
         /// or return only stored source fields directly from Atlas Search.
@@ -1192,11 +1193,12 @@ public static PipelineDefinition<TInput, TOutput> Search<TInput, TOutput>(
             SearchHighlightOptions<TOutput> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TOutput> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false)
         {
             Ensure.IsNotNull(pipeline, nameof(pipeline));
-            return pipeline.AppendStage(PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, returnStoredSource, scoreDetails));
+            return pipeline.AppendStage(PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, sort, returnStoredSource, scoreDetails));
         }
 
         /// <summary>

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

@@ -1316,6 +1316,7 @@ public static PipelineStageDefinition<TInput, TOutput> Project<TInput, TOutput>(
         /// <param name="highlight">The highlight options.</param>
         /// <param name="indexName">The index name.</param>
         /// <param name="count">The count options.</param>
+        /// <param name="sort">The sort specification.</param>
         /// <param name="returnStoredSource">
         /// Flag that specifies whether to perform a full document lookup on the backend database
         /// or return only stored source fields directly from Atlas Search.
@@ -1330,6 +1331,7 @@ public static PipelineStageDefinition<TInput, TInput> Search<TInput>(
             SearchHighlightOptions<TInput> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
+            SortDefinition<TInput> sort = null,
             bool returnStoredSource = false,
             bool scoreDetails = false)
         {
@@ -1343,6 +1345,7 @@ public static PipelineStageDefinition<TInput, TInput> Search<TInput>(
                     var renderedSearchDefinition = searchDefinition.Render(s, sr);
                     renderedSearchDefinition.Add("highlight", () => highlight.Render(s, sr), highlight != null);
                     renderedSearchDefinition.Add("count", () => count.Render(), count != null);
+                    renderedSearchDefinition.Add("sort", () => sort.Render(s, sr), sort != null);
                     renderedSearchDefinition.Add("index", indexName, indexName != null);
                     renderedSearchDefinition.Add("returnStoredSource", returnStoredSource, returnStoredSource);
                     renderedSearchDefinition.Add("scoreDetails", scoreDetails, scoreDetails);

tests/MongoDB.Driver.Tests/PipelineDefinitionBuilderTests.cs

@@ -194,6 +194,19 @@ public void Search_should_add_expected_stage_with_score_details()
             stages[0].Should().Be("{ $search: { text: { query: 'foo', path: 'bar' }, scoreDetails: true } }");
         }
 
+        [Fact]
+        public void Search_should_add_expected_stage_with_sort()
+        {
+            var pipeline = new EmptyPipelineDefinition<BsonDocument>();
+            var builder = new SearchDefinitionBuilder<BsonDocument>();
+            var sortBuilder = new SortDefinitionBuilder<BsonDocument>();
+
+            var result = pipeline.Search(builder.Text("bar", "foo"), sort: sortBuilder.Ascending("foo"));
+
+            var stages = RenderStages(result, BsonDocumentSerializer.Instance);
+            stages[0].Should().Be("{ $search: { text: { query: 'foo', path: 'bar' }, sort: { 'foo': 1 } } }");
+        }
+
         [Fact]
         public void Search_should_throw_when_pipeline_is_null()
         {

tests/MongoDB.Driver.Tests/Search/AtlasSearchTests.cs

@@ -232,7 +232,7 @@ public void MustNot()
             var result = SearchSingle(
                 Builders.Search.Compound().MustNot(
                     Builders.Search.Phrase(x => x.Body, "life, liberty")));
-            result.Title.Should().Be("US Constitution");
+            result.Title.Should().Be("Gettysburg Address");
         }
 
         [Fact]
@@ -413,6 +413,19 @@ public void Should()
             result.Title.Should().Be("Declaration of Independence");
         }
 
+        [Fact]
+        public void Sort()
+        {
+            var results = GetTestCollection().Aggregate()
+                .Search(
+                    Builders.Search.Text(x => x.Body, "liberty"),
+                    sort: Builders.Sort.Descending(x => x.Title))
+                .Project<HistoricalDocument>(Builders.Projection.Include(x => x.Title))
+                .Limit(1)
+                .ToList();
+            results.Should().ContainSingle().Which.Title.Should().Be("US Constitution");
+        }
+
         [Theory]
         [InlineData("first")]
         [InlineData("near")]