fix: setting persistence across clickonce upgrades

Author: woutervanranst

src/Arius.Explorer.Tests/Settings/ApplicationSettingsTests.cs

@@ -0,0 +1,39 @@
+using Arius.Explorer.Settings;
+using Shouldly;
+
+namespace Arius.Explorer.Tests.Settings;
+
+public class ApplicationSettingsTests
+{
+    [Fact]
+    public void UpgradeRequired_DefaultValue_ShouldBeTrue()
+    {
+        // Arrange & Act
+        var settings = ApplicationSettings.Default;
+
+        // Assert
+        // On first run, UpgradeRequired should default to true
+        // After Upgrade() is called and saved, it becomes false
+        settings.UpgradeRequired.ShouldBe(true);
+    }
+
+    [Fact]
+    public void RecentRepositories_DefaultValue_ShouldBeEmpty()
+    {
+        // Arrange & Act
+        var settings = ApplicationSettings.Default;
+
+        // Assert
+        settings.RecentRepositories.ShouldNotBeNull();
+    }
+
+    [Fact]
+    public void RecentLimit_DefaultValue_ShouldBe10()
+    {
+        // Arrange & Act
+        var settings = ApplicationSettings.Default;
+
+        // Assert
+        settings.RecentLimit.ShouldBe(10);
+    }
+}

src/Arius.Explorer/App.xaml.cs

@@ -27,6 +27,23 @@ protected override void OnStartup(StartupEventArgs e)
             var logger = ServiceProvider.GetRequiredService<ILogger<App>>();
             logger.LogInformation("Application starting up");
 
+            // Upgrade settings from previous ClickOnce version if needed
+            try
+            {
+                if (Settings.ApplicationSettings.Default.UpgradeRequired)
+                {
+                    logger.LogInformation("Upgrading application settings from previous version");
+                    Settings.ApplicationSettings.Default.Upgrade();
+                    Settings.ApplicationSettings.Default.UpgradeRequired = false;
+                    Settings.ApplicationSettings.Default.Save();
+                    logger.LogInformation("Settings upgraded successfully");
+                }
+            }
+            catch (Exception ex)
+            {
+                logger.LogWarning(ex, "Settings upgrade failed, continuing with default settings");
+            }
+
             // Get the repository explorer window from DI
             var repositoryWindow = ServiceProvider.GetRequiredService<RepositoryExplorer.RepositoryExplorerWindow>();
             MainWindow = repositoryWindow;

src/Arius.Explorer/Arius.Explorer.csproj

@@ -18,6 +18,10 @@
 		<!--<PackageId>Arius.Explorer</PackageId>-->
                 <Product>Arius Explorer</Product>
                 <EnableDefaultApplicationDefinition>false</EnableDefaultApplicationDefinition>
+
+		<!-- Strong name signing for ClickOnce settings persistence -->
+		<SignAssembly>true</SignAssembly>
+		<AssemblyOriginatorKeyFile>Arius.Explorer.snk</AssemblyOriginatorKeyFile>
         </PropertyGroup>
 
         <!--

src/Arius.Explorer/Arius.Explorer.snk

@@ -14,8 +14,6 @@ public class ApplicationSettings : ApplicationSettingsBase, IApplicationSettings
 {
     private static ApplicationSettings? defaultInstance;
 
-    private bool upgradeChecked;
-
     public static ApplicationSettings Default
     {
         get
@@ -28,34 +26,6 @@ public static ApplicationSettings Default
         }
     }
 
-    public ApplicationSettings()
-    {
-        EnsureUpgraded();
-    }
-
-    private void EnsureUpgraded()
-    {
-        if (upgradeChecked)
-        {
-            return;
-        }
-
-        upgradeChecked = true;
-
-        var currentVersion = typeof(ApplicationSettings)
-            .Assembly
-            .GetName()
-            .Version?
-            .ToString() ?? string.Empty;
-
-        if (!string.Equals(LastUpgradedVersion, currentVersion, StringComparison.Ordinal))
-        {
-            Upgrade();
-            LastUpgradedVersion = currentVersion;
-            Save();
-        }
-    }
-
     [UserScopedSetting]
     [SettingsSerializeAs(SettingsSerializeAs.Xml)]
     public ObservableCollection<RepositoryOptions> RecentRepositories
@@ -74,11 +44,11 @@ public int RecentLimit
     }
 
     [UserScopedSetting]
-    [DefaultSettingValue("")]
-    public string LastUpgradedVersion
+    [DefaultSettingValue("True")]
+    public bool UpgradeRequired
     {
-        get => (string)(this[nameof(LastUpgradedVersion)] ?? string.Empty);
-        set => this[nameof(LastUpgradedVersion)] = value;
+        get => (bool)(this[nameof(UpgradeRequired)] ?? true);
+        set => this[nameof(UpgradeRequired)] = value;
     }
 }