CSHARP-3431: Make MongoClient IDisposable (mongodb#1461)

obligaron · Oct 9, 2024 · 10658fe · 10658fe
1 parent 2086b5a
commit 10658fe
Show file tree

Hide file tree

Showing 78 changed files with 598 additions and 602 deletions.
diff --git a/benchmarks/MongoDB.Driver.Benchmarks/BenchmarkHelper.cs b/benchmarks/MongoDB.Driver.Benchmarks/BenchmarkHelper.cs
@@ -20,7 +20,6 @@
 using System.Linq;
 using MongoDB.Bson;
 using MongoDB.Driver;
-using MongoDB.Driver.TestHelpers;
 
 namespace MongoDB.Benchmarks
 {
@@ -79,13 +78,16 @@ public static class MongoConfiguration
             public const string PerfTestDatabaseName = "perftest";
             public const string PerfTestCollectionName = "corpus";
 
-            public static DisposableMongoClient CreateDisposableClient()
+            public static IMongoClient CreateClient()
             {
                 var mongoUri = Environment.GetEnvironmentVariable("MONGODB_URI");
-                var client = mongoUri != null ? new MongoClient(mongoUri) : new MongoClient();
+                var settings = mongoUri != null ? MongoClientSettings.FromConnectionString(mongoUri) : new();
+                settings.ClusterSource = DisposingClusterSource.Instance;
+
+                var client = new MongoClient(settings);
                 client.DropDatabase(PerfTestDatabaseName);
 
-                return new DisposableMongoClient(client, null);
+                return client;
             }
         }
     }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/LibmongocryptBindingBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/LibmongocryptBindingBenchmark.cs
@@ -21,7 +21,6 @@
 using MongoDB.Bson.TestHelpers;
 using MongoDB.Driver;
 using MongoDB.Driver.Encryption;
-using MongoDB.Driver.TestHelpers;
 
 namespace MongoDB.Benchmarks
 {
@@ -31,7 +30,7 @@ public class LibmongocryptBindingBenchmark
         private const string LocalMasterKey = "Mng0NCt4ZHVUYUJCa1kxNkVyNUR1QURhZ2h2UzR2d2RrZzh0cFBwM3R6NmdWMDFBMUN3YkQ5aXRRMkhGRGdQV09wOGVNYUMxT2k3NjZKelhaQmRCZGJkTXVyZG9uSjFk";
 
         private byte[] _encryptedValuesDocumentBytes;
-        private DisposableMongoClient _disposableKeyVaultClient;
+        private IMongoClient _disposableKeyVaultClient;
         private IAutoEncryptionLibMongoCryptController _libMongoCryptController;
 
         [Params(1)]
@@ -56,8 +55,9 @@ public void Setup()
 
             var clientSettings = MongoClientSettings.FromConnectionString("mongodb://localhost");
             clientSettings.AutoEncryptionOptions = autoEncryptionOptions;
+            clientSettings.ClusterSource = DisposingClusterSource.Instance;
 
-            _disposableKeyVaultClient = new DisposableMongoClient(new MongoClient(clientSettings), null);
+            _disposableKeyVaultClient = new MongoClient(clientSettings);
 
             var keyVaultDatabase = _disposableKeyVaultClient.GetDatabase(keyVaultNamespace.DatabaseNamespace.DatabaseName);
             keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName);

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/FindManyBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/FindManyBenchmark.cs
@@ -26,7 +26,7 @@ namespace MongoDB.Benchmarks.MultiDoc
     [BenchmarkCategory(DriverBenchmarkCategory.MultiBench, DriverBenchmarkCategory.ReadBench, DriverBenchmarkCategory.DriverBench)]
     public class FindManyBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private BsonDocument _tweetDocument;
 
