v14: Async healthchecks (#17090)

mattbrailsford · kjac · AndyButland · web-flow · commit 09b3bd14c037 · 2025-01-31T16:13:49.000+01:00
* Make block editor base classes public * Update BlockEditorValues.cs Change to trigger a new build for #16774 * Make healthchecks fully async * Updated obsolete comments to reference next but one major. --------- Co-authored-by: Kenn Jacobsen <kja@umbraco.dk> Co-authored-by: Andy Butland <abutland73@gmail.com>
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/ExecuteActionHealthCheckController.cs b/src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/ExecuteActionHealthCheckController.cs
@@ -61,7 +61,7 @@ public async Task<ActionResult<HealthCheckResultResponseModel>> ExecuteAction(
             return BadRequest(invalidModelProblem);
         }
 
-        HealthCheckStatus result = healthCheck.ExecuteAction(_umbracoMapper.Map<HealthCheckAction>(action)!);
+        HealthCheckStatus result = await healthCheck.ExecuteActionAsync(_umbracoMapper.Map<HealthCheckAction>(action)!);
 
         return await Task.FromResult(Ok(_umbracoMapper.Map<HealthCheckResultResponseModel>(result)));
     }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/Group/CheckHealthCheckGroupController.cs b/src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/Group/CheckHealthCheckGroupController.cs
@@ -39,6 +39,6 @@ public async Task<IActionResult> ByNameWithResult(
             return HealthCheckGroupNotFound();
         }
 
-        return await Task.FromResult(Ok(_healthCheckGroupPresentationFactory.CreateHealthCheckGroupWithResultViewModel(group)));
+        return Ok(await _healthCheckGroupPresentationFactory.CreateHealthCheckGroupWithResultViewModelAsync(group));
     }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Factories/HealthCheckGroupPresentationFactory.cs b/src/Umbraco.Cms.Api.Management/Factories/HealthCheckGroupPresentationFactory.cs
@@ -7,6 +7,7 @@
 
 namespace Umbraco.Cms.Api.Management.Factories;
 
