v2.5.1: Reworking modulesettings schema / correcting Promise/async dichotomy

Author: ChrisMaunder

src/SDK/NET/API/ApiClient.cs

@@ -145,7 +145,7 @@ public async Task<ServerResponse> GetAsync(string route)
             }
             catch (Exception ex)
             {
-                response = new ServerErrorResponse(ex.Message);
+                response = new ServerErrorResponse("GetAsync error: " + ex.Message);
             }
 
             return response;
@@ -178,7 +178,7 @@ public async Task<ServerResponse> GetAsync<T>(string route)
             }
             catch (Exception ex)
             {
-                response = new ServerErrorResponse(ex.Message);
+                response = new ServerErrorResponse("GetAsync<T> error: " + ex.Message);
             }
 
             return response;
@@ -212,7 +212,7 @@ public async Task<ServerResponse> PostAsync<T>(string route, ServerRequestConten
             }
             catch (Exception ex)
             {
-                response = new ServerErrorResponse(ex.Message);
+                response = new ServerErrorResponse("PostAsync error: " + ex.Message);
             }
 
             return response;

src/SDK/NET/API/ExplorerUI.cs

@@ -2,6 +2,44 @@
 
 namespace CodeProject.AI.SDK.API
 {
+    /// <summary>
+    /// Represents an option in a dropdown menu in the dashboard
+    /// </summary>
+    public class DashboardMenuOption
+    {
+        /// <summary>
+        /// Gets or sets the label for this menu option
+        /// </summary>
+        public string? Label { get; set; }
+
+        /// <summary>
+        /// Gets or sets the setting to be modified by this menu option
+        /// </summary>
+        public string? Setting { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value to be set by this menu option
+        /// </summary>
+        public string? Value { get; set; }
+    }
+
+    /// <summary>
+    /// Represents a dropdown menu in the dashboard. This will be used to construct a dropdown menu
+    /// in the CodeProject.AI Server dashboard for the given module.
+    /// </summary>
+    public class DashboardMenu
+    {
+        /// <summary>
+        /// Gets or sets the label for this menu
+        /// </summary>
+        public string? Label { get; set; }
+
+        /// <summary>
+        /// Gets or sets the options for this menu
+        /// </summary>
+        public DashboardMenuOption[]? Options { get; set; }
+    }
+
     /// <summary>
     /// A structure containing the HTML, CSS and Javascript that are to be injected into the 
     /// Explorer web app to allow the user to explore and test a module.

src/SDK/NET/API/ModuleResponses.cs

@@ -48,6 +48,11 @@ public class ModuleResponse : BaseResponse
         /// response.
         /// </summary>
         public long AnalysisRoundTripMs { get; set; }
+
+        /// <summary>
+        /// Gets or set a dictionary representing the current module status
+        /// </summary>
+        public object? StatusData { get; set; }
     }
 
     /// <summary>

src/SDK/NET/API/VersionInfo.cs

@@ -30,7 +30,7 @@ public class VersionInfo
         /// <summary>
         /// Gets or sets a value indicating whether this version contains a security update
         /// </summary>
-        public bool? SecurityUpdate { get; set; }
+        public bool SecurityUpdate { get; set; }
 
         /// <summary>
         /// Gets or sets the build number
@@ -155,11 +155,19 @@ public static int Compare(VersionInfo versionA, VersionInfo versionB)
             if (versionA.Build != versionB.Build)
                 return versionA.Build - versionB.Build;
 
-            // int result = (versionA.PreRelease ?? "").CompareTo(versionB.PreRelease ?? "");
-            // if (result != 0)
-            //     return result;
+            // A pre-release string will be greater than an empty string. We actually want the
+            // opposite. 2.5.0 > 2.5.0-RC1 and 2.5.0-RTM > 2.5.0-RC1
 
-            return (versionA.SecurityUpdate ?? false).CompareTo(versionB.SecurityUpdate ?? false);
+            if (string.IsNullOrWhiteSpace(versionA.PreRelease) && !string.IsNullOrWhiteSpace(versionB.PreRelease))
+                return 1;
+
+            if (!string.IsNullOrWhiteSpace(versionA.PreRelease) && string.IsNullOrWhiteSpace(versionB.PreRelease))
+                return -1;
+
+            if (!(versionA.PreRelease ?? string.Empty).Equals(versionB.PreRelease ?? string.Empty))
+                return (versionA.PreRelease ?? string.Empty).CompareTo(versionB.PreRelease ?? string.Empty);
+
+            return versionA.SecurityUpdate.CompareTo(versionB.SecurityUpdate);
         }
     }
 }

