Cleanup warnings etc

webprofusion-chrisc · webprofusion-chrisc · commit 1e85de105ecb · 2025-03-05T15:51:27.000+08:00
diff --git a/src/Certify.Core/Management/CertifyManager/CertifyManager.DataStores.cs b/src/Certify.Core/Management/CertifyManager/CertifyManager.DataStores.cs
@@ -162,7 +162,7 @@ public async Task<List<ProviderDefinition>> GetDataStoreProviders()
                 allProviders.AddRange(providers);
             }
 
-            return allProviders.OrderBy(p => p.Title).ToList();
+            return await Task.FromResult(allProviders.OrderBy(p => p.Title).ToList());
         }
 
         public async Task<List<DataStoreConnection>> GetDataStores()
@@ -187,7 +187,7 @@ public async Task<List<DataStoreConnection>> GetDataStores()
                 dataStores.Add(new DataStoreConnection { Id = "(default)", Title = "(Default SQLite)", TypeId = "sqlite" });
             }
 
-            return dataStores.OrderBy(t => t.Title).ToList();
+            return await Task.FromResult(dataStores.OrderBy(t => t.Title).ToList());
         }
         public async Task<List<ActionStep>> CopyDateStoreToTarget(string sourceId, string destId)
         {
diff --git a/src/Certify.Core/Management/Challenges/ChallengeResponseService.cs b/src/Certify.Core/Management/Challenges/ChallengeResponseService.cs
@@ -452,15 +452,18 @@ private async Task<ActionResult> PerformChallengeResponse_Http01(ILog log, ITarg
                 // renewing may all point to the same web root, we keep the configcheck file
                 pendingAuth.Cleanup = async () =>
                 {
-                    if (!destFile.EndsWith("configcheck") && File.Exists(destFile))
+                    await Task.Run(() =>
                     {
-                        log.Debug("Challenge Cleanup: Removing {file}", destFile);
-                        try
+                        if (!destFile.EndsWith("configcheck") && File.Exists(destFile))
                         {
-                            File.Delete(destFile);
+                            log.Debug("Challenge Cleanup: Removing {file}", destFile);
+                            try
+                            {
+                                File.Delete(destFile);
+                            }
+                            catch { }
                         }
-                        catch { }
-                    }
+                    });
                 };
 
                 performFilesystemBasedValidation = true;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/CertificateAuthorityController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/CertificateAuthorityController.cs
@@ -22,6 +22,7 @@ public partial class CertificateAuthorityController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtApi"></param>
         public CertificateAuthorityController(ILogger<CertificateAuthorityController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtApi)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/ChallengeProviderController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/ChallengeProviderController.cs
@@ -21,6 +21,7 @@ public partial class ChallengeProviderController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtAPI"></param>
         public ChallengeProviderController(ILogger<ChallengeProviderController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtAPI)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/DeploymentTaskController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/DeploymentTaskController.cs
@@ -22,6 +22,7 @@ public partial class DeploymentTaskController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtAPI"></param>
         public DeploymentTaskController(ILogger<DeploymentTaskController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtAPI)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/HubController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/HubController.cs
@@ -28,6 +28,8 @@ public partial class HubController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtStateProvider"></param>
+        /// <param name="mgmtHubContext"></param>
         public HubController(ILogger<CertificateController> logger, ICertifyInternalApiClient client, IInstanceManagementStateProvider mgmtStateProvider, IHubContext<InstanceManagementHub, IInstanceManagementHub> mgmtHubContext)
         {
             _logger = logger;
@@ -39,7 +41,9 @@ public HubController(ILogger<CertificateController> logger, ICertifyInternalApiC
         /// <summary>
         /// Get all managed certificates matching criteria
         /// </summary>
+        /// <param name="instanceId"></param>
         /// <param name="keyword"></param>
+        /// <param name="health"></param>
         /// <param name="page"></param>
         /// <param name="pageSize"></param>
         /// <returns></returns>
@@ -97,6 +101,10 @@ public async Task<IActionResult> GetHubManagedItems(string? instanceId, string?
             return new OkObjectResult(result);
         }
 
+        /// <summary>
+        /// Get all hub managed instances
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("instances")]
         [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme)]
@@ -112,6 +120,10 @@ public async Task<IActionResult> GetHubManagedInstances()
             return new OkObjectResult(managedInstances);
         }
 
