Merge pull request #4 from g4-api/development

Development

Author: gravity-api

src/G4.Api/Abstractions/IAutomationAsyncClient.cs

@@ -1,7 +1,4 @@
-using G4.Api.Models;
-using G4.Models;
-using G4.Models.Events;
-using G4.Plugins;
+using G4.Models;
 
 using Microsoft.Extensions.Logging;
 

src/G4.Api/Abstractions/IEnvironmentsClient.cs

@@ -42,14 +42,33 @@ public interface IEnvironmentsClient
         Dictionary<string, IDictionary<string, object>> GetEnvironments();
 
         /// <summary>
-        /// Retrieves the value of a specified environment parameter.
+        /// Retrieves the value of a specified environment parameter without any additional processing.
         /// </summary>
         /// <param name="environment">The name of the environment from which to retrieve the parameter.</param>
         /// <param name="parameter">The name of the parameter to retrieve.</param>
-        /// <param name="decode">A boolean value indicating whether to decode the parameter value from base64.</param>
+        /// <returns>The raw value of the specified parameter if it exists; otherwise, the default value.</returns>
+        string GetParameter(string environment, string parameter);
+
+        /// <summary>
+        /// Retrieves the value of a specified environment parameter with an option to decode it from Base64.
+        /// </summary>
+        /// <param name="environment">The name of the environment from which to retrieve the parameter.</param>
+        /// <param name="parameter">The name of the parameter to retrieve.</param>
+        /// <param name="decode">A boolean value indicating whether to decode the parameter value from Base64.</param>
         /// <returns>The value of the specified parameter if it exists; otherwise, the default value.</returns>
         string GetParameter(string environment, string parameter, bool decode);
 
+        /// <summary>
+        /// Retrieves the value of a specified environment parameter with options to decode it from Base64
+        /// and decrypt it using the provided encryption key.
+        /// </summary>
+        /// <param name="environment">The name of the environment from which to retrieve the parameter.</param>
+        /// <param name="parameter">The name of the parameter to retrieve.</param>
+        /// <param name="decode">A boolean value indicating whether to decode the parameter value from Base64.</param>
+        /// <param name="encryptionKey">An optional encryption key used to decrypt the parameter value. If <c>null</c> or empty, no decryption is performed.</param>
+        /// <returns>The processed parameter value as a string if it exists; otherwise, the default value.</returns>
+        string GetParameter(string environment, string parameter, bool decode, string encryptionKey);
+
         /// <summary>
         /// Removes the specified environment from the database.
         /// </summary>
@@ -107,6 +126,21 @@ public interface IEnvironmentsClient
         /// </returns>
         int SetEnvironment(string name, IDictionary<string, string> parameters, bool encode);
 
+        /// <summary>
+        /// Updates an existing environment with the specified name and parameters,
+        /// optionally encoding and encrypting the parameter values.
+        /// </summary>
+        /// <param name="name">The name of the environment to update.</param>
+        /// <param name="parameters">A dictionary of parameters to update in the environment. If <c>null</c>, an empty dictionary is used.</param>
+        /// <param name="encode">Indicates whether the parameter values should be converted to Base64.</param>
+        /// <param name="encryptionKey">An optional encryption key used to encrypt the parameter values. If <c>null</c> or empty, no encryption is applied.</param>
+        /// <returns>An integer representing the HTTP status code:
+        /// <c>201</c> if the environment was created successfully,
+        /// <c>204</c> if the environment was updated successfully.
+        /// </returns>
+        int SetEnvironment(string name, IDictionary<string, string> parameters, bool encode, string encryptionKey);
+
+
         /// <summary>
         /// Sets an environment parameter in the specified environment collection.
         /// </summary>

src/G4.Api/Clients/EnvironmentsClient.cs

@@ -4,9 +4,12 @@
 
 using LiteDB;
 
+using Microsoft.Extensions.Primitives;
+
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection.Metadata;
 
 namespace G4.Api.Clients
 {
@@ -38,8 +41,20 @@ public void ClearEnvironments()
             collection.DeleteMany(predicate: "_id IN @0", args: new BsonArray(documentsToRemove));
         }
 
+        /// <inheritdoc />
+        public string GetParameter(string environment, string parameter)
+        {
+            return GetParameter(environment, parameter, decode: true, encryptionKey: default);
+        }
+
         /// <inheritdoc />
         public string GetParameter(string environment, string parameter, bool decode)
