CSHARP-1903: Obsolete UseCursor.

rstam · rstam · commit 159d65587dae · 2020-01-21T13:01:29.000-05:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/AggregateOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/AggregateOperation.cs
@@ -253,6 +253,7 @@ public bool RetryRequested
         /// <value>
         /// A value indicating whether the server should use a cursor to return the results.
         /// </value>
+        [Obsolete("Server versions 3.6 and newer always use a cursor.")]
         public bool? UseCursor
         {
             get { return _useCursor; }
@@ -345,7 +346,7 @@ internal BsonDocument CreateCommand(ConnectionDescription connectionDescription,
 
             if (Feature.AggregateCursorResult.IsSupported(connectionDescription.ServerVersion))
             {
-                var useCursor = _useCursor.GetValueOrDefault(true) || connectionDescription.ServerVersion >= new SemanticVersion(3, 5, 0);
+                var useCursor = _useCursor.GetValueOrDefault(true) || connectionDescription.ServerVersion >= new SemanticVersion(3, 6, 0);
                 if (useCursor)
                 {
                     command["cursor"] = new BsonDocument
diff --git a/src/MongoDB.Driver.Core/Core/Operations/AggregateToCollectionOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/AggregateToCollectionOperation.cs
@@ -267,7 +267,7 @@ internal BsonDocument CreateCommand(ICoreSessionHandle session, ConnectionDescri
                 { "collation", () => _collation.ToBsonDocument(), _collation != null },
                 { "readConcern", readConcern, readConcern != null },
                 { "writeConcern", writeConcern, writeConcern != null },
-                { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 5, 0) },
+                { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 6, 0) },
                 { "hint", () => _hint, _hint != null },
                 { "comment", () => _comment, _comment != null }
             };
diff --git a/src/MongoDB.Driver.Legacy/AggregateArgs.cs b/src/MongoDB.Driver.Legacy/AggregateArgs.cs
@@ -24,6 +24,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// Represents the output mode for an aggregate operation.
     /// </summary>
+    [Obsolete("Server versions 3.6 and newer always use a cursor.")]
     public enum AggregateOutputMode
     {
         /// <summary>
@@ -47,7 +48,9 @@ public class AggregateArgs
         private bool? _bypassDocumentValidation;
         private Collation _collation;
         private TimeSpan? _maxTime;
+#pragma warning disable 618
         private AggregateOutputMode _outputMode = AggregateOutputMode.Inline;
+#pragma warning restore 618
         private IEnumerable<BsonDocument> _pipeline;
 
         // public properties
@@ -112,6 +115,7 @@ public TimeSpan? MaxTime
         /// <summary>
         /// Gets or sets the output mode.
         /// </summary>
+        [Obsolete("Server versions 3.6 and newer always use a cursor.")]
         public AggregateOutputMode OutputMode
         {
             get { return _outputMode; }
diff --git a/src/MongoDB.Driver.Legacy/MongoCollection.cs b/src/MongoDB.Driver.Legacy/MongoCollection.cs
@@ -214,7 +214,9 @@ private IEnumerable<BsonDocument> Aggregate(IClientSessionHandle session, Aggreg
                     MaxTime = args.MaxTime,
                     ReadConcern = _settings.ReadConcern,
                     RetryRequested = _server.Settings.RetryReads,
+#pragma warning disable 618
                     UseCursor = args.OutputMode == AggregateOutputMode.Cursor
+#pragma warning restore 618
                 };
                 return new AggregateEnumerable(this, operation, _settings.ReadPreference);
             }
diff --git a/src/MongoDB.Driver/AggregateOptions.cs b/src/MongoDB.Driver/AggregateOptions.cs
@@ -121,6 +121,7 @@ public ExpressionTranslationOptions TranslationOptions
         /// <summary>
         /// Gets or sets a value indicating whether to use a cursor.
         /// </summary>
+        [Obsolete("Server versions 3.6 and newer always use a cursor.")]
         public bool? UseCursor
         {
             get { return _useCursor; }
diff --git a/src/MongoDB.Driver/MongoCollectionImpl.cs b/src/MongoDB.Driver/MongoCollectionImpl.cs
@@ -725,7 +725,9 @@ private AggregateOperation<TResult> CreateAggregateOperation<TResult>(RenderedPi
                 MaxTime = options.MaxTime,
                 ReadConcern = _settings.ReadConcern,
                 RetryRequested = _database.Client.Settings.RetryReads,
+#pragma warning disable 618
                 UseCursor = options.UseCursor
+#pragma warning restore 618
             };
         }
 
diff --git a/src/MongoDB.Driver/MongoDatabaseImpl.cs b/src/MongoDB.Driver/MongoDatabaseImpl.cs
@@ -470,7 +470,9 @@ private AggregateOperation<TResult> CreateAggregateOperation<TResult>(RenderedPi
                 MaxTime = options.MaxTime,
                 ReadConcern = _settings.ReadConcern,
                 RetryRequested = _client.Settings.RetryReads,
+#pragma warning disable 618
                 UseCursor = options.UseCursor
+#pragma warning restore 618
             };
         }
 
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/AggregateOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/AggregateOperationTests.cs
@@ -51,7 +51,9 @@ public void Constructor_with_database_should_create_a_valid_instance()
             subject.MaxAwaitTime.Should().NotHaveValue();
             subject.MaxTime.Should().NotHaveValue();
             subject.ReadConcern.IsServerDefault.Should().BeTrue();
+#pragma warning disable 618
             subject.UseCursor.Should().NotHaveValue();
+#pragma warning restore 618
             subject.RetryRequested.Should().BeFalse();
         }
 
@@ -108,7 +110,9 @@ public void Constructor_with_collection_should_create_a_valid_instance()
             subject.MaxAwaitTime.Should().NotHaveValue();
             subject.MaxTime.Should().NotHaveValue();
             subject.ReadConcern.IsServerDefault.Should().BeTrue();
+#pragma warning disable 618
             subject.UseCursor.Should().NotHaveValue();
+#pragma warning restore 618
             subject.RetryRequested.Should().BeFalse();
         }
 
