From 6d3d3f2cdf602c774f873314de2bc1931e862875 Mon Sep 17 00:00:00 2001 From: gprossliner <6724584+gprossliner@users.noreply.github.com> Date: Sat, 5 Sep 2026 13:47:55 +0200 Subject: [PATCH] feat: implemented `Predicate` in `options` for filtering --- README.md | 13 +++ ...ealthPageEndpointRouteBuilderExtensions.cs | 2 +- .../SimpleHealthPageOptions.cs | 8 ++ .../HealthChecks.MiniUI.Tests.csproj | 1 + .../PredicateTests.cs | 89 +++++++++++++++++++ 5 files changed, 112 insertions(+), 1 deletion(-) create mode 100644 tests/HealthChecks.MiniUI.Tests/PredicateTests.cs diff --git a/README.md b/README.md index cc39b7a..5dbd344 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,19 @@ app.MapSimpleHealthPage("/health-ui", options => }); ``` +## Filtering which checks are executed + +By default the page executes all registered health checks. Use `Predicate` to select a subset, for example by tag. Checks that are filtered out are not executed at all: + +```csharp +app.MapSimpleHealthPage("/health-ui", options => +{ + options.Predicate = registration => registration.Tags.Contains("ui"); +}); +``` + +This is the same `Func` shape as `HealthCheckOptions.Predicate` used by `MapHealthChecks`. + ## Example for dynamic response If you want a single entry URL, you can dispatch based on the Accept header: diff --git a/src/HealthChecks.MiniUI/SimpleHealthPageEndpointRouteBuilderExtensions.cs b/src/HealthChecks.MiniUI/SimpleHealthPageEndpointRouteBuilderExtensions.cs index 7822f91..8b6dd4d 100644 --- a/src/HealthChecks.MiniUI/SimpleHealthPageEndpointRouteBuilderExtensions.cs +++ b/src/HealthChecks.MiniUI/SimpleHealthPageEndpointRouteBuilderExtensions.cs @@ -32,7 +32,7 @@ public static IEndpointConventionBuilder MapSimpleHealthPage( var endpoint = endpoints.MapGet(pattern, async context => { var healthCheckService = context.RequestServices.GetRequiredService(); - var report = await healthCheckService.CheckHealthAsync(context.RequestAborted); + var report = await healthCheckService.CheckHealthAsync(options.Predicate, context.RequestAborted); var renderer = new SimpleHealthPageHtmlRenderer { diff --git a/src/HealthChecks.MiniUI/SimpleHealthPageOptions.cs b/src/HealthChecks.MiniUI/SimpleHealthPageOptions.cs index 7f9e1c4..a6dad55 100644 --- a/src/HealthChecks.MiniUI/SimpleHealthPageOptions.cs +++ b/src/HealthChecks.MiniUI/SimpleHealthPageOptions.cs @@ -1,3 +1,5 @@ +using Microsoft.Extensions.Diagnostics.HealthChecks; + namespace HealthChecks.MiniUI; /// @@ -5,6 +7,12 @@ namespace HealthChecks.MiniUI; /// public sealed class SimpleHealthPageOptions { + /// + /// Gets or sets a predicate selecting which health check registrations are executed, for example by tag. + /// When , all registered health checks are executed. + /// + public Func? Predicate { get; set; } + /// /// Gets or sets the page title displayed at the top of the health page. /// diff --git a/tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj b/tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj index 4a367fa..88cedff 100644 --- a/tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj +++ b/tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj @@ -9,6 +9,7 @@ + diff --git a/tests/HealthChecks.MiniUI.Tests/PredicateTests.cs b/tests/HealthChecks.MiniUI.Tests/PredicateTests.cs new file mode 100644 index 0000000..4f495d8 --- /dev/null +++ b/tests/HealthChecks.MiniUI.Tests/PredicateTests.cs @@ -0,0 +1,89 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Hosting; + +namespace HealthChecks.MiniUI.Tests; + +public sealed class PredicateTests +{ + [Fact] + public void Predicate_DefaultsToNull() + { + Assert.Null(new SimpleHealthPageOptions().Predicate); + } + + [Fact] + public async Task Predicate_Null_RunsAllHealthChecks() + { + using var host = await CreateHostAsync(configure: null); + + var html = await host.GetTestClient().GetStringAsync("/health"); + + Assert.Contains("ready-check", html, StringComparison.Ordinal); + Assert.Contains("live-check", html, StringComparison.Ordinal); + } + + [Fact] + public async Task Predicate_FiltersByTag() + { + using var host = await CreateHostAsync(o => o.Predicate = r => r.Tags.Contains("ready")); + + var html = await host.GetTestClient().GetStringAsync("/health"); + + Assert.Contains("ready-check", html, StringComparison.Ordinal); + Assert.DoesNotContain("live-check", html, StringComparison.Ordinal); + } + + [Fact] + public async Task Predicate_ExcludingAllChecks_ReportsHealthy() + { + using var host = await CreateHostAsync(o => o.Predicate = _ => false); + + var response = await host.GetTestClient().GetAsync("/health"); + var html = await response.Content.ReadAsStringAsync(); + + Assert.Equal(System.Net.HttpStatusCode.OK, response.StatusCode); + Assert.DoesNotContain("ready-check", html, StringComparison.Ordinal); + Assert.DoesNotContain("live-check", html, StringComparison.Ordinal); + } + + [Fact] + public async Task Predicate_FilteringOutUnhealthyCheck_ChangesStatusCode() + { + using var host = await CreateHostAsync(o => + { + o.Predicate = r => r.Tags.Contains("live"); + o.StatusCodes.Unhealthy = StatusCodes.Status503ServiceUnavailable; + }); + + var response = await host.GetTestClient().GetAsync("/health"); + + Assert.Equal(System.Net.HttpStatusCode.OK, response.StatusCode); + } + + private static Task CreateHostAsync(Action? configure) + { + return new HostBuilder() + .ConfigureWebHost(webHost => + { + webHost.UseTestServer(); + webHost.ConfigureServices(services => + { + services.AddRouting(); + services.AddHealthChecks() + .AddCheck("ready-check", () => HealthCheckResult.Unhealthy("not ready"), tags: ["ready"]) + .AddCheck("live-check", () => HealthCheckResult.Healthy("alive"), tags: ["live"]); + }); + webHost.Configure(app => + { + app.UseRouting(); + app.UseEndpoints(endpoints => endpoints.MapSimpleHealthPage("/health", configure)); + }); + }) + .StartAsync(); + } +}