+        /// <summary>
+        /// Flush all hub managed instances
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("flush")]
         [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme)]
@@ -123,6 +135,10 @@ public async Task<IActionResult> FlushHubManagedInstances()
             return new OkResult();
         }
 
+        /// <summary>
+        /// Get info about the hub instance
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("info")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(HubInfo))]
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/StoredCredentialController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/StoredCredentialController.cs
@@ -23,6 +23,7 @@ public partial class StoredCredentialController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtApi"></param>
         public StoredCredentialController(ILogger<StoredCredentialController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtApi)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/TargetController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/internal/TargetController.cs
@@ -24,6 +24,7 @@ public partial class TargetController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtAPI"></param>
         public TargetController(ILogger<TargetController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtAPI)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/v1/CertificateController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/v1/CertificateController.cs
@@ -152,6 +152,7 @@ public async Task<IActionResult> Download(string instanceId, string managedCertI
         /// <summary>
         /// Download text log for the given managed certificate
         /// </summary>
+        /// <param name="instanceId"></param>
         /// <param name="managedCertId"></param>
         /// <param name="maxLines"></param>
         /// <returns>Log file in text format</returns>
@@ -221,7 +222,6 @@ public async Task<IActionResult> GetManagedCertificates(string? keyword, int? pa
         /// <summary>
         /// Get summary counts of all managed certs
         /// </summary>
-        /// <param name="keyword"></param>
         /// <returns></returns>
         [HttpPost]
         [Route("summary")]
@@ -253,6 +253,7 @@ public async Task<IActionResult> GetManagedCertificateDetails(string instanceId,
         /// <summary>
         /// Add/update the full settings for a specific managed certificate
         /// </summary>
+        /// <param name="instanceId"></param>
         /// <param name="managedCertificate"></param>
         /// <returns></returns>
         [HttpPost]
@@ -292,6 +293,7 @@ public async Task<IActionResult> BeginOrder(string instanceId, string id)
         /// <summary>
         /// Begin the managed certificate request/renewal process a set of managed certificates
         /// </summary>
+        /// <param name="instanceId"></param>
         /// <param name="settings"></param>
         /// <returns></returns>
         [HttpPost]
@@ -315,6 +317,7 @@ public async Task<IActionResult> PerformRenewal(string instanceId, Models.Renewa
         /// <summary>
         /// Perform default tests for the given configuration
         /// </summary>
+        /// <param name="instanceId"></param>
         /// <param name="item"></param>
         /// <returns></returns>
         [HttpPost]
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Controllers/v1/SystemController.cs b/src/Certify.Server/Certify.Server.Hub.Api/Controllers/v1/SystemController.cs
@@ -24,6 +24,7 @@ public partial class SystemController : ApiControllerBase
         /// </summary>
         /// <param name="logger"></param>
         /// <param name="client"></param>
+        /// <param name="mgmtApi"></param>
         public SystemController(ILogger<SystemController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtApi)
         {
             _logger = logger;
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementAPI.cs b/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementAPI.cs
@@ -557,7 +557,7 @@ internal async Task<List<ActionStep>> PerformInstanceImport(string instanceId, I
         /// <param name="exportRequest">The export request details.</param>
         /// <param name="currentAuthContext">The current authentication context.</param>
         /// <returns>An <see cref="ImportExportPackage"/> containing the exported configuration.</returns>
-        internal async Task<Models.Config.Migration.ImportExportPackage> PerformInstanceExport(string instanceId, ExportRequest exportRequest, AuthContext? currentAuthContext)
+        internal async Task<Models.Config.Migration.ImportExportPackage?> PerformInstanceExport(string instanceId, ExportRequest exportRequest, AuthContext? currentAuthContext)
         {
             var args = new KeyValuePair<string, string>[] {
                         new("instanceId", instanceId) ,
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementWorker.cs b/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementWorker.cs
@@ -4,6 +4,9 @@
 
 namespace Certify.Server.Hub.Api.Services
 {
+    /// <summary>
+    /// Simple worker to monitor for connected instances and manage instance state
+    /// </summary>
     public class ManagementWorker : IHostedService, IDisposable
     {
         private readonly ILogger<ManagementWorker> _logger;
@@ -13,13 +16,24 @@ public class ManagementWorker : IHostedService, IDisposable
         private int _updateFrequency = 10;
         private string _serviceName = "[Management Worker]";
 
+        /// <summary>
+        /// Create a new instance of the management worker
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="hubContext"></param>
+        /// <param name="stateProvider"></param>
         public ManagementWorker(ILogger<ManagementWorker> logger, IHubContext<InstanceManagementHub> hubContext, IInstanceManagementStateProvider stateProvider)
         {
             _logger = logger;
             _hubContext = hubContext;
             _stateProvider = stateProvider;
         }
 
+        /// <summary>
+        /// Start the management worker
+        /// </summary>
+        /// <param name="stoppingToken"></param>
+        /// <returns></returns>
         public Task StartAsync(CancellationToken stoppingToken)
         {
             _logger.LogInformation("{svc} running.", _serviceName);
@@ -28,6 +42,11 @@ public Task StartAsync(CancellationToken stoppingToken)
             return Task.CompletedTask;
         }
 
+        /// <summary>
+        /// Dispatch a command to a connected instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <param name="cmd"></param>
         private void DispatchCommand(string instanceId, InstanceCommandRequest cmd)
         {
             var connectionId = _stateProvider.GetConnectionIdForInstance(instanceId);
@@ -42,28 +61,21 @@ private void DispatchCommand(string instanceId, InstanceCommandRequest cmd)
             }
         }
 
+        /// <summary>
+        /// Perform simple monitoring of connected instances
+        /// </summary>
+        /// <param name="state"></param>
         private void DoWork(object? state)
         {
             var instances = _stateProvider.GetConnectedInstances();
             _logger.LogInformation("{svc} connected instances: {count}", _serviceName, instances.Count());
-
-            /*foreach (var instance in instances)
-            {
-                _logger.LogInformation("{svc} requesting info from instance: id:{id} title:{title}", _serviceName, instance.InstanceId, instance.Title);
-
-                // refresh instance status
-                var cmd = new InstanceCommandRequest { CommandId = Guid.NewGuid(), CommandType = ManagementHubCommands.GetInstanceItems, Value = null };
-
-                DispatchCommand(instance.InstanceId, cmd);
-            }
-
-            // 
-            var items = _stateProvider.GetManagedInstanceItems();
-            _logger.LogInformation("{svc} total items managed across instances: {count}", _serviceName, items.SelectMany(s=>s.Value.Items).Count());
-            */
-
         }
 
+        /// <summary>
+        /// Stop the management worker
+        /// </summary>
+        /// <param name="stoppingToken"></param>
+        /// <returns></returns>
         public Task StopAsync(CancellationToken stoppingToken)
         {
             _logger.LogInformation("{svc} is stopping.", _serviceName);
@@ -73,6 +85,9 @@ public Task StopAsync(CancellationToken stoppingToken)
             return Task.CompletedTask;
         }
 
+        /// <summary>
+        /// Dispose of the management worker timer etc
+        /// </summary>
         public void Dispose()
         {
             _timer?.Dispose();
diff --git a/src/Certify.Server/Certify.Server.HubService/Services/CertifyHubService.cs b/src/Certify.Server/Certify.Server.HubService/Services/CertifyHubService.cs
@@ -50,7 +50,7 @@ private ServiceControllers.ManagedChallengeController _managedChallengeControlle
         public Task<ICollection<SecurityPrinciple>> GetSecurityPrinciples(AuthContext authContext) => _accessController(authContext).GetSecurityPrinciples();
         public Task<ActionResult> AddAssignedAccessToken(AssignedAccessToken token, AuthContext authContext) => _accessController(authContext).AddAssignedccessToken(token);
         public Task<ActionResult> RemoveAssignedAccessToken(string id, AuthContext authContext) => _accessController(authContext).RemoveAssignedAccessToken(id);
-        public Task<ActionResult> CheckApiTokenHasAccess(AccessToken token, AccessCheck check, AuthContext? authContext = null) => _accessController(authContext).CheckApiTokenHasAccess(new AccessTokenCheck { Check = check, Token = token });
+        public Task<ActionResult> CheckApiTokenHasAccess(AccessToken token, AccessCheck check, AuthContext authContext) => _accessController(authContext).CheckApiTokenHasAccess(new AccessTokenCheck { Check = check, Token = token });
         public Task<ICollection<AssignedAccessToken>> GetAssignedAccessTokens(AuthContext authContext) => _accessController(authContext).GetAssignedAccessTokens();
         public Task<ActionResult> RemoveSecurityPrinciple(string id, AuthContext authContext) => _accessController(authContext).DeleteSecurityPrinciple(id);
         public Task<ActionResult> UpdateSecurityPrinciple(SecurityPrinciple principle, AuthContext authContext) => _accessController(authContext).UpdateSecurityPrinciple(principle);
diff --git a/src/Certify.Server/Certify.Server.HubService/Services/DirectInstanceManagementHub.cs b/src/Certify.Server/Certify.Server.HubService/Services/DirectInstanceManagementHub.cs
@@ -40,7 +40,7 @@ public Task ReceiveCommandResult(InstanceCommandResult result)
             {
                 _stateProvider.RemoveAwaitedCommandRequest(cmd.CommandId);
 
-                if (cmd.CommandType == ManagementHubCommands.GetInstanceInfo)
+                if (cmd.CommandType == ManagementHubCommands.GetInstanceInfo && result.Value != null)
                 {
                     var instanceInfo = System.Text.Json.JsonSerializer.Deserialize<ManagedInstanceInfo>(result.Value);
 
@@ -88,24 +88,24 @@ public Task ReceiveCommandResult(InstanceCommandResult result)
                         // action this message from this instance
                         _logger?.LogInformation("Received instance command result {result}", result.CommandType);
 
-                        if (cmd.CommandType == ManagementHubCommands.GetManagedItems)
+                        if (cmd.CommandType == ManagementHubCommands.GetManagedItems && result.Value != null)
                         {
                             // got items from an instance
                             var val = System.Text.Json.JsonSerializer.Deserialize<ManagedInstanceItems>(result.Value);
 
-                            _stateProvider.UpdateInstanceItemInfo(instanceId, val.Items);
+                            _stateProvider.UpdateInstanceItemInfo(instanceId, val!.Items);
                         }
-                        else if (cmd.CommandType == ManagementHubCommands.GetStatusSummary && result?.Value != null)
+                        else if (cmd.CommandType == ManagementHubCommands.GetStatusSummary && result.Value != null)
                         {
                             // got status summary
                             var val = System.Text.Json.JsonSerializer.Deserialize<StatusSummary>(result.Value);
 
-                            _stateProvider.UpdateInstanceStatusSummary(instanceId, val);
+                            _stateProvider.UpdateInstanceStatusSummary(instanceId, val!);
                         }
-                        else
+                        else if (result != null)
                         {
                             // store for something else to consume
-                            if (result.IsCommandResponse)
+                            if (result.IsCommandResponse == true)
                             {
                                 _stateProvider.AddAwaitedCommandResult(result);
                             }
diff --git a/src/Certify.Server/Certify.Server.HubService/Services/DirectManagementServerClient.cs b/src/Certify.Server/Certify.Server.HubService/Services/DirectManagementServerClient.cs
@@ -7,11 +7,11 @@ namespace Certify.Server.HubService.Services
 {
     public class DirectManagementServerClient : Client.IManagementServerClient
     {
-        public event Action OnConnectionClosed;
-        public event Action OnConnectionReconnected;
-        public event Action OnConnectionReconnecting;
-        public event Func<InstanceCommandRequest, Task<InstanceCommandResult>> OnGetCommandResult;
-        public event Func<ManagedInstanceItems> OnGetInstanceItems;
+        public event Action? OnConnectionClosed;
+        public event Action? OnConnectionReconnected;
+        public event Action? OnConnectionReconnecting;
+        public event Func<InstanceCommandRequest, Task<InstanceCommandResult>>? OnGetCommandResult;
+        public event Func<ManagedInstanceItems>? OnGetInstanceItems;
 
         private ICertifyManager _certifyManager;
         private IInstanceManagementHub _managementHub;
diff --git a/src/Certify.Shared/Management/CertificateManager.cs b/src/Certify.Shared/Management/CertificateManager.cs

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ public async Task<List<ProviderDefinition>> GetDataStoreProviders()`
`162`	`162`	`allProviders.AddRange(providers);`
`163`	`163`	`}`
`164`	`164`
`165`		`- return allProviders.OrderBy(p => p.Title).ToList();`
	`165`	`+ return await Task.FromResult(allProviders.OrderBy(p => p.Title).ToList());`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`public async Task<List<DataStoreConnection>> GetDataStores()`
`@@ -187,7 +187,7 @@ public async Task<List<DataStoreConnection>> GetDataStores()`
`187`	`187`	`dataStores.Add(new DataStoreConnection { Id = "(default)", Title = "(Default SQLite)", TypeId = "sqlite" });`
`188`	`188`	`}`
`189`	`189`
`190`		`- return dataStores.OrderBy(t => t.Title).ToList();`
	`190`	`+ return await Task.FromResult(dataStores.OrderBy(t => t.Title).ToList());`
`191`	`191`	`}`
`192`	`192`	`public async Task<List<ActionStep>> CopyDateStoreToTarget(string sourceId, string destId)`
`193`	`193`	`{`
Original file line number	Diff line number	Diff line change
`@@ -452,15 +452,18 @@ private async Task<ActionResult> PerformChallengeResponse_Http01(ILog log, ITarg`
`452`	`452`	`// renewing may all point to the same web root, we keep the configcheck file`
`453`	`453`	`pendingAuth.Cleanup = async () =>`
`454`	`454`	`{`
`455`		`- if (!destFile.EndsWith("configcheck") && File.Exists(destFile))`
	`455`	`+ await Task.Run(() =>`
`456`	`456`	`{`
`457`		`- log.Debug("Challenge Cleanup: Removing {file}", destFile);`
`458`		`- try`
	`457`	`+ if (!destFile.EndsWith("configcheck") && File.Exists(destFile))`
`459`	`458`	`{`
`460`		`- File.Delete(destFile);`
	`459`	`+ log.Debug("Challenge Cleanup: Removing {file}", destFile);`
	`460`	`+ try`
	`461`	`+ {`
	`462`	`+ File.Delete(destFile);`
	`463`	`+ }`
	`464`	`+ catch { }`
`461`	`465`	`}`
`462`		`- catch { }`
`463`		`- }`
	`466`	`+ });`
`464`	`467`	`};`
`465`	`468`
`466`	`469`	`performFilesystemBasedValidation = true;`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public partial class CertificateAuthorityController : ApiControllerBase`
`22`	`22`	`/// </summary>`
`23`	`23`	`/// <param name="logger"></param>`
`24`	`24`	`/// <param name="client"></param>`
	`25`	`+ /// <param name="mgmtApi"></param>`
`25`	`26`	`public CertificateAuthorityController(ILogger<CertificateAuthorityController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtApi)`
`26`	`27`	`{`
`27`	`28`	`_logger = logger;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ public partial class ChallengeProviderController : ApiControllerBase`
`21`	`21`	`/// </summary>`
`22`	`22`	`/// <param name="logger"></param>`
`23`	`23`	`/// <param name="client"></param>`
	`24`	`+ /// <param name="mgmtAPI"></param>`
`24`	`25`	`public ChallengeProviderController(ILogger<ChallengeProviderController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtAPI)`
`25`	`26`	`{`
`26`	`27`	`_logger = logger;`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public partial class StoredCredentialController : ApiControllerBase`
`23`	`23`	`/// </summary>`
`24`	`24`	`/// <param name="logger"></param>`
`25`	`25`	`/// <param name="client"></param>`
	`26`	`+ /// <param name="mgmtApi"></param>`
`26`	`27`	`public StoredCredentialController(ILogger<StoredCredentialController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtApi)`
`27`	`28`	`{`
`28`	`29`	`_logger = logger;`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ public partial class TargetController : ApiControllerBase`
`24`	`24`	`/// </summary>`
`25`	`25`	`/// <param name="logger"></param>`
`26`	`26`	`/// <param name="client"></param>`
	`27`	`+ /// <param name="mgmtAPI"></param>`
`27`	`28`	`public TargetController(ILogger<TargetController> logger, ICertifyInternalApiClient client, ManagementAPI mgmtAPI)`
`28`	`29`	`{`
`29`	`30`	`_logger = logger;`