CSHARP-2839: Add support for AllowDiskUse with Find.

rstam · rstam · commit 63b9ef865c74 · 2020-02-25T16:18:24.000-05:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindCommandOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindCommandOperation.cs
@@ -45,6 +45,7 @@ public class FindCommandOperation<TDocument> : IReadOperation<IAsyncCursor<TDocu
         #endregion
 
         // fields
+        private bool? _allowDiskUse;
         private bool? _allowPartialResults;
         private int? _batchSize;
         private Collation _collation;
@@ -93,6 +94,18 @@ public FindCommandOperation(
         }
 
         // properties
+        /// <summary>
+        /// Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if the server is allowed to write to disk while executing the Find operation; otherwise, <c>false</c>.
+        /// </value>
+        public bool? AllowDiskUse
+        {
+            get { return _allowDiskUse; }
+            set { _allowDiskUse = value; }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating whether the server is allowed to return partial results if any shards are unavailable.
         /// </summary>
@@ -459,6 +472,7 @@ internal BsonDocument CreateCommand(ConnectionDescription connectionDescription,
                 { "oplogReplay", () => _oplogReplay.Value, _oplogReplay.HasValue },
                 { "noCursorTimeout", () => _noCursorTimeout.Value, _noCursorTimeout.HasValue },
                 { "awaitData", true, _cursorType == CursorType.TailableAwait },
+                { "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
                 { "allowPartialResults", () => _allowPartialResults.Value, _allowPartialResults.HasValue && isShardRouter },
                 { "collation", () => _collation.ToBsonDocument(), _collation != null },
                 { "readConcern", readConcern, readConcern != null }
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs
@@ -31,6 +31,7 @@ namespace MongoDB.Driver.Core.Operations
     public class FindOperation<TDocument> : IReadOperation<IAsyncCursor<TDocument>>, IExecutableInRetryableReadContext<IAsyncCursor<TDocument>>
     {
         // fields
+        private bool? _allowDiskUse;
         private bool? _allowPartialResults;
         private int? _batchSize;
         private Collation _collation;
@@ -80,6 +81,18 @@ public FindOperation(
         }
 
         // properties
+        /// <summary>
+        /// Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if the server is allowed to write to disk while executing the Find operation; otherwise, <c>false</c>.
+        /// </value>
+        public bool? AllowDiskUse
+        {
+            get { return _allowDiskUse; }
+            set { _allowDiskUse = value; }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating whether the server is allowed to return partial results if any shards are unavailable.
         /// </summary>
@@ -511,6 +524,7 @@ internal FindCommandOperation<TDocument> CreateFindCommandOperation()
                 _resultSerializer,
                 _messageEncoderSettings)
             {
+                AllowDiskUse = _allowDiskUse,
                 AllowPartialResults = _allowPartialResults,
                 BatchSize = _batchSize,
                 Collation = _collation,
@@ -559,6 +573,7 @@ internal FindOpcodeOperation<TDocument> CreateFindOpcodeOperation()
                 _resultSerializer,
                 _messageEncoderSettings)
             {
+                // note: FindOpcodeOperation does not support AllowDiskUse
                 AllowPartialResults = _allowPartialResults,
                 BatchSize = _batchSize,
                 Comment = _comment,
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucket.cs b/src/MongoDB.Driver.GridFS/GridFSBucket.cs
@@ -637,6 +637,7 @@ private FindOperation<GridFSFileInfo<TFileId>> CreateFindOperation(FilterDefinit
                 _fileInfoSerializer,
                 messageEncoderSettings)
             {
+                AllowDiskUse = options.AllowDiskUse,
                 BatchSize = options.BatchSize,
                 Filter = renderedFilter,
                 Limit = options.Limit,
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucketCompat.cs b/src/MongoDB.Driver.GridFS/GridFSBucketCompat.cs
@@ -253,6 +253,7 @@ private GridFSFindOptions<ObjectId> WrapFindOptions(GridFSFindOptions options)
                 var wrappedSort = renderedSort == null ? null : new BsonDocumentSortDefinition<GridFSFileInfo<ObjectId>>(renderedSort);
                 return new GridFSFindOptions<ObjectId>
                 {
+                    AllowDiskUse = options.AllowDiskUse,
                     BatchSize = options.BatchSize,
                     Limit = options.Limit,
                     MaxTime = options.MaxTime,
diff --git a/src/MongoDB.Driver.GridFS/GridFSFindOptions.cs b/src/MongoDB.Driver.GridFS/GridFSFindOptions.cs
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.GridFS
     public class GridFSFindOptions<TFileId>
     {
         // fields
+        private bool? _allowDiskUse;
         private int? _batchSize;
         private int? _limit;
         private TimeSpan? _maxTime;
@@ -33,6 +34,15 @@ public class GridFSFindOptions<TFileId>
         private SortDefinition<GridFSFileInfo<TFileId>> _sort;
 
         // properties
+        /// <summary>
+        /// Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
+        /// </summary>
+        public bool? AllowDiskUse
+        {
+            get { return _allowDiskUse; }
+            set { _allowDiskUse = value; }
+        }
+
         /// <summary>
         /// Gets or sets the batch size.
         /// </summary>
diff --git a/src/MongoDB.Driver/FindFluent.cs b/src/MongoDB.Driver/FindFluent.cs
@@ -123,6 +123,7 @@ public override IFindFluent<TDocument, TNewProjection> Project<TNewProjection>(P
         {
             var newOptions = new FindOptions<TDocument, TNewProjection>
             {
+                AllowDiskUse = _options.AllowDiskUse,
                 AllowPartialResults = _options.AllowPartialResults,
                 BatchSize = _options.BatchSize,
                 Collation = _options.Collation,
diff --git a/src/MongoDB.Driver/FindOptions.cs b/src/MongoDB.Driver/FindOptions.cs
@@ -25,6 +25,7 @@ namespace MongoDB.Driver
     public abstract class FindOptionsBase
     {
         // fields
+        private bool? _allowDiskUse;
         private bool? _allowPartialResults;
         private int? _batchSize;
         private Collation _collation;
@@ -51,6 +52,15 @@ public FindOptionsBase()
         }
 
         // properties
+        /// <summary>
+        /// Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
+        /// </summary>
+        public bool? AllowDiskUse
+        {
+            get { return _allowDiskUse; }
+            set { _allowDiskUse = value; }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating whether to allow partial results when some shards are unavailable.
         /// </summary>
diff --git a/src/MongoDB.Driver/IMongoCollectionExtensions.cs b/src/MongoDB.Driver/IMongoCollectionExtensions.cs
@@ -838,6 +838,7 @@ private static IFindFluent<TDocument, TDocument> FindHelper<TDocument>(IClientSe
             {
                 genericOptions = new FindOptions<TDocument>
                 {
+                    AllowDiskUse = options.AllowDiskUse,
                     AllowPartialResults = options.AllowPartialResults,
                     BatchSize = options.BatchSize,
                     Collation = options.Collation,
diff --git a/src/MongoDB.Driver/MongoCollectionImpl.cs b/src/MongoDB.Driver/MongoCollectionImpl.cs
@@ -966,6 +966,7 @@ private FindOperation<TProjection> CreateFindOperation<TProjection>(FilterDefini
                 renderedProjection.ProjectionSerializer,
                 _messageEncoderSettings)
             {
+                AllowDiskUse = options.AllowDiskUse,
                 AllowPartialResults = options.AllowPartialResults,
                 BatchSize = options.BatchSize,
                 Collation = options.Collation,
diff --git a/tests/MongoDB.Driver.Core.TestHelpers/JsonDrivenTests/CommandStartedEventAsserter.cs b/tests/MongoDB.Driver.Core.TestHelpers/JsonDrivenTests/CommandStartedEventAsserter.cs
@@ -110,6 +110,7 @@ private void AssertCommandAspect(BsonDocument actualCommand, string name, BsonVa
             {
                 switch (name)
                 {
+                    case "allowDiskUse":
                     case "autocommit":
                     case "readConcern":
                     case "recoveryToken":
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindCommandOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindCommandOperationTests.cs
@@ -31,6 +31,20 @@ namespace MongoDB.Driver.Core.Operations
     public class FindCommandOperationTests : OperationTestBase
     {
         // public methods
+        [Theory]
+        [ParameterAttributeData]
+        public void AllowDiskUse_get_and_set_should_work(
+            [Values(null, false, true)]
+            bool? value)
+        {
+            var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);
+
+            subject.AllowDiskUse = value;
+            var result = subject.AllowDiskUse;
+
+            result.Should().Be(value);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void AllowPartialResults_get_and_set_should_work(
@@ -112,6 +126,7 @@ public void constructor_should_initialize_instance()
             subject.ResultSerializer.Should().BeSameAs(BsonDocumentSerializer.Instance);
             subject.MessageEncoderSettings.Should().BeSameAs(_messageEncoderSettings);
 
+            subject.AllowDiskUse.Should().NotHaveValue();
             subject.AllowPartialResults.Should().NotHaveValue();
             subject.BatchSize.Should().NotHaveValue();
             subject.Collation.Should().BeNull();
@@ -187,6 +202,32 @@ public void CreateCommand_should_return_expected_result()
             result.Should().Be(expectedResult);
         }
 
+        [Theory]
+        [ParameterAttributeData]
+        public void CreateCommand_should_return_expected_result_when_AllowDiskUse_is_set(
+            [Values(null, false, true)]
+            bool? allowDiskUse,
+            [Values(ServerType.Standalone, ServerType.ShardRouter)]
+            ServerType serverType)
+        {
+            var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)
+            {
+                AllowDiskUse = allowDiskUse
+            };
+
+            var connectionDescription = OperationTestHelper.CreateConnectionDescription(serverType: serverType);
+            var session = OperationTestHelper.CreateSession();
+
+            var result = subject.CreateCommand(connectionDescription, session);
+
+            var expectedResult = new BsonDocument
+            {
+                { "find", _collectionNamespace.CollectionName },
+                { "allowDiskUse", () => allowDiskUse.Value, allowDiskUse.HasValue }
+            };
+            result.Should().Be(expectedResult);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void CreateCommand_should_return_expected_result_when_AllowPartialResults_is_set(
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOperationTests.cs
@@ -32,6 +32,20 @@ namespace MongoDB.Driver.Core.Operations
     public class FindOperationTests : OperationTestBase
     {
         // public methods
+        [Theory]
+        [ParameterAttributeData]
+        public void AllowDiskUse_get_and_set_should_work(
+            [Values(null, false, true)]
+            bool? value)
+        {
+            var subject = new FindOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);
+
+            subject.AllowDiskUse = value;
+            var result = subject.AllowDiskUse;
+
+            result.Should().Be(value);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void AllowPartialResults_get_and_set_should_work(
@@ -127,6 +141,7 @@ public void constructor_should_initialize_instance()
             subject.ResultSerializer.Should().BeSameAs(BsonDocumentSerializer.Instance);
             subject.MessageEncoderSettings.Should().BeSameAs(_messageEncoderSettings);
 
+            subject.AllowDiskUse.Should().NotHaveValue();
             subject.AllowPartialResults.Should().NotHaveValue();
             subject.BatchSize.Should().NotHaveValue();
             subject.Collation.Should().BeNull();
@@ -239,6 +254,7 @@ public void CreateFindCommandOperation_should_return_expected_result()
 #pragma warning disable 618
             var subject = new FindOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)
             {
+                AllowDiskUse = true,
                 AllowPartialResults = true,
                 BatchSize = 1,
                 Collation = new Collation("en_US"),
@@ -269,6 +285,7 @@ public void CreateFindCommandOperation_should_return_expected_result()
 
             var result = subject.CreateFindCommandOperation();
 
+            result.AllowDiskUse.Should().Be(subject.AllowDiskUse);
             result.AllowPartialResults.Should().Be(subject.AllowPartialResults);
             result.BatchSize.Should().Be(subject.BatchSize);
             result.Collation.Should().BeSameAs(subject.Collation);
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSFindOptionsTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSFindOptionsTests.cs
@@ -26,6 +26,26 @@ namespace MongoDB.Driver.GridFS.Tests
 {
     public class GridFSFindOptionsTests
     {
+        [Fact]
+        public void AllowDiskUse_get_should_return_expected_result()
+        {
+            var subject = new GridFSFindOptions { AllowDiskUse = true };
+
+            var result = subject.AllowDiskUse;
+
+            result.Should().Be(true);
+        }
+
+        [Fact]
+        public void AllowDiskUse_set_should_have_expected_result()
+        {
+            var subject = new GridFSFindOptions();
+
+            subject.AllowDiskUse = true;
+
+            subject.AllowDiskUse.Should().Be(true);
+        }
+
         [Fact]
         public void BatchSize_get_should_return_expected_result()
         {
@@ -64,6 +84,7 @@ public void default_constructor_should_return_expected_result()
         {
             var result = new GridFSFindOptions();
 
+            result.AllowDiskUse.Should().NotHaveValue();
             result.BatchSize.Should().NotHaveValue();
             result.Limit.Should().NotHaveValue();
             result.MaxTime.Should().NotHaveValue();
diff --git a/tests/MongoDB.Driver.Tests/IMongoCollectionExtensionsTests.cs b/tests/MongoDB.Driver.Tests/IMongoCollectionExtensionsTests.cs
@@ -435,6 +435,7 @@ public void Find_should_return_expected_result(
             var filterExpression = (Expression<Func<Person, bool>>)(x => x.FirstName == "Jack");
             var options = new FindOptions
             {
+                AllowDiskUse = true,
                 AllowPartialResults = true,
                 BatchSize = 123,
                 Collation = new Collation("en-us"),
@@ -485,6 +486,7 @@ public void Find_should_return_expected_result(
             fluent._session().Should().BeSameAs(session);
 
             var actualOptions = fluent._options();
+            actualOptions.AllowDiskUse.Should().Be(options.AllowDiskUse);
             actualOptions.AllowPartialResults.Should().Be(options.AllowPartialResults);
             actualOptions.BatchSize.Should().Be(options.BatchSize);
             actualOptions.Collation.Should().Be(options.Collation);
diff --git a/tests/MongoDB.Driver.Tests/MongoCollectionImplTests.cs b/tests/MongoDB.Driver.Tests/MongoCollectionImplTests.cs
@@ -225,6 +225,7 @@ public void Aggregate_should_execute_an_AggregateToCollectionOperation_and_a_Fin
             VerifySessionAndCancellationToken(findCall, session, cancellationToken2);
 
             var findOperation = findCall.Operation.Should().BeOfType<FindOperation<BsonDocument>>().Subject;
+            findOperation.AllowDiskUse.Should().NotHaveValue();
             findOperation.AllowPartialResults.Should().NotHaveValue();
             findOperation.BatchSize.Should().Be(options.BatchSize);
             findOperation.Collation.Should().BeSameAs(options.Collation);
@@ -1068,6 +1069,7 @@ public void Find_should_execute_a_FindOperation(
             var sortDefinition = (SortDefinition<BsonDocument>)sortDocument;
             var options = new FindOptions<BsonDocument, BsonDocument>
             {
+                AllowDiskUse = true,
                 AllowPartialResults = true,
                 BatchSize = 20,
                 Collation = new Collation("en_US"),
@@ -1115,6 +1117,7 @@ public void Find_should_execute_a_FindOperation(
 
             call.Operation.Should().BeOfType<FindOperation<BsonDocument>>();
             var operation = (FindOperation<BsonDocument>)call.Operation;
+            operation.AllowDiskUse.Should().Be(options.AllowDiskUse);
             operation.AllowPartialResults.Should().Be(options.AllowPartialResults);
             operation.BatchSize.Should().Be(options.BatchSize);
             operation.Collation.Should().BeSameAs(options.Collation);
@@ -1153,6 +1156,7 @@ public void Find_with_an_expression_execute_a_FindOperation(
             var sortDefinition = (SortDefinition<BsonDocument>)sortDocument;
             var options = new FindOptions<BsonDocument, BsonDocument>
             {
+                AllowDiskUse = true,
                 AllowPartialResults = true,
                 BatchSize = 20,
                 Collation = new Collation("en_US"),
@@ -1199,6 +1203,7 @@ public void Find_with_an_expression_execute_a_FindOperation(
             VerifySessionAndCancellationToken(call, session, cancellationToken);
 
             var operation = call.Operation.Should().BeOfType<FindOperation<BsonDocument>>().Subject;
+            operation.AllowDiskUse.Should().Be(options.AllowDiskUse);
             operation.AllowPartialResults.Should().Be(options.AllowPartialResults);
             operation.BatchSize.Should().Be(options.BatchSize);
             operation.Collation.Should().BeSameAs(options.Collation);
diff --git a/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs b/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs
@@ -218,6 +218,7 @@ public void Aggregate_should_execute_an_AggregateToCollectionOperation_and_a_Fin
             VerifySessionAndCancellationToken(findCall, session, cancellationToken2);
 
             var findOperation = findCall.Operation.Should().BeOfType<FindOperation<BsonDocument>>().Subject;
+            findOperation.AllowDiskUse.Should().NotHaveValue();
             findOperation.AllowPartialResults.Should().NotHaveValue();
             findOperation.BatchSize.Should().Be(options.BatchSize);
             findOperation.Collation.Should().BeSameAs(options.Collation);
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/CrudTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/crud/CrudTestRunner.cs
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/FindTest.cs b/tests/MongoDB.Driver.Tests/Specifications/crud/FindTest.cs
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/README.rst b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/README.rst
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/v2/find-allowdiskuse.json b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/v2/find-allowdiskuse.json
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/tests/v2/find-allowdiskuse.yml b/tests/MongoDB.Driver.Tests/Specifications/crud/tests/v2/find-allowdiskuse.yml

Original file line number	Diff line number	Diff line change
`@@ -637,6 +637,7 @@ private FindOperation<GridFSFileInfo<TFileId>> CreateFindOperation(FilterDefinit`
`637`	`637`	`_fileInfoSerializer,`
`638`	`638`	`messageEncoderSettings)`
`639`	`639`	`{`
	`640`	`+ AllowDiskUse = options.AllowDiskUse,`
`640`	`641`	`BatchSize = options.BatchSize,`
`641`	`642`	`Filter = renderedFilter,`
`642`	`643`	`Limit = options.Limit,`
Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,7 @@ private GridFSFindOptions<ObjectId> WrapFindOptions(GridFSFindOptions options)`
`253`	`253`	`var wrappedSort = renderedSort == null ? null : new BsonDocumentSortDefinition<GridFSFileInfo<ObjectId>>(renderedSort);`
`254`	`254`	`return new GridFSFindOptions<ObjectId>`
`255`	`255`	`{`
	`256`	`+ AllowDiskUse = options.AllowDiskUse,`
`256`	`257`	`BatchSize = options.BatchSize,`
`257`	`258`	`Limit = options.Limit,`
`258`	`259`	`MaxTime = options.MaxTime,`
Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ public override IFindFluent<TDocument, TNewProjection> Project<TNewProjection>(P`
`123`	`123`	`{`
`124`	`124`	`var newOptions = new FindOptions<TDocument, TNewProjection>`
`125`	`125`	`{`
	`126`	`+ AllowDiskUse = _options.AllowDiskUse,`
`126`	`127`	`AllowPartialResults = _options.AllowPartialResults,`
`127`	`128`	`BatchSize = _options.BatchSize,`
`128`	`129`	`Collation = _options.Collation,`
Original file line number	Diff line number	Diff line change
`@@ -838,6 +838,7 @@ private static IFindFluent<TDocument, TDocument> FindHelper<TDocument>(IClientSe`
`838`	`838`	`{`
`839`	`839`	`genericOptions = new FindOptions<TDocument>`
`840`	`840`	`{`
	`841`	`+ AllowDiskUse = options.AllowDiskUse,`
`841`	`842`	`AllowPartialResults = options.AllowPartialResults,`
`842`	`843`	`BatchSize = options.BatchSize,`
`843`	`844`	`Collation = options.Collation,`
Original file line number	Diff line number	Diff line change
`@@ -966,6 +966,7 @@ private FindOperation<TProjection> CreateFindOperation<TProjection>(FilterDefini`
`966`	`966`	`renderedProjection.ProjectionSerializer,`
`967`	`967`	`_messageEncoderSettings)`
`968`	`968`	`{`
	`969`	`+ AllowDiskUse = options.AllowDiskUse,`
`969`	`970`	`AllowPartialResults = options.AllowPartialResults,`
`970`	`971`	`BatchSize = options.BatchSize,`
`971`	`972`	`Collation = options.Collation,`
Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,7 @@ private void AssertCommandAspect(BsonDocument actualCommand, string name, BsonVa`
`110`	`110`	`{`
`111`	`111`	`switch (name)`
`112`	`112`	`{`
	`113`	`+ case "allowDiskUse":`
`113`	`114`	`case "autocommit":`
`114`	`115`	`case "readConcern":`
`115`	`116`	`case "recoveryToken":`