feat(health.ef): generic DatabaseHealthCheck<TContext>

2026-06-01 06:48:20 -04:00
parent 25dd328280
commit 2dbedce0ac
2 changed files with 130 additions and 0 deletions
@@ -0,0 +1,28 @@
+using Microsoft.EntityFrameworkCore;
+
+namespace ZB.MOM.WW.Health.EntityFrameworkCore;
+
+/// <summary>
+/// Options for <see cref="DatabaseHealthCheck{TContext}"/>.
+/// </summary>
+/// <typeparam name="TContext">The EF Core <see cref="DbContext"/> the probe runs against.</typeparam>
+public sealed class DatabaseHealthCheckOptions<TContext>
+    where TContext : DbContext
+{
+    /// <summary>
+    /// Optional query-based probe that overrides the default
+    /// <see cref="Microsoft.EntityFrameworkCore.Infrastructure.DatabaseFacade.CanConnectAsync(CancellationToken)"/>
+    /// reachability check with stricter, query-level validation (the OtOpcUa "query <c>Deployments</c>"
+    /// pattern). Throw to signal failure; return normally to signal success.
+    /// </summary>
+    /// <remarks>
+    /// Example: <c>(db, ct) => db.Deployments.AsNoTracking().Take(1).ToListAsync(ct)</c>.
+    /// When <c>null</c>, the default <c>CanConnectAsync</c> probe is used.
+    /// </remarks>
+    public Func<TContext, CancellationToken, Task>? ProbeQuery { get; set; }
+
+    /// <summary>
+    /// Maximum time the probe may run before it is treated as a failure. Defaults to 10 seconds.
+    /// </summary>
+    public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(10);
+}