config defaulting, also include VPN service

Author: spikecurtis

App/App.xaml.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Diagnostics;
 using System.IO;
-using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Coder.Desktop.App.Models;
@@ -19,6 +18,7 @@
 using Windows.ApplicationModel.Activation;
 using Microsoft.Extensions.Logging;
 using Serilog;
+using System.Collections.Generic;
 
 namespace Coder.Desktop.App;
 
@@ -29,9 +29,6 @@ public partial class App : Application
     private bool _handleWindowClosed = true;
     private const string MutagenControllerConfigSection = "MutagenController";
 
-    private const string logTemplate =
-        "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}";
-
 #if !DEBUG
     private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\App";
     private const string logFilename = "app.log";
@@ -45,31 +42,22 @@ public partial class App : Application
     public App()
     {
         var builder = Host.CreateApplicationBuilder();
+        var configBuilder = builder.Configuration as IConfigurationBuilder;
 
-        (builder.Configuration as IConfigurationBuilder).Add(
+        // Add config in increasing order of precedence: first builtin defaults, then HKLM, finally HKCU
+        // so that the user's settings in the registry take precedence.
+        AddDefaultConfig(configBuilder);
+        configBuilder.Add(
             new RegistryConfigurationSource(Registry.LocalMachine, ConfigSubKey));
+        configBuilder.Add(
+            new RegistryConfigurationSource(Registry.CurrentUser, ConfigSubKey));
 
         var services = builder.Services;
 
         // Logging
         builder.Services.AddSerilog((_, loggerConfig) =>
         {
             loggerConfig.ReadFrom.Configuration(builder.Configuration);
-            var sinkConfig = builder.Configuration.GetSection("Serilog").GetSection("WriteTo");
-            if (!sinkConfig.GetChildren().Any())
-            {
-                // no log sink defined in the registry, so we'll add one here.
-                // We can't generally define these in the registry because we don't
-                // know, a priori, what user will execute Coder Desktop, and therefore
-                // what directories are writable by them. But, it's nice to be able to
-                // directly customize Serilog via the registry if you know what you are
-                // doing.
-                var logPath = Path.Combine(
-                    Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
-                    "CoderDesktop",
-                    logFilename);
-                loggerConfig.WriteTo.File(logPath, outputTemplate: logTemplate, rollingInterval: RollingInterval.Day);
-            }
         });
 
         services.AddSingleton<ICredentialManager, CredentialManager>();
@@ -108,6 +96,7 @@ public App()
 
     public async Task ExitApplication()
     {
+        _logger.LogDebug("exiting app");
         _handleWindowClosed = false;
         Exit();
         var syncController = _services.GetRequiredService<ISyncSessionController>();
@@ -169,6 +158,7 @@ protected override void OnLaunched(Microsoft.UI.Xaml.LaunchActivatedEventArgs ar
                 Debugger.Break();
 #endif
             }
+
             syncSessionCts.Dispose();
         }, CancellationToken.None);
 
@@ -208,4 +198,24 @@ public void HandleURIActivation(Uri uri)
         // don't log the query string as that's where we include some sensitive information like passwords
         _logger.LogInformation("handling URI activation for {path}", uri.AbsolutePath);
     }
+
+    private static void AddDefaultConfig(IConfigurationBuilder builder)
+    {
+        var logPath = Path.Combine(
+            Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
+            "CoderDesktop",
+            logFilename);
+        builder.AddInMemoryCollection(new Dictionary<string, string?>
+        {
+            [MutagenControllerConfigSection + ":MutagenExecutablePath"] = @"C:\mutagen.exe",
+            ["Serilog:Using:0"] = "Serilog.Sinks.File",
+            ["Serilog:MinimumLevel"] = "Information",
+            ["Serilog:Enrich:0"] = "FromLogContext",
+            ["Serilog:WriteTo:0:Name"] = "File",
+            ["Serilog:WriteTo:0:Args:path"] = logPath,
+            ["Serilog:WriteTo:0:Args:outputTemplate"] =
+                "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}",
+            ["Serilog:WriteTo:0:Args:rollingInterval"] = "Day",
+        });
+    }
 }

Installer/Program.cs

@@ -130,7 +130,8 @@ public class BootstrapperOptions : SharedOptions
         if (!SystemFile.Exists(MsiPath))
             throw new ArgumentException($"MSI package not found at '{MsiPath}'", nameof(MsiPath));
         if (!SystemFile.Exists(WindowsAppSdkPath))
-            throw new ArgumentException($"Windows App Sdk package not found at '{WindowsAppSdkPath}'", nameof(WindowsAppSdkPath));
+            throw new ArgumentException($"Windows App Sdk package not found at '{WindowsAppSdkPath}'",
+                nameof(WindowsAppSdkPath));
     }
 }
 
