Psp 8624 - allow api startup without external services. (#4095)

* psp-8624 reclassify health checks run as part of readiness check * PSP-8624 prevent psp health checks from preventing startup.
bcgov · Jun 10, 2024 · 9429943 · 9429943
1 parent 329e31e
commit 9429943
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/source/backend/api/Helpers/Healthchecks/PimsCdogsHealthCheck.cs b/source/backend/api/Helpers/Healthchecks/PimsCdogsHealthCheck.cs
@@ -23,12 +23,12 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
                 var fileTypes = await _generationRepository.TryGetFileTypesAsync();
                 if (fileTypes.HttpStatusCode != System.Net.HttpStatusCode.OK || fileTypes.Payload == null || fileTypes.Payload.Dictionary.Count == 0)
                 {
-                    return new HealthCheckResult(HealthStatus.Unhealthy, $"received invalid file types response from CDOGS");
+                    return new HealthCheckResult(HealthStatus.Degraded, $"received invalid file types response from CDOGS");
                 }
             }
             catch (Exception e)
             {
-                return new HealthCheckResult(HealthStatus.Degraded, $"Cdogs error response: {e.Message} {e.StackTrace}");
+                return new HealthCheckResult(context.Registration.FailureStatus, $"Cdogs error response: {e.Message} {e.StackTrace}");
             }
             return HealthCheckResult.Healthy();
         }

diff --git a/source/backend/api/Helpers/Healthchecks/PimsGeocoderHealthCheck.cs b/source/backend/api/Helpers/Healthchecks/PimsGeocoderHealthCheck.cs
@@ -26,12 +26,12 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
                 var sites = await _geocoderService.GetSiteAddressesAsync(_address);
                 if (sites == null || !sites.Features.Any())
                 {
-                    return new HealthCheckResult(HealthStatus.Unhealthy, $"received invalid file types response from Geocoder");
+                    return new HealthCheckResult(HealthStatus.Degraded, $"received invalid file types response from Geocoder");
                 }
             }
             catch (Exception e)
             {
-                return new HealthCheckResult(HealthStatus.Degraded, $"Mayan error response: {e.Message}");
+                return new HealthCheckResult(context.Registration.FailureStatus, $"Mayan error response: {e.Message}");
             }
             return HealthCheckResult.Healthy();
         }

diff --git a/source/backend/api/Helpers/Healthchecks/PimsLtsaHealthcheck.cs b/source/backend/api/Helpers/Healthchecks/PimsLtsaHealthcheck.cs
@@ -25,12 +25,12 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
                 var titleSummary = await _ltsaService.GetTitleSummariesAsync(_pid);
                 if (titleSummary.TitleSummaries.Count == 0)
                 {
-                    return new HealthCheckResult(HealthStatus.Unhealthy, $"received invalid title summary response for pid: {_pid}");
+                    return new HealthCheckResult(HealthStatus.Degraded, $"received invalid title summary response for pid: {_pid}");
                 }
             }
             catch(LtsaException e)
             {
-                return new HealthCheckResult(HealthStatus.Degraded, $"LTSA error response: {e.Message}");
+                return new HealthCheckResult(context.Registration.FailureStatus, $"LTSA error response: {e.Message}");
             }
             return HealthCheckResult.Healthy();
         }

diff --git a/source/backend/api/Helpers/Healthchecks/PimsMayanHealthCheck.cs b/source/backend/api/Helpers/Healthchecks/PimsMayanHealthCheck.cs
@@ -27,7 +27,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
             }
             catch (Exception e)
             {
-                return new HealthCheckResult(HealthStatus.Degraded, $"Mayan error response: {e.Message}");
+                return new HealthCheckResult(context.Registration.FailureStatus, $"Mayan error response: {e.Message}");
             }
             return HealthCheckResult.Healthy();
         }

diff --git a/source/backend/api/Pims.Api.csproj b/source/backend/api/Pims.Api.csproj
@@ -2,9 +2,9 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
     <UserSecretsId>0ef6255f-9ea0-49ec-8c65-c172304b4926</UserSecretsId>
-    <Version>5.3.0-81.35</Version>
-    <Version>5.3.0-81.35</Version>
-    <AssemblyVersion>5.3.0.81</AssemblyVersion>
+    <Version>5.3.1-81.35</Version>
+    <Version>5.3.1-81.35</Version>
+    <AssemblyVersion>5.3.1.81</AssemblyVersion>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <ProjectGuid>16BC0468-78F6-4C91-87DA-7403C919E646</ProjectGuid>
     <TargetFramework>net8.0</TargetFramework>

diff --git a/source/backend/api/Startup.cs b/source/backend/api/Startup.cs
@@ -415,7 +415,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
             });
             app.UseHealthChecks(this.Configuration.GetValue<string>("HealthChecks:ReadyPath"), healthPort, new HealthCheckOptions
             {
-                Predicate = r => r.Tags.Contains("services"),
+                Predicate = r => r.Tags.Contains("services") && !r.Tags.Contains("external"),
                 ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse,
             });
 

diff --git a/source/frontend/package.json b/source/frontend/package.json
@@ -1,6 +1,6 @@
 {
   "name": "frontend",
-  "version": "5.3.0-81.35",
+  "version": "5.3.1-81.35",
   "private": true,
   "dependencies": {
     "@bcgov/bc-sans": "1.0.1",