CSHARP-5304: Mark MD5 support in GridFS as Obsolete in 2.x (#1484)

papafe · web-flow · commit 59878b7527da · 2024-10-09T19:21:09.000+02:00
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucket.cs b/src/MongoDB.Driver.GridFS/GridFSBucket.cs
@@ -577,7 +577,9 @@ private BulkMixedWriteOperation CreateDeleteChunksOperation(TFileId id)
 
         private GridFSDownloadStream<TFileId> CreateDownloadStream(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var checkMD5 = options.CheckMD5 ?? false;
+#pragma warning restore CS0618 // Type or member is obsolete
             var seekable = options.Seekable ?? false;
             if (checkMD5 && seekable)
             {
@@ -777,7 +779,9 @@ private GridFSUploadStream<TFileId> CreateUploadStream(IReadWriteBindingHandle b
 
         private void DownloadToStreamHelper(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, Stream destination, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var checkMD5 = options.CheckMD5 ?? false;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             var retryReads = _database.Client.Settings.RetryReads;
             using (var source = new GridFSForwardOnlyDownloadStream<TFileId>(this, binding.Fork(), fileInfo, checkMD5) { RetryReads = retryReads })
@@ -798,7 +802,9 @@ private GridFSUploadStream<TFileId> CreateUploadStream(IReadWriteBindingHandle b
 
         private async Task DownloadToStreamHelperAsync(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, Stream destination, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var checkMD5 = options.CheckMD5 ?? false;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             var retryReads = _database.Client.Settings.RetryReads;
             using (var source = new GridFSForwardOnlyDownloadStream<TFileId>(this, binding.Fork(), fileInfo, checkMD5) { RetryReads = retryReads })
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucketOptions.cs b/src/MongoDB.Driver.GridFS/GridFSBucketOptions.cs
@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using MongoDB.Bson.Serialization;
 using MongoDB.Driver.Core.Misc;
 
@@ -49,7 +50,9 @@ public GridFSBucketOptions(GridFSBucketOptions other)
             Ensure.IsNotNull(other, nameof(other));
             _bucketName = other.BucketName;
             _chunkSizeBytes = other.ChunkSizeBytes;
+#pragma warning disable CS0618 // Type or member is obsolete
             _disableMD5 = other.DisableMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
@@ -64,7 +67,9 @@ public GridFSBucketOptions(ImmutableGridFSBucketOptions other)
             Ensure.IsNotNull(other, nameof(other));
             _bucketName = other.BucketName;
             _chunkSizeBytes = other.ChunkSizeBytes;
+#pragma warning disable CS0618 // Type or member is obsolete
             _disableMD5 = other.DisableMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
@@ -109,6 +114,7 @@ public int ChunkSizeBytes
         /// <value>
         /// Whether MD5 checksum computation is disabled when uploading a GridFS file.
         /// </value>
+        [Obsolete("MD5 support will be removed in a later release.")]
         public bool DisableMD5
         {
             get { return _disableMD5; }
@@ -201,7 +207,9 @@ public ImmutableGridFSBucketOptions(GridFSBucketOptions other)
             Ensure.IsNotNull(other, nameof(other));
             _bucketName = other.BucketName;
             _chunkSizeBytes = other.ChunkSizeBytes;
+#pragma warning disable CS0618 // Type or member is obsolete
             _disableMD5 = other.DisableMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
@@ -236,6 +244,7 @@ public int ChunkSizeBytes
         /// <value>
         /// Whether MD5 checksum computation is disabled when uploading a GridFS file.
         /// </value>
+        [Obsolete("MD5 support will be removed in a later release.")]
         public bool DisableMD5
         {
             get { return _disableMD5; }
diff --git a/src/MongoDB.Driver.GridFS/GridFSDownloadOptions.cs b/src/MongoDB.Driver.GridFS/GridFSDownloadOptions.cs
@@ -13,6 +13,8 @@
 * limitations under the License.
 */
 
+using System;
+
 namespace MongoDB.Driver.GridFS
 {
     /// <summary>
@@ -31,6 +33,7 @@ public class GridFSDownloadOptions
         /// <value>
         ///   <c>true</c> if the MD5 value should be checked; otherwise, <c>false</c>.
         /// </value>
+        [Obsolete("MD5 support will be removed in a later release.")]
         public bool? CheckMD5
         {
             get { return _checkMD5; }
diff --git a/src/MongoDB.Driver.GridFS/GridFSFileInfo.cs b/src/MongoDB.Driver.GridFS/GridFSFileInfo.cs
@@ -129,6 +129,7 @@ public long Length
         /// <value>
         /// The MD5 checksum.
         /// </value>
+        [Obsolete("MD5 support will be removed in a later release.")]
         public string MD5
         {
             get { return GetValue<string>("MD5", null); }
diff --git a/src/MongoDB.Driver.GridFS/GridFSForwardOnlyDownloadStream.cs b/src/MongoDB.Driver.GridFS/GridFSForwardOnlyDownloadStream.cs
@@ -157,12 +157,12 @@ protected override void CloseImplementation(CancellationToken cancellationToken)
             if (_checkMD5 && _position == FileInfo.Length)
             {
                 var md5 = BsonUtils.ToHexString(_md5.GetHashAndReset());
+#pragma warning disable CS0618 // Type or member is obsolete
                 if (!md5.Equals(FileInfo.MD5, StringComparison.OrdinalIgnoreCase))
                 {
-#pragma warning disable 618
                     throw new GridFSMD5Exception(_idAsBsonValue);
-#pragma warning restore
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
             }
         }
 
diff --git a/src/MongoDB.Driver.GridFS/GridFSMD5Exception.cs b/src/MongoDB.Driver.GridFS/GridFSMD5Exception.cs
@@ -24,6 +24,7 @@ namespace MongoDB.Driver.GridFS
     /// Represents a GridFSMD5 exception.
     /// </summary>
     [Serializable]
+    [Obsolete("MD5 support will be removed in a later release.")]
     public class GridFSMD5Exception : GridFSException
     {
         #region static
diff --git a/src/MongoDB.Driver.GridFS/GridFSUploadOptions.cs b/src/MongoDB.Driver.GridFS/GridFSUploadOptions.cs
@@ -94,6 +94,7 @@ public string ContentType
         /// <value>
         /// Whether or not MD5 checksum computation is disabled when uploading a GridFS file.
         /// </value>
+        [Obsolete("MD5 support will be removed in a later release.")]
         public bool DisableMD5
         {
             get { return _disableMD5; }
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketOptionsTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketOptionsTests.cs
@@ -144,9 +144,11 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul
         public void DisableMD5_get_and_set_should_return_expected_result(
             [Values(false, true)] bool disabled)
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var subject = new GridFSBucketOptions { DisableMD5 = disabled };
 
             var result = subject.DisableMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             result.Should().Be(disabled);
         }
@@ -241,7 +243,9 @@ public void constructor_with_arguments_should_initialize_instance()
             {
                 BucketName = "bucket",
                 ChunkSizeBytes = 123,
+#pragma warning disable CS0618 // Type or member is obsolete
                 DisableMD5 = true,
+#pragma warning restore CS0618 // Type or member is obsolete
                 ReadConcern = ReadConcern.Majority,
                 ReadPreference = ReadPreference.Secondary,
                 WriteConcern = WriteConcern.WMajority
@@ -251,7 +255,9 @@ public void constructor_with_arguments_should_initialize_instance()
 
             result.BucketName.Should().Be("bucket");
             result.ChunkSizeBytes.Should().Be(123);
+#pragma warning disable CS0618 // Type or member is obsolete
             result.DisableMD5.Should().Be(true);
+#pragma warning restore CS0618 // Type or member is obsolete
             result.ReadConcern.Should().Be(ReadConcern.Majority);
             result.ReadPreference.Should().Be(ReadPreference.Secondary);
             result.WriteConcern.Should().Be(WriteConcern.WMajority);
@@ -264,7 +270,9 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul
 
             result.BucketName.Should().Be("fs");
             result.ChunkSizeBytes.Should().Be(255 * 1024);
+#pragma warning disable CS0618 // Type or member is obsolete
             result.DisableMD5.Should().Be(false);
+#pragma warning restore CS0618 // Type or member is obsolete
             result.ReadConcern.Should().BeNull();
             result.ReadPreference.Should().BeNull();
             result.WriteConcern.Should().BeNull();
@@ -286,7 +294,9 @@ public void Defaults_get_should_return_expected_result()
 
             result.BucketName.Should().Be("fs");
             result.ChunkSizeBytes.Should().Be(255 * 1024);
+#pragma warning disable CS0618 // Type or member is obsolete
             result.DisableMD5.Should().Be(false);
+#pragma warning restore CS0618 // Type or member is obsolete
             result.ReadConcern.Should().BeNull();
             result.ReadPreference.Should().BeNull();
             result.WriteConcern.Should().BeNull();
@@ -297,9 +307,11 @@ public void Defaults_get_should_return_expected_result()
         public void DisableMD5_get_and_set_should_return_expected_result(
             [Values(false, true)] bool disabled)
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var subject = new ImmutableGridFSBucketOptions(new GridFSBucketOptions { DisableMD5 = disabled });
 
             var result = subject.DisableMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             result.Should().Be(disabled);
         }
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketTests.cs
@@ -45,7 +45,9 @@ public void constructor_should_initialize_instance()
             result.Database.Should().BeSameAs(database);
             result.Options.BucketName.Should().Be(options.BucketName);
             result.Options.ChunkSizeBytes.Should().Be(options.ChunkSizeBytes);
+#pragma warning disable CS0618 // Type or member is obsolete
             result.Options.DisableMD5.Should().Be(options.DisableMD5);
+#pragma warning restore CS0618 // Type or member is obsolete
             result.Options.ReadPreference.Should().Be(options.ReadPreference);
             result.Options.WriteConcern.Should().Be(options.WriteConcern);
         }
@@ -473,7 +475,9 @@ public void Options_get_should_return_the_expected_result()
 
             result.BucketName.Should().Be(options.BucketName);
             result.ChunkSizeBytes.Should().Be(options.ChunkSizeBytes);
+#pragma warning disable CS0618 // Type or member is obsolete
             result.DisableMD5.Should().Be(options.DisableMD5);
+#pragma warning restore CS0618 // Type or member is obsolete
             result.ReadConcern.Should().Be(options.ReadConcern);
             result.ReadPreference.Should().Be(options.ReadPreference);
             result.WriteConcern.Should().Be(options.WriteConcern);
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSDownloadOptionsTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSDownloadOptionsTests.cs
@@ -28,9 +28,11 @@ public class GridFSDownloadOptionsTests
         [Fact]
         public void CheckMD5_get_should_return_expected_result()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var subject = new GridFSDownloadOptions { CheckMD5 = true };
 
             var result = subject.CheckMD5;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             result.Should().Be(true);
         }
@@ -40,17 +42,21 @@ public void CheckMD5_set_should_have_expected_result()
         {
             var subject = new GridFSDownloadOptions();
 
+#pragma warning disable CS0618 // Type or member is obsolete
             subject.CheckMD5 = true;
 
             subject.CheckMD5.Should().Be(true);
+#pragma warning restore CS0618 // Type or member is obsolete
         }
 
         [Fact]
         public void default_constructor_should_return_expected_result()
         {
             var result = new GridFSDownloadOptions();
 
+#pragma warning disable CS0618 // Type or member is obsolete
             result.CheckMD5.Should().NotHaveValue();
+#pragma warning restore CS0618 // Type or member is obsolete
             result.Seekable.Should().NotHaveValue();
         }
 
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSMD5ExceptionTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSMD5ExceptionTests.cs
@@ -26,31 +26,39 @@ public class GridFSMD5ExceptionTests
         [Fact]
         public void constructor_should_initialize_instance()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var result = new GridFSMD5Exception(123);
+#pragma warning restore CS0618 // Type or member is obsolete
 
             result.Message.Should().Contain("id 123");
         }
 
         [Fact]
         public void constructor_should_throw_when_id_is_null()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             Action action = () => new GridFSMD5Exception(null);
+#pragma warning restore CS0618 // Type or member is obsolete
 
             action.ShouldThrow<ArgumentNullException>().And.ParamName.Should().Be("id");
         }
 
         [Fact]
         public void Serialization_should_work()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var subject = new GridFSMD5Exception(123);
+#pragma warning restore CS0618 // Type or member is obsolete
 
             var formatter = new BinaryFormatter();
             using (var stream = new MemoryStream())
             {
 #pragma warning disable SYSLIB0011 // BinaryFormatter serialization is obsolete
                 formatter.Serialize(stream, subject);
                 stream.Position = 0;
+#pragma warning disable CS0618 // Type or member is obsolete
                 var rehydrated = (GridFSMD5Exception)formatter.Deserialize(stream);
+#pragma warning restore CS0618 // Type or member is obsolete
 #pragma warning restore SYSLIB0011 // BinaryFormatter serialization is obsolete
 
                 rehydrated.Message.Should().Be(subject.Message);
diff --git a/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSDownloadAsBytesByNameTest.cs b/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSDownloadAsBytesByNameTest.cs
@@ -79,7 +79,9 @@ private void ParseOptions(BsonDocument options)
                 switch (option.Name)
                 {
                     case "checkMD5":
+#pragma warning disable CS0618 // Type or member is obsolete
                         _options.CheckMD5 = option.Value.ToBoolean();
+#pragma warning restore CS0618 // Type or member is obsolete
                         break;
 
                     case "revision":
diff --git a/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSDownloadAsBytesTest.cs b/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSDownloadAsBytesTest.cs
@@ -79,7 +79,9 @@ private void ParseOptions(BsonDocument options)
                 switch (option.Name)
                 {
                     case "checkMD5":
+#pragma warning disable CS0618 // Type or member is obsolete
                         _options.CheckMD5 = option.Value.ToBoolean();
+#pragma warning restore CS0618 // Type or member is obsolete
                         break;
 
                     default:
diff --git a/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSUploadFromBytesTest.cs b/tests/MongoDB.Driver.GridFS.Tests/Specifications/gridfs/GridFSUploadFromBytesTest.cs
@@ -101,7 +101,9 @@ private void ParseOptions(BsonDocument options)
                         break;
 
                     case "disableMD5":
+#pragma warning disable CS0618 // Type or member is obsolete
                         _options.DisableMD5 = option.Value.AsBoolean;
+#pragma warning restore CS0618 // Type or member is obsolete
                         break;
 
                     case "metadata":

Original file line number	Diff line number	Diff line change
`@@ -577,7 +577,9 @@ private BulkMixedWriteOperation CreateDeleteChunksOperation(TFileId id)`
`577`	`577`
`578`	`578`	`private GridFSDownloadStream<TFileId> CreateDownloadStream(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))`
`579`	`579`	`{`
	`580`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`580`	`581`	`var checkMD5 = options.CheckMD5 ?? false;`
	`582`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`581`	`583`	`var seekable = options.Seekable ?? false;`
`582`	`584`	`if (checkMD5 && seekable)`
`583`	`585`	`{`
`@@ -777,7 +779,9 @@ private GridFSUploadStream<TFileId> CreateUploadStream(IReadWriteBindingHandle b`
`777`	`779`
`778`	`780`	`private void DownloadToStreamHelper(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, Stream destination, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))`
`779`	`781`	`{`
	`782`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`780`	`783`	`var checkMD5 = options.CheckMD5 ?? false;`
	`784`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`781`	`785`
`782`	`786`	`var retryReads = _database.Client.Settings.RetryReads;`
`783`	`787`	`using (var source = new GridFSForwardOnlyDownloadStream<TFileId>(this, binding.Fork(), fileInfo, checkMD5) { RetryReads = retryReads })`
`@@ -798,7 +802,9 @@ private GridFSUploadStream<TFileId> CreateUploadStream(IReadWriteBindingHandle b`
`798`	`802`
`799`	`803`	`private async Task DownloadToStreamHelperAsync(IReadBindingHandle binding, GridFSFileInfo<TFileId> fileInfo, Stream destination, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))`
`800`	`804`	`{`
	`805`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`801`	`806`	`var checkMD5 = options.CheckMD5 ?? false;`
	`807`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`802`	`808`
`803`	`809`	`var retryReads = _database.Client.Settings.RetryReads;`
`804`	`810`	`using (var source = new GridFSForwardOnlyDownloadStream<TFileId>(this, binding.Fork(), fileInfo, checkMD5) { RetryReads = retryReads })`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ public long Length`
`129`	`129`	`/// <value>`
`130`	`130`	`/// The MD5 checksum.`
`131`	`131`	`/// </value>`
	`132`	`+ [Obsolete("MD5 support will be removed in a later release.")]`
`132`	`133`	`public string MD5`
`133`	`134`	`{`
`134`	`135`	`get { return GetValue<string>("MD5", null); }`
Original file line number	Diff line number	Diff line change
`@@ -157,12 +157,12 @@ protected override void CloseImplementation(CancellationToken cancellationToken)`
`157`	`157`	`if (_checkMD5 && _position == FileInfo.Length)`
`158`	`158`	`{`
`159`	`159`	`var md5 = BsonUtils.ToHexString(_md5.GetHashAndReset());`
	`160`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`160`	`161`	`if (!md5.Equals(FileInfo.MD5, StringComparison.OrdinalIgnoreCase))`
`161`	`162`	`{`
`162`		`-#pragma warning disable 618`
`163`	`163`	`throw new GridFSMD5Exception(_idAsBsonValue);`
`164`		`-#pragma warning restore`
`165`	`164`	`}`
	`165`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ namespace MongoDB.Driver.GridFS`
`24`	`24`	`/// Represents a GridFSMD5 exception.`
`25`	`25`	`/// </summary>`
`26`	`26`	`[Serializable]`
	`27`	`+ [Obsolete("MD5 support will be removed in a later release.")]`
`27`	`28`	`public class GridFSMD5Exception : GridFSException`
`28`	`29`	`{`
`29`	`30`	`#region static`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ public string ContentType`
`94`	`94`	`/// <value>`
`95`	`95`	`/// Whether or not MD5 checksum computation is disabled when uploading a GridFS file.`
`96`	`96`	`/// </value>`
	`97`	`+ [Obsolete("MD5 support will be removed in a later release.")]`
`97`	`98`	`public bool DisableMD5`
`98`	`99`	`{`
`99`	`100`	`get { return _disableMD5; }`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,11 @@ public class GridFSDownloadOptionsTests`
`28`	`28`	`[Fact]`
`29`	`29`	`public void CheckMD5_get_should_return_expected_result()`
`30`	`30`	`{`
	`31`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`31`	`32`	`var subject = new GridFSDownloadOptions { CheckMD5 = true };`
`32`	`33`
`33`	`34`	`var result = subject.CheckMD5;`
	`35`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`34`	`36`
`35`	`37`	`result.Should().Be(true);`
`36`	`38`	`}`
`@@ -40,17 +42,21 @@ public void CheckMD5_set_should_have_expected_result()`
`40`	`42`	`{`
`41`	`43`	`var subject = new GridFSDownloadOptions();`
`42`	`44`
	`45`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`43`	`46`	`subject.CheckMD5 = true;`
`44`	`47`
`45`	`48`	`subject.CheckMD5.Should().Be(true);`
	`49`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`46`	`50`	`}`
`47`	`51`
`48`	`52`	`[Fact]`
`49`	`53`	`public void default_constructor_should_return_expected_result()`
`50`	`54`	`{`
`51`	`55`	`var result = new GridFSDownloadOptions();`
`52`	`56`
	`57`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`53`	`58`	`result.CheckMD5.Should().NotHaveValue();`
	`59`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`54`	`60`	`result.Seekable.Should().NotHaveValue();`
`55`	`61`	`}`
`56`	`62`