2.8.1: missing changes restored

Author: ChrisMaunder

.gitignore

@@ -210,6 +210,7 @@ _pkginfo.txt
 *.appx
 *.appxbundle
 *.appxupload
+*.msixbundle
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
@@ -353,9 +354,11 @@ wget-log*
 # Module packages --------------------------------------------------------------
 
 # Generated exe packages
-/src/modules/*/*-[0-9]*.[0-9]*.[0-9]*.zip
+/modules/*/*-[0-9]*.[0-9]*.[0-9]*.zip
+
 
 # Debug debris -----------------------------------------------------------------
 
 /SDK
-/debug
+/debug
+object-detect.exe

.vscode/launch.docker.json

@@ -17,11 +17,13 @@
             "cwd": "/app/server/",
             "stopAtEntry": false,
             "requireExactSource": false,
+            /*
             "serverReadyAction": {
                 "action": "openExternally",
-                "pattern": "\\bNow listening on:\\s+(https?://\\S+)",
+                "pattern": "\\blistening on port: (\\d+)",
                 "uriFormat": "http://localhost:%s/swagger"
             },
+            */
             "env": {
                 "ASPNETCORE_ENVIRONMENT": "Development",
                 "RUNNING_IN_VSCODE": "true",
@@ -62,11 +64,13 @@
             ],
             "cwd": "/app/server/",
             "stopAtEntry": false,
+            /*
             "serverReadyAction": {
                 "action": "openExternally",
-                "pattern": "\\bNow listening on:\\s+(https?://\\S+)",
+                "pattern": "\\blistening on port: (\\d+)",
                 "uriFormat": "http://localhost:%s/swagger"
             },
+            */
             "env": {
                 "ASPNETCORE_ENVIRONMENT": "Development",
                 "RUNNING_IN_VSCODE": "true",

.vscode/tasks.docker.json

@@ -9,7 +9,7 @@
             "group": "none",
             "type": "process",
             "command": "bash",
-            "args": [ "/app/devops/scripts/stop_all.sh" ],
+            "args": [ "/app/devops/utils/stop_all.sh" ],
             "problemMatcher": "$msCompile"
         }
     ]

modules/install_script_help.md

@@ -116,8 +116,8 @@ As an example, `requirements.linux.arm64.cuda11_7.txt` would be a requirements f
 | `writeLine` | text [foreground [background]]
 | `installAptPackages` | "list of packages to install"<br>Installs a list of apt packages. <br>eg `installAptPackages "libjpeg-dev zlib1g-dev libpython3-dev"` |
 | `installPythonPackagesByName` | *`PIP module names, separated by space` or `Wheel file path`, `Module name`*<br>- `PIP module name` - the name of the Python module to install, eg 'torch'<br> - `Wheel file path` - instead of a module name you can supply a wheel file path for installation<br> - `Module description` - (optional) the name or description of the module being installed<br>eg `installPythonPackagesByName "torch"`<br>`installPythonPackagesByName "my-torch-wheel.whl" "torch"`<br> - `PIP options` - (optional) Any otions you wish to pass to PIP (eg --index-url)|
-|  `downloadAndExtract` | *storageUrl filename downloadDirPath dirNameToSave message*<br>`storageUrl` - Url that holds the compressed archive to Download<br>`filename` - Name of the compressed archive to be downloaded<br> `downloadDirPath` - path to where the downloaded compressed archive should be downloaded<br>`dirNameToSave` - name of directory, relative to downloadDirPath, where contents of archive will be extracted and saved<br>`message` - Message to display during download |
-|  `Download`  | *storageUrl downloadDirPath filename moduleDirName message*<br> - `storageUrl` Url that holds the compressed archive to Download<<br> - `downloadDirPath` Path to where the downloaded compressed archive should be downloade<br> - `filename`      name of the compressed archive to be downloaded<br> - `dirNameToSave` name of directory, relative to downloadDirPath, where contents of archive will be extracted and saved<br> - `message` Message to display during download |
+|  `downloadAndExtract` | *assetStorageUrl filename downloadDirPath dirNameToSave message*<br>`assetStorageUrl` - Url that holds the compressed archive to Download<br>`filename` - Name of the compressed archive to be downloaded<br> `downloadDirPath` - path to where the downloaded compressed archive should be downloaded<br>`dirNameToSave` - name of directory, relative to downloadDirPath, where contents of archive will be extracted and saved<br>`message` - Message to display during download |
+|  `Download`  | *assetStorageUrl downloadDirPath filename moduleDirName message*<br> - `assetStorageUrl` Url that holds the compressed archive to Download<<br> - `downloadDirPath` Path to where the downloaded compressed archive should be downloade<br> - `filename`      name of the compressed archive to be downloaded<br> - `dirNameToSave` name of directory, relative to downloadDirPath, where contents of archive will be extracted and saved<br> - `message` Message to display during download |
 |||
 |  `getFromServer` | *folder filename moduleAssetDir message*<br>`folder` - name of the folder in the S3 bucket where the file lives<br>`filename` - Name of the compressed archive to be downloaded<br>`moduleAssetDir`- Name of folder in module's directory where archive will be extracted<br>`message` - Message to display during download <br><br>Tnis method will pull an archive from the current CodeProject cloud storage. This storage is read-only and subject to change.|
 |||

