Use yaml static context, use dictionary for app config

Fleny113 · Jul 3, 2024 · 7849226 · 7849226
1 parent 7af2f26
commit 7849226
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 31 deletions.
diff --git a/Hexus.Daemon/AppJsonSerializerContext.cs → Hexus.Daemon/AppSerializerContext.cs b/Hexus.Daemon/AppJsonSerializerContext.cs → Hexus.Daemon/AppSerializerContext.cs
@@ -1,7 +1,9 @@
+using Hexus.Daemon.Configuration;
 using Hexus.Daemon.Contracts;
 using Hexus.Daemon.Contracts.Requests;
 using Hexus.Daemon.Contracts.Responses;
 using System.Text.Json.Serialization;
+using YamlDotNet.Serialization;
 
 namespace Hexus.Daemon;
 
@@ -14,3 +16,8 @@ namespace Hexus.Daemon;
 [JsonSerializable(typeof(SendInputRequest))]
 [JsonSourceGenerationOptions(UseStringEnumConverter = true)]
 internal partial class AppJsonSerializerContext : JsonSerializerContext;
+
+[YamlSerializable(typeof(HexusConfigurationFile))]
+[YamlSerializable(typeof(HexusApplication))]
+[YamlStaticContext]
+public partial class AppYamlSerializerContext : StaticContext;
diff --git a/Hexus.Daemon/Configuration/HexusApplication.cs b/Hexus.Daemon/Configuration/HexusApplication.cs
@@ -1,16 +1,17 @@
-using System.ComponentModel;
+using YamlDotNet.Serialization;
 
 namespace Hexus.Daemon.Configuration;
 
 public sealed record HexusApplication
 {
-    public required string Name { get; set; }
-    public required string Executable { get; set; }
+    [YamlIgnore]
+    public string Name { get; set; } = null!;
+    public string Executable { get; set; } = null!;
 
-    [DefaultValue("")] public string Arguments { get; set; } = "";
-    public string WorkingDirectory { get; set; } = "";
+    public string? Arguments { get; set; }
+    public string WorkingDirectory { get; set; } = null!;
     public HexusApplicationStatus Status { get; set; } = HexusApplicationStatus.Exited;
-    [DefaultValue("")] public string Note { get; set; } = "";
+    public string? Note { get; set; }
 
     public Dictionary<string, string> EnvironmentVariables { get; set; } = [];
 }
diff --git a/Hexus.Daemon/Configuration/HexusConfiguration.cs b/Hexus.Daemon/Configuration/HexusConfiguration.cs
@@ -1,10 +1,5 @@
-using System.ComponentModel;
+namespace Hexus.Daemon.Configuration;
 
-namespace Hexus.Daemon.Configuration;
-
-/// <summary>
-/// Object used to consume the config file
-/// </summary>
 public sealed record HexusConfiguration
 {
     public required string UnixSocket { get; init; }
@@ -13,13 +8,11 @@ public sealed record HexusConfiguration
     public Dictionary<string, HexusApplication> Applications { get; init; } = [];
 }
 
-/// <summary>
-/// Object used to write to the config file
-/// </summary>
-public sealed record HexusConfigurationFile
+// Used for the YAML File serialization
+internal sealed record HexusConfigurationFile
 {
-    public string? UnixSocket { get; init; }
-    public int? HttpPort { get; init; }
-    public double? CpuRefreshIntervalSeconds { get; init; }
-    public IEnumerable<HexusApplication>? Applications { get; init; }
+    public string? UnixSocket { get; set; }
+    public int? HttpPort { get; set; }
+    public double? CpuRefreshIntervalSeconds { get; set; }
+    public Dictionary<string, HexusApplication>? Applications { get; set; }
 }
diff --git a/Hexus.Daemon/Configuration/HexusConfigurationManager.cs b/Hexus.Daemon/Configuration/HexusConfigurationManager.cs
@@ -8,14 +8,14 @@ internal class HexusConfigurationManager
 {
     public HexusConfiguration Configuration { get; private set; } = null!;
 
-    private static readonly IDeserializer YamlDeserializer = new DeserializerBuilder()
+    private static readonly AppYamlSerializerContext _yamlStaticContext = new();
+    private static readonly IDeserializer _yamlDeserializer = new StaticDeserializerBuilder(_yamlStaticContext)
         .WithNamingConvention(CamelCaseNamingConvention.Instance)
         .Build();
-
-    private static readonly ISerializer YamlSerializer = new SerializerBuilder()
-        .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull | DefaultValuesHandling.OmitDefaults)
-        .WithIndentedSequences()
+    private static readonly ISerializer _yamlSerializer = new StaticSerializerBuilder(_yamlStaticContext)
+        .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull | DefaultValuesHandling.OmitDefaults | DefaultValuesHandling.OmitEmptyCollections)
         .WithNamingConvention(CamelCaseNamingConvention.Instance)
+        .WithIndentedSequences()
         .Build();
 
     private void LoadConfiguration()
