Hub Service: allow invalid config and log problems

Author: webprofusion-chrisc

src/Certify.Models/Reporting/SystemStatusCategories.cs

@@ -16,7 +16,8 @@ public class SystemStatusKeys
         public const string HUB_API_STARTUP_SVCPORTENV = "hub.api.startup.serviceportenv";
         public const string HUB_API_STARTUP_ENVIRONMENT = "hub.api.startup.environment";
         public const string HUB_API_STARTUP_URL = "hub.api.startup.url";
-        public const string HUB_API_STARTUP_SWAGGER = "hub.api.startup.swagger";
+        public const string HUB_API_STARTUP_CUSTOMCONFIG = "hub.api.startup.customconfig";
+        public const string HUB_API_STARTUP_APIDOCS = "hub.api.startup.apidocs";
         public const string HUB_API_STARTUP_SVC_STATUS_STREAM = "hub.api.startup.svc.stream";
 
         public const string SERVICE_CORE_PLATFORM = "service.core.platform";

src/Certify.Server/Certify.Server.Hub.Api/Startup.cs

@@ -300,7 +300,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
             AddSystemStatusItem(
                 SystemStatusCategories.HUB_API,
-                SystemStatusKeys.HUB_API_STARTUP_SWAGGER,
+                SystemStatusKeys.HUB_API_STARTUP_APIDOCS,
                 title: "API Docs UI enabled",
                 description: $"Hub API Swagger docs available at /docs"
             );

src/Certify.Server/Certify.Server.HubService/Program.cs

@@ -30,6 +30,7 @@
 var cwd = Path.GetDirectoryName(assembly.Location);
 if (cwd != null)
 {
+
     System.Diagnostics.Debug.WriteLine($"Using working directory {cwd}");
     Directory.SetCurrentDirectory(cwd);
 }
@@ -57,7 +58,27 @@
 }
 #endif
 
-builder.Configuration.AddJsonFile(hubSettings, optional: true, reloadOnChange: true);
+// load optional config but ignore errors if it doesn't exist or is invalid, otherwise service will fail to start
+var hubConfigFailed = false;
+builder.Configuration.AddJsonFile(p =>
+        {
+            p.Path = hubSettings;
+            p.Optional = true;
+            p.ReloadOnChange = true;
+            p.OnLoadException = e =>
+            {
+                e.Ignore = true;
+                hubConfigFailed = true;
+
+                AddSystemStatusItem(
+                    SystemStatusCategories.HUB_API,
+                    SystemStatusKeys.HUB_API_STARTUP_CUSTOMCONFIG,
+                    title: "Hub API Service Custom Config",
+                    description: $"Error loading config file {hubSettings} - {e}",
+                    hasError: true
+                );
+            };
+        });
 
 // if windows, run as service, otherwise run as console app
 if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
@@ -289,7 +310,7 @@
 
 AddSystemStatusItem(
     SystemStatusCategories.HUB_API,
-    SystemStatusKeys.HUB_API_STARTUP_SWAGGER,
+    SystemStatusKeys.HUB_API_STARTUP_APIDOCS,
     title: "API Docs UI enabled",
     description: $"Hub API docs available at /api/docs"
 );
@@ -358,6 +379,20 @@
 foreach (var statusItem in _systemStatusItems)
 {
     hubStateProvider.AddOrUpdateSystemStatusItem(statusItem);
+
+    if (statusItem.HasError)
+    {
+        app.Logger.LogError($"{statusItem.Key} - {statusItem.Title} - {statusItem.Description}");
+    }
+    else if (statusItem.HasWarning)
+    {
+        app.Logger.LogWarning($"{statusItem.Key} - {statusItem.Title} - {statusItem.Description}");
+    }
+    else
+    {
+
+        app.Logger.LogInformation($"{statusItem.Key} - {statusItem.Title} - {statusItem.Description}");
+    }
 }
 
 app.WaitForShutdown();

src/Certify.Server/Certify.Server.HubService/default-settings.json

@@ -1,30 +1,31 @@
 {
-    "Logging": {
-        "LogLevel": {
-            "Default": "Information",
-            "Microsoft": "Warning",
-            "Microsoft.Hosting.Lifetime": "Information"
-        }
-    },
-    "Kestrel": {
-        "Endpoints": {
-            "SvcHttpEndpoint": {
-                "Url": "http://0.0.0.0:8080"
-            }
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "Kestrel": {
+    "Endpoints": {
+      "SvcHttpEndpoint": {
+        "Url": "http://0.0.0.0:8080"
+      }
 
-            // example HTTP config. Before using, acquire a certificate for desired host e.g. certifyhub.intranet.yourdomain.com
-            // Then add a Deployment Task (Export Certificate) to export pfx to where it's required e.g. C:\ProgramData\certify\internal-certs\hub.pfx , then run the task to export the initial certificate.
-            // the choice of port and filename etc is arbitrary, as long as the process can access the file.
-            // https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-9.0
-            /*
-              "HttpsInlineCertFile": {
+      // Example HTTPS config. Remove /* and */ to use, keep the comma before the entry so that the json remains valid. Before using, acquire a certificate for desired host e.g. certifyhub.intranet.yourdomain.com
+      // Then add a Deployment Task (Export Certificate) to export pfx to where it's required e.g. C:\ProgramData\certify\internal-certs\hub.pfx, then run the task to export the initial certificate.
+      // the choice of port and filename etc is arbitrary, as long as the process can access the file.
+      // https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-9.0
+      /*
+        ,
+        "HttpsInlineCertFile": {
                 "Url": "https://0.0.0.0:9697",
                 "Certificate": {
                   "Path": "C:\\ProgramData\\certify\\internal-certs\\hub.pfx",
                   "Password": ""
                 }
               }
-            */
-        }
+        */
     }
+  }
 }