Add DbContextChecks to Health Checks (#648)

This will ensure that the /healthcheck endpoint correctly reports the status of the service if a database connection faults

Dfe.Academies.Api.Infrastructure/Dfe.Academies.Infrastructure.csproj

@@ -17,6 +17,7 @@
     </PackageReference>
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="8.0.8" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.8" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.8" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
     <PackageReference Include="Microsoft.Identity.Web" Version="3.1.0" />
   </ItemGroup>

Dfe.Academies.Api.Infrastructure/InfrastructureServiceCollectionExtensions.cs

@@ -31,6 +31,8 @@ public static IServiceCollection AddInfrastructureDependencyGroup(
             services.AddDbContext<EdperfContext>(options =>
                 options.UseSqlServer(connectionString));
 
+            AddInfrastructureHealthChecks(services);
+
             return services;
         }
 
@@ -58,10 +60,17 @@ public static IServiceCollection AddPersonsApiInfrastructureDependencyGroup(
             services.AddDbContext<MopContext>(options =>
                 options.UseSqlServer(connectionString));
 
+            AddInfrastructureHealthChecks(services);
+
             // Authentication
             services.AddCustomAuthorization(config);
 
             return services;
         }
+
+        public static void AddInfrastructureHealthChecks(this IServiceCollection services) {
+            services.AddHealthChecks()
+                .AddDbContextCheck<MstrContext>("Academies Database");
+        }
     }
-}
+}

PersonsApi/PersonsApi.csproj

@@ -62,5 +62,5 @@
 		<Message Text="$(NSwagOutput)" Condition="'$(NSwagExitCode)' == '0'" Importance="low" />
 		<Error Text="$(NSwagOutput)" Condition="'$(NSwagExitCode)' != '0'" />
 	</Target>
-	
+
 </Project>

PersonsApi/Program.cs

@@ -30,4 +30,6 @@
 
 logger.LogInformation("Logger is working...");
 
+app.MapHealthChecks("/HealthCheck").AllowAnonymous();
+
 app.Run();

PersonsApi/Startup.cs

@@ -99,7 +99,6 @@ public void ConfigureServices(IServiceCollection services)
             {
                 configure.Title = "PersonsApi";
             });
-
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
@@ -175,10 +174,10 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
             app.UseHttpsRedirection();
             app.UseRouting();
 
-            app.UseAuthentication(); 
+            app.UseAuthentication();
             app.UseAuthorization();
 
             app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
         }
     }
-}
+}

TramsDataApi/Program.cs

@@ -37,4 +37,6 @@
 
 logger.LogInformation("Logger is working...");
 
+app.MapHealthChecks("/HealthCheck").AllowAnonymous();
+
 app.Run();