@@ -276,8 +280,10 @@ public void UseCursor_get_and_set_should_work()
         {
             var subject = new AggregateOperation<BsonDocument>(_collectionNamespace, __pipeline, __resultSerializer, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.UseCursor = true;
             var result = subject.UseCursor;
+#pragma warning restore 618
 
             result.Should().BeTrue();
         }
@@ -575,7 +581,9 @@ public void CreateCommand_should_return_the_expected_result_when_UseCursor_is_se
         {
             var subject = new AggregateOperation<BsonDocument>(_collectionNamespace, __pipeline, __resultSerializer, _messageEncoderSettings)
             {
+#pragma warning disable 618
                 UseCursor = useCursor
+#pragma warning restore 618
             };
             var serverVersion = Feature.AggregateCursorResult.SupportedOrNotSupportedVersion(useServerVersionSupportingAggregateCursorResult);
 
@@ -901,7 +909,9 @@ public void Execute_should_return_expected_result_when_UseCursor_is_set(
             EnsureTestData();
             var subject = new AggregateOperation<BsonDocument>(_collectionNamespace, __pipeline, __resultSerializer, _messageEncoderSettings)
             {
+#pragma warning disable 618
                 UseCursor = useCursor
+#pragma warning restore 618
             };
 
             var cursor = ExecuteOperation(subject, async);
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/AggregateToCollectionOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/AggregateToCollectionOperationTests.cs
@@ -303,7 +303,7 @@ public void CreateCommand_should_return_expected_result_when_BypassDocumentValid
                 { "aggregate", _collectionNamespace.CollectionName },
                 { "pipeline", new BsonArray(__pipeline) },
                 { "bypassDocumentValidation", () => bypassDocumentValidation.Value, bypassDocumentValidation != null && Feature.BypassDocumentValidation.IsSupported(serverVersion) },
-                { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 5, 0) }
+                { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 6, 0) }
             };
             result.Should().Be(expectedResult);
         }
