feat: add logging to App

Author: spikecurtis

App/App.csproj

@@ -61,10 +61,13 @@
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
         <PackageReference Include="H.NotifyIcon.WinUI" Version="2.2.0" />
-        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.1" />
-        <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.1" />
-        <PackageReference Include="Microsoft.Extensions.Options" Version="9.0.1" />
+        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.4" />
+        <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.4" />
+        <PackageReference Include="Microsoft.Extensions.Options" Version="9.0.4" />
         <PackageReference Include="Microsoft.WindowsAppSDK" Version="1.6.250108002" />
+        <PackageReference Include="Serilog.Extensions.Hosting" Version="9.0.0" />
+        <PackageReference Include="Serilog.Settings.Configuration" Version="9.0.0" />
+        <PackageReference Include="Serilog.Sinks.File" Version="6.0.0" />
         <PackageReference Include="WinUIEx" Version="2.5.1" />
     </ItemGroup>
 

App/App.xaml.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Coder.Desktop.App.Models;
@@ -16,6 +17,8 @@
 using Microsoft.Win32;
 using Microsoft.Windows.AppLifecycle;
 using Windows.ApplicationModel.Activation;
+using Microsoft.Extensions.Logging;
+using Serilog;
 
 namespace Coder.Desktop.App;
 
@@ -24,22 +27,51 @@ public partial class App : Application
     private readonly IServiceProvider _services;
 
     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 MutagenControllerConfigSection = "AppMutagenController";
+    private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\App";
+    private const string logFilename = "app.log";
 #else
-    private const string MutagenControllerConfigSection = "DebugAppMutagenController";
+    private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\DebugApp";
+    private const string logFilename = "debug-app.log";
 #endif
 
+    private readonly ILogger<App> _logger;
+
     public App()
     {
         var builder = Host.CreateApplicationBuilder();
 
         (builder.Configuration as IConfigurationBuilder).Add(
-            new RegistryConfigurationSource(Registry.LocalMachine, @"SOFTWARE\Coder Desktop"));
+            new RegistryConfigurationSource(Registry.LocalMachine, 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>();
         services.AddSingleton<IRpcController, RpcController>();
 
@@ -69,6 +101,7 @@ public App()
         services.AddTransient<TrayWindow>();
 
         _services = services.BuildServiceProvider();
+        _logger = (ILogger<App>)(_services.GetService(typeof(ILogger<App>))!);
 
         InitializeComponent();
     }
@@ -87,6 +120,7 @@ public async Task ExitApplication()
 
     protected override void OnLaunched(Microsoft.UI.Xaml.LaunchActivatedEventArgs args)
     {
+        _logger.LogInformation("new instance launched");
         // Start connecting to the manager in the background.
         var rpcController = _services.GetRequiredService<IRpcController>();
         if (rpcController.GetState().RpcLifecycle == RpcLifecycle.Disconnected)
@@ -110,13 +144,15 @@ protected override void OnLaunched(Microsoft.UI.Xaml.LaunchActivatedEventArgs ar
         _ = credentialManager.LoadCredentials(credentialManagerCts.Token).ContinueWith(t =>
         {
             // TODO: log
-#if DEBUG
             if (t.Exception != null)
             {
+                _logger.LogError(t.Exception, "failed to load credentials");
+#if DEBUG
                 Debug.WriteLine(t.Exception);
                 Debugger.Break();
-            }
 #endif
+            }
+
             credentialManagerCts.Dispose();
         }, CancellationToken.None);
 
@@ -126,9 +162,13 @@ protected override void OnLaunched(Microsoft.UI.Xaml.LaunchActivatedEventArgs ar
         _ = syncSessionController.RefreshState(syncSessionCts.Token).ContinueWith(t =>
         {
             // TODO: log
+            if (t.IsCanceled || t.Exception != null)
+            {
+                _logger.LogError(t.Exception, "failed to refresh sync state (canceled = {canceled}", t.IsCanceled);
 #if DEBUG
-            if (t.IsCanceled || t.Exception != null) Debugger.Break();
+                Debugger.Break();
 #endif
+            }
             syncSessionCts.Dispose();
         }, CancellationToken.None);
 
@@ -148,17 +188,24 @@ public void OnActivated(object? sender, AppActivationArguments args)
         {
             case ExtendedActivationKind.Protocol:
                 var protoArgs = args.Data as IProtocolActivatedEventArgs;
+                if (protoArgs == null)
+                {
+                    _logger.LogWarning("URI activation with null data");
+                    return;
+                }
+
                 HandleURIActivation(protoArgs.Uri);
                 break;
 
             default:
-                // TODO: log
+                _logger.LogWarning("activation for {kind}, which is unhandled", args.Kind);
                 break;
         }
     }
 
     public void HandleURIActivation(Uri uri)
     {
-        // TODO: handle
+        // 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);
     }
 }

App/packages.lock.json

@@ -17,6 +17,7 @@
     </ItemGroup>
 
     <ItemGroup>
+        <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="9.0.4" />
         <PackageReference Include="WixSharp_wix4" Version="2.6.0" />
         <PackageReference Include="WixSharp_wix4.bin" Version="2.6.0" />
         <PackageReference Include="CommandLineParser" Version="2.9.1" />

Installer/Installer.csproj

@@ -2,7 +2,9 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text;
 using CommandLine;
+using Microsoft.Extensions.Configuration;
 using WixSharp;
 using WixSharp.Bootstrapper;
 using WixSharp.CommonTasks;
@@ -138,6 +140,7 @@ public class Program
     private const string Manufacturer = "Coder Technologies Inc.";
     private const string HelpUrl = "https://coder.com/docs";
     private const string RegistryKey = @"SOFTWARE\Coder Desktop";
+    private const string AppConfigRegistryKey = RegistryKey + @"\App";
 
     private const string DotNetCheckName = "DOTNET_RUNTIME_CHECK";
     private const RollForward DotNetCheckRollForward = RollForward.minor;
@@ -256,6 +259,7 @@ 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
@@ -266,12 +270,32 @@ private static int BuildMsiPackage(MsiOptions opts)
             new RegValue(RegistryHive, RegistryKey, "Manager:LogFileLocation",
                 @"[INSTALLFOLDER]coder-desktop-service.log"),
             new RegValue(RegistryHive, RegistryKey, "Manager:TunnelBinarySignatureSigner", "Coder Technologies Inc."),
-            new RegValue(RegistryHive, RegistryKey, "Manager:TunnelBinaryAllowVersionMismatch", "false"),
-            // Add registry values that are consumed by the App MutagenController. See App/Services/MutagenController.cs
-            new RegValue(RegistryHive, RegistryKey, "AppMutagenController:MutagenExecutablePath",
-                @"[INSTALLFOLDER]mutagen.exe")
+            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]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));
+        }
+
         // Note: most of this control panel info will not be visible as this
         // package is usually hidden in favor of the bootstrapper showing
         // instead.

Installer/Program.cs

@@ -25,9 +25,9 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.1" />
-        <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="9.0.1" />
-        <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="9.0.1" />
+        <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.4" />
+        <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="9.0.4" />
+        <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="9.0.4" />
         <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" />