CSHARP-2214: Deprecate snapshot option.

rstam · rstam · commit 8c5ba62b426b · 2018-06-05T09:03:50.000-04:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindCommandOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindCommandOperation.cs
@@ -395,6 +395,7 @@ public int? Skip
         /// <value>
         /// Whether to use snapshot behavior.
         /// </value>
+        [Obsolete("Snapshot was deprecated in server version 3.7.4.")]
         public bool? Snapshot
         {
             get { return _snapshot; }
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindOpcodeOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindOpcodeOperation.cs
@@ -336,6 +336,7 @@ public int? Skip
         /// <value>
         /// Whether to use snapshot behavior.
         /// </value>
+        [Obsolete("Snapshot was deprecated in server version 3.7.4.")]
         public bool? Snapshot
         {
             get { return _snapshot; }
diff --git a/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/FindOperation.cs
@@ -394,6 +394,7 @@ public int? Skip
         /// <value>
         /// Whether to use snapshot behavior.
         /// </value>
+        [Obsolete("Snapshot was deprecated in server version 3.7.4.")]
         public bool? Snapshot
         {
             get { return _snapshot; }
@@ -477,6 +478,7 @@ internal FindCommandOperation<TDocument> CreateFindCommandOperation()
                 }
             }
 
+#pragma warning disable 618
             var operation = new FindCommandOperation<TDocument>(
                 _collectionNamespace,
                 _resultSerializer,
@@ -507,6 +509,7 @@ internal FindCommandOperation<TDocument> CreateFindCommandOperation()
                 Snapshot = snapshot,
                 Sort = sort
             };
+#pragma warning restore
 
             return operation;
         }
@@ -522,6 +525,7 @@ internal FindOpcodeOperation<TDocument> CreateFindOpcodeOperation()
                 throw new NotSupportedException($"OP_QUERY does not support collations.");
             }
 
+#pragma warning disable 618
             var operation = new FindOpcodeOperation<TDocument>(
                 _collectionNamespace,
                 _resultSerializer,
@@ -551,6 +555,7 @@ internal FindOpcodeOperation<TDocument> CreateFindOpcodeOperation()
 
             return operation;
         }
