feat: restructuring healthcheck response

Author: Per Kops

docs/CodeDoc/Atc.Rest.HealthChecks/Atc.Rest.HealthChecks.Extensions.md

@@ -17,11 +17,11 @@
 
 #### ToHealthCheck
 >```csharp
->HealthCheck ToHealthCheck(this KeyValuePair<string, HealthReportEntry> healthReportEntry)
+>HealthCheck ToHealthCheck(this KeyValuePair<string, HealthReportEntry> kvp)
 >```
 #### ToHealthChecks
 >```csharp
->IList<HealthCheck> ToHealthChecks(this IReadOnlyDictionary<string, HealthReportEntry> healthReportEntries)
+>IList<HealthCheck> ToHealthChecks(this IReadOnlyDictionary<string, HealthReportEntry> entries)
 >```
 
 <br />

docs/CodeDoc/Atc.Rest.HealthChecks/Atc.Rest.HealthChecks.Models.md

@@ -15,6 +15,14 @@
 
 ### Properties
 
+#### Data
+>```csharp
+>Data
+>```
+#### Description
+>```csharp
+>Description
+>```
 #### Duration
 >```csharp
 >Duration
@@ -23,10 +31,6 @@
 >```csharp
 >Name
 >```
-#### Resources
->```csharp
->Resources
->```
 #### Status
 >```csharp
 >Status
@@ -39,7 +43,7 @@
 >```
 #### Deconstruct
 >```csharp
->void Deconstruct(out string Name, out IList`1 Resources, out HealthStatus Status, out TimeSpan Duration)
+>void Deconstruct(out string Name, out HealthStatus Status, out TimeSpan Duration, out string Description, out IReadOnlyDictionary`2 Data)
 >```
 #### Equals
 >```csharp
@@ -121,13 +125,13 @@
 
 ### Properties
 
-#### Duration
+#### Description
 >```csharp
->Duration
+>Description
 >```