@@ -141,6 +142,7 @@ public class Program
     private const string HelpUrl = "https://coder.com/docs";
     private const string RegistryKey = @"SOFTWARE\Coder Desktop";
     private const string AppConfigRegistryKey = RegistryKey + @"\App";
+    private const string VpnServiceConfigRegistryKey = RegistryKey + @"\VpnService";
 
     private const string DotNetCheckName = "DOTNET_RUNTIME_CHECK";
     private const RollForward DotNetCheckRollForward = RollForward.minor;
@@ -259,42 +261,24 @@ private static int BuildMsiPackage(MsiOptions opts)
         project.AddDir(programFiles64Folder);
 
 
-
         project.AddRegValues(
             // Add registry values that are consumed by the manager. Note that these
-            // should not be changed. See Vpn.Service/Program.cs and
+            // should not be changed. See Vpn.Service/Program.cs (AddDefaultConfig) and
             // Vpn.Service/ManagerConfig.cs for more details.
-            new RegValue(RegistryHive, RegistryKey, "Manager:ServiceRpcPipeName", "Coder.Desktop.Vpn"),
-            new RegValue(RegistryHive, RegistryKey, "Manager:TunnelBinaryPath",
+            new RegValue(RegistryHive, VpnServiceConfigRegistryKey, "Manager:ServiceRpcPipeName", "Coder.Desktop.Vpn"),
+            new RegValue(RegistryHive, VpnServiceConfigRegistryKey, "Manager:TunnelBinaryPath",
                 $"[INSTALLFOLDER]{opts.VpnDir}\\coder-vpn.exe"),
-            new RegValue(RegistryHive, RegistryKey, "Manager:LogFileLocation",
+            new RegValue(RegistryHive, VpnServiceConfigRegistryKey, "Manager:TunnelBinarySignatureSigner",
+                "Coder Technologies Inc."),
+            new RegValue(RegistryHive, VpnServiceConfigRegistryKey, "Manager:TunnelBinaryAllowVersionMismatch",
+                "false"),
+            new RegValue(RegistryHive, VpnServiceConfigRegistryKey, "Serilog:WriteTo:0:Args:path",
                 @"[INSTALLFOLDER]coder-desktop-service.log"),
-            new RegValue(RegistryHive, RegistryKey, "Manager:TunnelBinarySignatureSigner", "Coder Technologies Inc."),
-            new RegValue(RegistryHive, RegistryKey, "Manager:TunnelBinaryAllowVersionMismatch", "false")
-        );
 
-        // rather than adding individual reg values, it's much clearer to write the whole config as JSON then
-        // programmatically spit out the registry values.
-        var appConfigJson = """
-                            {
-                                "MutagenController": {
-                                    "MutagenExecutablePath": "[INSTALLFOLDER]vpn\mutagen.exe"
-                                },
-                                "Serilog": {
-                                    "Using": ["Serilog.Sinks.File"],
-                                    "MinimumLevel": "Information",
-                                    "Enrich": [ "FromLogContext" ],
-                                }
-                            }
-                            """;
-        var appConfig =
-            new ConfigurationBuilder().AddJsonStream(new MemoryStream(Encoding.UTF8.GetBytes(appConfigJson))).Build();
-
-        foreach (var kvp in appConfig.AsEnumerable())
-        {
-            if (kvp.Value is null) continue;
-            project.AddRegValue(new RegValue(RegistryHive, AppConfigRegistryKey, kvp.Key, kvp.Value));
-        }
+            // Add registry values that are consumed by the App MutagenController. See App/Services/MutagenController.cs
+            new RegValue(RegistryHive, AppConfigRegistryKey, "MutagenController:MutagenExecutablePath",
+                @"[INSTALLFOLDER]vpn\mutagen.exe")
+        );
 
         // Note: most of this control panel info will not be visible as this
         // package is usually hidden in favor of the bootstrapper showing

Tests.Vpn.Service/packages.lock.json

@@ -137,6 +137,15 @@
         "resolved": "9.0.4",
         "contentHash": "UI0TQPVkS78bFdjkTodmkH0Fe8lXv9LnhGFKgKrsgUJ5a5FVdFRcgjIkBVLbGgdRhxWirxH/8IXUtEyYJx6GQg=="
       },
