Hub: indicate if command result is awaited

Some commands may be issued on connection and these results are processed as they are encountered instead of being an awaited result elsewhere.

Author: webprofusion-chrisc

src/Certify.Models/Hub/ManagementHubMessages.cs

@@ -94,6 +94,11 @@ public InstanceCommandRequest(string commandType, KeyValuePair<string, string>[]
         /// Command associated value
         /// </summary>
         public string? Value { get; set; } = string.Empty;
+
+        /// <summary>
+        /// If true we are directly returning this result to a caller
+        /// </summary>
+        public bool IsResultAwaited { get; set; }
     }
 
     /// <summary>

src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementAPI.cs

@@ -127,6 +127,8 @@ private async Task SendCommandWithNoResult(string instanceId, InstanceCommandReq
             InstanceCommandResult result;
             var cmd = new InstanceCommandRequest(commandType, args);
 
+            cmd.IsResultAwaited = true;
+
             result = await GetCommandResult(instanceId, cmd);
 
             if (result?.Value != null)

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

@@ -248,21 +248,29 @@ private async Task ProcessInstanceCommandResult(InstanceCommandResult result, In
             // action this message from this instance
             _logger?.LogDebug("[ProcessInstanceCommandResult] Received instance command result {instanceId} {cmdType}", instanceId, cmd.CommandType);
 
-            if (cmd.CommandType == ManagementHubCommands.GetManagedItems && result.Value != null)
+            if (!cmd.IsResultAwaited && cmd.CommandType == ManagementHubCommands.GetManagedItems && result.Value != null)
             {
+                // remove awaited command now it's been handled
+
+                _stateProvider.RemoveAwaitedCommandRequest(cmd.CommandId);
+
                 // got items from an instance
                 var val = System.Text.Json.JsonSerializer.Deserialize<ManagedInstanceItems>(result.Value, JsonOptions.DefaultJsonSerializerOptions);
 
                 _stateProvider.UpdateInstanceItemInfo(instanceId, val!.Items);
             }
-            else if (cmd.CommandType == ManagementHubCommands.GetStatusSummary && result.Value != null)
+            else if (!cmd.IsResultAwaited && cmd.CommandType == ManagementHubCommands.GetStatusSummary && result.Value != null)
             {
+                // remove awaited command now it's been handled
+                _stateProvider.RemoveAwaitedCommandRequest(cmd.CommandId);
+
                 // got status summary
                 var val = System.Text.Json.JsonSerializer.Deserialize<StatusSummary>(result.Value, JsonOptions.DefaultJsonSerializerOptions);
 
                 _stateProvider.UpdateInstanceStatusSummary(instanceId, val!);
             }
-            else if (result.IsCommandResponse)
+            else
+            if (result.IsCommandResponse)
             {
                 _stateProvider.AddAwaitedCommandResult(result);
             }

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

@@ -1,4 +1,4 @@
-using System.Collections.Concurrent;
+using System.Collections.Concurrent;
 using Certify.Models;
 using Certify.Models.Hub;
 using Certify.Models.Reporting;
@@ -17,6 +17,11 @@ public interface IInstanceManagementStateProvider
         string? GetInstanceIdForConnection(string connectionId);
         List<ManagedInstanceInfo> GetConnectedInstances();
         void AddAwaitedCommandRequest(InstanceCommandRequest command);
+
+        /// <summary>
+        /// Remove an awaited command so we don't keep waiting on the result
+        /// </summary>
+        /// <param name="commandId"></param>
         void RemoveAwaitedCommandRequest(Guid commandId);
         InstanceCommandRequest? GetAwaitedCommandRequest(Guid commandId);
         void AddAwaitedCommandResult(InstanceCommandResult result);
@@ -228,9 +233,11 @@ public void AddAwaitedCommandResult(InstanceCommandResult result)
             }
             else
             {
-                _logger.LogDebug("[ConsumeAwaitedCommandResult] Got command result {commandId} {cmdType}..", cmd.CommandId, cmd.CommandType);
+                _logger.LogDebug("[ConsumeAwaitedCommandResult] Received and consumed command result {commandId} {cmdType}..", cmd.CommandId, cmd.CommandType);
             }
 
+            RemoveAwaitedCommandRequest(cmd.CommandId);
+
             return cmdResult;
         }
 
@@ -244,7 +251,7 @@ public void RemoveAwaitedCommandRequest(Guid commandId)
 
             if (request != null)
             {
-                _logger.LogDebug("[RemoveAwaitedCommandRequest] Removed command request {commandId} {cmdType}..", request.CommandId, request.CommandType);
+                _logger.LogDebug("[RemoveAwaitedCommandRequest] Removed awaited command request {commandId} {cmdType}..", request.CommandId, request.CommandType);
             }
             else
             {