CSHARP-2738: Deprecate mapparams, out.sharded, and out.nonAtomic arguments to mapReduce.

Author: DmitryLukyanov

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

@@ -14,9 +14,6 @@
 */
 
 using System;
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
 using MongoDB.Bson;
 using MongoDB.Driver.Core.Bindings;
 using MongoDB.Driver.Core.Connections;
@@ -120,6 +117,7 @@ public BsonJavaScript FinalizeFunction
         /// </remarks>
         ///   <c>true</c> if objects emitted by the map function remain as JavaScript objects; otherwise, <c>false</c>.
         /// </value>
+        [Obsolete("JavaScriptMode is ignored by server versions 4.4.0 and newer.")]
         public bool? JavaScriptMode
         {
             get { return _javaScriptMode; }

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

@@ -82,6 +82,7 @@ public bool? BypassDocumentValidation
         /// <value>
         ///   <c>true</c> if the server should not lock the database for merge and reduce output modes; otherwise, <c>false</c>.
         /// </value>
+        [Obsolete("NonAtomicOutput is rejected by server versions 4.4.0 and newer.")]
         public bool? NonAtomicOutput
         {
             get { return _nonAtomicOutput; }
@@ -117,6 +118,7 @@ public MapReduceOutputMode OutputMode
         /// <value>
         ///   <c>true</c> if the output collection should be sharded; otherwise, <c>false</c>.
         /// </value>
+        [Obsolete("ShardedOutput is rejected by server versions 4.4.0 and newer.")]
         public bool? ShardedOutput
         {
             get { return _shardedOutput; }

src/MongoDB.Driver.Legacy/CommandResults/MapReduceResult.cs

@@ -84,6 +84,7 @@ public string DatabaseName
         /// <summary>
         /// Gets the duration.
         /// </summary>
+        [Obsolete("Duration is not available on server versions 4.4.0 and newer.")]
         public TimeSpan Duration
         {
             get { return TimeSpan.FromMilliseconds(Response["timeMillis"].ToInt32()); }
@@ -92,6 +93,7 @@ public TimeSpan Duration
         /// <summary>
         /// Gets the emit count.
         /// </summary>
+        [Obsolete("EmitCount is not available on server versions 4.4.0 and newer.")]
         public long EmitCount
         {
             get { return Response["counts"]["emit"].ToInt64(); }
@@ -100,6 +102,7 @@ public long EmitCount
         /// <summary>
         /// Gets the output count.
         /// </summary>
+        [Obsolete("OutputCount is not available on server versions 4.4.0 and newer.")]
         public long OutputCount
         {
             get { return Response["counts"]["output"].ToInt64(); }
@@ -116,6 +119,7 @@ public IEnumerable<BsonDocument> InlineResults
         /// <summary>
         /// Gets the input count.
         /// </summary>
+        [Obsolete("InputCount is not available on server versions 4.4.0 and newer.")]
         public long InputCount
         {
             get { return Response["counts"]["input"].ToInt64(); }

src/MongoDB.Driver.Legacy/MapReduceArgs.cs

@@ -122,6 +122,7 @@ public BsonJavaScript FinalizeFunction
         /// <summary>
         /// Gets or sets the JavaScript mode (if true all intermediate values are kept in memory as JavaScript objects).
         /// </summary>
+        [Obsolete("JsMode is ignored by server versions 4.4.0 and newer.")]
         public bool? JsMode
         {
             get { return _jsMode; }
@@ -176,6 +177,7 @@ public string OutputDatabaseName
         /// <summary>
         /// Gets or sets a value indicating whether Merge and Reduce output should not be atomic.
         /// </summary>
+        [Obsolete("OutputIsNonAtomic is rejected by server versions 4.4.0 and newer.")]
         public bool? OutputIsNonAtomic
         {
             get { return _outputIsNonAtomic; }
@@ -185,6 +187,7 @@ public bool? OutputIsNonAtomic
         /// <summary>
         /// Gets or sets a value indicating whether the output is sharded.
         /// </summary>
+        [Obsolete("OutputIsSharded is rejected by server versions 4.4.0 and newer.")]
         public bool? OutputIsSharded
         {
             get { return _outputIsSharded; }

src/MongoDB.Driver.Legacy/MongoCollection.cs

@@ -1686,7 +1686,9 @@ private MapReduceResult MapReduce(IClientSessionHandle session, MapReduceArgs ar
                     Collation = args.Collation,
                     Filter = query,
                     FinalizeFunction = args.FinalizeFunction,
+#pragma warning disable 618
                     JavaScriptMode = args.JsMode,
+#pragma warning restore 618
                     Limit = args.Limit,
                     MaxTime = args.MaxTime,
                     ReadConcern = _settings.ReadConcern,
@@ -1714,13 +1716,19 @@ private MapReduceResult MapReduce(IClientSessionHandle session, MapReduceArgs ar
                     Collation = args.Collation,
                     Filter = query,
                     FinalizeFunction = args.FinalizeFunction,
+#pragma warning disable 618
                     JavaScriptMode = args.JsMode,
+#pragma warning restore 618
                     Limit = args.Limit,
                     MaxTime = args.MaxTime,
+#pragma warning disable 618
                     NonAtomicOutput = args.OutputIsNonAtomic,
+#pragma warning restore 618
                     OutputMode = outputMode,
                     Scope = scope,
+#pragma warning disable 618
                     ShardedOutput = args.OutputIsSharded,
+#pragma warning restore 618
                     Sort = sort,
                     Verbose = args.Verbose,
                     WriteConcern = _settings.WriteConcern

src/MongoDB.Driver/MapReduceOptions.cs

@@ -81,6 +81,7 @@ public BsonJavaScript Finalize
         /// <summary>
         /// Gets or sets the java script mode.
         /// </summary>
+        [Obsolete("JavaScriptMode is ignored by server versions 4.4.0 and newer.")]
         public bool? JavaScriptMode
         {
             get { return _javaScriptMode; }
@@ -177,12 +178,25 @@ public static MapReduceOutputOptions Inline
         /// <param name="sharded">Whether the output collection should be sharded.</param>
         /// <param name="nonAtomic">Whether the server should not lock the database for the duration of the merge.</param>
         /// <returns>A merge map-reduce output options.</returns>
+        [Obsolete("Use an overload of Merge that does not have sharded and nonAtomic parameters instead.")]
         public static MapReduceOutputOptions Merge(string collectionName, string databaseName = null, bool? sharded = null, bool? nonAtomic = null)
         {
             Ensure.IsNotNull(collectionName, nameof(collectionName));
             return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Merge, databaseName, sharded, nonAtomic);
         }
 
+        /// <summary>
+        /// A merge map-reduce output options.
+        /// </summary>
+        /// <param name="collectionName">The name of the collection.</param>
+        /// <param name="databaseName">The name of the database.</param>
+        /// <returns>A merge map-reduce output options.</returns>
+        public static MapReduceOutputOptions Merge(string collectionName, string databaseName)
+        {
+            Ensure.IsNotNull(collectionName, nameof(collectionName));
+            return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Merge, databaseName);
+        }
+
         /// <summary>
         /// A reduce map-reduce output options.
         /// </summary>
@@ -191,25 +205,51 @@ public static MapReduceOutputOptions Merge(string collectionName, string databas
         /// <param name="sharded">Whether the output collection should be sharded.</param>
         /// <param name="nonAtomic">Whether the server should not lock the database for the duration of the reduce.</param>
         /// <returns>A reduce map-reduce output options.</returns>
+        [Obsolete("Use an overload of Reduce that does not have sharded and nonAtomic parameters instead.")]
         public static MapReduceOutputOptions Reduce(string collectionName, string databaseName = null, bool? sharded = null, bool? nonAtomic = null)
         {
             Ensure.IsNotNull(collectionName, nameof(collectionName));
             return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Reduce, databaseName, sharded, nonAtomic);
         }
 
+        /// <summary>
+        /// A reduce map-reduce output options.
+        /// </summary>
+        /// <param name="collectionName">The name of the collection.</param>
+        /// <param name="databaseName">The name of the database.</param>
+        /// <returns>A reduce map-reduce output options.</returns>
+        public static MapReduceOutputOptions Reduce(string collectionName, string databaseName)
+        {
+            Ensure.IsNotNull(collectionName, nameof(collectionName));
+            return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Reduce, databaseName);
+        }
+
         /// <summary>
         /// A replace map-reduce output options.
         /// </summary>
         /// <param name="collectionName">The name of the collection.</param>
         /// <param name="databaseName">Name of the database.</param>
         /// <param name="sharded">Whether the output collection should be sharded.</param>
         /// <returns>A replace map-reduce output options.</returns>
+        [Obsolete("Use an overload of Replace that does not have a sharded parameter instead.")]
         public static MapReduceOutputOptions Replace(string collectionName, string databaseName = null, bool? sharded = null)
         {
             Ensure.IsNotNull(collectionName, nameof(collectionName));
             return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Replace, databaseName, sharded, null);
         }
 
+        /// <summary>
+        /// A replace map-reduce output options.
+        /// </summary>
+        /// <param name="collectionName">The name of the collection.</param>
+        /// <param name="databaseName">Name of the database.</param>
+        /// <returns>A replace map-reduce output options.</returns>
+        public static MapReduceOutputOptions Replace(string collectionName, string databaseName)
+        {
+            Ensure.IsNotNull(collectionName, nameof(collectionName));
+            return new CollectionOutput(collectionName, Core.Operations.MapReduceOutputMode.Replace, databaseName);
+        }
+
         internal sealed class InlineOutput : MapReduceOutputOptions
         {
             internal InlineOutput()
@@ -243,6 +283,7 @@ public string DatabaseName
                 get { return _databaseName; }
             }
 
+            [Obsolete("NonAtomic is rejected by server versions 4.4.0 and newer.")]
             public bool? NonAtomic
             {
                 get { return _nonAtomic; }
@@ -253,6 +294,7 @@ public Core.Operations.MapReduceOutputMode OutputMode
                 get { return _outputMode; }
             }
 
+            [Obsolete("Sharded is rejected by server versions 4.4.0 and newer.")]
             public bool? Sharded
             {
                 get { return _sharded; }

src/MongoDB.Driver/MongoCollectionImpl.cs

@@ -1010,7 +1010,9 @@ private MapReduceOperation<TResult> CreateMapReduceOperation<TResult>(BsonJavaSc
                 Collation = options.Collation,
                 Filter = options.Filter == null ? null : options.Filter.Render(_documentSerializer, _settings.SerializerRegistry),
                 FinalizeFunction = options.Finalize,
+#pragma warning disable 618
                 JavaScriptMode = options.JavaScriptMode,
+#pragma warning restore 618
                 Limit = options.Limit,
                 MaxTime = options.MaxTime,
                 ReadConcern = _settings.ReadConcern,
@@ -1039,13 +1041,19 @@ private MapReduceOutputToCollectionOperation CreateMapReduceOutputToCollectionOp
                 Collation = options.Collation,
                 Filter = options.Filter == null ? null : options.Filter.Render(_documentSerializer, _settings.SerializerRegistry),
                 FinalizeFunction = options.Finalize,
+#pragma warning disable 618
                 JavaScriptMode = options.JavaScriptMode,
+#pragma warning restore 618
                 Limit = options.Limit,
                 MaxTime = options.MaxTime,
+#pragma warning disable 618
                 NonAtomicOutput = collectionOutputOptions.NonAtomic,
+#pragma warning restore 618
                 Scope = options.Scope,
                 OutputMode = collectionOutputOptions.OutputMode,
+#pragma warning disable 618
                 ShardedOutput = collectionOutputOptions.Sharded,
+#pragma warning restore 618
                 Sort = options.Sort == null ? null : options.Sort.Render(_documentSerializer, _settings.SerializerRegistry),
                 Verbose = options.Verbose,
                 WriteConcern = _settings.WriteConcern

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

@@ -16,8 +16,6 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
-using System.Threading;
-using System.Threading.Tasks;
 using FluentAssertions;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization;
@@ -81,8 +79,9 @@ public void Execute_should_return_expected_results(
             };
 
             var result = ExecuteOperation(subject, async);
+            var results = result["results"].AsBsonArray.ToList();
 
-            result["results"].Should().Be(new BsonArray(expectedResults));
+            results.Should().BeEquivalentTo(new BsonArray(expectedResults));
         }
 
         [SkippableTheory]

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

@@ -72,7 +72,9 @@ public void constructor_should_initialize_instance()
             subject.Collation.Should().BeNull();
             subject.Filter.Should().BeNull();
             subject.FinalizeFunction.Should().BeNull();
+#pragma warning disable 618
             subject.JavaScriptMode.Should().NotHaveValue();
+#pragma warning restore 618
             subject.Limit.Should().NotHaveValue();
             subject.MaxTime.Should().NotHaveValue();
             subject.Scope.Should().BeNull();
@@ -240,7 +242,9 @@ public void CreateCommand_should_return_the_expected_result_when_JavaScriptMode_
         {
             var subject = new FakeMapReduceOperation(_collectionNamespace, _mapFunction, _reduceFunction, _messageEncoderSettings)
             {
+#pragma warning disable 618
                 JavaScriptMode = javaScriptMode
+#pragma warning restore 618
             };
             var session = OperationTestHelper.CreateSession();
             var connectionDescription = OperationTestHelper.CreateConnectionDescription();
@@ -432,8 +436,10 @@ public void JavaScriptMode_should_get_and_set_value(
         {
             var subject = new FakeMapReduceOperation(_collectionNamespace, _mapFunction, _reduceFunction, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.JavaScriptMode = value;
             var result = subject.JavaScriptMode;
+#pragma warning restore 618
 
             result.Should().Be(value);
         }