src/SDK/NET/Analysis/BackendClient.cs

@@ -34,7 +34,7 @@ public BackendClient(string url, TimeSpan timeout = default, CancellationToken t
             _httpClient ??= new HttpClient
             {
                 BaseAddress = new Uri(url),
-                Timeout = (timeout == default) ? TimeSpan.FromMinutes(1) : timeout
+                Timeout     = (timeout == default) ? TimeSpan.FromMinutes(1) : timeout
             };
 
             loggingTask = ProcessLoggingQueue(token);
@@ -77,33 +77,27 @@ public BackendClient(string url, TimeSpan timeout = default, CancellationToken t
             BackendRequest? request = null;
             try
             {
-                //request = await _httpClient!.GetFromJsonAsync<BackendRequest>(requestUri, token)
-                //                            .ConfigureAwait(false);
-                var response = await _httpClient!.GetAsync(requestUri, token);
-                // only process responses that have content
+                HttpResponseMessage response = await _httpClient!.GetAsync(requestUri, token);
                 if (response.StatusCode == System.Net.HttpStatusCode.OK)
-                {
                     request = await response.Content.ReadFromJsonAsync<BackendRequest>();
-                }
-                else
-                {
-                    return null;
-                }
             }
             catch (JsonException)
             {
+#if DEBUG
+                Debug.WriteLine("JsonException GetRequest");
+#endif
                 // This is probably due to timing out and therefore no JSON to parse.
             }
 #if DEBUG
             catch (Exception ex)
             {
-                Debug.WriteLine(ex);
+                Debug.WriteLine("Error in GetRequest: " + ex.Message);
 #else
             catch (Exception /*ex*/)
             {
 #endif
                 Console.WriteLine($"Unable to get request from {queueName} for {moduleId}");
-                _errorPauseSecs = Math.Min(_errorPauseSecs > 0 ? _errorPauseSecs * 2 : 5, 60);
+                _errorPauseSecs = Math.Min(_errorPauseSecs > 0 ? _errorPauseSecs * 3/2 : 5, 30);
 
                 if (!token.IsCancellationRequested && _errorPauseSecs > 0)
                 {
@@ -199,7 +193,7 @@ private async Task ProcessLoggingQueue(CancellationToken token = default)
                     }
                     catch(Exception e)
                     {
-                        Debug.Write(e);
+                        Debug.Write("Error processing logging queue: " + e.Message);
                     }
                 }
             }

src/SDK/NET/Analysis/BackendRequests.cs

@@ -216,7 +216,7 @@ public void AddFile(string filePath)
             }
             catch (Exception e)
             {
-                Debug.WriteLine(e);
+                Debug.WriteLine("Error adding file: " + e.Message);
             }
         }
 

src/SDK/NET/Analysis/ModuleWorkerBase.cs

@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Dynamic;
 using System.Net.Http.Json;
 
 using CodeProject.AI.SDK.API;
@@ -28,8 +29,11 @@ public abstract class ModuleWorkerBase : BackgroundService
         private readonly ILogger       _logger;
         private readonly IHostApplicationLifetime _appLifetime;
 
-        private bool _cancelled       = false;
-        private bool _performSelfTest = false;
+        private bool _cancelled         = false;
+        private bool _performSelfTest   = false;
+        private int  _successInferences;
+        private long _totalSuccessInf_ms;
+        private int  _failedInferences;
 
         /// <summary>
         /// Gets or sets the name of this Module
