Add MongoDB.Driver v3 client integration package

Aspire.sln

@@ -637,6 +637,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ServiceBusWorker", "playgro
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ServiceBus.AppHost", "playground\AzureServiceBus\ServiceBus.AppHost\ServiceBus.AppHost.csproj", "{A7EC9111-F3CC-46E8-B95E-3768481D67B4}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aspire.MongoDB.Driver.v3", "src\Components\Aspire.MongoDB.Driver.v3\Aspire.MongoDB.Driver.v3.csproj", "{FD53B608-138D-8FB1-AA57-9B8CD42CF13E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aspire.MongoDB.Driver.v3.Tests", "tests\Aspire.MongoDB.Driver.v3.Tests\Aspire.MongoDB.Driver.v3.Tests.csproj", "{223AF8EB-3A4E-E778-4EBD-6E4876C308B6}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -1667,6 +1671,14 @@ Global
 		{A7EC9111-F3CC-46E8-B95E-3768481D67B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A7EC9111-F3CC-46E8-B95E-3768481D67B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{A7EC9111-F3CC-46E8-B95E-3768481D67B4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FD53B608-138D-8FB1-AA57-9B8CD42CF13E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FD53B608-138D-8FB1-AA57-9B8CD42CF13E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FD53B608-138D-8FB1-AA57-9B8CD42CF13E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FD53B608-138D-8FB1-AA57-9B8CD42CF13E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{223AF8EB-3A4E-E778-4EBD-6E4876C308B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{223AF8EB-3A4E-E778-4EBD-6E4876C308B6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{223AF8EB-3A4E-E778-4EBD-6E4876C308B6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{223AF8EB-3A4E-E778-4EBD-6E4876C308B6}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1973,6 +1985,8 @@ Global
 		{D2938171-1DBB-4E8D-AF16-97F75F1AE6DE} = {D173887B-AF42-4576-B9C1-96B9E9B3D9C0}
 		{162F0B66-E88F-4735-8CE0-BE8950F74CC6} = {D2938171-1DBB-4E8D-AF16-97F75F1AE6DE}
 		{A7EC9111-F3CC-46E8-B95E-3768481D67B4} = {D2938171-1DBB-4E8D-AF16-97F75F1AE6DE}
+		{FD53B608-138D-8FB1-AA57-9B8CD42CF13E} = {27381127-6C45-4B4C-8F18-41FF48DFE4B2}
+		{223AF8EB-3A4E-E778-4EBD-6E4876C308B6} = {C424395C-1235-41A4-BF55-07880A04368C}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {6DCEDFEC-988E-4CB3-B45B-191EB5086E0C}

Directory.Packages.props

@@ -58,7 +58,7 @@
     <PackageVersion Include="AspNetCore.HealthChecks.AzureServiceBus" Version="8.0.1" />
     <PackageVersion Include="AspNetCore.HealthChecks.CosmosDb" Version="8.0.1" />
     <PackageVersion Include="AspNetCore.HealthChecks.Kafka" Version="8.0.1" />
-    <PackageVersion Include="AspNetCore.HealthChecks.MongoDb" Version="8.1.0" />
+    <PackageVersion Include="AspNetCore.HealthChecks.MongoDb" Version="9.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.MySql" Version="8.0.1" />
     <PackageVersion Include="AspNetCore.HealthChecks.NpgSql" Version="8.0.2" />
     <PackageVersion Include="AspNetCore.HealthChecks.Oracle" Version="8.0.1" />
@@ -90,8 +90,8 @@
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components" Version="4.10.3" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components.Icons" Version="4.10.3" />
     <PackageVersion Include="Milvus.Client" Version="2.3.0-preview.1" />
-    <PackageVersion Include="MongoDB.Driver" Version="[2.30.0,3.0.0)" />
-    <PackageVersion Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" Version="1.5.0" />
+    <PackageVersion Include="MongoDB.Driver" Version="3.1.0" />
+    <PackageVersion Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" Version="2.0.0" />
     <PackageVersion Include="MySqlConnector.DependencyInjection" Version="2.3.6" />
     <PackageVersion Include="MySqlConnector.Logging.Microsoft.Extensions.Logging" Version="2.1.0" />
     <PackageVersion Include="NATS.Net" Version="2.5.3" />

playground/mongo/Mongo.ApiService/Mongo.ApiService.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <AspireProjectOrPackageReference Include="Aspire.MongoDB.Driver" />
+    <AspireProjectOrPackageReference Include="Aspire.MongoDB.Driver.v3" />
 
     <ProjectReference Include="..\..\Playground.ServiceDefaults\Playground.ServiceDefaults.csproj" />
   </ItemGroup>

src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs

@@ -7,6 +7,7 @@
 using Aspire.Hosting.MongoDB;
 using Aspire.Hosting.Utils;
 using Microsoft.Extensions.DependencyInjection;
+using MongoDB.Driver;
 
 namespace Aspire.Hosting;
 
@@ -71,7 +72,12 @@ public static IResourceBuilder<MongoDBServerResource> AddMongoDB(this IDistribut
         });
 
         var healthCheckKey = $"{name}_check";
-        builder.Services.AddHealthChecks().AddMongoDb(sp => connectionString ?? throw new InvalidOperationException("Connection string is unavailable"), name: healthCheckKey);
+        // cache the client so it is reused on subsequent calls to the health check
+        IMongoClient? client = null;
+        builder.Services.AddHealthChecks()
+            .AddMongoDb(
+                sp => client ??= new MongoClient(connectionString ?? throw new InvalidOperationException("Connection string is unavailable")),
+                name: healthCheckKey);
 
         return builder
             .AddResource(mongoDBContainer)
@@ -117,7 +123,14 @@ public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(this IResour
         });
 
         var healthCheckKey = $"{name}_check";
-        builder.ApplicationBuilder.Services.AddHealthChecks().AddMongoDb(sp => connectionString ?? throw new InvalidOperationException("Connection string is unavailable"), name: healthCheckKey);
+        // cache the database client so it is reused on subsequent calls to the health check
+        IMongoDatabase? database = null;
+        builder.ApplicationBuilder.Services.AddHealthChecks()
+            .AddMongoDb(
+                sp => database ??=
+                    new MongoClient(connectionString ?? throw new InvalidOperationException("Connection string is unavailable"))
+                        .GetDatabase(databaseName),
+                name: healthCheckKey);
 
         return builder.ApplicationBuilder
             .AddResource(mongoDBDatabase);

src/Components/Aspire.MongoDB.Driver.v3/Aspire.MongoDB.Driver.v3.csproj

@@ -0,0 +1,42 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>$(DefaultTargetFramework)</TargetFramework>
+    <IsPackable>true</IsPackable>
+    <PackageTags>$(ComponentDatabasePackageTags) MongoDB</PackageTags>
+    <PackageIconFullPath>$(SharedDir)MongoDB_300px.png</PackageIconFullPath>
+    <Description>A generic MongoDB client that integrates with Aspire.</Description>
+    <MinCodeCoverage>86</MinCodeCoverage>
+    <!-- MongoDB.Driver.Core.Extensions.DiagnosticSources is not signed -->
+    <NoWarn>$(NoWarn);CS8002</NoWarn>
+    <!-- Disable package validation as this package hasn't shipped yet. -->
+    <EnablePackageValidation>false</EnablePackageValidation>
+
+    <!-- Keep the same assembly name as the main library. -->
+    <AssemblyName>Aspire.MongoDB.Driver</AssemblyName>
+    <!-- PackageId defaults to AssemblyName, so need to reset it. -->
+    <PackageId>$(MSBuildProjectName)</PackageId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="..\Aspire.MongoDB.Driver\AspireMongoDBDriverExtensions.cs" />
+    <Compile Include="..\Aspire.MongoDB.Driver\AssemblyInfo.cs" />
+    <Compile Include="..\Aspire.MongoDB.Driver\MongoDBSettings.cs" />
+    <None Include="..\Aspire.MongoDB.Driver\README.md" Pack="true" PackagePath="\" />
+
+    <Compile Include="..\Common\ConfigurationSchemaAttributes.cs" Link="ConfigurationSchemaAttributes.cs" />
+    <Compile Include="..\Common\HealthChecksExtensions.cs" Link="HealthChecksExtensions.cs" />
+    <Compile Include="..\Common\ConnectionStringValidation.cs" Link="ConnectionStringValidation.cs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="AspNetCore.HealthChecks.MongoDb" />
+    <PackageReference Include="MongoDB.Driver" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
+    <PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+  </ItemGroup>
+
+</Project>

src/Components/Aspire.MongoDB.Driver.v3/ConfigurationSchema.json

@@ -0,0 +1,63 @@
+{
+  "definitions": {
+    "logLevel": {
+      "properties": {
+        "MongoDB": {
+          "$ref": "#/definitions/logLevelThreshold"
+        },
+        "MongoDB.Command": {
+          "$ref": "#/definitions/logLevelThreshold"
+        },
+        "MongoDB.Connection": {
+          "$ref": "#/definitions/logLevelThreshold"
+        },
+        "MongoDB.Internal": {
+          "$ref": "#/definitions/logLevelThreshold"
+        },
+        "MongoDB.SDAM": {
+          "$ref": "#/definitions/logLevelThreshold"
+        },
+        "MongoDB.ServerSelection": {
+          "$ref": "#/definitions/logLevelThreshold"
+        }
+      }
+    }
+  },
+  "type": "object",
+  "properties": {
+    "Aspire": {
+      "type": "object",
+      "properties": {
+        "MongoDB": {
+          "type": "object",
+          "properties": {
+            "Driver": {
+              "type": "object",
+              "properties": {
+                "ConnectionString": {
+                  "type": "string",
+                  "description": "Gets or sets the connection string of the MongoDB database to connect to."
+                },
+                "DisableHealthChecks": {
+                  "type": "boolean",
+                  "description": "Gets or sets a boolean value that indicates whether the MongoDB health check is disabled or not.",
+                  "default": false
+                },
+                "DisableTracing": {
+                  "type": "boolean",
+                  "description": "Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.",
+                  "default": false
+                },
+                "HealthCheckTimeout": {
+                  "type": "integer",
+                  "description": "Gets or sets a integer value that indicates the MongoDB health check timeout in milliseconds."
+                }
+              },
+              "description": "Provides the client configuration settings for connecting to a MongoDB database using MongoDB driver."
+            }
+          }
+        }
+      }
+    }
+  }
+}

src/Components/Aspire.MongoDB.Driver.v3/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/Components/Aspire.MongoDB.Driver.v3/PublicAPI.Unshipped.txt

@@ -0,0 +1,14 @@
+#nullable enable
+Aspire.MongoDB.Driver.MongoDBSettings
+Aspire.MongoDB.Driver.MongoDBSettings.ConnectionString.get -> string?
+Aspire.MongoDB.Driver.MongoDBSettings.ConnectionString.set -> void
+Aspire.MongoDB.Driver.MongoDBSettings.DisableHealthChecks.get -> bool
+Aspire.MongoDB.Driver.MongoDBSettings.DisableHealthChecks.set -> void
+Aspire.MongoDB.Driver.MongoDBSettings.DisableTracing.get -> bool
+Aspire.MongoDB.Driver.MongoDBSettings.DisableTracing.set -> void
+Aspire.MongoDB.Driver.MongoDBSettings.HealthCheckTimeout.get -> int?
+Aspire.MongoDB.Driver.MongoDBSettings.HealthCheckTimeout.set -> void
+Aspire.MongoDB.Driver.MongoDBSettings.MongoDBSettings() -> void
+Microsoft.Extensions.Hosting.AspireMongoDBDriverExtensions
+static Microsoft.Extensions.Hosting.AspireMongoDBDriverExtensions.AddKeyedMongoDBClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! name, System.Action<Aspire.MongoDB.Driver.MongoDBSettings!>? configureSettings = null, System.Action<MongoDB.Driver.MongoClientSettings!>? configureClientSettings = null) -> void
+static Microsoft.Extensions.Hosting.AspireMongoDBDriverExtensions.AddMongoDBClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder! builder, string! connectionName, System.Action<Aspire.MongoDB.Driver.MongoDBSettings!>? configureSettings = null, System.Action<MongoDB.Driver.MongoClientSettings!>? configureClientSettings = null) -> void

src/Components/Aspire.MongoDB.Driver/Aspire.MongoDB.Driver.csproj

@@ -6,7 +6,9 @@
     <PackageTags>$(ComponentDatabasePackageTags) MongoDB</PackageTags>
     <PackageIconFullPath>$(SharedDir)MongoDB_300px.png</PackageIconFullPath>
     <Description>A generic MongoDB client that integrates with Aspire.</Description>
-    <NoWarn>$(NoWarn);CS8002</NoWarn> <!-- MongoDB.Driver.Core.Extensions.DiagnosticSources and AspNetCore.HealthChecks.MongoDb packages are not signed -->
+    <!-- MongoDB.Driver.Core.Extensions.DiagnosticSources and AspNetCore.HealthChecks.MongoDb packages are not signed -->
+    <NoWarn>$(NoWarn);CS8002</NoWarn>
+    <DefineConstants>$(DefineConstants);MONGODB_V2</DefineConstants>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -20,14 +22,13 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="AspNetCore.HealthChecks.MongoDb" />
-    <PackageReference Include="MongoDB.Driver" />
+    <PackageReference Include="AspNetCore.HealthChecks.MongoDb" VersionOverride="[8.1.0,9.0.0)" />
+    <PackageReference Include="MongoDB.Driver" VersionOverride="[2.30.0,3.0.0)" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
-    <PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" />
+    <PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" VersionOverride="[1.5.0,2.0.0)" />
     <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
   </ItemGroup>
 
-
 </Project>

src/Components/Aspire.MongoDB.Driver/AspireMongoDBDriverExtensions.cs

@@ -95,7 +95,8 @@ private static void AddMongoDBClient(
 
         builder.AddMongoDatabase(settings.ConnectionString, serviceKey);
         builder.AddHealthCheck(
-            serviceKey is null ? "MongoDB.Driver" : $"MongoDB.Driver_{connectionName}",
+            connectionName,
+            serviceKey,
             settings);
     }
 
@@ -158,18 +159,27 @@ private static void AddMongoDatabase(
 
     private static void AddHealthCheck(
         this IHostApplicationBuilder builder,
-        string healthCheckName,
+        string connectionName,
+        object? serviceKey,
         MongoDBSettings settings)
     {
         if (settings.DisableHealthChecks || string.IsNullOrWhiteSpace(settings.ConnectionString))
         {
             return;
         }
 
+        var healthCheckName = serviceKey is null ? "MongoDB.Driver" : $"MongoDB.Driver_{connectionName}";
         builder.TryAddHealthCheck(
             healthCheckName,
             healthCheck => healthCheck.AddMongoDb(
+#if MONGODB_V2
                 settings.ConnectionString,
+#else
+                serviceKey is null
+                    ? sp => sp.GetRequiredService<IMongoClient>()
+                    : sp => sp.GetRequiredKeyedService<IMongoClient>(serviceKey),
+                _ => MongoUrl.Create(settings.ConnectionString).DatabaseName,
+#endif
                 healthCheckName,
                 null,
                 null,
@@ -194,7 +204,7 @@ private static MongoClient CreateMongoClient(
         configureClientSettings?.Invoke(clientSettings);
 
         clientSettings.LoggingSettings ??= new LoggingSettings(serviceProvider.GetService<ILoggerFactory>());
-        
+
         var aspireVersion = typeof(MongoDBSettings).Assembly.GetName().Version?.ToString();
         if (clientSettings.LibraryInfo != null)
         {
@@ -204,7 +214,7 @@ private static MongoClient CreateMongoClient(
         {
             clientSettings.LibraryInfo = new LibraryInfo("aspire", aspireVersion);
         }
-        
+
         return new MongoClient(clientSettings);
     }
 

tests/Aspire.Hosting.MongoDB.Tests/Aspire.Hosting.MongoDB.Tests.csproj

@@ -6,7 +6,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\Aspire.Hosting.MongoDB\Aspire.Hosting.MongoDB.csproj" />
-    <ProjectReference Include="..\..\src\Components\Aspire.MongoDB.Driver\Aspire.MongoDB.Driver.csproj" />
+    <ProjectReference Include="..\..\src\Components\Aspire.MongoDB.Driver.v3\Aspire.MongoDB.Driver.v3.csproj" />
     <ProjectReference Include="..\Aspire.Hosting.Tests\Aspire.Hosting.Tests.csproj" />
 
     <PackageReference Include="Microsoft.Extensions.Http.Resilience" />

tests/Aspire.MongoDB.Driver.Tests/Aspire.MongoDB.Driver.Tests.csproj

@@ -10,6 +10,10 @@
     <None Include="$(RepoRoot)src\Components\Aspire.MongoDB.Driver\ConfigurationSchema.json" CopyToOutputDirectory="PreserveNewest" />
 
     <ProjectReference Include="..\..\src\Components\Aspire.MongoDB.Driver\Aspire.MongoDB.Driver.csproj" />
+    <PackageReference Include="AspNetCore.HealthChecks.MongoDb" VersionOverride="[8.1.0,9.0.0)" />
+    <PackageReference Include="MongoDB.Driver" VersionOverride="[2.30.0,3.0.0)" />
+    <PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" VersionOverride="[1.5.0,2.0.0)" />
+
     <ProjectReference Include="..\Aspire.Components.Common.Tests\Aspire.Components.Common.Tests.csproj" />
 
     <PackageReference Include="TestContainers.MongoDb" />

tests/Aspire.MongoDB.Driver.v3.Tests/Aspire.MongoDB.Driver.v3.Tests.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>$(DefaultTargetFramework)</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="$(RepoRoot)src\Components\Aspire.MongoDB.Driver\ConfigurationSchema.json" CopyToOutputDirectory="PreserveNewest" />
+    <Compile Include="$(RepoRoot)src\Aspire.Hosting.MongoDB\MongoDBContainerImageTags.cs" />
+
+    <Compile Include="..\Aspire.MongoDB.Driver.Tests\AspireMongoDBDriverExtensionsTests.cs" />
+    <Compile Include="..\Aspire.MongoDB.Driver.Tests\ConformanceTests.cs" />
+    <Compile Include="..\Aspire.MongoDB.Driver.Tests\MongoDbContainerFixture.cs" />
+    <Compile Include="..\Aspire.MongoDB.Driver.Tests\MongoDBDriverPublicApiTests.cs" />
+
+    <ProjectReference Include="..\..\src\Components\Aspire.MongoDB.Driver.v3\Aspire.MongoDB.Driver.v3.csproj" />
+    <ProjectReference Include="..\Aspire.Components.Common.Tests\Aspire.Components.Common.Tests.csproj" />
+
+    <PackageReference Include="TestContainers.MongoDb" />
+  </ItemGroup>
+
+</Project>

tests/Shared/RepoTesting/Directory.Packages.Helix.props

@@ -63,6 +63,7 @@
     <PackageVersion Include="Aspire.Microsoft.EntityFrameworkCore.SqlServer" Version="$(PackageVersion)" />
     <PackageVersion Include="Aspire.Milvus.Client" Version="$(PackageVersion)" />
     <PackageVersion Include="Aspire.MongoDB.Driver" Version="$(PackageVersion)" />
+    <PackageVersion Include="Aspire.MongoDB.Driver.v3" Version="$(PackageVersion)" />
     <PackageVersion Include="Aspire.MySqlConnector" Version="$(PackageVersion)" />
     <PackageVersion Include="Aspire.NATS.Net" Version="$(PackageVersion)" />
     <PackageVersion Include="Aspire.Npgsql" Version="$(PackageVersion)" />