+#pragma warning restore
 
         private IReadOperation<IAsyncCursor<TDocument>> CreateOperation(SemanticVersion serverVersion)
         {
diff --git a/src/MongoDB.Driver.Legacy/MongoCursor.cs b/src/MongoDB.Driver.Legacy/MongoCursor.cs
@@ -688,6 +688,7 @@ public virtual MongoCursor SetSkip(int skip)
         /// Sets the $snapshot option.
         /// </summary>
         /// <returns>The cursor (so you can chain method calls to it).</returns>
+        [Obsolete("Snapshot was deprecated in server version 3.7.4.")]
         public virtual MongoCursor SetSnapshot()
         {
             if (_isFrozen) { ThrowFrozen(); }
@@ -1074,6 +1075,7 @@ public virtual MongoCursor<TDocument> SetSerializer(IBsonSerializer<TDocument> s
         /// Sets the $snapshot option.
         /// </summary>
         /// <returns>The cursor (so you can chain method calls to it).</returns>
+        [Obsolete("Snapshot was deprecated in server version 3.7.4.")]
         public new virtual MongoCursor<TDocument> SetSnapshot()
         {
             return (MongoCursor<TDocument>)base.SetSnapshot();
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindCommandOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindCommandOperationTests.cs
@@ -134,7 +134,9 @@ public void constructor_should_initialize_instance()
             subject.ShowRecordId.Should().NotHaveValue();
             subject.SingleBatch.Should().NotHaveValue();
             subject.Skip.Should().NotHaveValue();
+#pragma warning disable 618
             subject.Snapshot.Should().NotHaveValue();
+#pragma warning restore
             subject.Sort.Should().BeNull();
         }
 
@@ -661,10 +663,12 @@ public void CreateCommand_should_return_expected_result_when_Snapshot_is_set(
             [Values(null, false, true)]
             bool? snapshot)
         {
+#pragma warning disable 618
             var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)
             {
                 Snapshot = snapshot
             };
+#pragma warning restore
 
             var connectionDescription = OperationTestHelper.CreateConnectionDescription();
             var session = OperationTestHelper.CreateSession();
@@ -1241,8 +1245,10 @@ public void Snapshot_get_and_set_should_work(
         {
             var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.Snapshot = value;
             var result = subject.Snapshot;
+#pragma warning restore
 
             result.Should().Be(value);
         }
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOpcodeOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOpcodeOperationTests.cs
@@ -130,7 +130,9 @@ public void constructor_should_initialize_instance()
             subject.Projection.Should().BeNull();
             subject.ShowRecordId.Should().NotHaveValue();
             subject.Skip.Should().NotHaveValue();
+#pragma warning disable 618
             subject.Snapshot.Should().NotHaveValue();
+#pragma warning restore
             subject.Sort.Should().BeNull();
         }
 
@@ -624,9 +626,11 @@ public void Snapshot_get_and_set_should_work(
         {
             var subject = new FindOpcodeOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.Snapshot = value;
             var result = subject.Snapshot;
-
+#pragma warning restore
+        
             result.Should().Be(value);
         }
 
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/FindOperationTests.cs
@@ -150,7 +150,9 @@ public void constructor_should_initialize_instance()
             subject.ShowRecordId.Should().NotHaveValue();
             subject.SingleBatch.Should().NotHaveValue();
             subject.Skip.Should().NotHaveValue();
+#pragma warning disable 618
             subject.Snapshot.Should().NotHaveValue();
+#pragma warning restore
             subject.Sort.Should().BeNull();
         }
 
@@ -184,6 +186,7 @@ public void constructor_should_throw_when_resultSerializer_is_null()
         [Fact]
         public void CreateFindCommandOperation_should_return_expected_result()
         {
+#pragma warning disable 618
             var subject = new FindOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)
             {
                 AllowPartialResults = true,
@@ -211,6 +214,7 @@ public void CreateFindCommandOperation_should_return_expected_result()
                 Snapshot = true,
                 Sort = new BsonDocument("sort", 1)
             };
+#pragma warning restore
 
             var result = subject.CreateFindCommandOperation();
 
@@ -239,7 +243,9 @@ public void CreateFindCommandOperation_should_return_expected_result()
             result.ShowRecordId.Should().Be(subject.ShowRecordId);
             result.SingleBatch.Should().Be(subject.SingleBatch);
             result.Skip.Should().Be(subject.Skip);
+#pragma warning disable 618
             result.Snapshot.Should().Be(subject.Snapshot);
+#pragma warning restore
             result.Sort.Should().BeSameAs(subject.Sort);
         }
 
@@ -273,13 +279,16 @@ public void CreateFindCommandOperation_should_return_expected_result_when_modifi
             result.Min.Should().Be(subject.Modifiers["$min"].AsBsonDocument);
             result.ReturnKey.Should().Be(subject.Modifiers["$returnKey"].ToBoolean());
             result.ShowRecordId.Should().Be(subject.Modifiers["$showDiskLoc"].AsBoolean);
+#pragma warning disable 618
             result.Snapshot.Should().Be(subject.Modifiers["$snapshot"].AsBoolean);
+#pragma warning restore
             result.Sort.Should().Be(subject.Modifiers["$orderby"].AsBsonDocument);
         }
 
         [Fact]
         public void CreateFindOpcodeOperation_should_return_expected_result()
         {
+#pragma warning disable 618
             var subject = new FindOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)
             {
                 AllowPartialResults = true,
@@ -305,6 +314,7 @@ public void CreateFindOpcodeOperation_should_return_expected_result()
                 Snapshot = true,
                 Sort = new BsonDocument("sort", 1)
             };
+#pragma warning restore
 
             var result = subject.CreateFindOpcodeOperation();
 
@@ -329,7 +339,9 @@ public void CreateFindOpcodeOperation_should_return_expected_result()
             result.ResultSerializer.Should().Be(subject.ResultSerializer);
             result.ShowRecordId.Should().Be(subject.ShowRecordId);
             result.Skip.Should().Be(subject.Skip);
+#pragma warning disable 618
             result.Snapshot.Should().Be(subject.Snapshot);
+#pragma warning restore
             result.Sort.Should().Be(subject.Sort);
         }
 
@@ -933,8 +945,10 @@ public void Snapshot_get_and_set_should_work(
         {
             var subject = new FindOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);
 
+#pragma warning disable 618
             subject.Snapshot = value;
             var result = subject.Snapshot;
+#pragma warning restore
 
             result.Should().Be(value);
         }

Original file line number	Diff line number	Diff line change
`@@ -395,6 +395,7 @@ public int? Skip`
`395`	`395`	`/// <value>`
`396`	`396`	`/// Whether to use snapshot behavior.`
`397`	`397`	`/// </value>`
	`398`	`+ [Obsolete("Snapshot was deprecated in server version 3.7.4.")]`
`398`	`399`	`public bool? Snapshot`
`399`	`400`	`{`
`400`	`401`	`get { return _snapshot; }`
Original file line number	Diff line number	Diff line change
`@@ -336,6 +336,7 @@ public int? Skip`
`336`	`336`	`/// <value>`
`337`	`337`	`/// Whether to use snapshot behavior.`
`338`	`338`	`/// </value>`
	`339`	`+ [Obsolete("Snapshot was deprecated in server version 3.7.4.")]`
`339`	`340`	`public bool? Snapshot`
`340`	`341`	`{`
`341`	`342`	`get { return _snapshot; }`
Original file line number	Diff line number	Diff line change
`@@ -394,6 +394,7 @@ public int? Skip`
`394`	`394`	`/// <value>`
`395`	`395`	`/// Whether to use snapshot behavior.`
`396`	`396`	`/// </value>`
	`397`	`+ [Obsolete("Snapshot was deprecated in server version 3.7.4.")]`
