CSHARP-4094: Add 'comment' option to EstimatedDocumentCountOptions. (#792)

Author: JamesKovacs

src/MongoDB.Driver.Core/Core/Operations/EstimatedDocumentCountOperation.cs

@@ -32,6 +32,7 @@ public class EstimatedDocumentCountOperation : IReadOperation<long>
     {
         // private fields
         private readonly CollectionNamespace _collectionNamespace;
+        private BsonValue _comment;
         private TimeSpan? _maxTime;
         private readonly MessageEncoderSettings _messageEncoderSettings;
         private ReadConcern _readConcern = ReadConcern.Default;
@@ -55,6 +56,15 @@ public EstimatedDocumentCountOperation(CollectionNamespace collectionNamespace,
         /// </summary>
         public CollectionNamespace CollectionNamespace => _collectionNamespace;
 
+        /// <summary>
+        /// Gets or sets the comment.
+        /// </summary>
+        public BsonValue Comment
+        {
+            get => _comment;
+            set => _comment = value;
+        }
+
         /// <summary>
         /// Gets or sets the maximum time the server should spend on this operation.
         /// </summary>
@@ -183,6 +193,7 @@ private IExecutableInRetryableReadContext<long> CreateCountOperation()
         {
             var countOperation = new CountOperation(_collectionNamespace, _messageEncoderSettings)
             {
+                Comment = _comment,
                 MaxTime = _maxTime,
                 ReadConcern = _readConcern,
                 RetryRequested = _retryRequested

src/MongoDB.Driver/EstimatedDocumentCountOptions.cs

@@ -14,6 +14,7 @@
 */
 
 using System;
+using MongoDB.Bson;
 using MongoDB.Driver.Core.Misc;
 
 namespace MongoDB.Driver
@@ -24,9 +25,19 @@ namespace MongoDB.Driver
     public sealed class EstimatedDocumentCountOptions
     {
         // private fields
+        private BsonValue _comment;
         private TimeSpan? _maxTime;
 
         // public properties
+        /// <summary>
+        /// Gets or sets the comment.
+        /// </summary>
+        public BsonValue Comment
+        {
+            get { return _comment; }
+            set { _comment = value; }
+        }
+
         /// <summary>
         /// Gets or sets the maximum time.
         /// </summary>

src/MongoDB.Driver/MongoCollectionImpl.cs

@@ -972,6 +972,7 @@ private EstimatedDocumentCountOperation CreateEstimatedDocumentCountOperation(Es
         {
             return new EstimatedDocumentCountOperation(_collectionNamespace, _messageEncoderSettings)
             {
+                Comment = options?.Comment,
                 MaxTime = options?.MaxTime,
                 RetryRequested = _database.Client.Settings.RetryReads
             };

tests/MongoDB.Driver.Core.Tests/Core/Operations/CountOperationTests.cs

@@ -18,7 +18,6 @@
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.XunitExtensions;
 using MongoDB.Driver.Core.Clusters;
-using MongoDB.Driver.Core.Misc;
 using MongoDB.Driver.Core.TestHelpers;
 using MongoDB.Driver.Core.TestHelpers.XunitExtensions;
 using Xunit;
@@ -36,6 +35,7 @@ public void constructor_should_initialize_instance()
             subject.MessageEncoderSettings.Should().BeSameAs(_messageEncoderSettings);
 
             subject.Collation.Should().BeNull();
+            subject.Comment.Should().BeNull();
             subject.Filter.Should().BeNull();
             subject.Hint.Should().BeNull();
             subject.Limit.Should().NotHaveValue();
@@ -210,6 +210,30 @@ public void CreateCommand_should_return_expected_result()
             result.Should().Be(expectedResult);
         }
 
+        [Theory]
+        [ParameterAttributeData]
+        public void CreateCommand_should_return_expected_result_when_Comment_is_set(
+            [Values(null, "comment")]
+            string comment)
+        {
+            var subject = new CountOperation(_collectionNamespace, _messageEncoderSettings)
+            {
+                Comment = comment
+            };
+
+            var connectionDescription = OperationTestHelper.CreateConnectionDescription();
+            var session = OperationTestHelper.CreateSession();
+
+            var result = subject.CreateCommand(connectionDescription, session);
+
+            var expectedResult = new BsonDocument
+            {
+                { "count", _collectionNamespace.CollectionName },
+                { "comment", comment, comment != null }
+            };
+            result.Should().Be(expectedResult);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void CreateCommand_should_return_expected_result_when_Collation_is_set(

tests/MongoDB.Driver.Core.Tests/Core/Operations/EstimatedDocumentCountOperationTests.cs

@@ -37,6 +37,7 @@ public void constructor_should_initialize_instance()
 
             subject.CollectionNamespace.Should().BeSameAs(_collectionNamespace);
             subject.MessageEncoderSettings.Should().BeSameAs(_messageEncoderSettings);
+            subject.Comment.Should().BeNull();
             subject.MaxTime.Should().NotHaveValue();
             subject.ReadConcern.IsServerDefault.Should().BeTrue();
             subject.RetryRequested.Should().BeFalse();
@@ -60,6 +61,35 @@ public void constructor_should_throw_when_messageEncoderSettings_is_null()
             argumentNullException.ParamName.Should().Be("messageEncoderSettings");
         }
 
+        [Fact]
+        public void Comment_get_and_set_should_work()
+        {
+            var subject = new EstimatedDocumentCountOperation(_collectionNamespace, _messageEncoderSettings);
+            var value = new BsonString("comment");
+
+            subject.Comment = value;
+            var result = subject.Comment;
+
+            result.Should().Be(value);
+        }
+
+        [Theory]
+        [ParameterAttributeData]
+        public void CreateCountOperation_should_return_expected_result_when_Comment_is_set(
+            [Values(null, "test")] string comment)
+        {
+            var value = (BsonValue)comment;
+            var subject = new EstimatedDocumentCountOperation(_collectionNamespace, _messageEncoderSettings)
+            {
+                Comment = value
+            };
+
+            var result = subject.CreateCountOperation();
+
+            result.Should().BeOfType<CountOperation>()
+                .Subject.Comment.Should().BeSameAs(value);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void MaxTime_get_and_set_should_work(

tests/MongoDB.Driver.Tests/EstimatedDocumentCountOptionsTests.cs

@@ -27,6 +27,7 @@ public void constructor_should_initialize_instance()
         {
             var result = new EstimatedDocumentCountOptions();
 
+            result.Comment.Should().BeNull();
             result.MaxTime.Should().NotHaveValue();
         }
 

tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedCountDocumentsOperation.cs

@@ -93,6 +93,10 @@ public UnifiedCountDocumentsOperation Build(string targetCollectionId, BsonDocum
             {
                 switch (argument.Name)
                 {
+                    case "comment":
+                        options ??= new CountOptions();
+                        options.Comment = argument.Value;
+                        break;
                     case "filter":
                         filter = new BsonDocumentFilterDefinition<BsonDocument>(argument.Value.AsBsonDocument);
                         break;

tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedEstimatedDocumentCountOperation.cs

@@ -81,6 +81,9 @@ public UnifiedEstimatedDocumentCountOperation Build(string targetCollectionId, B
             {
                 switch (argument.Name)
                 {
+                    case "comment":
+                        options.Comment = argument.Value.AsBsonValue;
+                        break;
                     case "maxTimeMS":
                         options.MaxTime = TimeSpan.FromMilliseconds(argument.Value.AsInt32);
                         break;