src/SDK/NET/API/ApiClient.cs

@@ -1,7 +1,7 @@
 using System.Net.Http.Json;
-using CodeProject.AI.SDK.API;
+using CodeProject.AI.SDK.Common;
 
-namespace CodeProject.AI.API
+namespace CodeProject.AI.SDK.API
 {
     /// <summary>
     /// Contains the data to be sent as part of a request to the server
@@ -105,9 +105,9 @@ protected HttpClient Client
         /// Initializes a new instance of the ApiClient class.
         /// </summary>
         /// <param name="port">The oort for the HTTP calls</param>
-        public ApiClient(int port)
+        public ApiClient(int port = 0)
         {
-            Port = port;
+            Port = port <= 0 ? Constants.DefaultPort : port;
         }
 
         /// <summary>

src/SDK/NET/API/ServerResponses.cs

@@ -1,5 +1,9 @@
 using System.Net;
 
+using CodeProject.AI.SDK.Modules;
+using CodeProject.AI.SDK.Common;
+using CodeProject.AI.SDK.Server;
+
 namespace CodeProject.AI.SDK.API
 {
     /// <summary>

src/SDK/NET/Auxiliary.info

@@ -0,0 +1,3 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<!-- This file deliberately empty -->
+</Project>

src/SDK/NET/Analysis/BackendClient.cs renamed to src/SDK/NET/Backend/BackendClient.cs

@@ -9,7 +9,8 @@
 namespace CodeProject.AI.SDK
 {
     /// <summary>
-    /// Represents an HTTP client to get requests and return responses to the CodeProject.AI server.
+    /// Represents an HTTP client for modules that gets requests and returns responses to the
+    /// CodeProject.AI server.
     /// </summary>
     public class BackendClient
     {

src/SDK/NET/Backend/BackendRequests.cs

@@ -0,0 +1,52 @@
+using System.Text.Json.Serialization;
+
+namespace CodeProject.AI.SDK
+{
+#pragma warning disable IDE1006 // Naming Styles
+
+    /// <summary>
+    /// Base class for queued requests for the backend. The naming here is for legacy backwards 
+    /// compatibility, and should probably be updated to something sensible.
+    /// </summary>
+    /// <remarks>We should rename reqtype to command and just have BackendRequest. We don't need
+    /// this base class.</remarks>
+    public class BackendRequestBase
+    {
+        /// <summary>
+        /// Gets the request unique id.  Used to return the response to the correct caller.
+        /// </summary>
+        [JsonInclude]
+        public string reqid { get; private set; } = Guid.NewGuid().ToString();
+
+        /// <summary>
+        /// Gets or sets the request type.
+        /// </summary>
+        [JsonInclude]
+        public string? reqtype { get; protected set; }
+    }
+
+    /// <summary>
+    /// Request with payload.
+    /// </summary>
+    public class BackendRequest : BackendRequestBase
+    {
+        /// <summary>
+        /// Gets or sets the payload.
+        /// </summary>
+        [JsonInclude]
+        public RequestPayload payload { get; protected set; }
+
+        /// <summary>
+        /// Instantiates a new instance of the <cref="BackendRequest" /> class.
+        /// TODO: Normalise the input. Currently reqtype == payload.command. One or the other, please.
+        /// </summary>
+        /// <param name="payload">The request payload</param>
+        public BackendRequest(RequestPayload payload)
+        {
+            this.reqtype = payload.command ?? string.Empty;
+            this.payload = payload;
+        }
+    }
+
+#pragma warning restore IDE1006 // Naming Styles
+}

src/SDK/NET/Analysis/ModuleWorkerBase.cs renamed to src/SDK/NET/Backend/ModuleWorkerBase.cs

@@ -3,7 +3,6 @@
 using System.Net.Http.Json;
 
 using CodeProject.AI.SDK.API;
-using CodeProject.AI.SDK.Common;
 using CodeProject.AI.SDK.Utils;
 
 using Microsoft.Extensions.Configuration;
@@ -104,6 +103,23 @@ public ModuleWorkerBase(ILogger logger, IConfiguration configuration,
             string currentModuleDirPath = GetModuleDirectoryPath();
             string currentDirName       = new DirectoryInfo(currentModuleDirPath).Name;
 
+            // TODO: We could load the settings directly from the modulesettings files rather than rely 
+            //       rely environment variables:
+            /*
+            // Load up the module's settings and start the module
+            var config = new ConfigurationBuilder();
+            config.AddModuleSettingsConfigFiles(moduleDirPath, false);
+            IConfiguration configuration = config.Build();
+
+            // Bind the values in the configuration to a ModuleConfig object
+            string moduleId = [get module id from config]
+            var moduleConfig = new ModuleConfig();
+            configuration.Bind($"Modules:{moduleId}", moduleConfig);
+
+            // Complete the ModuleConfig's setup. 
+            if (moduleConfig.Initialise(moduleId, moduleDirPath, ModuleLocation.Internal))
+            */
+
             _moduleId        = configuration.GetValue<string?>("CPAI_MODULE_ID", null)        ?? currentDirName;
             ModuleName       = configuration.GetValue<string?>("CPAI_MODULE_NAME", null)      ?? _moduleId;
             moduleDirPath    = configuration.GetValue<string?>("CPAI_MODULE_PATH", null)      ?? currentModuleDirPath;