`397`	`398`	`public bool? Snapshot`
`398`	`399`	`{`
`399`	`400`	`get { return _snapshot; }`
`@@ -477,6 +478,7 @@ internal FindCommandOperation<TDocument> CreateFindCommandOperation()`
`477`	`478`	`}`
`478`	`479`	`}`
`479`	`480`
	`481`	`+#pragma warning disable 618`
`480`	`482`	`var operation = new FindCommandOperation<TDocument>(`
`481`	`483`	`_collectionNamespace,`
`482`	`484`	`_resultSerializer,`
`@@ -507,6 +509,7 @@ internal FindCommandOperation<TDocument> CreateFindCommandOperation()`
`507`	`509`	`Snapshot = snapshot,`
`508`	`510`	`Sort = sort`
`509`	`511`	`};`
	`512`	`+#pragma warning restore`
`510`	`513`
`511`	`514`	`return operation;`
`512`	`515`	`}`
`@@ -522,6 +525,7 @@ internal FindOpcodeOperation<TDocument> CreateFindOpcodeOperation()`
`522`	`525`	`throw new NotSupportedException($"OP_QUERY does not support collations.");`
`523`	`526`	`}`
`524`	`527`
	`528`	`+#pragma warning disable 618`
`525`	`529`	`var operation = new FindOpcodeOperation<TDocument>(`
`526`	`530`	`_collectionNamespace,`
`527`	`531`	`_resultSerializer,`
`@@ -551,6 +555,7 @@ internal FindOpcodeOperation<TDocument> CreateFindOpcodeOperation()`
`551`	`555`
`552`	`556`	`return operation;`
`553`	`557`	`}`
	`558`	`+#pragma warning restore`
`554`	`559`
`555`	`560`	`private IReadOperation<IAsyncCursor<TDocument>> CreateOperation(SemanticVersion serverVersion)`
`556`	`561`	`{`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,9 @@ public void constructor_should_initialize_instance()`
`134`	`134`	`subject.ShowRecordId.Should().NotHaveValue();`
`135`	`135`	`subject.SingleBatch.Should().NotHaveValue();`
`136`	`136`	`subject.Skip.Should().NotHaveValue();`
	`137`	`+#pragma warning disable 618`
`137`	`138`	`subject.Snapshot.Should().NotHaveValue();`
	`139`	`+#pragma warning restore`
`138`	`140`	`subject.Sort.Should().BeNull();`
`139`	`141`	`}`
`140`	`142`
`@@ -661,10 +663,12 @@ public void CreateCommand_should_return_expected_result_when_Snapshot_is_set(`
`661`	`663`	`[Values(null, false, true)]`
`662`	`664`	`bool? snapshot)`
`663`	`665`	`{`
	`666`	`+#pragma warning disable 618`
`664`	`667`	`var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings)`
`665`	`668`	`{`
`666`	`669`	`Snapshot = snapshot`
`667`	`670`	`};`
	`671`	`+#pragma warning restore`
`668`	`672`
`669`	`673`	`var connectionDescription = OperationTestHelper.CreateConnectionDescription();`
`670`	`674`	`var session = OperationTestHelper.CreateSession();`
`@@ -1241,8 +1245,10 @@ public void Snapshot_get_and_set_should_work(`
`1241`	`1245`	`{`
`1242`	`1246`	`var subject = new FindCommandOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);`
`1243`	`1247`
	`1248`	`+#pragma warning disable 618`
`1244`	`1249`	`subject.Snapshot = value;`
`1245`	`1250`	`var result = subject.Snapshot;`
	`1251`	`+#pragma warning restore`
`1246`	`1252`
`1247`	`1253`	`result.Should().Be(value);`
`1248`	`1254`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,9 @@ public void constructor_should_initialize_instance()`
`130`	`130`	`subject.Projection.Should().BeNull();`
`131`	`131`	`subject.ShowRecordId.Should().NotHaveValue();`
`132`	`132`	`subject.Skip.Should().NotHaveValue();`
	`133`	`+#pragma warning disable 618`
`133`	`134`	`subject.Snapshot.Should().NotHaveValue();`
	`135`	`+#pragma warning restore`
`134`	`136`	`subject.Sort.Should().BeNull();`
`135`	`137`	`}`
`136`	`138`
`@@ -624,9 +626,11 @@ public void Snapshot_get_and_set_should_work(`
`624`	`626`	`{`
`625`	`627`	`var subject = new FindOpcodeOperation<BsonDocument>(_collectionNamespace, BsonDocumentSerializer.Instance, _messageEncoderSettings);`
`626`	`628`
	`629`	`+#pragma warning disable 618`
`627`	`630`	`subject.Snapshot = value;`
`628`	`631`	`var result = subject.Snapshot;`
`629`		`-`
	`632`	`+#pragma warning restore`
	`633`	`+`
`630`	`634`	`result.Should().Be(value);`
`631`	`635`	`}`
`632`	`636`