created Settings class to handle versioning

ibetitsmike · ibetitsmike · commit c21072fa19e5 · 2025-06-03T15:49:34.000+02:00
diff --git a/App/Services/SettingsManager.cs b/App/Services/SettingsManager.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace Coder.Desktop.App.Services;
 
@@ -28,10 +29,10 @@ public interface ISettingsManager
 public sealed class SettingsManager : ISettingsManager
 {
     private readonly string _settingsFilePath;
+    private Settings _settings;
     private readonly string _fileName = "app-settings.json";
     private readonly string _appName = "CoderDesktop";
     private readonly object _lock = new();
-    private Dictionary<string, JsonElement> _cache;
 
     public const string ConnectOnLaunchKey = "ConnectOnLaunch";
     public const string StartOnLoginKey = "StartOnLogin";
@@ -87,9 +88,12 @@ public SettingsManager(string? settingsFilePath = null)
             // Create the settings file if it doesn't exist
             string emptyJson = JsonSerializer.Serialize(new { });
             File.WriteAllText(_settingsFilePath, emptyJson);
+            _settings = new();
+        }
+        else
+        {
+            _settings = Load();
         }
-
-        _cache = Load();
     }
 
     private void Save(string name, bool value)
@@ -105,12 +109,12 @@ private void Save(string name, bool value)
                     FileShare.None);
 
                 // Ensure cache is loaded before saving 
-                var currentCache = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(fs) ?? [];
-                _cache = currentCache;
-                _cache[name] = JsonSerializer.SerializeToElement(value);
+                var freshCache = JsonSerializer.Deserialize<Settings>(fs) ?? new();
+                _settings = freshCache;
+                _settings.Options[name] = JsonSerializer.SerializeToElement(value);
                 fs.Position = 0; // Reset stream position to the beginning before writing
 
-                JsonSerializer.Serialize(fs, _cache, new JsonSerializerOptions { WriteIndented = true });
+                JsonSerializer.Serialize(fs, _settings, new JsonSerializerOptions { WriteIndented = true });
 
                 // This ensures the file is truncated to the new length
                 // if the new content is shorter than the old content
@@ -127,7 +131,7 @@ private bool Read(string name, bool defaultValue)
     {
         lock (_lock)
         {
-            if (_cache.TryGetValue(name, out var element))
+            if (_settings.Options.TryGetValue(name, out var element))
             {
                 try
                 {
@@ -143,16 +147,38 @@ private bool Read(string name, bool defaultValue)
         }
     }
 
-    private Dictionary<string, JsonElement> Load()
+    private Settings Load()
     {
         try
         {
             using var fs = File.OpenRead(_settingsFilePath);
-            return JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(fs) ?? new();
+            return JsonSerializer.Deserialize<Settings>(fs) ?? new(null, new Dictionary<string, JsonElement>());
         }
         catch (Exception ex)
         {
             throw new InvalidOperationException($"Failed to load settings from {_settingsFilePath}. The file may be corrupted or malformed. Exception: {ex.Message}");
         }
     }
+
+    [JsonSerializable(typeof(Settings))]
+    private class Settings
+    {
+        /// <summary>
+        /// User settings version. Increment this when the settings schema changes.
+        /// In future iterations we will be able to handle migrations when the user has
+        /// an older version.
+        /// </summary>
+        public int Version { get; set; } = 1;
+        public Dictionary<string, JsonElement> Options { get; set; }
+        public Settings()
+        {
+            Options = new Dictionary<string, JsonElement>();
+        }
+
+        public Settings(int? version, Dictionary<string, JsonElement> options)
+        {
+            Version = version ?? Version;
+            Options = options;
+        }
+    }
 }
diff --git a/App/Views/Pages/SettingsMainPage.xaml b/App/Views/Pages/SettingsMainPage.xaml
@@ -51,6 +51,7 @@
                                        >
                     <ToggleSwitch IsOn="{x:Bind ViewModel.ConnectOnLaunch, Mode=TwoWay}" />
                 </controls:SettingsCard>
+
             </StackPanel>
         </Grid>
     </ScrollViewer>

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@`
`51`	`51`	`>`
`52`	`52`	`<ToggleSwitch IsOn="{x:Bind ViewModel.ConnectOnLaunch, Mode=TwoWay}" />`
`53`	`53`	`</controls:SettingsCard>`
	`54`	`+`
`54`	`55`	`</StackPanel>`
`55`	`56`	`</Grid>`
`56`	`57`	`</ScrollViewer>`