@@ -31,7 +31,7 @@ private void LoadConfiguration()
         }
 
         var configurationFile = File.ReadAllText(EnvironmentHelper.ConfigurationFile);
-        var configFile = YamlDeserializer.Deserialize<HexusConfigurationFile?>(configurationFile) ?? new HexusConfigurationFile();
+        var configFile = _yamlDeserializer.Deserialize<HexusConfigurationFile?>(configurationFile) ?? new HexusConfigurationFile();
 
         Configuration = configFile.MapToConfig();
 
@@ -42,7 +42,7 @@ internal void SaveConfiguration()
     {
         EnvironmentHelper.EnsureDirectoriesExistence();
 
-        var yamlString = YamlSerializer.Serialize(Configuration.MapToConfigFile());
+        var yamlString = _yamlSerializer.Serialize(Configuration.MapToConfigFile());
 
         lock (this)
         {

diff --git a/Hexus.Daemon/Contracts/Responses/ApplicationResponse.cs b/Hexus.Daemon/Contracts/Responses/ApplicationResponse.cs
@@ -5,9 +5,9 @@ namespace Hexus.Daemon.Contracts.Responses;
 public sealed record ApplicationResponse(
     string Name,
     string Executable,
-    string Arguments,
+    string? Arguments,
     string WorkingDirectory,
-    string Note,
+    string? Note,
     Dictionary<string, string> EnvironmentVariables,
     HexusApplicationStatus Status,
     TimeSpan ProcessUptime,

diff --git a/Hexus.Daemon/Extensions/MapperExtensions.cs b/Hexus.Daemon/Extensions/MapperExtensions.cs
@@ -2,6 +2,7 @@
 using Hexus.Daemon.Contracts.Requests;
 using Hexus.Daemon.Contracts.Responses;
 using Hexus.Daemon.Services;
+using Microsoft.Extensions.Configuration;
 
 namespace Hexus.Daemon.Extensions;
 
@@ -46,12 +47,23 @@ public static ApplicationResponse MapToResponse(this HexusApplication applicatio
 
     public static HexusConfiguration MapToConfig(this HexusConfigurationFile configurationFile)
     {
+        var applications = configurationFile.Applications?.Select(x => new KeyValuePair<string, HexusApplication>(x.Key, new()
+        {
+            Name = x.Key,
+            Executable = x.Value.Executable,
+            Arguments = x.Value.Arguments,
+            WorkingDirectory = x.Value.WorkingDirectory,
+            Status = x.Value.Status,
+            Note = x.Value.Note,
+            EnvironmentVariables = x.Value.EnvironmentVariables
+        }));
+
         return new()
         {
             UnixSocket = configurationFile.UnixSocket ?? EnvironmentHelper.SocketFile,
             HttpPort = configurationFile.HttpPort,
             CpuRefreshIntervalSeconds = configurationFile.CpuRefreshIntervalSeconds ?? 2.5,
-            Applications = configurationFile.Applications?.ToDictionary(application => application.Name) ?? [],
+            Applications = applications?.ToDictionary() ?? [],
         };
     }
     public static HexusConfigurationFile MapToConfigFile(this HexusConfiguration configuration)
@@ -60,12 +72,24 @@ public static HexusConfigurationFile MapToConfigFile(this HexusConfiguration con
         var socket = configuration.UnixSocket != EnvironmentHelper.SocketFile ? configuration.UnixSocket : null;
         var cpuRefresh = configuration.CpuRefreshIntervalSeconds != 2.5 ? configuration.CpuRefreshIntervalSeconds : (double?)null;
 
+        var applications = configuration.Applications.Select(x => new KeyValuePair<string, HexusApplication>(x.Key, new()
+        {
+            // We don't want to serialize the name in the config file
+            Name = null!,
+            Executable = x.Value.Executable,
+            Arguments = x.Value.Arguments,
+            WorkingDirectory = x.Value.WorkingDirectory,
+            Status = x.Value.Status,
+            Note = x.Value.Note,
+            EnvironmentVariables = x.Value.EnvironmentVariables
+        }));
+
         return new()
         {
             UnixSocket = socket,
             HttpPort = configuration.HttpPort,
             CpuRefreshIntervalSeconds = cpuRefresh,
-            Applications = configuration.Applications.Values,
+            Applications = applications.ToDictionary(),
         };
     }
 }
diff --git a/Hexus.Daemon/Hexus.Daemon.csproj b/Hexus.Daemon/Hexus.Daemon.csproj
@@ -15,6 +15,7 @@
         <PackageReference Include="Microsoft.Extensions.Hosting.Systemd" Version="8.0.0" />
         <PackageReference Include="NReco.Logging.File" Version="1.2.1" />
         <PackageReference Include="System.Linq.Async" Version="6.0.1" />
+        <PackageReference Include="Vecc.YamlDotNet.Analyzers.StaticGenerator" Version="15.1.2" />
         <PackageReference Include="YamlDotNet" Version="15.3.0" />
 
         <InternalsVisibleTo Include="Hexus" />