+        {
+            return GetParameter(environment, parameter, decode, encryptionKey: default);
+        }
+
+        /// <inheritdoc />
+        public string GetParameter(string environment, string parameter, bool decode, string encryptionKey)
         {
             // Retrieve the environment parameters for the specified environment name
             var applicationEnviornment = G4Environment
@@ -56,9 +71,14 @@ public string GetParameter(string environment, string parameter, bool decode)
             }
 
             // Return the decoded value if requested, otherwise return the raw value as a string
-            return decode
+            var decodedValue = decode
                 ? $"{value}".ConvertFromBase64()
                 : $"{value}";
+
+            // Return the decrypted value if an encryption key is provided, otherwise return the decoded value
+            return !string.IsNullOrEmpty(encryptionKey)
+                ? decodedValue.Decrypt(encryptionKey)
+                : decodedValue;
         }
 
         /// <inheritdoc />
@@ -204,8 +224,15 @@ public int RemoveParameter(string environment, string parameter)
                     Name = name
                 };
 
+                // Encrypt the parameter value if an encryption key is provided
+                parameterValue = !string.IsNullOrEmpty(parameter.EncryptionKey)
+                    ? parameter.Value.Encrypt(parameter.EncryptionKey)
+                    : parameter.Value;
+
                 // Encode the parameter value if required
-                parameterValue = parameter.Encode ? parameter.Value.ConvertToBase64() : parameter.Value;
+                parameterValue = parameter.Encode
+                    ? parameter.Value.ConvertToBase64()
+                    : parameter.Value;
 
                 // Check if the Parameters dictionary is null (i.e., no parameters exist)
                 if (document.Parameters == null)