diff --git a/tests/MongoDB.Driver.Legacy.Tests/MongoCollectionTests.cs b/tests/MongoDB.Driver.Legacy.Tests/MongoCollectionTests.cs
@@ -124,7 +124,9 @@ public void TestAggregateCursor()
                     {
                         new BsonDocument("$group", new BsonDocument { { "_id", "$x" }, { "count", new BsonDocument("$sum", 1) } })
                     },
+#pragma warning disable 618
                     OutputMode = AggregateOutputMode.Cursor,
+#pragma warning disable 618
                     BatchSize = 1
                 });
                 var results = query.ToList();
diff --git a/tests/MongoDB.Driver.Tests/MongoCollectionImplTests.cs b/tests/MongoDB.Driver.Tests/MongoCollectionImplTests.cs
@@ -89,7 +89,9 @@ public void Aggregate_should_execute_an_AggregateOperation_when_out_is_not_speci
                 Hint = new BsonDocument("x", 1),
                 MaxAwaitTime = TimeSpan.FromSeconds(4),
                 MaxTime = TimeSpan.FromSeconds(3),
+#pragma warning disable 618
                 UseCursor = false
+#pragma warning restore 618
             };
             var cancellationToken = new CancellationTokenSource().Token;
             var renderedPipeline = RenderPipeline(subject, pipeline);
@@ -133,7 +135,9 @@ public void Aggregate_should_execute_an_AggregateOperation_when_out_is_not_speci
             operation.ReadConcern.Should().Be(_readConcern);
             operation.RetryRequested.Should().BeTrue();
             operation.ResultSerializer.Should().BeSameAs(renderedPipeline.OutputSerializer);
+#pragma warning disable 618
             operation.UseCursor.Should().Be(options.UseCursor);
+#pragma warning restore 618
         }
 
         [Theory]
@@ -158,7 +162,9 @@ public void Aggregate_should_execute_an_AggregateToCollectionOperation_and_a_Fin
                 Comment = "test",
                 Hint = new BsonDocument("x", 1),
                 MaxTime = TimeSpan.FromSeconds(3),
-                UseCursor = false,
+#pragma warning disable 618
+                UseCursor = false
+#pragma warning restore 618
             };
             var cancellationToken1 = new CancellationTokenSource().Token;
             var cancellationToken2 = new CancellationTokenSource().Token;
diff --git a/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs b/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs
@@ -82,7 +82,9 @@ public void Aggregate_should_execute_an_AggregateOperation_when_out_is_not_speci
                 Hint = new BsonDocument("x", 1),
                 MaxAwaitTime = TimeSpan.FromSeconds(4),
                 MaxTime = TimeSpan.FromSeconds(3),
+#pragma warning disable 618
                 UseCursor = false
+#pragma warning restore 618
             };
             var cancellationToken = new CancellationTokenSource().Token;
             var renderedPipeline = RenderPipeline(subject, pipeline);
@@ -127,7 +129,9 @@ public void Aggregate_should_execute_an_AggregateOperation_when_out_is_not_speci
             operation.ReadConcern.Should().Be(subject.Settings.ReadConcern);
             operation.RetryRequested.Should().BeTrue();
             operation.ResultSerializer.Should().BeSameAs(renderedPipeline.OutputSerializer);
+#pragma warning disable 618
             operation.UseCursor.Should().Be(options.UseCursor);
+#pragma warning restore 618
         }
 
         [Theory]
@@ -151,7 +155,9 @@ public void Aggregate_should_execute_an_AggregateToCollectionOperation_and_a_Fin
                 Comment = "test",
                 Hint = new BsonDocument("x", 1),
                 MaxTime = TimeSpan.FromSeconds(3),
