Features/add gethealthcheckasync using result

src/AStar.Dev.Api.HealthChecks/AStar.Dev.Api.HealthChecks.csproj

@@ -21,15 +21,15 @@
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageProjectUrl>https://github.com/astar-development/astar-dev-api-health-checks</PackageProjectUrl>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
-        <PackageReleaseNotes>This version only updates the GitHub actions.</PackageReleaseNotes>
+        <PackageReleaseNotes>This version cleans up the HealthCheck code without affecting the public API.</PackageReleaseNotes>
         <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
         <PackageTags>ASP.Core HealthChecks;HealthChecks</PackageTags>
         <RepositoryType>git</RepositoryType>
         <RepositoryUrl>https://github.com/astar-development/astar-dev-api-health-checks.git</RepositoryUrl>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <TargetFramework>net9.0</TargetFramework>
         <Title>AStar API HealthChecks</Title>
-        <Version>0.3.1</Version>
+        <Version>0.4.0</Version>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
@@ -43,6 +43,8 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="AStar.Dev.Functional.Extensions" Version="0.2.0"/>
+        <PackageReference Include="AStar.Dev.Technical.Debt.Reporting" Version="0.1.0"/>
         <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" Version="9.0.4"/>
         <PackageReference Include="Microsoft.Extensions.Features" Version="9.0.4"/>
     </ItemGroup>

src/AStar.Dev.Api.HealthChecks/HealthCheckExtensions.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using Microsoft.Extensions.Diagnostics.HealthChecks;
@@ -13,7 +14,7 @@ public static class HealthCheckExtensions
                                                                           {
                                                                               WriteIndented          = true,
                                                                               DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
-                                                                              PropertyNamingPolicy   = JsonNamingPolicy.CamelCase,
+                                                                              PropertyNamingPolicy   = JsonNamingPolicy.CamelCase
                                                                           };
 
     /// <summary>
@@ -31,9 +32,9 @@ public static WebApplication ConfigureHealthCheckEndpoints(this WebApplication a
                                     {
                                         [HealthStatus.Degraded]  = StatusCodes.Status424FailedDependency,
                                         [HealthStatus.Healthy]   = StatusCodes.Status200OK,
-                                        [HealthStatus.Unhealthy] = StatusCodes.Status500InternalServerError,
+                                        [HealthStatus.Unhealthy] = StatusCodes.Status500InternalServerError
                                     },
-                                    Predicate = _ => true,
+                                    Predicate = _ => true
                                 });
 
         _ = app.MapHealthChecks("/health/ready",
@@ -44,39 +45,40 @@ public static WebApplication ConfigureHealthCheckEndpoints(this WebApplication a
                                     {
                                         [HealthStatus.Degraded]  = StatusCodes.Status424FailedDependency,
                                         [HealthStatus.Healthy]   = StatusCodes.Status200OK,
-                                        [HealthStatus.Unhealthy] = StatusCodes.Status500InternalServerError,
+                                        [HealthStatus.Unhealthy] = StatusCodes.Status500InternalServerError
                                     },
-                                    Predicate = _ => true,
+                                    Predicate = _ => true
                                 });
 
         return app;
     }
 
+    [ExcludeFromCodeCoverage]
     private static Task WriteHealthCheckResponseAsync(
         HttpContext  httpContext,
         HealthReport healthReport)
     {
         httpContext.Response.ContentType = "application/json; charset=utf-8";
 
-        IEnumerable<HealthStatusResponse> dependencyHealthChecks = healthReport.Entries.Select(static entry => new HealthStatusResponse
-                                                                                                               {
-                                                                                                                   Name        = entry.Key,
-                                                                                                                   Description = entry.Value.Description,
-                                                                                                                   Status      = entry.Value.Status.ToString(),
-                                                                                                                   DurationInMilliseconds = entry.Value.Duration
-                                                                                                                                                 .TotalMilliseconds,
-                                                                                                                   Data      = entry.Value.Data,
-                                                                                                                   Exception = entry.Value.Exception?.Message,
-                                                                                                               });
+        var dependencyHealthChecks = healthReport.Entries.Select(static entry => new HealthStatusResponse
+                                                                                 {
+                                                                                     Name        = entry.Key,
+                                                                                     Description = entry.Value.Description,
+                                                                                     Status      = entry.Value.Status.ToString(),
+                                                                                     DurationInMilliseconds = entry.Value.Duration
+                                                                                                                   .TotalMilliseconds,
+                                                                                     Data      = entry.Value.Data,
+                                                                                     Exception = entry.Value.Exception?.Message
+                                                                                 });
 
         var healthCheckResponse = new
                                   {
                                       Status                                = healthReport.Status.ToString(),
                                       TotalCheckExecutionTimeInMilliseconds = healthReport.TotalDuration.TotalMilliseconds,
-                                      DependencyHealthChecks                = dependencyHealthChecks,
+                                      DependencyHealthChecks                = dependencyHealthChecks
                                   };
 
-        string responseString = JsonSerializer.Serialize(healthCheckResponse, JsonSerializerOptions);
+        var responseString = JsonSerializer.Serialize(healthCheckResponse, JsonSerializerOptions);
 
         return httpContext.Response.WriteAsync(responseString);
     }

