CSHARP-4799: Pipeline stage with BsonDocumentSearchDefinition can be rendered only once (#1188)

Author: BorisDog

src/MongoDB.Driver/Search/SearchDefinition.cs

@@ -76,7 +76,7 @@ public BsonDocumentSearchDefinition(BsonDocument document)
 
         /// <inheritdoc />
         public override BsonDocument Render(SearchDefinitionRenderContext<TDocument> renderContext) =>
-            Document;
+            (BsonDocument)Document.Clone();
     }
 
     /// <summary>
@@ -86,7 +86,7 @@ public override BsonDocument Render(SearchDefinitionRenderContext<TDocument> ren
     public sealed class JsonSearchDefinition<TDocument> : SearchDefinition<TDocument>
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="BsonDocumentSearchDefinition{TDocument}"/> class.
+        /// Initializes a new instance of the <see cref="JsonSearchDefinition{TDocument}"/> class.
         /// </summary>
         /// <param name="json">The JSON string specifying the search definition.</param>
         public JsonSearchDefinition(string json)

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

@@ -306,7 +306,7 @@ public void Equals_should_render_supported_type<T>(
         };
 
         [Theory]
-        [MemberData(nameof(EqualsUnsupporteddTypesTestData))]
+        [MemberData(nameof(EqualsUnsupportedTypesTestData))]
         public void Equals_should_throw_on_unsupported_type<T>(T value, Expression<Func<Person, T>> fieldExpression) where T : struct, IComparable<T>
         {
             var subject = CreateSubject<BsonDocument>();
@@ -316,7 +316,7 @@ public void Equals_should_throw_on_unsupported_type<T>(T value, Expression<Func<
             Record.Exception(() => subjectTyped.Equals(fieldExpression, value)).Should().BeOfType<InvalidCastException>();
         }
 
-        public static object[][] EqualsUnsupporteddTypesTestData => new[]
+        public static object[][] EqualsUnsupportedTypesTestData => new[]
         {
             new object[] { (ulong)1, Exp(p => p.UInt64) },
             new object[] { TimeSpan.Zero, Exp(p => p.TimeSpan) },

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

@@ -0,0 +1,91 @@
+/* Copyright 2010-present MongoDB Inc.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+using FluentAssertions;
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Search;
+using Xunit;
+
+namespace MongoDB.Driver.Tests.Search
+{
+    public class SearchDefinitionTests
+    {
+        [Theory]
+        [InlineData(null)]
+        [InlineData("{ operator: 'parameter' }")]
+        public void BsonDocument_implicit_cast_should_create_BsonSearchDefinition(string searchDefinitionJson)
+        {
+            var searchDefinitionDocument = searchDefinitionJson != null ? BsonDocument.Parse(searchDefinitionJson) : null;
+            var searchDefinition = (SearchDefinition<BsonDocument>)searchDefinitionDocument;
+
+            if (searchDefinitionJson == null)
+            {
+                searchDefinition.Should().BeNull();
+            }
+            else
+            {
+                var subject = searchDefinition.Should().BeOfType<BsonDocumentSearchDefinition<BsonDocument>>().Subject;
+                subject.Document.Should().Be(searchDefinitionDocument);
+            }
+        }
+
+        [Fact]
+        public void Pipeline_with_BsonDocumentSearchDefinition_should_render_correctly_multiple_times()
+        {
+            var searchOptions = new SearchOptions<BsonDocument>()
+            {
+                IndexName = "test",
+                ScoreDetails = true,
+            };
+
+            var document = new BsonDocument("operator", "parameter");
+            var searchDefinition = (BsonDocumentSearchDefinition<BsonDocument>)document;
+
+            var pipeline = (new EmptyPipelineDefinition<BsonDocument>()).Search(searchDefinition, searchOptions);
+
+            var renderedPipeline = pipeline.Render(BsonSerializer.SerializerRegistry.GetSerializer<BsonDocument>(), BsonSerializer.SerializerRegistry);
+            AssertStages();
+
+            renderedPipeline = pipeline.Render(BsonSerializer.SerializerRegistry.GetSerializer<BsonDocument>(), BsonSerializer.SerializerRegistry);
+            AssertStages();
+
+            void AssertStages()
+            {
+                var stages = renderedPipeline.Documents;
+                stages.Count.Should().Be(1);
+                stages[0].Should().Be("{ $search: { operator: 'parameter', index: 'test', scoreDetails: true} }");
+            }
+        }
+
+        [Theory]
+        [InlineData(null)]
+        [InlineData("{ operator: 'parameter' }")]
+        public void String_implicit_cast_should_create_JsonSearchDefinition(string searchDefinitionJson)
+        {
+            var searchDefinition = (SearchDefinition<BsonDocument>)searchDefinitionJson;
+
+            if (searchDefinitionJson == null)
+            {
+                searchDefinition.Should().BeNull();
+            }
+            else
+            {
+                var subject = searchDefinition.Should().BeOfType<JsonSearchDefinition<BsonDocument>>().Subject;
+                subject.Json.Should().Be(searchDefinitionJson);
+            }
+        }
+    }
+}