@@ -36,7 +36,7 @@ public class FindManyBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _tweetDocument = ReadExtendedJson("single_and_multi_document/tweet.json");
             _collection = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName).GetCollection<BsonDocument>(MongoConfiguration.PerfTestCollectionName);
 

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/GridFSDownloadBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/GridFSDownloadBenchmark.cs
@@ -16,8 +16,8 @@
 using System.IO;
 using BenchmarkDotNet.Attributes;
 using MongoDB.Bson;
+using MongoDB.Driver;
 using MongoDB.Driver.GridFS;
-using MongoDB.Driver.TestHelpers;
 using static MongoDB.Benchmarks.BenchmarkHelper;
 
 namespace MongoDB.Benchmarks.MultiDoc
@@ -26,7 +26,7 @@ namespace MongoDB.Benchmarks.MultiDoc
     [BenchmarkCategory(DriverBenchmarkCategory.MultiBench, DriverBenchmarkCategory.ReadBench, DriverBenchmarkCategory.DriverBench)]
     public class GridFsDownloadBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private ObjectId _fileId;
         private GridFSBucket _gridFsBucket;
 
@@ -36,7 +36,7 @@ public class GridFsDownloadBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _gridFsBucket = new GridFSBucket(_client.GetDatabase(MongoConfiguration.PerfTestDatabaseName));
             _fileId = _gridFsBucket.UploadFromStream("gridfstest", File.OpenRead($"{DataFolderPath}single_and_multi_document/gridfs_large.bin"));
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/GridFSUploadBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/GridFSUploadBenchmark.cs
@@ -15,8 +15,8 @@
 
 using System.IO;
 using BenchmarkDotNet.Attributes;
+using MongoDB.Driver;
 using MongoDB.Driver.GridFS;
-using MongoDB.Driver.TestHelpers;
 using static MongoDB.Benchmarks.BenchmarkHelper;
 
 namespace MongoDB.Benchmarks.MultiDoc
