feat: add auto updater

.github/workflows/release.yaml

@@ -68,6 +68,9 @@ jobs:
         service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
         token_format: "access_token"
 
+    - name: Install gcloud
+      uses: google-github-actions/setup-gcloud@77e7a554d41e2ee56fc945c52dfd3f33d12def9a # 2.1.4
+
     - name: Install wix
       shell: pwsh
       run: |
@@ -120,6 +123,52 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+    - name: Update appcast
+      if: startsWith(github.ref, 'refs/tags/')
+      shell: pwsh
+      run: |
+        $ErrorActionPreference = "Stop"
+
+        # The Update-AppCast.ps1 script fetches the release notes from GitHub,
+        # which might take a few seconds to be ready.
+        Start-Sleep -Seconds 10
+
+        # Save the appcast signing key to a temporary file.
+        $keyPath = Join-Path $env:TEMP "appcast-key.pem"
+        $key = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($env:APPCAST_SIGNATURE_KEY_BASE64))
+        Set-Content -Path $keyPath -Value $key
+
+        # Download the old appcast from GCS.
+        $oldAppCastPath = Join-Path $env:TEMP "appcast.old.xml"
+        & gsutil cp $env:APPCAST_GCS_URI $oldAppCastPath
+        if ($LASTEXITCODE -ne 0) { throw "Failed to download appcast" }
+
+        # Generate the new appcast and signature.
+        $newAppCastPath = Join-Path $env:TEMP "appcast.new.xml"
+        $newAppCastSignaturePath = $newAppCastPath + ".signature"
+        & ./scripts/Update-AppCast.ps1 `
+          -tag "${{ github.ref_name }}" `
+          -version "${{ steps.version.outputs.VERSION }}" `
+          -channel stable `
+          -x64Path "${{ steps.release.outputs.X64_OUTPUT_PATH }}" `
+          -arm64Path "${{ steps.release.outputs.ARM64_OUTPUT_PATH }}" `
+          -keyPath $keyPath `
+          -inputAppCastPath $oldAppCastPath `
+          -outputAppCastPath $newAppCastPath `
+          -outputAppCastSignaturePath $newAppCastSignaturePath
+        if ($LASTEXITCODE -ne 0) { throw "Failed to generate new appcast" }
+
+        # Upload the new appcast and signature to GCS.
+        & gsutil -h "Cache-Control:no-cache,max-age=0" cp $newAppCastPath $env:APPCAST_GCS_URI
+        if ($LASTEXITCODE -ne 0) { throw "Failed to upload new appcast" }
+        & gsutil -h "Cache-Control:no-cache,max-age=0" cp $newAppCastSignaturePath $env:APPCAST_SIGNATURE_GCS_URI
+        if ($LASTEXITCODE -ne 0) { throw "Failed to upload new appcast signature" }
+      env:
+        APPCAST_GCS_URI: gs://releases.coder.com/coder-desktop/windows/appcast.xml
+        APPCAST_SIGNATURE_GCS_URI: gs://releases.coder.com/coder-desktop/windows/appcast.xml.signature
+        APPCAST_SIGNATURE_KEY_BASE64: ${{ secrets.APPCAST_SIGNATURE_KEY_BASE64 }}
+        GCLOUD_ACCESS_TOKEN: ${{ steps.gcloud_auth.outputs.access_token }}
+
   winget:
     runs-on: depot-windows-latest
     needs: release
@@ -177,7 +226,6 @@ jobs:
           # to GitHub and then making a PR in a different repo.
           WINGET_GH_TOKEN: ${{ secrets.CDRCI_GITHUB_TOKEN }}
 
-
       - name: Comment on PR
         run: |
           # wait 30 seconds

.gitignore

@@ -411,3 +411,12 @@ publish
 *.wixmdb
 *.wixprj
 *.wixproj
+
+appcast.xml
+appcast.xml.signature
+*.key
+*.key.*
+*.pem
+*.pem.*
+*.pub
+*.pub.*

App/App.csproj

@@ -19,6 +19,10 @@
         <DefineConstants>DISABLE_XAML_GENERATED_MAIN;DISABLE_XAML_GENERATED_BREAK_ON_UNHANDLED_EXCEPTION</DefineConstants>
 
         <AssemblyName>Coder Desktop</AssemblyName>
+        <AssemblyTitle>Coder Desktop</AssemblyTitle>
+        <Company>Coder Technologies Inc.</Company>
+        <Product>Coder Desktop</Product>
+        <Copyright>© Coder Technologies Inc.</Copyright>
         <ApplicationIcon>coder.ico</ApplicationIcon>
     </PropertyGroup>
 
@@ -31,9 +35,7 @@
 
     <ItemGroup>
         <Content Include="coder.ico" />
-    </ItemGroup>
-
-    <ItemGroup>
+        <EmbeddedResource Include="Assets\changelog.css" />
         <Manifest Include="$(ApplicationManifest)" />
     </ItemGroup>
 
@@ -67,12 +69,17 @@
         <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="NetSparkleUpdater.SparkleUpdater" Version="3.0.2" />
         <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>
 
+    <ItemGroup Condition="'$(Configuration)' == 'Debug'">
+        <PackageReference Include="Serilog.Sinks.Debug" Version="3.0.0" />
+    </ItemGroup>
+
     <ItemGroup>
         <ProjectReference Include="..\CoderSdk\CoderSdk.csproj" />
         <ProjectReference Include="..\MutagenSdk\MutagenSdk.csproj" />

App/App.xaml.cs

@@ -21,28 +21,38 @@
 using Microsoft.Win32;
 using Microsoft.Windows.AppLifecycle;
 using Microsoft.Windows.AppNotifications;
+using NetSparkleUpdater.Interfaces;
 using Serilog;
 using LaunchActivatedEventArgs = Microsoft.UI.Xaml.LaunchActivatedEventArgs;
 
 namespace Coder.Desktop.App;
 
 public partial class App : Application
 {
-    private readonly IServiceProvider _services;
-
-    private bool _handleWindowClosed = true;
     private const string MutagenControllerConfigSection = "MutagenController";
+    private const string UpdaterConfigSection = "Updater";
 
 #if !DEBUG
     private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\App";
-    private const string logFilename = "app.log";
+    private const string LogFilename = "app.log";
+    private const string DefaultLogLevel = "Information";
 #else
     private const string ConfigSubKey = @"SOFTWARE\Coder Desktop\DebugApp";
-    private const string logFilename = "debug-app.log";
+    private const string LogFilename = "debug-app.log";
+    private const string DefaultLogLevel = "Debug";
 #endif
 
+    // HACK: This is exposed for dispatcher queue access. The notifier uses
+    //       this to ensure action callbacks run in the UI thread (as
+    //       activation events aren't in the main thread).
+    public TrayWindow? TrayWindow;
+
+    private readonly IServiceProvider _services;
     private readonly ILogger<App> _logger;
     private readonly IUriHandler _uriHandler;
+    private readonly IUserNotifier _userNotifier;
+
+    private bool _handleWindowClosed = true;
 
     public App()
     {
@@ -55,7 +65,17 @@ public App()
         configBuilder.Add(
             new RegistryConfigurationSource(Registry.LocalMachine, ConfigSubKey));
         configBuilder.Add(
-            new RegistryConfigurationSource(Registry.CurrentUser, ConfigSubKey));
+            new RegistryConfigurationSource(
+                Registry.CurrentUser,
+                ConfigSubKey,
+                // Block "Updater:" configuration from HKCU, so that updater
+                // settings can only be set at the HKLM level.
+                //
+                // HACK: This isn't super robust, but the security risk is
+                //       minor anyway. Malicious apps running as the user could
+                //       likely override this setting by altering the memory of
+                //       this app.
+                UpdaterConfigSection + ":"));
 
         var services = builder.Services;
 
@@ -81,6 +101,12 @@ public App()
         services.AddSingleton<IRdpConnector, RdpConnector>();
         services.AddSingleton<IUriHandler, UriHandler>();
 
+        services.AddOptions<UpdaterConfig>()
+            .Bind(builder.Configuration.GetSection(UpdaterConfigSection));
+        services.AddSingleton<IUpdaterUpdateAvailableViewModelFactory, UpdaterUpdateAvailableViewModelFactory>();
+        services.AddSingleton<IUIFactory, CoderSparkleUIFactory>();
+        services.AddSingleton<IUpdateController, SparkleUpdateController>();
+
         // SignInWindow views and view models
         services.AddTransient<SignInViewModel>();
         services.AddTransient<SignInWindow>();
@@ -107,8 +133,9 @@ public App()
         services.AddTransient<TrayWindow>();
 
         _services = services.BuildServiceProvider();
-        _logger = (ILogger<App>)_services.GetService(typeof(ILogger<App>))!;
-        _uriHandler = (IUriHandler)_services.GetService(typeof(IUriHandler))!;
+        _logger = _services.GetRequiredService<ILogger<App>>();
+        _uriHandler = _services.GetRequiredService<IUriHandler>();
+        _userNotifier = _services.GetRequiredService<IUserNotifier>();
 
         InitializeComponent();
     }
@@ -129,6 +156,18 @@ public async Task ExitApplication()
     protected override void OnLaunched(LaunchActivatedEventArgs args)
     {
         _logger.LogInformation("new instance launched");
+
+        // Prevent the TrayWindow from closing, just hide it.
+        if (TrayWindow != null)
+            throw new InvalidOperationException("OnLaunched was called multiple times? TrayWindow is already set");
+        TrayWindow = _services.GetRequiredService<TrayWindow>();
+        TrayWindow.Closed += (_, closedArgs) =>
+        {
+            if (!_handleWindowClosed) return;
+            closedArgs.Handled = true;
+            TrayWindow.AppWindow.Hide();
+        };
+
         // Start connecting to the manager in the background.
         var rpcController = _services.GetRequiredService<IRpcController>();
         if (rpcController.GetState().RpcLifecycle == RpcLifecycle.Disconnected)
@@ -166,7 +205,6 @@ protected override void OnLaunched(LaunchActivatedEventArgs args)
 
         // Initialize file sync.
         // We're adding a 5s delay here to avoid race conditions when loading the mutagen binary.
-
         _ = Task.Delay(5000).ContinueWith((_) =>
         {
             var syncSessionCts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
@@ -181,15 +219,6 @@ protected override void OnLaunched(LaunchActivatedEventArgs args)
                     syncSessionCts.Dispose();
                 }, CancellationToken.None);
         });
-
-        // Prevent the TrayWindow from closing, just hide it.
-        var trayWindow = _services.GetRequiredService<TrayWindow>();
-        trayWindow.Closed += (_, closedArgs) =>
-        {
-            if (!_handleWindowClosed) return;
-            closedArgs.Handled = true;
-            trayWindow.AppWindow.Hide();
-        };
     }
 
     public void OnActivated(object? sender, AppActivationArguments args)
@@ -231,27 +260,36 @@ public void OnActivated(object? sender, AppActivationArguments args)
 
     public void HandleNotification(AppNotificationManager? sender, AppNotificationActivatedEventArgs args)
     {
-        // right now, we don't do anything other than log
-        _logger.LogInformation("handled notification activation");
+        _logger.LogInformation("handled notification activation: {Argument}", args.Argument);
+        _userNotifier.HandleActivation(args);
     }
 
     private static void AddDefaultConfig(IConfigurationBuilder builder)
     {
         var logPath = Path.Combine(
             Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
             "CoderDesktop",
-            logFilename);
+            LogFilename);
         builder.AddInMemoryCollection(new Dictionary<string, string?>
         {
             [MutagenControllerConfigSection + ":MutagenExecutablePath"] = @"C:\mutagen.exe",
+
             ["Serilog:Using:0"] = "Serilog.Sinks.File",
-            ["Serilog:MinimumLevel"] = "Information",
+            ["Serilog:MinimumLevel"] = DefaultLogLevel,
             ["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",
+
+#if DEBUG
+            ["Serilog:Using:1"] = "Serilog.Sinks.Debug",
+            ["Serilog:Enrich:1"] = "FromLogContext",
+            ["Serilog:WriteTo:1:Name"] = "Debug",
+            ["Serilog:WriteTo:1:Args:outputTemplate"] =
+                "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext} - {Message:lj}{NewLine}{Exception}",
+#endif
         });
     }
 }