-#### Message
+#### Duration
 >```csharp
->Message
+>Duration
 >```
 #### Name
 >```csharp
@@ -145,7 +149,7 @@
 >```
 #### Deconstruct
 >```csharp
->void Deconstruct(out string Name, out HealthStatus Status, out string Message, out TimeSpan Duration)
+>void Deconstruct(out string Name, out HealthStatus Status, out string Description, out TimeSpan Duration)
 >```
 #### Equals
 >```csharp

docs/CodeDoc/Atc.Rest.HealthChecks/IndexExtended.md

@@ -12,8 +12,8 @@
 
 - [HealthReportEntryExtensions](Atc.Rest.HealthChecks.Extensions.md#healthreportentryextensions)
   -  Static Methods
-     - ToHealthCheck(this KeyValuePair<string, HealthReportEntry> healthReportEntry)
-     - ToHealthChecks(this IReadOnlyDictionary<string, HealthReportEntry> healthReportEntries)
+     - ToHealthCheck(this KeyValuePair<string, HealthReportEntry> kvp)
+     - ToHealthChecks(this IReadOnlyDictionary<string, HealthReportEntry> entries)
 - [ResourceHealthCheckExtensions](Atc.Rest.HealthChecks.Extensions.md#resourcehealthcheckextensions)
   -  Static Methods
      - ToIReadOnlyDictionary(this IEnumerable<ResourceHealthCheck> resourceHealthCheck)
@@ -28,13 +28,14 @@
 
 - [HealthCheck](Atc.Rest.HealthChecks.Models.md#healthcheck)
   -  Properties
+     - Data
+     - Description
      - Duration
      - Name
-     - Resources
      - Status
   -  Methods
      - <Clone>$()
-     - Deconstruct(out string Name, out IList`1 Resources, out HealthStatus Status, out TimeSpan Duration)
+     - Deconstruct(out string Name, out HealthStatus Status, out TimeSpan Duration, out string Description, out IReadOnlyDictionary`2 Data)
      - Equals(HealthCheck other)
      - Equals(object obj)
      - GetHashCode()
@@ -54,13 +55,13 @@
      - ToString()
 - [ResourceHealthCheck](Atc.Rest.HealthChecks.Models.md#resourcehealthcheck)
   -  Properties
+     - Description
      - Duration
-     - Message
      - Name
      - Status
   -  Methods
      - <Clone>$()
-     - Deconstruct(out string Name, out HealthStatus Status, out string Message, out TimeSpan Duration)
+     - Deconstruct(out string Name, out HealthStatus Status, out string Description, out TimeSpan Duration)
      - Equals(ResourceHealthCheck other)
      - Equals(object obj)
      - GetHashCode()

src/Atc.Rest.HealthChecks/Extensions/HealthReportEntryExtensions.cs

@@ -3,37 +3,25 @@ namespace Atc.Rest.HealthChecks.Extensions;
 public static class HealthReportEntryExtensions
 {
     public static HealthCheck ToHealthCheck(
-        this KeyValuePair<string, HealthReportEntry> healthReportEntry)
+        this KeyValuePair<string, HealthReportEntry> kvp)
     {
-        var resourceHealthChecks = new List<ResourceHealthCheck>();
-        foreach (var item in healthReportEntry.Value.Data)
-        {
-            switch (item.Value)
-            {
-                case ResourceHealthCheck resourceHealthCheck:
-                    resourceHealthChecks.Add(resourceHealthCheck);
-                    break;
-                case string stringContent:
-                    resourceHealthChecks.Add(
-                        new ResourceHealthCheck(
-                            item.Key,
-                            healthReportEntry.Value.Status,
-                            stringContent,
-                            TimeSpan.Zero));
-                    break;
-            }
-        }
+        var entry = kvp.Value;
+
+        var data = entry.Data.Count > 0
+            ? entry.Data
+            : null;
 
         return new HealthCheck(
-                healthReportEntry.Key,
-                resourceHealthChecks,
-                healthReportEntry.Value.Status,
-                healthReportEntry.Value.Duration);
+            Name: kvp.Key,
+            Status: entry.Status,
+            Duration: entry.Duration,
+            Description: entry.Description,
+            Data: data);
     }
 
     public static IList<HealthCheck> ToHealthChecks(
-        this IReadOnlyDictionary<string, HealthReportEntry> healthReportEntries)
-        => healthReportEntries
-            .Select(x => x.ToHealthCheck())
+        this IReadOnlyDictionary<string, HealthReportEntry> entries)
+        => entries
+            .Select(ToHealthCheck)
             .ToList();
 }

src/Atc.Rest.HealthChecks/Extensions/ResourceHealthCheckExtensions.cs

@@ -5,7 +5,12 @@ public static class ResourceHealthCheckExtensions
     public static IReadOnlyDictionary<string, object> ToIReadOnlyDictionary(
         this IEnumerable<ResourceHealthCheck> resourceHealthCheck)
         => resourceHealthCheck.ToDictionary(
-            keySelector: _ => Guid.NewGuid().ToString(),
-            elementSelector: e => (object)e,
+            keySelector: key => key.Name,
+            elementSelector: e => (object)new
+            {
+                e.Status,
+                e.Duration,
+                e.Description,
+            },
             StringComparer.Ordinal);
 }

src/Atc.Rest.HealthChecks/Models/HealthCheck.cs

@@ -2,6 +2,7 @@ namespace Atc.Rest.HealthChecks.Models;
 
 public sealed record HealthCheck(
     string Name,
-    IList<ResourceHealthCheck> Resources,
     HealthStatus Status,
-    TimeSpan Duration);
+    TimeSpan Duration,
+    string? Description,
+    IReadOnlyDictionary<string, object>? Data);

src/Atc.Rest.HealthChecks/Models/ResourceHealthCheck.cs

@@ -3,5 +3,5 @@ namespace Atc.Rest.HealthChecks.Models;
 public sealed record ResourceHealthCheck(
     string Name,
     HealthStatus Status,
-    string Message,
+    string Description,
     TimeSpan Duration);