@@ -93,7 +97,7 @@ public ModuleWorkerBase(ILogger logger, IConfiguration configuration,
             EnableGPU        = configuration.GetValue<bool>("CPAI_MODULE_ENABLE_GPU",   true);
             _accelDeviceName = configuration.GetValue<string?>("CPAI_ACCEL_DEVICE_NAME", null);
             _halfPrecision   = configuration.GetValue<string?>("CPAI_HALF_PRECISION", null) ?? "enable"; // Can be enable, disable or force
-            _logVerbosity    = configuration.GetValue<string?>("CPAI_LOG_VERBOSITY", null)  ?? "info";   // Can be Quiet, Info or Loud
+            _logVerbosity    = configuration.GetValue<string?>("CPAI_LOG_VERBOSITY", null)  ?? "quiet";   // Can be Quiet, Info or Loud
 
             _performSelfTest = configuration.GetValue<bool>("CPAI_MODULE_DO_SELFTEST", false);
 
@@ -127,6 +131,22 @@ protected virtual void InitModule()
         /// <returns>An object to serialize back to the server.</returns>
         protected abstract ModuleResponse ProcessRequest(BackendRequest request);
 
+        /// <summary>
+        /// Returns an object containing current stats for this module
+        /// </summary>
+        /// <returns>An object</returns>
+        protected virtual dynamic? Status()
+        {
+            dynamic status = new ExpandoObject();
+            status.SuccessfulInferences = _successInferences;
+            status.FailedInferences     = _failedInferences;
+            status.NumInferences        = _successInferences + _failedInferences;
+            status.AverageInferenceMs   = _successInferences > 0 
+                                        ? _totalSuccessInf_ms / _successInferences : 0;
+
+            return status;
+        }
+
         /// <summary>
         /// Called when the module is asked to execute a self-test to ensure it install and runs
         /// correctly
@@ -188,13 +208,22 @@ private async Task ProcessQueue(CancellationToken token, int taskNumber)
                     ModuleResponse response = ProcessRequest(request);
                     stopWatch.Stop();
 
+                    if (response.Success)
+                    {
+                        _successInferences++;
+                        _totalSuccessInf_ms += response.InferenceMs;   
+                    }
+                    else
+                        _failedInferences++;
+
                     long processMs = stopWatch.ElapsedMilliseconds;
                     response.ModuleName        = ModuleName;
                     response.ModuleId          = _moduleId;
                     response.ProcessMs         = processMs;
                     response.ExecutionProvider = ExecutionProvider ?? string.Empty;
                     response.Command           = request.payload?.command ?? string.Empty;
                     response.CanUseGPU         = CanUseGPU;
+                    response.StatusData        = Status();
 
                     HttpContent content = JsonContent.Create(response, response.GetType());
 

src/SDK/NET/Common/Constants.cs

@@ -0,0 +1,81 @@
+namespace CodeProject.AI.SDK.Common
+{
+    /// <summary>
+    /// Contains constants for CodeProject.AI Server
+    /// </summary>
+    public static class Constants
+    {
+        /// <summary>
+        /// The name of the company publishing this (will first check project file - it should be there)
+        /// </summary>
+        public const string Company         = "CodeProject";
+
+        /// <summary>
+        /// The product name (will first check project file - it should be there)
+        /// </summary>
+        public const string ProductName     = "CodeProject.AI Server";
+
+        /// <summary>
+        /// The category of product. Handy for placing this in a subdir of the main company dir.
+        /// </summary>
+        public const string ProductCategory = "AI";
+
+        /// <summary>
+        /// The default port the server listens on using HTTP
+        /// </summary>
+        public const int DefaultPort    = 32168;
+
+        /// <summary>
+        /// The default port the server listens on when using HTTP with SSL/TLS
+        /// </summary>
+        public const int DefaultPortSsl = 32016;
+
+        /// <summary>
+        /// The legacy port (Deepstack compatibility) the server listens on
+        /// </summary>
+        public const int LegacyPort    = 5000;
+
+        /// <summary>
+        /// The legacy port the server listens on when running under macOS
+        /// </summary>
+        public const int LegacyPortOsx = 5500;
+
+        /// <summary>
+        /// Used wherever there needs to be a distinction between release and dev. Typically used in
+        /// filenames
+        /// </summary>
+        public const string Development               = "development";
+
+        /// <summary>
+        /// The name of the file containing the settings for the server
+        /// </summary>
+        public const string ServerSettingsFilename    = "serversettings.json";
+
+        /// <summary>
+        /// The name of the file containing the settings for the server for the development environment
+        /// </summary>
+        public const string DevServerSettingsFilename = $"serversettings.{Development}.json";
+
+        /// <summary>
+        /// The name of the modules settings file without extension
+        /// </summary>
+        public const string ModulesSettingFilenameNoExt = "modulesettings";
+
+        /// <summary>
+        /// The name of the file containing the settings for a module, or a collection of modules
+        /// (This file can handle one or more sets of settings)
+        /// </summary>
+        public const string ModuleSettingsFilename    = ModulesSettingFilenameNoExt + ".json";
+
+        /// <summary>
+        /// The name of the file containing the settings for a module, or a collection of modules,
+        /// for the development environment
+        /// </summary>
+        public const string DevModuleSettingsFilename = $"{ModulesSettingFilenameNoExt}.{Development}.json";
+
+        /// <summary>
+        /// The name of the file that stores the list of known modules
+        /// </summary>
+        public const string ModulesListingFilename   = "modules.json";
+    };
+}