Add health check UI page and cache tag support

Author: pwelter34

Directory.Packages.props

@@ -23,6 +23,7 @@
     <PackageVersion Include="Equatable.Generator" Version="3.0.0" />
     <PackageVersion Include="FluentValidation" Version="12.1.1" />
     <PackageVersion Include="Fluid.Core" Version="2.31.0" />
+    <PackageVersion Include="Humanizer" Version="3.0.10" />
     <PackageVersion Include="Injectio" Version="6.1.0" />
     <PackageVersion Include="LoreSoft.Blazor.Controls" Version="13.9.4" />
     <PackageVersion Include="MailKit" Version="4.17.0" />

samples/EntityFramework/src/Tracker.Client/Components/IconSelector.razor

@@ -0,0 +1,55 @@
+@switch (Name.ToLowerInvariant())
+{
+    case "warning":
+    case "degraded":
+    case "caution":
+        <i class="bi bi-exclamation-triangle-fill  text-warning"
+           @attributes="Attributes"></i>
+        break;
+    case "error":
+    case "critical":
+    case "fatal":
+    case "failed":
+    case "unhealthy":
+    case "false":
+        <i class="bi bi-x-circle-fill text-danger"
+           @attributes="Attributes"></i>
+        break;
+    case "information":
+        <i class="bi bi-info-circle-fill text-primary"
+           @attributes="Attributes"></i>
+        break;
+    case "debug":
+    case "verbose":
+    case "trace":
+        <i class="bi bi-info-circle-fill text-secondary"
+           @attributes="Attributes"></i>
+        break;
+    case "success":
+    case "healthy":
+    case "true":
+        <i class="bi bi-check-circle-fill text-success"
+           @attributes="Attributes"></i>
+        break;
+    case "credit":
+        <i class="bi bi-arrow-down-circle text-success"></i>
+        break;
+    case "debit":
+        <i class="bi bi-arrow-up-circle text-danger"></i>
+        break;
+    case "status":
+        <i class="bi bi-arrow-left-right text-primary"></i>
+        break;
+    default:
+        <i class="bi bi-question-circle-fill text-secondary"
+           @attributes="Attributes"></i>
+        break;
+}
+
+@code {
+    [Parameter, EditorRequired]
+    public required string Name { get; set; }
+
+    [Parameter(CaptureUnmatchedValues = true)]
+    public IReadOnlyDictionary<string, object>? Attributes { get; set; }
+}

samples/EntityFramework/src/Tracker.Client/Layout/ApplicationBar.razor

@@ -73,6 +73,16 @@
                                     Users
                                 </a>
                             </li>
+                            <li><hr class="dropdown-divider"></li>
+                            <li>
+                                <a id="navbar-item-administrative-healthCheck-link"
+                                   class="dropdown-item"
+                                   title="Health Check"
+                                   href="/health">
+                                    Health Check
+                                </a>
+                            </li>
+
                         </ul>
                     </li>
                 </ul>

samples/EntityFramework/src/Tracker.Client/Pages/Health.razor

@@ -0,0 +1,96 @@
+@page "/health"
+
+@using Arbiter.CommandQuery.Commands
+@using Arbiter.CommandQuery.Models
+@using Arbiter.Dispatcher.Client
+@using Humanizer
+
+<PageTitle>Health Check</PageTitle>
+
+<div class="container-fluid">
+    <LoadingBlock IsLoading="HealthReport == null">
+        <table class="table table-bordered">
+            <tbody>
+                <tr>
+                    <th class="table-secondary">Overall Status</th>
+                    <td>
+                        <IconSelector Name="@HealthReport?.Status" />
+                        @HealthReport?.Status
+                    </td>
+                    <th class="table-secondary">Total Duration</th>
+                    <td>@HealthReport?.TotalDuration?.Humanize()</td>
+                </tr>
+            </tbody>
+        </table>
+
+        <table class="table table-bordered table-hover">
+            <colgroup>
+                <col style="width: 30px" />
+                <col style="" />
+                <col style="width: 120px" />
+                <col style="width: 180px" />
+                <col style="" />
+                <col style="width: 170px" />
+            </colgroup>
+            <thead>
+                <tr class="table-secondary">
+                    <th scope="col"></th>
+                    <th scope="col">Name</th>
+                    <th scope="col">Status</th>
+                    <th scope="col">Tags</th>
+                    <th scope="col">Description</th>
+                    <th scope="col">Duration</th>
+                </tr>
+            </thead>
+            <tbody>
+                @foreach (var healthEntiry in HealthReport?.Entries ?? [])
+                {
+                    <tr>
+                        <td class="text-center">
+                            <IconSelector Name="@healthEntiry.Status" />
+                        </td>
+                        <td>@healthEntiry.Key</td>
+                        <td>@healthEntiry.Status</td>
+                        <td>@healthEntiry.Tags?.Humanize(",")</td>
+                        <td>
+                            @healthEntiry.Description
+                            @healthEntiry.Message
+                        </td>
+                        <td>
+                            @healthEntiry.Duration?.Humanize()
+                        </td>
+                    </tr>
+                }
+            </tbody>
+        </table>
+    </LoadingBlock>
+</div>
+
+@code {
+    [Inject]
+    public NotificationService NotificationService { get; set; } = null!;
+
+    [Inject]
+    public IDispatcher Dispatcher { get; set; } = null!;
+
+    protected HealthReportModel? HealthReport { get; set; }
+
+    protected override async Task OnInitializedAsync()
+    {
+        try
+        {
+            var command = new HealthCheckCommand(null);
+            var result = await Dispatcher.Send(command);
+
+            HealthReport = result;
+        }
+        catch (Exception ex)
+        {
+            NotificationService.ShowError(ex);
+        }
+        finally
+        {
+            await InvokeAsync(StateHasChanged);
+        }
+    }
+}