src/AStar.Dev.Api.HealthChecks/HealthStatusResponse.cs

@@ -2,7 +2,7 @@
 
 /// <summary>
 /// </summary>
-public sealed class HealthStatusResponse
+public sealed record HealthStatusResponse
 {
     /// <summary>
     /// </summary>

src/AStar.Dev.Api.HealthChecks/IApiClient.cs

@@ -1,3 +1,5 @@
+using AStar.Dev.Functional.Extensions;
+
 namespace AStar.Dev.Api.HealthChecks;
 
 /// <summary>
@@ -14,4 +16,14 @@ public interface IApiClient
     ///     Health Status.
     /// </returns>
     public Task<HealthStatusResponse> GetHealthAsync(CancellationToken cancellationToken = default);
+
+    /// <summary>
+    ///     The GetHealthAsync method will return the basic Health Status of the API.
+    /// </summary>
+    /// <param name="cancellationToken">The token to optionally use to cancel the operation</param>
+    /// <returns>
+    ///     An instance of the <see cref="Result{TError,TSuccess}" /> class wrapping an instance of the <see href="HealthStatusResponse"></see> class when successful (containing the text representation of
+    ///     the API Health Status). When the call fails, a string error message will be returned
+    /// </returns>
+    public Task<Result<string, HealthStatusResponse>> GetHealthCheckAsync(CancellationToken cancellationToken = default);
 }

src/AStar.Dev.Api.HealthChecks/Program.cs

@@ -1,7 +1,12 @@
-namespace AStar.Dev.Api.HealthChecks;
+using System.Diagnostics.CodeAnalysis;
 
+namespace AStar.Dev.Api.HealthChecks;
+
+[ExcludeFromCodeCoverage]
 internal static class Program
 {
-    private static void Main() =>
+    private static void Main()
+    {
         Console.WriteLine("Hello, World!");
+    }
 }

test/AStar.Dev.Api.HealthChecks.Tests.Unit/AStar.Dev.Api.HealthChecks.Tests.Unit.csproj

@@ -15,10 +15,22 @@
     </ItemGroup>
 
     <ItemGroup>
+        <PackageReference Include="AStar.Dev.Utilities" Version="1.6.0"/>
         <PackageReference Include="coverlet.collector" Version="6.0.4">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
+        <PackageReference Include="JetBrains.Annotations" Version="2025.1.0-eap1"/>
+        <PackageReference Include="AStar.Dev.Technical.Debt.Reporting" Version="0.1.0"/>
+        <PackageReference Include="Asp.Versioning.Mvc" Version="8.1.0"/>
+        <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0"/>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.4"/>
+        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.4"/>
+        <PackageReference Include="Serilog" Version="4.2.0"/>
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="8.1.1"/>
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="8.1.1"/>
+        <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="9.0.4"/>
+        <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" Version="9.0.4"/>
         <PackageReference Include="Shouldly" Version="4.3.0"/>
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0"/>
         <PackageReference Include="xunit" Version="2.9.3"/>
@@ -33,6 +45,10 @@
         <Using Include="Shouldly"/>
     </ItemGroup>
 
+    <ItemGroup>
+        <ProjectReference Include="..\..\src\AStar.Dev.Api.HealthChecks\AStar.Dev.Api.HealthChecks.csproj"/>
+    </ItemGroup>
+
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
         <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
         <NoWarn>1701;1702;IDE0058;</NoWarn>

test/AStar.Dev.Api.HealthChecks.Tests.Unit/HealthCheckExtensionsShould.cs

@@ -0,0 +1,21 @@
+using JetBrains.Annotations;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace AStar.Dev.Api.HealthChecks;
+
+[TestSubject(typeof(HealthCheckExtensions))]
+public class HealthCheckExtensionsShould()
+{
+    [Fact]
+    public void ConfigureTheHealthCheckEndpoints()
+    {
+        var webApplication = WebApplication.CreateBuilder();
+        webApplication.Services.AddHealthChecks();
+
+        var sut =  webApplication.Build().ConfigureHealthCheckEndpoints();
+
+        sut.Services.GetServices< HealthCheckService>().Count().ShouldBe(1);
+    }
+}

test/AStar.Dev.Api.HealthChecks.Tests.Unit/HealthStatusResponseShould.ContainTheExpectedProperties.approved.txt

@@ -0,0 +1,8 @@
+{
+  "name": "Test Name",
+  "description": "Test Description",
+  "status": "OK",
+  "durationInMilliseconds": 123,
+  "data": {},
+  "exception": "Test Exception"
+}

test/AStar.Dev.Api.HealthChecks.Tests.Unit/HealthStatusResponseShould.cs

@@ -0,0 +1,15 @@
+using AStar.Dev.Utilities;
+using JetBrains.Annotations;
+
+namespace AStar.Dev.Api.HealthChecks;
+
+[TestSubject(typeof(HealthStatusResponse))]
+public class HealthStatusResponseShould
+{
+    [Fact]
+    public void ContainTheExpectedProperties()
+    {
+        new HealthStatusResponse(){Name = "Test Name", Description = "Test Description", DurationInMilliseconds = 123, Data = new Dictionary<string, object>(), Exception = "Test Exception", Status = "OK"}
+            .ToJson().ShouldMatchApproved();
+    }
+}