+      "Microsoft.Extensions.DependencyModel": {
+        "type": "Transitive",
+        "resolved": "9.0.0",
+        "contentHash": "saxr2XzwgDU77LaQfYFXmddEDRUKHF4DaGMZkNB3qjdVSZlax3//dGJagJkKrGMIPNZs2jVFXITyCCR6UHJNdA==",
+        "dependencies": {
+          "System.Text.Encodings.Web": "9.0.0",
+          "System.Text.Json": "9.0.0"
+        }
+      },
       "Microsoft.Extensions.Diagnostics": {
         "type": "Transitive",
         "resolved": "9.0.4",
@@ -409,6 +418,16 @@
           "Serilog": "4.2.0"
         }
       },
+      "Serilog.Settings.Configuration": {
+        "type": "Transitive",
+        "resolved": "9.0.0",
+        "contentHash": "4/Et4Cqwa+F88l5SeFeNZ4c4Z6dEAIKbu3MaQb2Zz9F/g27T5a3wvfMcmCOaAiACjfUb4A6wrlTVfyYUZk3RRQ==",
+        "dependencies": {
+          "Microsoft.Extensions.Configuration.Binder": "9.0.0",
+          "Microsoft.Extensions.DependencyModel": "9.0.0",
+          "Serilog": "4.2.0"
+        }
+      },
       "Serilog.Sinks.Console": {
         "type": "Transitive",
         "resolved": "6.0.0",
@@ -496,6 +515,7 @@
           "Microsoft.Security.Extensions": "[1.3.0, )",
           "Semver": "[3.0.0, )",
           "Serilog.Extensions.Hosting": "[9.0.0, )",
+          "Serilog.Settings.Configuration": "[9.0.0, )",
           "Serilog.Sinks.Console": "[6.0.0, )",
           "Serilog.Sinks.File": "[6.0.0, )"
         }

Vpn.Service/ManagerConfig.cs

@@ -15,8 +15,6 @@ public class ManagerConfig
 
     [Required] public string TunnelBinaryPath { get; set; } = @"C:\coder-vpn.exe";
 
-    [Required] public string LogFileLocation { get; set; } = @"C:\coder-desktop-service.log";
-
     // If empty, signatures will not be verified.
     [Required] public string TunnelBinarySignatureSigner { get; set; } = "Coder Technologies Inc.";
 

Vpn.Service/Program.cs

@@ -3,6 +3,7 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Win32;
 using Serilog;
+using ILogger = Serilog.ILogger;
 
 namespace Coder.Desktop.Vpn.Service;
 
@@ -14,29 +15,22 @@ public static class Program
     // installer.
 #if !DEBUG
     private const string ServiceName = "Coder Desktop";
-    private const string ManagerConfigSection = "Manager";
+    private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\VpnService";
 #else
     // This value matches Create-Service.ps1.
     private const string ServiceName = "Coder Desktop (Debug)";
-    private const string ManagerConfigSection = "DebugManager";
+    private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\DebugVpnService";
 #endif
 
-    private const string ConsoleOutputTemplate =
-        "[{Timestamp:HH:mm:ss} {Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}";
-
-    private const string FileOutputTemplate =
-        "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}";
+    private const string ManagerConfigSection = "Manager";
 
     private static ILogger MainLogger => Log.ForContext("SourceContext", "Coder.Desktop.Vpn.Service.Program");
 