-                UseCursor = false,
+#pragma warning disable 618
+                UseCursor = false
+#pragma warning restore 618
             };
             var cancellationToken1 = new CancellationTokenSource().Token;
             var cancellationToken2 = new CancellationTokenSource().Token;

Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,7 @@ public bool RetryRequested`
`253`	`253`	`/// <value>`
`254`	`254`	`/// A value indicating whether the server should use a cursor to return the results.`
`255`	`255`	`/// </value>`
	`256`	`+ [Obsolete("Server versions 3.6 and newer always use a cursor.")]`
`256`	`257`	`public bool? UseCursor`
`257`	`258`	`{`
`258`	`259`	`get { return _useCursor; }`
`@@ -345,7 +346,7 @@ internal BsonDocument CreateCommand(ConnectionDescription connectionDescription,`
`345`	`346`
`346`	`347`	`if (Feature.AggregateCursorResult.IsSupported(connectionDescription.ServerVersion))`
`347`	`348`	`{`
`348`		`- var useCursor = _useCursor.GetValueOrDefault(true) \|\| connectionDescription.ServerVersion >= new SemanticVersion(3, 5, 0);`
	`349`	`+ var useCursor = _useCursor.GetValueOrDefault(true) \|\| connectionDescription.ServerVersion >= new SemanticVersion(3, 6, 0);`
`349`	`350`	`if (useCursor)`
`350`	`351`	`{`
`351`	`352`	`command["cursor"] = new BsonDocument`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,7 @@ public ExpressionTranslationOptions TranslationOptions`
`121`	`121`	`/// <summary>`
`122`	`122`	`/// Gets or sets a value indicating whether to use a cursor.`
`123`	`123`	`/// </summary>`
	`124`	`+ [Obsolete("Server versions 3.6 and newer always use a cursor.")]`
`124`	`125`	`public bool? UseCursor`
`125`	`126`	`{`
`126`	`127`	`get { return _useCursor; }`
Original file line number	Diff line number	Diff line change
`@@ -725,7 +725,9 @@ private AggregateOperation<TResult> CreateAggregateOperation<TResult>(RenderedPi`
`725`	`725`	`MaxTime = options.MaxTime,`
`726`	`726`	`ReadConcern = _settings.ReadConcern,`
`727`	`727`	`RetryRequested = _database.Client.Settings.RetryReads,`
	`728`	`+#pragma warning disable 618`
`728`	`729`	`UseCursor = options.UseCursor`
	`730`	`+#pragma warning restore 618`
`729`	`731`	`};`
`730`	`732`	`}`
`731`	`733`
Original file line number	Diff line number	Diff line change
`@@ -470,7 +470,9 @@ private AggregateOperation<TResult> CreateAggregateOperation<TResult>(RenderedPi`
`470`	`470`	`MaxTime = options.MaxTime,`
`471`	`471`	`ReadConcern = _settings.ReadConcern,`
`472`	`472`	`RetryRequested = _client.Settings.RetryReads,`
	`473`	`+#pragma warning disable 618`
`473`	`474`	`UseCursor = options.UseCursor`
	`475`	`+#pragma warning restore 618`
`474`	`476`	`};`
`475`	`477`	`}`
`476`	`478`
Original file line number	Diff line number	Diff line change
`@@ -303,7 +303,7 @@ public void CreateCommand_should_return_expected_result_when_BypassDocumentValid`
`303`	`303`	`{ "aggregate", _collectionNamespace.CollectionName },`
`304`	`304`	`{ "pipeline", new BsonArray(__pipeline) },`
`305`	`305`	`{ "bypassDocumentValidation", () => bypassDocumentValidation.Value, bypassDocumentValidation != null && Feature.BypassDocumentValidation.IsSupported(serverVersion) },`
`306`		`- { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 5, 0) }`
	`306`	`+ { "cursor", new BsonDocument(), serverVersion >= new SemanticVersion(3, 6, 0) }`
`307`	`307`	`};`
`308`	`308`	`result.Should().Be(expectedResult);`
`309`	`309`	`}`