Cleanup

Author: webprofusion-chrisc

src/Certify.Core/Management/Access/AccessControl.cs

@@ -26,16 +26,19 @@ public AccessControl(ILog log, IConfigurationStore store)
         public async Task AuditWarning(string template, params object[] propertyvalues)
         {
             _log?.Warning(template, propertyvalues);
+            await Task.CompletedTask;
         }
 
         public async Task AuditError(string template, params object[] propertyvalues)
         {
             _log?.Error(template, propertyvalues);
+            await Task.CompletedTask;
         }
 
         public async Task AuditInformation(string template, params object[] propertyvalues)
         {
             _log?.Information(template, propertyvalues);
+            await Task.CompletedTask;
         }
 
         /// <summary>

src/Certify.Core/Management/Servers/ServerProviderIIS.cs

@@ -541,7 +541,7 @@ public async Task<ActionStep> AddOrUpdateSiteBinding(BindingInfo bindingSpec, bo
                     if (remainingAttempts == 0 && !isCompleted)
                     {
                         // failed to create this binding, possible due to settings serialisation conflict
-                        throw exp;
+                        throw;
                     }
                     else
                     {
@@ -604,7 +604,7 @@ public async Task<ActionStep> AddOrUpdateFtpSiteBinding(BindingInfo bindingSpec,
                     if (remainingAttempts == 0 && !isCompleted)
                     {
                         // failed to create this binding, possible due to settings serialisation conflict
-                        throw exp;
+                        throw;
                     }
                     else
                     {

src/Certify.Server/Certify.Server.Hub.Api/SignalR/ManagementHub/InstanceManagementStateProvider.cs

@@ -5,6 +5,7 @@
 
 namespace Certify.Server.Hub.Api.SignalR.ManagementHub
 {
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
     public interface IInstanceManagementStateProvider
     {
         public void Clear();
@@ -29,6 +30,7 @@ public interface IInstanceManagementStateProvider
         public bool HasStatusSummaryForManagedInstance(string instanceId);
         public ConcurrentDictionary<string, StatusSummary> GetManagedInstanceStatusSummaries();
     }
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
 
     /// <summary>
     /// Track state across pool of instance connections to the management hub
@@ -44,11 +46,18 @@ public class InstanceManagementStateProvider : IInstanceManagementStateProvider
         private ILogger<InstanceManagementStateProvider> _logger;
         private string _mgmtHubInstanceId = string.Empty;
 
+        /// <summary>
+        /// Create a new instance of the state provider
+        /// </summary>
+        /// <param name="logger"></param>
         public InstanceManagementStateProvider(ILogger<InstanceManagementStateProvider> logger)
         {
             _logger = logger;
         }
 
+        /// <summary>
+        /// Clear all state
+        /// </summary>
         public void Clear()
         {
             _logger.LogWarning("Flushing management hub state, clients will need to reconnect.");
@@ -60,20 +69,33 @@ public void Clear()
 
         }
 
+        /// <summary>
+        /// Set the instance ID of the management hub
+        /// </summary>
+        /// <param name="instanceId"></param>
         public void SetManagementHubInstanceId(string instanceId)
         {
             _mgmtHubInstanceId = instanceId;
         }
 
+        /// <summary>
+        /// Get the instance ID of the management hub
+        /// </summary>
+        /// <returns></returns>
         public string GetManagementHubInstanceId()
         {
             return _mgmtHubInstanceId;
         }
 
+        /// <summary>
+        /// Get a list of all connected instances
+        /// </summary>
+        /// <returns></returns>
         public List<ManagedInstanceInfo> GetConnectedInstances()
         {
             return _instanceConnections.Values.ToList();
         }
+
         /// <summary>
         /// Track the instance info associated with a hub connection
         /// </summary>
@@ -95,6 +117,11 @@ public void UpdateInstanceConnectionInfo(string connectionId, ManagedInstanceInf
             });
         }
 
+        /// <summary>
+        /// Update the status summary for a given instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <param name="summary"></param>
         public void UpdateInstanceStatusSummary(string instanceId, StatusSummary summary)
         {
             _managedInstanceStatusSummary.AddOrUpdate(instanceId, summary, (i, oldValue) => summary);
@@ -113,6 +140,11 @@ public string GetConnectionIdForInstance(string instanceId)
             return info.Key;
         }
 
+        /// <summary>
+        /// Get the instance ID associated with a given connection ID
+        /// </summary>
+        /// <param name="connectionId"></param>
+        /// <returns></returns>
         public string? GetInstanceIdForConnection(string connectionId)
         {
             _instanceConnections.TryGetValue(connectionId, out var managedInstanceInfo);
@@ -147,11 +179,20 @@ public void AddAwaitedCommandRequest(InstanceCommandRequest command)
             return cmd;
         }
 
+        /// <summary>
+        /// Add a command result we are waiting for
+        /// </summary>
+        /// <param name="result"></param>
         public void AddAwaitedCommandResult(InstanceCommandResult result)
         {
             _awaitedCommandResults.AddOrUpdate(result.CommandId, result, (i, oldValue) => result);
         }
 
+        /// <summary>
+        /// Wait for a command result to be available
+        /// </summary>
+        /// <param name="commandId"></param>
+        /// <returns></returns>
         public async Task<InstanceCommandResult?> ConsumeAwaitedCommandResult(Guid commandId)
         {
             _logger.LogInformation("Waiting for command result {commandId}..", commandId);
@@ -187,22 +228,41 @@ public void RemoveAwaitedCommandRequest(Guid commandId)
             _awaitedCommandRequests.Remove(commandId, out _);
         }
 
+        /// <summary>
+        /// Update the managed certificate items for a given instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <param name="items"></param>
         public void UpdateInstanceItemInfo(string instanceId, List<ManagedCertificate> items)
         {
             var info = new ManagedInstanceItems { InstanceId = instanceId, Items = items };
             _managedInstanceItems.AddOrUpdate(instanceId, info, (k, old) => info);
         }
 
+        /// <summary>
+        /// Get the current managed certificate items for a given instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <returns></returns>
         public ConcurrentDictionary<string, ManagedInstanceItems> GetManagedInstanceItems(string instanceId = null)
         {
             return _managedInstanceItems;
         }
 
+        /// <summary>
+        /// Get the current status summaries for all managed instances
+        /// </summary>
+        /// <returns></returns>
         public ConcurrentDictionary<string, StatusSummary> GetManagedInstanceStatusSummaries()
         {
             return _managedInstanceStatusSummary;
         }
 
+        /// <summary>
+        /// Update a cached managed certificate item for a given instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <param name="managedCertificate"></param>
         public void UpdateCachedManagedInstanceItem(string instanceId, ManagedCertificate managedCertificate)
         {
             _managedInstanceItems.TryGetValue(instanceId, out var instance);
@@ -213,16 +273,31 @@ public void UpdateCachedManagedInstanceItem(string instanceId, ManagedCertificat
             }
         }
 
+        /// <summary>
+        /// Check if we have any items cached for a given managed instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <returns></returns>
         public bool HasItemsForManagedInstance(string instanceId)
         {
             return _managedInstanceItems.ContainsKey(instanceId);
         }
 
+        /// <summary>
+        /// Check if we have a status summary for a given managed instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <returns></returns>
         public bool HasStatusSummaryForManagedInstance(string instanceId)
         {
             return _managedInstanceStatusSummary.ContainsKey(instanceId);
         }
 
+        /// <summary>
+        /// Remove a cached managed certificate item for a given instance
+        /// </summary>
+        /// <param name="instanceId"></param>
+        /// <param name="managedCertificateId"></param>
         public void DeleteCachedManagedInstanceItem(string instanceId, string managedCertificateId)
         {
             _managedInstanceItems.TryGetValue(instanceId, out var instance);