-    private static LoggerConfiguration BaseLogConfig => new LoggerConfiguration()
-        .Enrich.FromLogContext()
-        .MinimumLevel.Debug()
-        .WriteTo.Console(outputTemplate: ConsoleOutputTemplate);
-
     public static async Task<int> Main(string[] args)
     {
-        Log.Logger = BaseLogConfig.CreateLogger();
+        // This logger will only be used until we load our full logging configuration and replace it.
+        Log.Logger = new LoggerConfiguration().MinimumLevel.Debug().WriteTo.Console()
+            .CreateLogger();
         MainLogger.Information("Application is starting");
         try
         {
@@ -58,27 +52,26 @@ public static async Task<int> Main(string[] args)
     private static async Task BuildAndRun(string[] args)
     {
         var builder = Host.CreateApplicationBuilder(args);
+        var configBuilder = builder.Configuration as IConfigurationBuilder;
 
         // Configuration sources
         builder.Configuration.Sources.Clear();
-        (builder.Configuration as IConfigurationBuilder).Add(
-            new RegistryConfigurationSource(Registry.LocalMachine, @"SOFTWARE\Coder Desktop"));
+        AddDefaultConfig(configBuilder);
+        configBuilder.Add(
+            new RegistryConfigurationSource(Registry.LocalMachine, ConfigSubKey));
         builder.Configuration.AddEnvironmentVariables("CODER_MANAGER_");
         builder.Configuration.AddCommandLine(args);
 
         // Options types (these get registered as IOptions<T> singletons)
         builder.Services.AddOptions<ManagerConfig>()
             .Bind(builder.Configuration.GetSection(ManagerConfigSection))
-            .ValidateDataAnnotations()
-            .PostConfigure(config =>
-            {
-                Log.Logger = BaseLogConfig
-                    .WriteTo.File(config.LogFileLocation, outputTemplate: FileOutputTemplate)
-                    .CreateLogger();
-            });
+            .ValidateDataAnnotations();
 
         // Logging
-        builder.Services.AddSerilog();
+        builder.Services.AddSerilog((_, loggerConfig) =>
+        {
+            loggerConfig.ReadFrom.Configuration(builder.Configuration);
+        });
 
         // Singletons
         builder.Services.AddSingleton<IDownloader, Downloader>();
@@ -101,6 +94,32 @@ private static async Task BuildAndRun(string[] args)
         builder.Services.AddHostedService<ManagerService>();
         builder.Services.AddHostedService<ManagerRpcService>();
 
-        await builder.Build().RunAsync();
+        var host = builder.Build();
+        Log.Logger = (ILogger)host.Services.GetService(typeof(ILogger))!;
+        MainLogger.Information("Application is starting");
+
+        await host.RunAsync();
+    }
+
+    private static void AddDefaultConfig(IConfigurationBuilder builder)
+    {
+        builder.AddInMemoryCollection(new Dictionary<string, string?>
+        {
+            ["Serilog:Using:0"] = "Serilog.Sinks.File",
+            ["Serilog:Using:1"] = "Serilog.Sinks.Console",
+
+            ["Serilog:MinimumLevel"] = "Information",
+            ["Serilog:Enrich:0"] = "FromLogContext",
+
+            ["Serilog:WriteTo:0:Name"] = "File",
+            ["Serilog:WriteTo:0:Args:path"] = @"C:\coder-desktop-service.log",
+            ["Serilog:WriteTo:0:Args:outputTemplate"] =
+                "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}",
+            ["Serilog:WriteTo:0:Args:rollingInterval"] = "Day",
+
+            ["Serilog:WriteTo:1:Name"] = "Console",
+            ["Serilog:WriteTo:1:Args:outputTemplate"] =
+                "[{Timestamp:HH:mm:ss} {Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}",
+        });
     }
 }

Vpn.Service/Vpn.Service.csproj

@@ -31,6 +31,7 @@
         <PackageReference Include="Microsoft.Security.Extensions" Version="1.3.0" />
         <PackageReference Include="Semver" Version="3.0.0" />
         <PackageReference Include="Serilog.Extensions.Hosting" Version="9.0.0" />
+        <PackageReference Include="Serilog.Settings.Configuration" Version="9.0.0" />
         <PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
         <PackageReference Include="Serilog.Sinks.File" Version="6.0.0" />
     </ItemGroup>

Vpn.Service/packages.lock.json

@@ -81,6 +81,17 @@
           "Serilog.Extensions.Logging": "9.0.0"
         }
       },
+      "Serilog.Settings.Configuration": {
+        "type": "Direct",
+        "requested": "[9.0.0, )",
+        "resolved": "9.0.0",
+        "contentHash": "4/Et4Cqwa+F88l5SeFeNZ4c4Z6dEAIKbu3MaQb2Zz9F/g27T5a3wvfMcmCOaAiACjfUb4A6wrlTVfyYUZk3RRQ==",
+        "dependencies": {
+          "Microsoft.Extensions.Configuration.Binder": "9.0.0",
+          "Microsoft.Extensions.DependencyModel": "9.0.0",
+          "Serilog": "4.2.0"
+        }
+      },
       "Serilog.Sinks.Console": {
         "type": "Direct",
         "requested": "[6.0.0, )",
@@ -195,6 +206,15 @@
         "resolved": "9.0.4",
         "contentHash": "UI0TQPVkS78bFdjkTodmkH0Fe8lXv9LnhGFKgKrsgUJ5a5FVdFRcgjIkBVLbGgdRhxWirxH/8IXUtEyYJx6GQg=="
       },
+      "Microsoft.Extensions.DependencyModel": {
+        "type": "Transitive",
+        "resolved": "9.0.0",
+        "contentHash": "saxr2XzwgDU77LaQfYFXmddEDRUKHF4DaGMZkNB3qjdVSZlax3//dGJagJkKrGMIPNZs2jVFXITyCCR6UHJNdA==",
+        "dependencies": {
+          "System.Text.Encodings.Web": "9.0.0",
+          "System.Text.Json": "9.0.0"
+        }
+      },
       "Microsoft.Extensions.Diagnostics": {
         "type": "Transitive",
         "resolved": "9.0.4",