CSHARP-4046: getMore helper should explicitly send inherited comment

BorisDog · BorisDog · commit c0c973a076f7 · 2022-03-01T12:21:28.000-08:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/AggregateOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/AggregateOperation.cs
@@ -401,6 +401,7 @@ private AsyncCursor<TResult> CreateCursorFromCursorResult(IChannelSourceHandle c
             return new AsyncCursor<TResult>(
                 getMoreChannelSource,
                 result.CollectionNamespace,
+                _comment,
                 result.Results,
                 cursorId,
                 result.PostBatchResumeToken,
@@ -416,6 +417,7 @@ private AsyncCursor<TResult> CreateCursorFromInlineResult(AggregateResult result
             return new AsyncCursor<TResult>(
                 null, // channelSource
                 CollectionNamespace,
+                _comment,
                 result.Results,
                 0, // cursorId
                 null, // postBatchResumeToken
diff --git a/src/MongoDB.Driver.Core/Core/Operations/AsyncCursor.cs b/src/MongoDB.Driver.Core/Core/Operations/AsyncCursor.cs
@@ -49,6 +49,7 @@ public class AsyncCursor<TDocument> : IAsyncCursor<TDocument>, ICursorBatchInfo
         private readonly CollectionNamespace _collectionNamespace;
         private IChannelSource _channelSource;
         private bool _closed;
+        private readonly BsonValue _comment;
         private int _count;
         private IReadOnlyList<TDocument> _currentBatch;
         private long _cursorId;
@@ -68,6 +69,7 @@ public class AsyncCursor<TDocument> : IAsyncCursor<TDocument>, ICursorBatchInfo
         /// </summary>
         /// <param name="channelSource">The channel source.</param>
         /// <param name="collectionNamespace">The collection namespace.</param>
+        /// <param name="comment">The comment.</param>
         /// <param name="firstBatch">The first batch.</param>
         /// <param name="cursorId">The cursor identifier.</param>
         /// <param name="batchSize">The size of a batch.</param>
@@ -78,6 +80,7 @@ public class AsyncCursor<TDocument> : IAsyncCursor<TDocument>, ICursorBatchInfo
         public AsyncCursor(
             IChannelSource channelSource,
             CollectionNamespace collectionNamespace,
+            BsonValue comment,
             IReadOnlyList<TDocument> firstBatch,
             long cursorId,
             int? batchSize,
@@ -88,6 +91,7 @@ public AsyncCursor(
             : this(
                 channelSource,
                 collectionNamespace,
+                comment,
                 firstBatch,
                 cursorId,
                 null, // postBatchResumeToken
@@ -169,6 +173,7 @@ public AsyncCursor(
             : this(
                   channelSource,
                   collectionNamespace,
+                  comment: null,
                   firstBatch,
                   cursorId,
                   postBatchResumeToken,
@@ -185,6 +190,7 @@ public AsyncCursor(
         /// </summary>
         /// <param name="channelSource">The channel source.</param>
         /// <param name="collectionNamespace">The collection namespace.</param>
+        /// <param name="comment">The comment.</param>
         /// <param name="firstBatch">The first batch.</param>
         /// <param name="cursorId">The cursor identifier.</param>
         /// <param name="postBatchResumeToken">The post batch resume token.</param>
@@ -196,6 +202,7 @@ public AsyncCursor(
         public AsyncCursor(
             IChannelSource channelSource,
             CollectionNamespace collectionNamespace,
+            BsonValue comment,
             IReadOnlyList<TDocument> firstBatch,
             long cursorId,
             BsonDocument postBatchResumeToken,
@@ -207,6 +214,7 @@ public AsyncCursor(
         {
             _operationId = EventContext.OperationId;
             _channelSource = channelSource;
+            _comment = comment;
             _collectionNamespace = Ensure.IsNotNull(collectionNamespace, nameof(collectionNamespace));
             _firstBatch = Ensure.IsNotNull(firstBatch, nameof(firstBatch));
             _cursorId = cursorId;
@@ -326,7 +334,8 @@ private BsonDocument CreateGetMoreCommand()
                 { "getMore", _cursorId },
                 { "collection", _collectionNamespace.CollectionName },
                 { "batchSize", () => CalculateGetMoreNumberToReturn(), _batchSize > 0 || _limit > 0 },
-                { "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue }
+                { "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue },
+                { "comment", _comment, _comment != null },
             };
 
             return command;
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs
@@ -553,6 +553,7 @@ private AsyncCursor<TDocument> CreateCursor(IChannelSourceHandle channelSource,
             return new AsyncCursor<TDocument>(
                 getMoreChannelSource,
                 collectionNamespace,
+                _comment,
                 firstBatch.Documents,
                 firstBatch.CursorId,
                 _batchSize,
diff --git a/src/MongoDB.Driver.Core/Core/Operations/ListCollectionsOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/ListCollectionsOperation.cs
@@ -221,6 +221,7 @@ private IAsyncCursor<BsonDocument> CreateCursor(IChannelSourceHandle channelSour
             var cursor = new AsyncCursor<BsonDocument>(
                 getMoreChannelSource,
                 CollectionNamespace.FromFullName(cursorDocument["ns"].AsString),
+                _comment,
                 cursorDocument["firstBatch"].AsBsonArray.OfType<BsonDocument>().ToList(),
                 cursorId,
                 batchSize: _batchSize ?? 0,
diff --git a/src/MongoDB.Driver.Core/Core/Operations/ListIndexesUsingCommandOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/ListIndexesUsingCommandOperation.cs
@@ -198,6 +198,7 @@ private IAsyncCursor<BsonDocument> CreateCursor(IChannelSourceHandle channelSour
             var cursor = new AsyncCursor<BsonDocument>(
                 getMoreChannelSource,
                 CollectionNamespace.FromFullName(cursorDocument["ns"].AsString),
+                _comment,
                 cursorDocument["firstBatch"].AsBsonArray.OfType<BsonDocument>().ToList(),
                 cursorId,
                 batchSize: _batchSize ?? 0,
diff --git a/src/MongoDB.Driver.Core/Core/Operations/ParallelScanOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/ParallelScanOperation.cs
@@ -180,10 +180,11 @@ private IReadOnlyList<IAsyncCursor<TDocument>> CreateCursors(IChannelSourceHandl
                     var cursor = new AsyncCursor<TDocument>(
                         getMoreChannelSource.Fork(),
                         _collectionNamespace,
+                        comment: null,
                         firstBatch,
                         cursorId,
                         _batchSize ?? 0,
-                        0, // limit
+                        limit: 0,
                         _serializer,
                         _messageEncoderSettings);
 
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/AsyncCursorEnumeratorTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/AsyncCursorEnumeratorTests.cs
@@ -180,6 +180,7 @@ private AsyncCursorEnumerator<BsonDocument> CreateSubject(int count)
             var cursor = new AsyncCursor<BsonDocument>(
                 channelSource: new Mock<IChannelSource>().Object,
                 collectionNamespace: new CollectionNamespace("foo", "bar"),
+                comment: null,
                 firstBatch: firstBatch,
                 cursorId: 0,
                 batchSize: null,
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/AsyncCursorTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/AsyncCursorTests.cs
@@ -194,6 +194,7 @@ public void constructor_should_initialize_instance()
             var result = new AsyncCursor<BsonDocument>(
                 channelSource,
                 collectionNamespace,
+                comment: null,
                 firstBatch,
                 cursorId,
                 batchSize,
@@ -496,6 +497,7 @@ private AsyncCursor<BsonDocument> CreateSubject(
             return new AsyncCursor<BsonDocument>(
                 channelSource.WithDefault(new Mock<IChannelSource>().Object),
                 collectionNamespace.WithDefault(new CollectionNamespace("test", "test")),
+                comment: null,
                 firstBatch.WithDefault(new List<BsonDocument>()),
                 cursorId.WithDefault(0),
                 batchSize.WithDefault(null),
@@ -661,7 +663,7 @@ public void Session_reference_count_should_be_decremented_as_soon_as_possible(in
                 long cursorId;
                 var firstBatch = GetFirstBatch(channel, query, batchSize, cancellationToken, out cursorId);
 
-                using (var cursor = new AsyncCursor<BsonDocument>(channelSource, _collectionNamespace, firstBatch, cursorId, batchSize, null, BsonDocumentSerializer.Instance, new MessageEncoderSettings()))
+                using (var cursor = new AsyncCursor<BsonDocument>(channelSource, _collectionNamespace, comment: null, firstBatch, cursorId, batchSize, null, BsonDocumentSerializer.Instance, new MessageEncoderSettings()))
                 {
                     AssertExpectedSessionReferenceCount(_session, cursor);
                     while (cursor.MoveNext(cancellationToken))
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/CursorTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/CursorTests.cs
@@ -32,6 +32,7 @@ public void Constructor_should_call_Dispose_on_channelSource_if_cursorId_is_zero
             new AsyncCursor<BsonDocument>(
                 mockChannelSource.Object,
                 new CollectionNamespace("databaseName", "collectionName"),
+                comment: null,
                 new BsonDocument[0], // firstBatch
                 cursorId,
                 null, // batchSize
diff --git a/tests/MongoDB.Driver.Core.Tests/IAsyncCursorExtensionsTests.cs b/tests/MongoDB.Driver.Core.Tests/IAsyncCursorExtensionsTests.cs
@@ -284,6 +284,7 @@ private IAsyncCursor<BsonDocument> CreateCursor(int count)
             return new AsyncCursor<BsonDocument>(
                 channelSource: new Mock<IChannelSource>().Object,
                 collectionNamespace: new CollectionNamespace("foo", "bar"),
+                comment: null,
                 firstBatch: firstBatch,
                 cursorId: 0,
                 batchSize: null,
diff --git a/tests/MongoDB.Driver.Core.Tests/IAsyncCursorSourceExtensionsTests.cs b/tests/MongoDB.Driver.Core.Tests/IAsyncCursorSourceExtensionsTests.cs
@@ -285,6 +285,7 @@ private IAsyncCursor<BsonDocument> CreateCursor(int count)
             return new AsyncCursor<BsonDocument>(
                 channelSource: new Mock<IChannelSource>().Object,
                 collectionNamespace: new CollectionNamespace("foo", "bar"),
+                comment: null,
                 firstBatch: firstBatch,
                 cursorId: 0,
                 batchSize: null,
diff --git a/tests/MongoDB.Driver.Tests/Specifications/change-streams/tests/unified/change-streams.json b/tests/MongoDB.Driver.Tests/Specifications/change-streams/tests/unified/change-streams.json
@@ -247,6 +247,92 @@
           ]
         }
       ]
+    },
+    {
+      "description": "Test that comment is set on getMore",
+      "runOnRequirements": [
+        {
+          "minServerVersion": "4.4.0",
+          "topologies": [
+            "single",
+            "replicaset"
+          ]
+        }
+      ],
+      "operations": [
+        {
+          "name": "createChangeStream",
+          "object": "collection0",
+          "arguments": {
+            "pipeline": [],
+            "comment": "comment"
+          },
+          "saveResultAsEntity": "changeStream0"
+        },
+        {
+          "name": "insertOne",
+          "object": "collection0",
+          "arguments": {
+            "document": {
+              "_id": 1,
+              "a": 1
+            }
+          }
+        },
+        {
+          "name": "iterateUntilDocumentOrError",
+          "object": "changeStream0"
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "aggregate": "collection0",
+                  "pipeline": [
+                    {
+                      "$changeStream": {}
+                    }
+                  ],
+                  "comment": "comment"
+                }
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "insert": "collection0",
+                  "documents": [
+                    {
+                      "_id": 1,
+                      "a": 1
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "getMore": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "collection": "collection0",
+                  "comment": "comment"
+                },
+                "commandName": "getMore",
+                "databaseName": "database0"
+              }
+            }
+          ]
+        }
+      ]
     }
   ]
 }
diff --git a/tests/MongoDB.Driver.Tests/Specifications/change-streams/tests/unified/change-streams.yml b/tests/MongoDB.Driver.Tests/Specifications/change-streams/tests/unified/change-streams.yml
@@ -136,3 +136,44 @@ tests:
                 pipeline:
                   - $changeStream: {}
                 comment: "comment"
+
+  - description: "Test that comment is set on getMore"
+    runOnRequirements:
+      - minServerVersion: "4.4.0"
+        topologies: [ single, replicaset ]
+    operations:
+      - name: createChangeStream
+        object: *collection0
+        arguments:
+          pipeline: []
+          comment: "comment"
+        saveResultAsEntity: &changeStream0 changeStream0
+      - name: insertOne
+        object: *collection0
+        arguments:
+          document: &new_document
+            _id: 1
+            a: 1
+      - name: iterateUntilDocumentOrError
+        object: *changeStream0
+    expectEvents:
+      - client: *client0
+        events:
+          - commandStartedEvent:
+              command:
+                aggregate: *collection0
+                pipeline:
+                  - $changeStream: {}
+                comment: "comment"
+          - commandStartedEvent:
+              command:
+                insert: *collection0
+                documents:
+                  - *new_document
+          - commandStartedEvent:
+              command:
+                getMore: { $$type: [ int, long ] }
+                collection: *collection0
+                comment: "comment"
+              commandName: getMore
+              databaseName: *database0
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/aggregate.json b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/aggregate.json
@@ -327,10 +327,14 @@
       ]
     },
     {
-      "description": "aggregate with comment does not set comment on getMore",
+      "description": "aggregate with comment sets comment on getMore",
       "runOnRequirements": [
         {
-          "minServerVersion": "3.6.0"
+          "minServerVersion": "4.4.0",
+          "topologies": [
+            "single",
+            "replicaset"
+          ]
         }
       ],
       "operations": [
@@ -411,9 +415,7 @@
                   },
                   "collection": "coll0",
                   "batchSize": 2,
-                  "comment": {
-                    "$$exists": false
-                  }
+                  "comment": "comment"
                 },
                 "commandName": "getMore",
                 "databaseName": "aggregate-tests"
@@ -430,9 +432,7 @@
                   },
                   "collection": "coll0",
                   "batchSize": 2,
-                  "comment": {
-                    "$$exists": false
-                  }
+                  "comment": "comment"
                 },
                 "commandName": "getMore",
                 "databaseName": "aggregate-tests"
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/aggregate.yml b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/aggregate.yml
@@ -125,9 +125,10 @@ tests:
               commandName: aggregate
               databaseName: *database0Name
 
-  - description: "aggregate with comment does not set comment on getMore"
+  - description: "aggregate with comment sets comment on getMore"
     runOnRequirements:
-      - minServerVersion: "3.6.0"
+      - minServerVersion: "4.4.0"
+        topologies: [ single, replicaset ]
     operations:
       - name: aggregate
         arguments:
@@ -157,14 +158,14 @@ tests:
                 getMore: { $$type: [ int, long ] }
                 collection: *collection0Name
                 batchSize: 2
-                comment: { $$exists: false }
+                comment: "comment"
               commandName: getMore
               databaseName: *database0Name
           - commandStartedEvent:
               command:
                 getMore: { $$type: [ int, long ] }
                 collection: *collection0Name
                 batchSize: 2
-                comment: { $$exists: false }
+                comment: "comment"
               commandName: getMore
               databaseName: *database0Name
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/find-comment.json b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/find-comment.json
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/find-comment.yml b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/unified/find-comment.yml