@@ -25,7 +25,7 @@ namespace MongoDB.Benchmarks.MultiDoc
     [BenchmarkCategory(DriverBenchmarkCategory.MultiBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class GridFsUploadBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private byte[] _fileBytes;
         private GridFSBucket _gridFsBucket;
 
@@ -35,7 +35,7 @@ public class GridFsUploadBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _fileBytes = File.ReadAllBytes($"{DataFolderPath}single_and_multi_document/gridfs_large.bin");
             _gridFsBucket = new GridFSBucket(_client.GetDatabase(MongoConfiguration.PerfTestDatabaseName));
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/InsertManyLargeBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/InsertManyLargeBenchmark.cs
@@ -27,7 +27,7 @@ namespace MongoDB.Benchmarks.MultiDoc
     [BenchmarkCategory(DriverBenchmarkCategory.MultiBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class InsertManyLargeBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private IEnumerable<BsonDocument> _largeDocuments;
@@ -38,7 +38,7 @@ public class InsertManyLargeBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
 
             var largeDocument = ReadExtendedJson("single_and_multi_document/large_doc.json");

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/InsertManySmallBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/MultiDoc/InsertManySmallBenchmark.cs
@@ -27,7 +27,7 @@ namespace MongoDB.Benchmarks.MultiDoc
     [BenchmarkCategory(DriverBenchmarkCategory.MultiBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class InsertManySmallBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private IEnumerable<BsonDocument> _smallDocuments;
@@ -38,7 +38,7 @@ public class InsertManySmallBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
 
             var smallDocument = ReadExtendedJson("single_and_multi_document/small_doc.json");

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/GridFSMultiFileDownloadBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/GridFSMultiFileDownloadBenchmark.cs
@@ -17,8 +17,8 @@
 using System.IO;
 using BenchmarkDotNet.Attributes;
 using MongoDB.Bson.TestHelpers;
+using MongoDB.Driver;
 using MongoDB.Driver.GridFS;
-using MongoDB.Driver.TestHelpers;
 using static MongoDB.Benchmarks.BenchmarkHelper;
 
 namespace MongoDB.Benchmarks.ParallelBench
@@ -27,7 +27,7 @@ namespace MongoDB.Benchmarks.ParallelBench
     [BenchmarkCategory(DriverBenchmarkCategory.ParallelBench, DriverBenchmarkCategory.ReadBench, DriverBenchmarkCategory.DriverBench)]
     public class GridFSMultiFileDownloadBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private GridFSBucket _gridFsBucket;
         private string _tmpDirectoryPath;
         private ConcurrentQueue<(string, int)> _filesToDownload;
@@ -38,7 +38,7 @@ public class GridFSMultiFileDownloadBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _gridFsBucket = new GridFSBucket(_client.GetDatabase(MongoConfiguration.PerfTestDatabaseName));
             _gridFsBucket.Drop();
             _tmpDirectoryPath = $"{DataFolderPath}parallel/tmpGridFS";

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/GridFSMultiFileUploadBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/GridFSMultiFileUploadBenchmark.cs
@@ -17,8 +17,8 @@
 using System.IO;
 using BenchmarkDotNet.Attributes;
 using MongoDB.Bson.TestHelpers;
+using MongoDB.Driver;
 using MongoDB.Driver.GridFS;
-using MongoDB.Driver.TestHelpers;
 using static MongoDB.Benchmarks.BenchmarkHelper;
 
 namespace MongoDB.Benchmarks.ParallelBench
@@ -27,7 +27,7 @@ namespace MongoDB.Benchmarks.ParallelBench
     [BenchmarkCategory(DriverBenchmarkCategory.ParallelBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class GridFSMultiFileUploadBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private GridFSBucket _gridFsBucket;
         private ConcurrentQueue<(string, int)> _filesToUpload;
 
@@ -37,7 +37,7 @@ public class GridFSMultiFileUploadBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _gridFsBucket = new GridFSBucket(_client.GetDatabase(MongoConfiguration.PerfTestDatabaseName));
             _filesToUpload = new ConcurrentQueue<(string, int)>();
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/MultiFileExportBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/MultiFileExportBenchmark.cs
@@ -30,7 +30,7 @@ namespace MongoDB.Benchmarks.ParallelBench
     [BenchmarkCategory(DriverBenchmarkCategory.ParallelBench, DriverBenchmarkCategory.ReadBench, DriverBenchmarkCategory.DriverBench)]
     public class MultiFileExportBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private string _tmpDirectoryPath;
@@ -42,7 +42,7 @@ public class MultiFileExportBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
             _collection = _database.GetCollection<BsonDocument>(MongoConfiguration.PerfTestCollectionName);
             _tmpDirectoryPath = $"{DataFolderPath}parallel/tmpLDJSON";

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/MultiFileImportBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/ParallelBench/MultiFileImportBenchmark.cs
@@ -30,7 +30,7 @@ namespace MongoDB.Benchmarks.ParallelBench
     [BenchmarkCategory(DriverBenchmarkCategory.ParallelBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class MultiFileImportBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private ConcurrentQueue<(string, int)> _filesToUpload;
@@ -41,7 +41,7 @@ public class MultiFileImportBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
             _filesToUpload = new ConcurrentQueue<(string, int)>();
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/FindOneBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/FindOneBenchmark.cs
@@ -26,7 +26,7 @@ namespace MongoDB.Benchmarks.SingleDoc
     [BenchmarkCategory(DriverBenchmarkCategory.SingleBench, DriverBenchmarkCategory.ReadBench, DriverBenchmarkCategory.DriverBench)]
     public class FindOneBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private BsonDocument _tweetDocument;
 
@@ -36,7 +36,7 @@ public class FindOneBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _collection = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName).GetCollection<BsonDocument>(MongoConfiguration.PerfTestCollectionName);
             _tweetDocument = ReadExtendedJson("single_and_multi_document/tweet.json");
 

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/InsertOneLargeBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/InsertOneLargeBenchmark.cs
@@ -25,7 +25,7 @@ namespace MongoDB.Benchmarks.SingleDoc
     [BenchmarkCategory(DriverBenchmarkCategory.SingleBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class InsertOneLargeBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private BsonDocument _largeDocument;
@@ -36,7 +36,7 @@ public class InsertOneLargeBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
             _largeDocument = ReadExtendedJson("single_and_multi_document/large_doc.json");
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/InsertOneSmallBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/InsertOneSmallBenchmark.cs
@@ -25,7 +25,7 @@ namespace MongoDB.Benchmarks.SingleDoc
     [BenchmarkCategory(DriverBenchmarkCategory.SingleBench, DriverBenchmarkCategory.WriteBench, DriverBenchmarkCategory.DriverBench)]
     public class InsertOneSmallBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoCollection<BsonDocument> _collection;
         private IMongoDatabase _database;
         private BsonDocument _smallDocument;
@@ -36,7 +36,7 @@ public class InsertOneSmallBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = MongoConfiguration.CreateDisposableClient();
+            _client = MongoConfiguration.CreateClient();
             _database = _client.GetDatabase(MongoConfiguration.PerfTestDatabaseName);
             _smallDocument = ReadExtendedJson("single_and_multi_document/small_doc.json");
         }

diff --git a/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/RunCommandBenchmark.cs b/benchmarks/MongoDB.Driver.Benchmarks/SingleDoc/RunCommandBenchmark.cs
@@ -24,7 +24,7 @@ namespace MongoDB.Benchmarks.SingleDoc
     [BenchmarkCategory("RunBench")]
     public class RunCommandBenchmark
     {
-        private DisposableMongoClient _client;
+        private IMongoClient _client;
         private IMongoDatabase _database;
 
         [Params(130_000)]
@@ -33,7 +33,7 @@ public class RunCommandBenchmark
         [GlobalSetup]
         public void Setup()
         {
-            _client = BenchmarkHelper.MongoConfiguration.CreateDisposableClient();
+            _client = BenchmarkHelper.MongoConfiguration.CreateClient();
             _database = _client.GetDatabase("admin");
         }
 

diff --git a/src/MongoDB.Driver/IClusterSource.cs b/src/MongoDB.Driver/IClusterSource.cs
@@ -0,0 +1,41 @@
+/* Copyright 2010-present MongoDB Inc.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+using MongoDB.Driver.Core.Clusters;
+
+namespace MongoDB.Driver
+{
+    internal interface IClusterSource
+    {
+        public IClusterInternal Get(ClusterKey key);
+        public void Return(IClusterInternal cluster);
+    }
+
+    internal sealed class DefaultClusterSource : IClusterSource
+    {
+        public static IClusterSource Instance { get; } = new DefaultClusterSource();
+
+        public IClusterInternal Get(ClusterKey key) => ClusterRegistry.Instance.GetOrCreateCluster(key);
+        public void Return(IClusterInternal cluster) { /* Do nothing for now, until cluster caching can handle disposing */ }
+    }
+
+    internal sealed class DisposingClusterSource : IClusterSource
+    {
+        public static IClusterSource Instance { get; } = new DisposingClusterSource();
+
+        public IClusterInternal Get(ClusterKey key) => ClusterRegistry.Instance.GetOrCreateCluster(key);
+        public void Return(IClusterInternal cluster) => ClusterRegistry.Instance.UnregisterAndDisposeCluster(cluster);
+    }
+}
diff --git a/src/MongoDB.Driver/IMongoClient.cs b/src/MongoDB.Driver/IMongoClient.cs
@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 using MongoDB.Bson;
@@ -23,7 +24,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// The client interface to MongoDB.
     /// </summary>
-    public interface IMongoClient
+    public interface IMongoClient : IDisposable
     {
         /// <summary>
         /// Gets the cluster.