+// TODO (V16): Make internal sealed.
 public class HealthCheckGroupPresentationFactory : IHealthCheckGroupPresentationFactory
 {
     private readonly HealthChecksSettings _healthChecksSettings;
@@ -40,13 +41,21 @@ public HealthCheckGroupPresentationFactory(
         return groups;
     }
 
+    [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]
     public HealthCheckGroupWithResultResponseModel CreateHealthCheckGroupWithResultViewModel(IGrouping<string?, HealthCheck> healthCheckGroup)
+        => CreateHealthCheckGroupWithResultViewModelAsync(healthCheckGroup).GetAwaiter().GetResult();
+
+    [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]
+    public HealthCheckWithResultPresentationModel CreateHealthCheckWithResultViewModel(HealthCheck healthCheck) =>
+        CreateHealthCheckWithResultViewModelAsync(healthCheck).GetAwaiter().GetResult();
+
+    public async Task<HealthCheckGroupWithResultResponseModel> CreateHealthCheckGroupWithResultViewModelAsync(IGrouping<string?, HealthCheck> healthCheckGroup)
     {
         var healthChecks = new List<HealthCheckWithResultPresentationModel>();
 
         foreach (HealthCheck healthCheck in healthCheckGroup)
         {
-            healthChecks.Add(CreateHealthCheckWithResultViewModel(healthCheck));
+            healthChecks.Add(await CreateHealthCheckWithResultViewModelAsync(healthCheck));
         }
 
         var healthCheckGroupViewModel = new HealthCheckGroupWithResultResponseModel
@@ -57,11 +66,11 @@ public HealthCheckGroupWithResultResponseModel CreateHealthCheckGroupWithResultV
         return healthCheckGroupViewModel;
     }
 
-    public HealthCheckWithResultPresentationModel CreateHealthCheckWithResultViewModel(HealthCheck healthCheck)
+    public async Task<HealthCheckWithResultPresentationModel> CreateHealthCheckWithResultViewModelAsync(HealthCheck healthCheck)
     {
         _logger.LogDebug($"Running health check: {healthCheck.Name}");
 
-        IEnumerable<HealthCheckStatus> results = healthCheck.GetStatus().Result;
+        IEnumerable<HealthCheckStatus> results = await healthCheck.GetStatusAsync();
 
         var healthCheckViewModel = new HealthCheckWithResultPresentationModel
         {
diff --git a/src/Umbraco.Cms.Api.Management/Factories/IHealthCheckGroupPresentationFactory.cs b/src/Umbraco.Cms.Api.Management/Factories/IHealthCheckGroupPresentationFactory.cs
@@ -7,7 +7,19 @@ public interface IHealthCheckGroupPresentationFactory
 {
     IEnumerable<IGrouping<string?, HealthCheck>> CreateGroupingFromHealthCheckCollection();
 
+    [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]
     HealthCheckGroupWithResultResponseModel CreateHealthCheckGroupWithResultViewModel(IGrouping<string?, HealthCheck> healthCheckGroup);
 
+    [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]
     HealthCheckWithResultPresentationModel CreateHealthCheckWithResultViewModel(HealthCheck healthCheck);
+
+    Task<HealthCheckGroupWithResultResponseModel> CreateHealthCheckGroupWithResultViewModelAsync(IGrouping<string?, HealthCheck> healthCheckGroup)
+#pragma warning disable CS0618 // Type or member is obsolete
+        => Task.FromResult(CreateHealthCheckGroupWithResultViewModel(healthCheckGroup));
+#pragma warning restore CS0618 // Type or member is obsolete
+
+    Task<HealthCheckWithResultPresentationModel> CreateHealthCheckWithResultViewModelAsync(HealthCheck healthCheck)
+#pragma warning disable CS0618 // Type or member is obsolete
+        => Task.FromResult(CreateHealthCheckWithResultViewModel(healthCheck));
+#pragma warning restore CS0618 // Type or member is obsolete
 }
diff --git a/src/Umbraco.Core/HealthChecks/Checks/AbstractSettingsCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/AbstractSettingsCheck.cs
@@ -63,7 +63,7 @@ public abstract class AbstractSettingsCheck : HealthCheck
                 "healthcheck", "checkErrorMessageUnexpectedValue", new[] { CurrentValue, Values.First(v => v.IsRecommended).Value, ItemPath });
 
     /// <inheritdoc />
-    public override Task<IEnumerable<HealthCheckStatus>> GetStatus()
+    public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()
     {
         // update the successMessage with the CurrentValue
         var successMessage = string.Format(CheckSuccessMessage, ItemPath, Values, CurrentValue);
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Data/DatabaseIntegrityCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Data/DatabaseIntegrityCheck.cs
@@ -38,7 +38,7 @@ public DatabaseIntegrityCheck(
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         Task.FromResult((IEnumerable<HealthCheckStatus>)new[] { CheckDocuments(false), CheckMedia(false) });
 
     /// <inheritdoc />
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Permissions/FolderAndFilePermissionsCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Permissions/FolderAndFilePermissionsCheck.cs
@@ -35,7 +35,7 @@ public FolderAndFilePermissionsCheck(
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override Task<IEnumerable<HealthCheckStatus>> GetStatus()
+    public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()
     {
         _filePermissionHelper.RunFilePermissionTestSuite(
             out Dictionary<FilePermissionTest, IEnumerable<string>> errors);
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Security/BaseHttpHeaderCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Security/BaseHttpHeaderCheck.cs
@@ -62,7 +62,7 @@ protected BaseHttpHeaderCheck(
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         await Task.WhenAll(CheckForHeader());
 
     /// <summary>
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Security/ExcessiveHeadersCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Security/ExcessiveHeadersCheck.cs
@@ -35,7 +35,7 @@ public ExcessiveHeadersCheck(ILocalizedTextService textService, IHostingEnvironm
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         await Task.WhenAll(CheckForHeaders());
 
     /// <summary>
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Security/HstsCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Security/HstsCheck.cs
@@ -43,7 +43,7 @@ public HstsCheck(IHostingEnvironment hostingEnvironment, ILocalizedTextService t
     protected override string ReadMoreLink => Constants.HealthChecks.DocumentationLinks.Security.HstsCheck;
 
     /// <inheritdoc />
-    public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         new HealthCheckStatus[] { await CheckForHeader() };
 
     /// <summary>
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Security/HttpsCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Security/HttpsCheck.cs
@@ -46,7 +46,7 @@ public HttpsCheck(
         _hostingEnvironment = hostingEnvironment;
     }
     /// <inheritdoc />
-    public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         await Task.WhenAll(
             CheckIfCurrentSchemeIsHttps(),
             CheckHttpsConfigurationSetting(),
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Security/UmbracoApplicationUrlCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Security/UmbracoApplicationUrlCheck.cs
@@ -35,7 +35,7 @@ public override HealthCheckStatus ExecuteAction(HealthCheckAction action) =>
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         Task.FromResult(CheckUmbracoApplicationUrl().Yield());
 
     private HealthCheckStatus CheckUmbracoApplicationUrl()
diff --git a/src/Umbraco.Core/HealthChecks/Checks/Services/SmtpCheck.cs b/src/Umbraco.Core/HealthChecks/Checks/Services/SmtpCheck.cs
@@ -34,7 +34,7 @@ public SmtpCheck(ILocalizedTextService textService, IOptionsMonitor<GlobalSettin
     /// <summary>
     ///     Get the status for this health check
     /// </summary>
-    public override Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+    public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
         Task.FromResult(CheckSmtpSettings().Yield());
 
     /// <summary>
diff --git a/src/Umbraco.Core/HealthChecks/HealthCheck.cs b/src/Umbraco.Core/HealthChecks/HealthCheck.cs
@@ -46,12 +46,34 @@ protected HealthCheck()
     ///     If there are possible actions to take to rectify this check, this method must be overridden by a sub class
     ///     in order to explicitly provide those actions.
     /// </remarks>
-    public abstract Task<IEnumerable<HealthCheckStatus>> GetStatus();
+    [Obsolete("Use GetStatusAsync instead. Will be removed in v17")]
+    public virtual Task<IEnumerable<HealthCheckStatus>> GetStatus() => Task.FromResult(Enumerable.Empty<HealthCheckStatus>());
+
+    /// <summary>
+    ///     Get the status for this health check
+    /// </summary>
+    /// <returns></returns>
+    /// <remarks>
+    ///     If there are possible actions to take to rectify this check, this method must be overridden by a sub class
+    ///     in order to explicitly provide those actions.
+    /// </remarks>
+#pragma warning disable CS0618 // Type or member is obsolete
+    public virtual Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() => GetStatus();
+#pragma warning restore CS0618 // Type or member is obsolete
+
+    /// <summary>
+    ///     Executes the action and returns it's status
+    /// </summary>
+    /// <param name="action"></param>
+    /// <returns></returns>
+    public virtual HealthCheckStatus ExecuteAction(HealthCheckAction action) =>
+        new HealthCheckStatus("Not implemented");
 
     /// <summary>
     ///     Executes the action and returns it's status
     /// </summary>
     /// <param name="action"></param>
     /// <returns></returns>
-    public abstract HealthCheckStatus ExecuteAction(HealthCheckAction action);
+    public virtual Task<HealthCheckStatus> ExecuteActionAsync(HealthCheckAction action) =>
+        Task.FromResult(ExecuteAction(action));
 }
diff --git a/src/Umbraco.Core/HealthChecks/HealthCheckResults.cs b/src/Umbraco.Core/HealthChecks/HealthCheckResults.cs
@@ -26,7 +26,7 @@ public static async Task<HealthCheckResults> Create(IEnumerable<HealthCheck> che
             {
                 try
                 {
-                    return await t.GetStatus();
+                    return await t.GetStatusAsync();
                 }
                 catch (Exception ex)
                 {
diff --git a/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/BackgroundJobs/Jobs/HealthCheckNotifierJobTests.cs b/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/BackgroundJobs/Jobs/HealthCheckNotifierJobTests.cs
@@ -136,6 +136,6 @@ private class TestHealthCheck : HealthCheck
     {
         public override HealthCheckStatus ExecuteAction(HealthCheckAction action) => new("Check message");
 
-        public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() => Enumerable.Empty<HealthCheckStatus>();
+        public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() => Enumerable.Empty<HealthCheckStatus>();
     }
 }
diff --git a/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/HealthChecks/HealthCheckResultsTests.cs b/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/HealthChecks/HealthCheckResultsTests.cs
@@ -26,7 +26,7 @@ public StubHealthCheck(StatusResultType resultType, string message)
         public override HealthCheckStatus ExecuteAction(HealthCheckAction action) =>
             throw new NotImplementedException();
 
-        public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+        public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
             new List<HealthCheckStatus> { new(_message) { ResultType = _resultType } };
     }
 
@@ -56,7 +56,7 @@ public StubHealthCheck3(StatusResultType resultType, string message)
         {
         }
 
-        public override async Task<IEnumerable<HealthCheckStatus>> GetStatus() =>
+        public override async Task<IEnumerable<HealthCheckStatus>> GetStatusAsync() =>
             throw new Exception("Check threw exception");
     }
 

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public async Task<ActionResult<HealthCheckResultResponseModel>> ExecuteAction(`
`61`	`61`	`return BadRequest(invalidModelProblem);`
`62`	`62`	`}`
`63`	`63`
`64`		`- HealthCheckStatus result = healthCheck.ExecuteAction(_umbracoMapper.Map<HealthCheckAction>(action)!);`
	`64`	`+ HealthCheckStatus result = await healthCheck.ExecuteActionAsync(_umbracoMapper.Map<HealthCheckAction>(action)!);`
`65`	`65`
`66`	`66`	`return await Task.FromResult(Ok(_umbracoMapper.Map<HealthCheckResultResponseModel>(result)));`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@ public async Task<IActionResult> ByNameWithResult(`
`39`	`39`	`return HealthCheckGroupNotFound();`
`40`	`40`	`}`
`41`	`41`
`42`		`- return await Task.FromResult(Ok(_healthCheckGroupPresentationFactory.CreateHealthCheckGroupWithResultViewModel(group)));`
	`42`	`+ return Ok(await _healthCheckGroupPresentationFactory.CreateHealthCheckGroupWithResultViewModelAsync(group));`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`namespace Umbraco.Cms.Api.Management.Factories;`
`9`	`9`
	`10`	`+// TODO (V16): Make internal sealed.`
`10`	`11`	`public class HealthCheckGroupPresentationFactory : IHealthCheckGroupPresentationFactory`
`11`	`12`	`{`
`12`	`13`	`private readonly HealthChecksSettings _healthChecksSettings;`
`@@ -40,13 +41,21 @@ public HealthCheckGroupPresentationFactory(`
`40`	`41`	`return groups;`
`41`	`42`	`}`
`42`	`43`
	`44`	`+ [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]`
`43`	`45`	`public HealthCheckGroupWithResultResponseModel CreateHealthCheckGroupWithResultViewModel(IGrouping<string?, HealthCheck> healthCheckGroup)`
	`46`	`+ => CreateHealthCheckGroupWithResultViewModelAsync(healthCheckGroup).GetAwaiter().GetResult();`
	`47`	`+`
	`48`	`+ [Obsolete("Use CreateHealthCheckGroupWithResultViewModelAsync instead. Will be removed in v17.")]`
	`49`	`+ public HealthCheckWithResultPresentationModel CreateHealthCheckWithResultViewModel(HealthCheck healthCheck) =>`
	`50`	`+ CreateHealthCheckWithResultViewModelAsync(healthCheck).GetAwaiter().GetResult();`
	`51`	`+`
	`52`	`+ public async Task<HealthCheckGroupWithResultResponseModel> CreateHealthCheckGroupWithResultViewModelAsync(IGrouping<string?, HealthCheck> healthCheckGroup)`
`44`	`53`	`{`
`45`	`54`	`var healthChecks = new List<HealthCheckWithResultPresentationModel>();`
`46`	`55`
`47`	`56`	`foreach (HealthCheck healthCheck in healthCheckGroup)`
`48`	`57`	`{`
`49`		`- healthChecks.Add(CreateHealthCheckWithResultViewModel(healthCheck));`
	`58`	`+ healthChecks.Add(await CreateHealthCheckWithResultViewModelAsync(healthCheck));`
`50`	`59`	`}`
`51`	`60`
`52`	`61`	`var healthCheckGroupViewModel = new HealthCheckGroupWithResultResponseModel`
`@@ -57,11 +66,11 @@ public HealthCheckGroupWithResultResponseModel CreateHealthCheckGroupWithResultV`
`57`	`66`	`return healthCheckGroupViewModel;`
`58`	`67`	`}`
`59`	`68`
`60`		`- public HealthCheckWithResultPresentationModel CreateHealthCheckWithResultViewModel(HealthCheck healthCheck)`
	`69`	`+ public async Task<HealthCheckWithResultPresentationModel> CreateHealthCheckWithResultViewModelAsync(HealthCheck healthCheck)`
`61`	`70`	`{`
`62`	`71`	`_logger.LogDebug($"Running health check: {healthCheck.Name}");`
`63`	`72`
`64`		`- IEnumerable<HealthCheckStatus> results = healthCheck.GetStatus().Result;`
	`73`	`+ IEnumerable<HealthCheckStatus> results = await healthCheck.GetStatusAsync();`
`65`	`74`
`66`	`75`	`var healthCheckViewModel = new HealthCheckWithResultPresentationModel`
`67`	`76`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public abstract class AbstractSettingsCheck : HealthCheck`
`63`	`63`	`"healthcheck", "checkErrorMessageUnexpectedValue", new[] { CurrentValue, Values.First(v => v.IsRecommended).Value, ItemPath });`
`64`	`64`
`65`	`65`	`/// <inheritdoc />`
`66`		`- public override Task<IEnumerable<HealthCheckStatus>> GetStatus()`
	`66`	`+ public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()`
`67`	`67`	`{`
`68`	`68`	`// update the successMessage with the CurrentValue`
`69`	`69`	`var successMessage = string.Format(CheckSuccessMessage, ItemPath, Values, CurrentValue);`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public FolderAndFilePermissionsCheck(`
`35`	`35`	`/// <summary>`
`36`	`36`	`/// Get the status for this health check`
`37`	`37`	`/// </summary>`
`38`		`- public override Task<IEnumerable<HealthCheckStatus>> GetStatus()`
	`38`	`+ public override Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()`
`39`	`39`	`{`
`40`	`40`	`_filePermissionHelper.RunFilePermissionTestSuite(`
`41`	`41`	`out Dictionary<FilePermissionTest, IEnumerable<string>> errors);`