CSHARP-2253: Deprecate AutoIndexId for collection creation.

rstam · rstam · commit 38033d48270c · 2018-06-04T16:18:40.000-04:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/CreateCollectionOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/CreateCollectionOperation.cs
@@ -69,6 +69,7 @@ public CreateCollectionOperation(
         /// <value>
         /// A value indicating whether an index on _id should be created automatically.
         /// </value>
+        [Obsolete("AutoIndexId has been deprecated since server version 3.2.")]
         public bool? AutoIndexId
         {
             get { return _autoIndexId; }
diff --git a/src/MongoDB.Driver.Legacy/Builders/CollectionOptionsBuilder.cs b/src/MongoDB.Driver.Legacy/Builders/CollectionOptionsBuilder.cs
@@ -41,6 +41,7 @@ public static IMongoCollectionOptions Null
         /// </summary>
         /// <param name="value">Whether to automatically create an index on the _id element.</param>
         /// <returns>The builder (so method calls can be chained).</returns>
+        [Obsolete("AutoIndexId has been deprecated since server version 3.2.")]
         public static CollectionOptionsBuilder SetAutoIndexId(bool value)
         {
             return new CollectionOptionsBuilder().SetAutoIndexId(value);
@@ -163,6 +164,7 @@ public CollectionOptionsBuilder()
         /// </summary>
         /// <param name="value">Whether to automatically create an index on the _id element.</param>
         /// <returns>The builder (so method calls can be chained).</returns>
+        [Obsolete("AutoIndexId has been deprecated since server version 3.2.")]
         public CollectionOptionsBuilder SetAutoIndexId(bool value)
         {
             _document["autoIndexId"] = value;
diff --git a/src/MongoDB.Driver.Legacy/MongoDatabase.cs b/src/MongoDB.Driver.Legacy/MongoDatabase.cs
@@ -299,6 +299,7 @@ private CommandResult CreateCollection(IClientSessionHandle session, string coll
                 }
             }
 
+#pragma warning disable 618
             var operation = new CreateCollectionOperation(collectionNamespace, messageEncoderSettings)
             {
                 AutoIndexId = autoIndexId,
@@ -315,6 +316,7 @@ private CommandResult CreateCollection(IClientSessionHandle session, string coll
                 Validator = validator,
                 WriteConcern = _settings.WriteConcern
             };
+#pragma warning restore
 
             var response = ExecuteWriteOperation(session, operation);
             return new CommandResult(response);
diff --git a/src/MongoDB.Driver/CreateCollectionOptions.cs b/src/MongoDB.Driver/CreateCollectionOptions.cs
@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization;
 
@@ -50,6 +51,7 @@ public Collation Collation
         /// <summary>
         /// Gets or sets a value indicating whether to automatically create an index on the _id.
         /// </summary>
+        [Obsolete("AutoIndexId has been deprecated since server version 3.2.")]
         public bool? AutoIndexId
         {
             get { return _autoIndexId; }
@@ -178,6 +180,7 @@ internal static CreateCollectionOptions<TDocument> CoercedFrom(CreateCollectionO
 
             if (options.GetType() == typeof(CreateCollectionOptions))
             {
+#pragma warning disable 618
                 return new CreateCollectionOptions<TDocument>
                 {
                     AutoIndexId = options.AutoIndexId,
@@ -193,6 +196,7 @@ internal static CreateCollectionOptions<TDocument> CoercedFrom(CreateCollectionO
                     ValidationAction = options.ValidationAction,
                     ValidationLevel = options.ValidationLevel
                 };
+#pragma warning restore
             }
 
             return (CreateCollectionOptions<TDocument>)options;
diff --git a/src/MongoDB.Driver/MongoDatabaseImpl.cs b/src/MongoDB.Driver/MongoDatabaseImpl.cs
@@ -327,6 +327,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation(string name, C
             options = options ?? new CreateCollectionOptions();
             var messageEncoderSettings = GetMessageEncoderSettings();
 
+#pragma warning disable 618
             return new CreateCollectionOperation(new CollectionNamespace(_databaseNamespace, name), messageEncoderSettings)
             {
                 AutoIndexId = options.AutoIndexId,
@@ -339,6 +340,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation(string name, C
                 UsePowerOf2Sizes = options.UsePowerOf2Sizes,
                 WriteConcern = _settings.WriteConcern
             };
+#pragma warning restore
         }
 
         private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(string name, CreateCollectionOptions<TDocument> options)
@@ -352,6 +354,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(str
                 validator = options.Validator.Render(documentSerializer, serializerRegistry);
             }
 
+#pragma warning disable 618
             return new CreateCollectionOperation(new CollectionNamespace(_databaseNamespace, name), messageEncoderSettings)
             {
                 AutoIndexId = options.AutoIndexId,
@@ -368,6 +371,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(str
                 Validator = validator,
                 WriteConcern = _settings.WriteConcern
             };
+#pragma warning restore
         }
 
         private CreateViewOperation CreateCreateViewOperation<TDocument, TResult>(string viewName, string viewOn, PipelineDefinition<TDocument, TResult> pipeline, CreateViewOptions<TDocument> options)
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/CreateCollectionOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/CreateCollectionOperationTests.cs
@@ -38,8 +38,10 @@ public void AutoIndexId_get_and_set_should_work(
         {
             var subject = new CreateCollectionOperation(_collectionNamespace, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.AutoIndexId = value;
             var result = subject.AutoIndexId;
+#pragma warning restore
 
             result.Should().Be(value);
         }
@@ -81,7 +83,9 @@ public void constructor_should_initialize_subject()
             subject.CollectionNamespace.Should().BeSameAs(_collectionNamespace);
             subject.MessageEncoderSettings.Should().BeSameAs(_messageEncoderSettings);
 
+#pragma warning disable 618
             subject.AutoIndexId.Should().NotHaveValue();
+#pragma warning restore
             subject.Capped.Should().NotHaveValue();
             subject.Collation.Should().BeNull();
             subject.IndexOptionDefaults.Should().BeNull();
@@ -127,10 +131,12 @@ public void CreateCommand_should_return_expected_result_when_AutoIndexId_is_set(
             [Values(null, false, true)]
             bool? autoIndexId)
         {
+#pragma warning disable 618
             var subject = new CreateCollectionOperation(_collectionNamespace, _messageEncoderSettings)
             {
                 AutoIndexId = autoIndexId
             };
+#pragma warning restore
             var session = OperationTestHelper.CreateSession();
             var connectionDescription = OperationTestHelper.CreateConnectionDescription();
 
@@ -472,10 +478,12 @@ public void Execute_should_create_collection_when_AutoIndexId_is_set(
         {
             RequireServer.Check().VersionLessThan("3.7.0");
             DropCollection();
+#pragma warning disable 618
             var subject = new CreateCollectionOperation(_collectionNamespace, _messageEncoderSettings)
             {
                 AutoIndexId = autoIndexId
             };
+#pragma warning restore
 
             BsonDocument info;
             using (var binding = CreateReadWriteBinding())
diff --git a/tests/MongoDB.Driver.Legacy.Tests/Builders/CollectionOptionsBuilderTests.cs b/tests/MongoDB.Driver.Legacy.Tests/Builders/CollectionOptionsBuilderTests.cs
@@ -24,27 +24,33 @@ public class CollectionOptionsBuilderTests
         [Fact]
         public void TestSetAll()
         {
+#pragma warning disable 618
             var options = CollectionOptions
                 .SetAutoIndexId(true)
                 .SetCapped(true)
                 .SetMaxDocuments(100)
                 .SetMaxSize(2000);
+#pragma warning restore
             var expected = "{ 'autoIndexId' : true, 'capped' : true, 'max' : NumberLong(100), 'size' : NumberLong(2000) }".Replace("'", "\"");
             Assert.Equal(expected, options.ToJson());
         }
 
         [Fact]
         public void TestSetAutoIndexIdFalse()
         {
+#pragma warning disable 618
             var options = CollectionOptions.SetAutoIndexId(false);
+#pragma warning restore
             var expected = "{ 'autoIndexId' : false }".Replace("'", "\"");
             Assert.Equal(expected, options.ToJson());
         }
 
         [Fact]
         public void TestSetAutoIndexIdTrue()
         {
+#pragma warning disable 618
             var options = CollectionOptions.SetAutoIndexId(true);
+#pragma warning restore
             var expected = "{ 'autoIndexId' : true }".Replace("'", "\"");
             Assert.Equal(expected, options.ToJson());
         }
diff --git a/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs b/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs
@@ -73,6 +73,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
             var storageEngine = new BsonDocument("awesome", true);
             var validatorDocument = BsonDocument.Parse("{ x : 1 }");
             var validatorDefinition = (FilterDefinition<BsonDocument>)validatorDocument;
+#pragma warning disable 618
             var options = new CreateCollectionOptions<BsonDocument>
             {
                 AutoIndexId = false,
@@ -88,6 +89,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
                 ValidationLevel = DocumentValidationLevel.Off,
                 Validator = validatorDefinition
             };
+#pragma warning restore
             var cancellationToken = new CancellationTokenSource().Token;
 
             if (usingSession)
@@ -118,7 +120,9 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
 
             var op = call.Operation.Should().BeOfType<CreateCollectionOperation>().Subject;
             op.CollectionNamespace.Should().Be(new CollectionNamespace(_subject.DatabaseNamespace, name));
+#pragma warning disable 618
             op.AutoIndexId.Should().Be(options.AutoIndexId);
+#pragma warning restore
             op.Capped.Should().Be(options.Capped);
             op.Collation.Should().BeSameAs(options.Collation);
             op.IndexOptionDefaults.ToBsonDocument().Should().Be(options.IndexOptionDefaults.ToBsonDocument());
@@ -144,6 +148,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
             var session = CreateSession(usingSession);
             var name = "bar";
             var storageEngine = new BsonDocument("awesome", true);
+#pragma warning disable 618
             var options = new CreateCollectionOptions
             {
                 AutoIndexId = false,
@@ -158,6 +163,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
                 ValidationAction = DocumentValidationAction.Warn,
                 ValidationLevel = DocumentValidationLevel.Off
             };
+#pragma warning restore
             var cancellationToken = new CancellationTokenSource().Token;
 
             if (usingSession)
@@ -188,7 +194,9 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
 
             var op = call.Operation.Should().BeOfType<CreateCollectionOperation>().Subject;
             op.CollectionNamespace.Should().Be(new CollectionNamespace(_subject.DatabaseNamespace, name));
+#pragma warning disable 618
             op.AutoIndexId.Should().Be(options.AutoIndexId);
+#pragma warning restore
             op.Capped.Should().Be(options.Capped);
             op.Collation.Should().BeSameAs(options.Collation);
             op.IndexOptionDefaults.ToBsonDocument().Should().Be(options.IndexOptionDefaults.ToBsonDocument());
@@ -242,7 +250,9 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
 
             var op = call.Operation.Should().BeOfType<CreateCollectionOperation>().Subject;
             op.CollectionNamespace.Should().Be(new CollectionNamespace(_subject.DatabaseNamespace, name));
+#pragma warning disable 618
             op.AutoIndexId.Should().NotHaveValue();
+#pragma warning restore
             op.Capped.Should().NotHaveValue();
             op.IndexOptionDefaults.Should().BeNull();
             op.MaxDocuments.Should().NotHaveValue();

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ public CreateCollectionOperation(`
`69`	`69`	`/// <value>`
`70`	`70`	`/// A value indicating whether an index on _id should be created automatically.`
`71`	`71`	`/// </value>`
	`72`	`+ [Obsolete("AutoIndexId has been deprecated since server version 3.2.")]`
`72`	`73`	`public bool? AutoIndexId`
`73`	`74`	`{`
`74`	`75`	`get { return _autoIndexId; }`
Original file line number	Diff line number	Diff line change
`@@ -299,6 +299,7 @@ private CommandResult CreateCollection(IClientSessionHandle session, string coll`
`299`	`299`	`}`
`300`	`300`	`}`
`301`	`301`
	`302`	`+#pragma warning disable 618`
`302`	`303`	`var operation = new CreateCollectionOperation(collectionNamespace, messageEncoderSettings)`
`303`	`304`	`{`
`304`	`305`	`AutoIndexId = autoIndexId,`
`@@ -315,6 +316,7 @@ private CommandResult CreateCollection(IClientSessionHandle session, string coll`
`315`	`316`	`Validator = validator,`
`316`	`317`	`WriteConcern = _settings.WriteConcern`
`317`	`318`	`};`
	`319`	`+#pragma warning restore`
`318`	`320`
`319`	`321`	`var response = ExecuteWriteOperation(session, operation);`
`320`	`322`	`return new CommandResult(response);`
Original file line number	Diff line number	Diff line change
`@@ -327,6 +327,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation(string name, C`
`327`	`327`	`options = options ?? new CreateCollectionOptions();`
`328`	`328`	`var messageEncoderSettings = GetMessageEncoderSettings();`
`329`	`329`
	`330`	`+#pragma warning disable 618`
`330`	`331`	`return new CreateCollectionOperation(new CollectionNamespace(_databaseNamespace, name), messageEncoderSettings)`
`331`	`332`	`{`
`332`	`333`	`AutoIndexId = options.AutoIndexId,`
`@@ -339,6 +340,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation(string name, C`
`339`	`340`	`UsePowerOf2Sizes = options.UsePowerOf2Sizes,`
`340`	`341`	`WriteConcern = _settings.WriteConcern`
`341`	`342`	`};`
	`343`	`+#pragma warning restore`
`342`	`344`	`}`
`343`	`345`
`344`	`346`	`private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(string name, CreateCollectionOptions<TDocument> options)`
`@@ -352,6 +354,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(str`
`352`	`354`	`validator = options.Validator.Render(documentSerializer, serializerRegistry);`
`353`	`355`	`}`
`354`	`356`
	`357`	`+#pragma warning disable 618`
`355`	`358`	`return new CreateCollectionOperation(new CollectionNamespace(_databaseNamespace, name), messageEncoderSettings)`
`356`	`359`	`{`
`357`	`360`	`AutoIndexId = options.AutoIndexId,`
`@@ -368,6 +371,7 @@ private CreateCollectionOperation CreateCreateCollectionOperation<TDocument>(str`
`368`	`371`	`Validator = validator,`
`369`	`372`	`WriteConcern = _settings.WriteConcern`
`370`	`373`	`};`
	`374`	`+#pragma warning restore`
`371`	`375`	`}`
`372`	`376`
`373`	`377`	`private CreateViewOperation CreateCreateViewOperation<TDocument, TResult>(string viewName, string viewOn, PipelineDefinition<TDocument, TResult> pipeline, CreateViewOptions<TDocument> options)`
Original file line number	Diff line number	Diff line change
`@@ -24,27 +24,33 @@ public class CollectionOptionsBuilderTests`
`24`	`24`	`[Fact]`
`25`	`25`	`public void TestSetAll()`
`26`	`26`	`{`
	`27`	`+#pragma warning disable 618`
`27`	`28`	`var options = CollectionOptions`
`28`	`29`	`.SetAutoIndexId(true)`
`29`	`30`	`.SetCapped(true)`
`30`	`31`	`.SetMaxDocuments(100)`
`31`	`32`	`.SetMaxSize(2000);`
	`33`	`+#pragma warning restore`
`32`	`34`	`var expected = "{ 'autoIndexId' : true, 'capped' : true, 'max' : NumberLong(100), 'size' : NumberLong(2000) }".Replace("'", "\"");`
`33`	`35`	`Assert.Equal(expected, options.ToJson());`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`[Fact]`
`37`	`39`	`public void TestSetAutoIndexIdFalse()`
`38`	`40`	`{`
	`41`	`+#pragma warning disable 618`
`39`	`42`	`var options = CollectionOptions.SetAutoIndexId(false);`
	`43`	`+#pragma warning restore`
`40`	`44`	`var expected = "{ 'autoIndexId' : false }".Replace("'", "\"");`
`41`	`45`	`Assert.Equal(expected, options.ToJson());`
`42`	`46`	`}`
`43`	`47`
`44`	`48`	`[Fact]`
`45`	`49`	`public void TestSetAutoIndexIdTrue()`
`46`	`50`	`{`
	`51`	`+#pragma warning disable 618`
`47`	`52`	`var options = CollectionOptions.SetAutoIndexId(true);`
	`53`	`+#pragma warning restore`
`48`	`54`	`var expected = "{ 'autoIndexId' : true }".Replace("'", "\"");`
`49`	`55`	`Assert.Equal(expected, options.ToJson());`
`50`	`56`	`}`