samples/EntityFramework/src/Tracker.Client/Tracker.Client.csproj

@@ -11,6 +11,7 @@
 
   <ItemGroup>
     <PackageReference Include="Blazilla" />
+    <PackageReference Include="Humanizer" />
     <PackageReference Include="LoreSoft.Blazor.Controls" />
     <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" />
     <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" />

samples/EntityFramework/src/Tracker.Core/Health/HealthRegistration.cs

@@ -1,3 +1,5 @@
+using Arbiter.Health;
+
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Diagnostics.HealthChecks;
 
@@ -10,6 +12,8 @@ public static class HealthRegistration
     [RegisterServices]
     public static void Register(IServiceCollection services)
     {
+        services.AddHealthServices();
+
         var health = services.AddHealthChecks();
 
         //default liveness check to ensure app is responsive

samples/EntityFramework/src/Tracker.Core/Tracker.Core.csproj

@@ -18,6 +18,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\..\..\src\Arbiter.CommandQuery.EntityFramework\Arbiter.CommandQuery.EntityFramework.csproj" />
+    <ProjectReference Include="..\..\..\..\src\Arbiter.Health\Arbiter.Health.csproj" />
     <ProjectReference Include="..\..\..\..\src\Arbiter.Mapping.Generators\Arbiter.Mapping.Generators.csproj">
       <OutputItemType>Analyzer</OutputItemType>
       <ReferenceOutputAssembly>false</ReferenceOutputAssembly>

samples/EntityFramework/src/Tracker.Service/Tracker.Service.http

@@ -37,3 +37,15 @@ X-API-KEY: {{apiKey}}
   "name": "Updated Priority",
   "description": "Updated description for the priority"
 }
+
+### Health Check
+
+GET {{baseUrl}}/health-check
+Accept: application/json
+X-API-KEY: {{apiKey}}
+
+### Configuration Debugger
+
+GET {{baseUrl}}/config-debugger
+Accept: application/json
+X-API-KEY: {{apiKey}}

src/Arbiter.CommandQuery.Endpoints/DiagnosticsEndpoint.cs

@@ -180,18 +180,23 @@ private async Task<Results<Ok<List<ClaimType>>, ProblemHttpResult>> ClaimsCheck(
     }
 
     /// <summary>
-    /// Clears cached entries by invalidating all cache tags.
+    /// Clears cached entries by invalidating the specified cache tags, or all tags when none are specified.
     /// </summary>
     /// <param name="hybridCache">The configured hybrid cache instance.</param>
+    /// <param name="tags">The cache tags to invalidate. When empty, all cache entries are invalidated.</param>
     /// <param name="user">The current user principal.</param>
     /// <param name="cancellationToken">The cancellation token.</param>
     /// <returns>A result indicating whether the cache was cleared.</returns>
     private async Task<IResult> CacheClear(
         [FromServices] HybridCache? hybridCache = null,
+        [FromQuery(Name = "tag")] string[]? tags = null,
         ClaimsPrincipal? user = default,
         CancellationToken cancellationToken = default)
     {
-        _logger.LogInformation("Cache clear requested by {UserName}", user?.Identity?.Name ?? "anonymous");
+        _logger.LogInformation(
+            "Cache clear requested by {UserName} for tags: {Tags}",
+            user?.Identity?.Name ?? "anonymous",
+            tags != null ? string.Join(", ", tags) : "all");
 
         try
         {
@@ -201,7 +206,12 @@ private async Task<IResult> CacheClear(
                 return TypedResults.NoContent();
             }
 
-            await hybridCache.RemoveByTagAsync("*", cancellationToken).ConfigureAwait(false);
+            // no tags specified, clear everything using the wildcard tag
+            var cacheTags = tags?.Where(t => !string.IsNullOrWhiteSpace(t)).ToArray();
+            if (cacheTags is null || cacheTags.Length == 0)
+                cacheTags = ["*"];
+
+            await hybridCache.RemoveByTagAsync(cacheTags, cancellationToken).ConfigureAwait(false);
 
             return TypedResults.Ok("Cache cleared by request");
         }