Add DbDataSource for Postgresql (#1832)

src/HealthChecks.NpgSql/DependencyInjection/NpgSqlHealthCheckBuilderExtensions.cs

@@ -65,15 +65,43 @@ public static IHealthChecksBuilder AddNpgSql(
         IEnumerable<string>? tags = default,
         TimeSpan? timeout = default)
     {
-        Guard.ThrowIfNull(connectionStringFactory);
+        return builder.AddNpgSql(sp => new NpgsqlDataSourceBuilder(connectionStringFactory(sp)).Build(), healthQuery, configure, name, failureStatus, tags, timeout);
+    }
+
+    /// <summary>
+    /// Add a health check for Postgres databases.
+    /// </summary>
+    /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+    /// <param name="dbDataSourceFactory">A factory to build the NpgsqlDataSource to use.</param>
+    /// <param name="healthQuery">The query to be used in check.</param>
+    /// <param name="configure">An optional action to allow additional Npgsql specific configuration.</param>
+    /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'npgsql' will be used for the name.</param>
+    /// <param name="failureStatus">
+    /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+    /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+    /// </param>
+    /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+    /// <param name="timeout">An optional <see cref="TimeSpan"/> representing the timeout of the check.</param>
+    /// <returns>The specified <paramref name="builder"/>.</returns>
+    public static IHealthChecksBuilder AddNpgSql(
+        this IHealthChecksBuilder builder,
+        Func<IServiceProvider, NpgsqlDataSource> dbDataSourceFactory,
+        string healthQuery = HEALTH_QUERY,
+        Action<NpgsqlConnection>? configure = null,
+        string? name = default,
+        HealthStatus? failureStatus = default,
+        IEnumerable<string>? tags = default,
+        TimeSpan? timeout = default)
+    {
+        Guard.ThrowIfNull(dbDataSourceFactory);
 
         return builder.Add(new HealthCheckRegistration(
             name ?? NAME,
             sp =>
             {
                 var options = new NpgSqlHealthCheckOptions
                 {
-                    ConnectionString = connectionStringFactory(sp),
+                    DataSource = dbDataSourceFactory(sp),
                     CommandText = healthQuery,
                     Configure = configure,
                 };

src/HealthChecks.NpgSql/NpgSqlHealthCheck.cs

@@ -1,5 +1,4 @@
 using Microsoft.Extensions.Diagnostics.HealthChecks;
-using Npgsql;
 
 namespace HealthChecks.NpgSql;
 
@@ -12,7 +11,7 @@ public class NpgSqlHealthCheck : IHealthCheck
 
     public NpgSqlHealthCheck(NpgSqlHealthCheckOptions options)
     {
-        Guard.ThrowIfNull(options.ConnectionString, true);
+        Guard.ThrowIfNull(options.DataSource);
         Guard.ThrowIfNull(options.CommandText, true);
         _options = options;
     }
@@ -22,7 +21,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
     {
         try
         {
-            using var connection = new NpgsqlConnection(_options.ConnectionString);
+            await using var connection = _options.DataSource!.CreateConnection();
 
             _options.Configure?.Invoke(connection);
             await connection.OpenAsync(cancellationToken).ConfigureAwait(false);

src/HealthChecks.NpgSql/NpgSqlHealthCheckOptions.cs

@@ -11,8 +11,18 @@ public class NpgSqlHealthCheckOptions
 {
     /// <summary>
     /// The Postgres connection string to be used.
+    /// Use <see cref="DataSource"/> property for advanced configuration.
     /// </summary>
-    public string ConnectionString { get; set; } = null!;
+    public string? ConnectionString
+    {
+        get => DataSource?.ConnectionString;
+        set => DataSource = value is not null ? NpgsqlDataSource.Create(value) : null;
+    }
+
+    /// <summary>
+    /// The Postgres data source to be used.
+    /// </summary>
+    public NpgsqlDataSource? DataSource { get; set; }
 
     /// <summary>
     /// The query to be executed.

test/HealthChecks.Npgsql.Tests/DependencyInjection/RegistrationTests.cs

@@ -9,7 +9,7 @@ public void add_health_check_when_properly_configured()
     {
         var services = new ServiceCollection();
         services.AddHealthChecks()
-            .AddNpgSql("connectionstring");
+            .AddNpgSql("Server=localhost");
 
         using var serviceProvider = services.BuildServiceProvider();
         var options = serviceProvider.GetRequiredService<IOptions<HealthCheckServiceOptions>>();
@@ -27,7 +27,7 @@ public void add_named_health_check_when_properly_configured()
     {
         var services = new ServiceCollection();
         services.AddHealthChecks()
-            .AddNpgSql("connectionstring", name: "my-npg-1");
+            .AddNpgSql("Server=localhost", name: "my-npg-1");
 
         using var serviceProvider = services.BuildServiceProvider();
         var options = serviceProvider.GetRequiredService<IOptions<HealthCheckServiceOptions>>();
@@ -48,7 +48,7 @@ public void add_health_check_with_connection_string_factory_when_properly_config
             .AddNpgSql(_ =>
             {
                 factoryCalled = true;
-                return "connectionstring";
+                return "Server=localhost";
             }, name: "my-npg-1");
 
         using var serviceProvider = services.BuildServiceProvider();

test/HealthChecks.Npgsql.Tests/HealthChecks.NpgSql.approved.txt

@@ -10,7 +10,8 @@ namespace HealthChecks.NpgSql
         public NpgSqlHealthCheckOptions() { }
         public string CommandText { get; set; }
         public System.Action<Npgsql.NpgsqlConnection>? Configure { get; set; }
-        public string ConnectionString { get; set; }
+        public string? ConnectionString { get; set; }
+        public Npgsql.NpgsqlDataSource? DataSource { get; set; }
         public System.Func<object?, Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult>? HealthCheckResultBuilder { get; set; }
     }
 }
@@ -19,6 +20,7 @@ namespace Microsoft.Extensions.DependencyInjection
     public static class NpgSqlHealthCheckBuilderExtensions
     {
         public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddNpgSql(this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, HealthChecks.NpgSql.NpgSqlHealthCheckOptions options, string? name = null, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = null, System.TimeSpan? timeout = default) { }
+        public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddNpgSql(this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, System.Func<System.IServiceProvider, Npgsql.NpgsqlDataSource> dbDataSourceFactory, string healthQuery = "SELECT 1;", System.Action<Npgsql.NpgsqlConnection>? configure = null, string? name = null, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = null, System.TimeSpan? timeout = default) { }
         public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddNpgSql(this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, System.Func<System.IServiceProvider, string> connectionStringFactory, string healthQuery = "SELECT 1;", System.Action<Npgsql.NpgsqlConnection>? configure = null, string? name = null, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = null, System.TimeSpan? timeout = default) { }
         public static Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder AddNpgSql(this Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder builder, string connectionString, string healthQuery = "SELECT 1;", System.Action<Npgsql.NpgsqlConnection>? configure = null, string? name = null, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus = default, System.Collections.Generic.IEnumerable<string>? tags = null, System.TimeSpan? timeout = default) { }
     }