@@ -254,18 +281,60 @@ public int SetEnvironment(string name, IDictionary<string, string> parameters)
         /// <inheritdoc />
         public int SetEnvironment(string name, IDictionary<string, string> parameters, bool encode)
         {
+            return SetEnvironment(name, parameters, encode, encryptionKey: default);
+        }
+
+        /// <inheritdoc />
+        public int SetEnvironment(string name, IDictionary<string, string> parameters, bool encode, string encryptionKey)
+        {
+            // Initializes a new environment with the specified name and parameters.
+            static void InitializeEnvironment(
+                ILiteCollection<ApplicationParametersModel> collection,
+                string name, IDictionary<string, string> parameters,
+                bool encode,
+                string encryptionKey)
+            {
+                // Create a new ApplicationParametersModel with a unique ID, the specified name, and the provided parameters.
+                var document = new ApplicationParametersModel
+                {
+                    Id = Guid.NewGuid(),
+                    Name = name,
+                    Parameters = InitializeParameters(parameters, encode, encryptionKey)
+                };
+
+                // Insert the newly created parameters model into the collection.
+                collection.Insert(document);
+            }
+
+            // Initializes a collection of parameters by optionally encrypting and encoding their values.
+            static Dictionary<string, object> InitializeParameters(
+                    IDictionary<string, string> parameters, bool encode, string encryptionKey)
+            {
+                // Create a dictionary to hold the processed parameters.
+                var parametersCollection = new Dictionary<string, object>();
+
+                // Iterate through each key-value pair in the provided parameters dictionary.
+                foreach (var parameter in parameters)
+                {
+                    // Store the processed value in the collection using the original parameter key.
+                    parametersCollection[parameter.Key] = InitializeParameterValue(value: parameter.Value, encode, encryptionKey);
+                }
+
+                // Return the collection of processed parameters.
+                return parametersCollection;
+            }
+
             // Initialize parameters to an empty dictionary if it is null
             parameters ??= new Dictionary<string, string>();
 
-            // TODO: Find a way to remove double call to GetDocument when calling InitializeEnvironment
             // Attempt to find the existing parameters model in the collection
             var (collection, documents) = GetDocuments(LiteDatabase, name);
 
             // Check if the parameters model does not exist
             if (documents.Length == 0)
             {
                 // Initialize the environment if the parameters model does not exist
-                InitializeEnvironment(LiteDatabase, name, parameters, encode);
+                InitializeEnvironment(collection, name, parameters, encode, encryptionKey);
 
                 // Return 201 Created to indicate successful initialization
                 return 201;
@@ -280,7 +349,7 @@ public int SetEnvironment(string name, IDictionary<string, string> parameters, b
                 // Iterate through each parameter and update or add it to the Parameters dictionary
                 foreach (var parameter in parameters)
                 {
-                    document.Parameters[parameter.Key] = parameter.Value;
+                    document.Parameters[parameter.Key] = InitializeParameterValue(value: parameter.Value, encode, encryptionKey);
                 }
 
                 // Update the parameters model in the collection to persist the changes
@@ -291,31 +360,16 @@ public int SetEnvironment(string name, IDictionary<string, string> parameters, b
             return 204;
         }
 
-        // Initializes a new environment with the specified name and parameters.
-        private static void InitializeEnvironment(ILiteDatabase liteDatabase, string name, IDictionary<string, string> parameters, bool encode)
+        // Initializes the parameter value by optionally encrypting and encoding it.
+        private static string InitializeParameterValue(string value, bool encode, string encryptionKey)
         {
-            // Retrieve the collection and existing documents for the specified environment name.
-            var (collection, documents) = GetDocuments(liteDatabase, name);
-
-            // Check if the parameters model already exists.
-            if (documents.Length > 0)
-            {
-                // If the parameters model exists, return HTTP 204 No Content with the existing model.
-                return;
-            }
+            // Encrypt the value if an encryption key is provided.
+            value = !string.IsNullOrEmpty(encryptionKey)
+                ? value.Encrypt(encryptionKey)
+                : value;
 
-            // Create a new ApplicationParametersModel with a unique ID, the specified name, and the provided parameters.
-            var document = new ApplicationParametersModel
-            {
-                Id = Guid.NewGuid(),
-                Name = name,
-                Parameters = parameters?.ToDictionary(
-                    k => k.Key,
-                    v => encode ? (object)v.Value.ConvertToBase64() : v.Value)
-            };
-
-            // Insert the newly created parameters model into the collection.
-            collection.Insert(document);
+            // Encode the value in Base64 if encoding is enabled, otherwise return the original value.
+            return encode ? value.ConvertToBase64() : value;
         }
 
         // Retrieves a single ApplicationParametersModel document from the specified LiteDatabase collection based on the provided environment name.

src/G4.Api/Extensions/LocalExtensions.cs

@@ -9,7 +9,6 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using System.Threading;
-using G4.Cache;
 
 namespace G4.Extensions
 {

src/G4.Api/G4.Api.csproj

@@ -30,9 +30,9 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="G4.Plugins" Version="2025.3.7.34" />
-		<PackageReference Include="G4.Plugins.Common" Version="2025.3.11.106" />
-		<PackageReference Include="G4.Plugins.Ui" Version="2025.3.11.106" />
+		<PackageReference Include="G4.Plugins" Version="2025.3.28.36" />
+		<PackageReference Include="G4.Plugins.Common" Version="2025.3.28.107" />
+		<PackageReference Include="G4.Plugins.Ui" Version="2025.3.28.107" />
 	</ItemGroup>
 
 </Project>

src/G4.Api/Models/EnvironmentParameterModel.cs

@@ -13,6 +13,11 @@ public class EnvironmentParameterModel
         /// <remarks>Optional field; defaults to true.</remarks>
         public bool Encode { get; set; } = true;
 
+        /// <summary>
+        /// The encryption key used to encrypt the parameter value.
+        /// </summary>
+        public string EncryptionKey { get; set; }
+
         /// <summary>
         /// The name of the environment.
         /// </summary>

src/G4.IntegrationTests/G4.IntegrationTests.csproj

@@ -34,13 +34,13 @@
 	<ItemGroup>
 		<PackageReference Include="Microsoft.AspNetCore.MiddlewareAnalysis" Version="8.0.10" PrivateAssets="all" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
-		<PackageReference Include="MSTest.TestAdapter" Version="3.8.2" />
-		<PackageReference Include="MSTest.TestFramework" Version="3.8.2" />
+		<PackageReference Include="MSTest.TestAdapter" Version="3.8.3" />
+		<PackageReference Include="MSTest.TestFramework" Version="3.8.3" />
 		<PackageReference Include="coverlet.collector" Version="6.0.4">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
-		<PackageReference Include="Swashbuckle.AspNetCore" Version="7.3.1" />
+		<PackageReference Include="Swashbuckle.AspNetCore" Version="8.0.0" />
 	</ItemGroup>
 
 	<ItemGroup>