mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-06 03:07:04 +02:00
CmdPal: Extract persistence services from SettingsModel and AppStateModel (#46312)
## Summary of the Pull Request Extracts persistence (load/save) logic from `SettingsModel` and `AppStateModel` into dedicated service classes, following the single-responsibility principle. Consumers now interact with `ISettingsService` and `IAppStateService` instead of receiving raw model objects through DI. **New services introduced:** - `IPersistenceService` / `PersistenceService` — generic `Load<T>` / `Save<T>` with AOT-compatible `JsonTypeInfo<T>`, ensures target directory exists before writing - `ISettingsService` / `SettingsService` — loads settings on construction, runs migrations, exposes `Settings` property and `SettingsChanged` event - `IAppStateService` / `AppStateService` — loads state on construction, exposes `State` property and `StateChanged` event **Key changes:** - `SettingsModel` and `AppStateModel` are now pure data models — all file I/O, migration, and directory management removed - Raw `SettingsModel` and `AppStateModel` removed from DI container; consumers receive the appropriate service - `IApplicationInfoService.ConfigDirectory` injected into services for config path resolution (no more hardcoded `Utilities.BaseSettingsPath`) - ~30 consumer files updated across `Microsoft.CmdPal.UI.ViewModels` and `Microsoft.CmdPal.UI` projects - All `#pragma warning disable SA1300` suppressions removed — convenience accessors replaced with direct `_settingsService.Settings` / `_appStateService.State` access - Namespace prefixes (`Services.ISettingsService`) replaced with proper `using` directives ## PR Checklist - [ ] **Communication:** I've discussed this with core contributors already. - [x] **Tests:** Added/updated and all pass - [ ] **Localization:** N/A — no end-user-facing strings changed - [ ] **Dev docs:** N/A — internal refactor, no public API changes - [ ] **New binaries:** N/A — no new binaries introduced ## Detailed Description of the Pull Request / Additional comments ### Architecture Services are registered as singletons in `App.xaml.cs`: ```csharp services.AddSingleton<IPersistenceService, PersistenceService>(); services.AddSingleton<ISettingsService, SettingsService>(); services.AddSingleton<IAppStateService, AppStateService>(); ``` `PersistenceService.Save<T>` writes the serialized model directly to disk, creating the target directory if it doesn't exist. It also does not attempt to merge existing and new settings/state. `SettingsService` runs hotkey migrations on load and raises `SettingsChanged` after saves. `AppStateService` always raises `StateChanged` after saves. ### Files changed (41 files, +1169/−660) | Area | Files | What changed | |------|-------|-------------| | New services | `Services/IPersistenceService.cs`, `PersistenceService.cs`, `ISettingsService.cs`, `SettingsService.cs`, `IAppStateService.cs`, `AppStateService.cs` | New service interfaces and implementations | | Models | `SettingsModel.cs`, `AppStateModel.cs` | Stripped to pure data bags | | DI | `App.xaml.cs` | Service registration, removed raw model DI | | ViewModels | 12 files | Constructor injection of services | | UI | 10 files | Service injection replacing model access | | Settings | `DockSettings.cs` | `Colors.Transparent` replaced with struct literal to avoid WinUI3 COM dependency | | Tests | `PersistenceServiceTests.cs`, `SettingsServiceTests.cs`, `AppStateServiceTests.cs` | 38 unit tests covering all three services | | Config | `.gitignore` | Added `.squad/`, `.github/agents/` exclusions | ## Validation Steps Performed - Built `Microsoft.CmdPal.UI` with MSBuild (x64/Debug) — exit code 0, clean build - Ran 38 unit tests via `vstest.console.exe` — all passing - Verified no remaining `#pragma warning disable SA1300` blocks - Verified no remaining `Services.` namespace prefixes --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Michael Jolley
@@ -0,0 +1,46 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using Microsoft.CmdPal.Common.Services;
|
||||
using Windows.Foundation;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Default implementation of <see cref="IAppStateService"/>.
|
||||
/// Handles loading, saving, and change notification for <see cref="AppStateModel"/>.
|
||||
/// </summary>
|
||||
public sealed class AppStateService : IAppStateService
|
||||
{
|
||||
private readonly IPersistenceService _persistence;
|
||||
private readonly IApplicationInfoService _appInfoService;
|
||||
private readonly string _filePath;
|
||||
|
||||
public AppStateService(IPersistenceService persistence, IApplicationInfoService appInfoService)
|
||||
{
|
||||
_persistence = persistence;
|
||||
_appInfoService = appInfoService;
|
||||
_filePath = StateJsonPath();
|
||||
State = _persistence.Load(_filePath, JsonSerializationContext.Default.AppStateModel);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public AppStateModel State { get; private set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public event TypedEventHandler<IAppStateService, AppStateModel>? StateChanged;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void Save()
|
||||
{
|
||||
_persistence.Save(State, _filePath, JsonSerializationContext.Default.AppStateModel);
|
||||
StateChanged?.Invoke(this, State);
|
||||
}
|
||||
|
||||
private string StateJsonPath()
|
||||
{
|
||||
var directory = _appInfoService.ConfigDirectory;
|
||||
return Path.Combine(directory, "state.json");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using Windows.Foundation;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Manages the lifecycle of <see cref="AppStateModel"/>: load, save, and change notification.
|
||||
/// </summary>
|
||||
public interface IAppStateService
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the current application state instance.
|
||||
/// </summary>
|
||||
AppStateModel State { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Persists the current state to disk and raises <see cref="StateChanged"/>.
|
||||
/// </summary>
|
||||
void Save();
|
||||
|
||||
/// <summary>
|
||||
/// Raised after state has been saved to disk.
|
||||
/// </summary>
|
||||
event TypedEventHandler<IAppStateService, AppStateModel> StateChanged;
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using System.Text.Json.Serialization.Metadata;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Provides AOT-compatible JSON file persistence with shallow-merge strategy.
|
||||
/// </summary>
|
||||
public interface IPersistenceService
|
||||
{
|
||||
/// <summary>
|
||||
/// Loads and deserializes a model from the specified JSON file.
|
||||
/// Returns a new <typeparamref name="T"/> instance when the file is missing or unreadable.
|
||||
/// </summary>
|
||||
T Load<T>(string filePath, JsonTypeInfo<T> typeInfo)
|
||||
where T : new();
|
||||
|
||||
/// <summary>
|
||||
/// Serializes <paramref name="model"/>, shallow-merges into the existing file
|
||||
/// (preserving unknown keys), and writes the result back to disk.
|
||||
/// </summary>
|
||||
/// <param name="model">The model to persist.</param>
|
||||
/// <param name="filePath">Target JSON file path.</param>
|
||||
/// <param name="typeInfo">AOT-compatible type metadata.</param>
|
||||
void Save<T>(T model, string filePath, JsonTypeInfo<T> typeInfo);
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using Windows.Foundation;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Manages the lifecycle of <see cref="SettingsModel"/>: load, save, migration, and change notification.
|
||||
/// </summary>
|
||||
public interface ISettingsService
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the current settings instance.
|
||||
/// </summary>
|
||||
SettingsModel Settings { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Persists the current settings to disk.
|
||||
/// </summary>
|
||||
/// <param name="hotReload">When <see langword="true"/>, raises <see cref="SettingsChanged"/> after saving.</param>
|
||||
void Save(bool hotReload = true);
|
||||
|
||||
/// <summary>
|
||||
/// Raised after settings are saved with <paramref name="hotReload"/> enabled, or after <see cref="Reload"/>.
|
||||
/// </summary>
|
||||
event TypedEventHandler<ISettingsService, SettingsModel> SettingsChanged;
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Nodes;
|
||||
using System.Text.Json.Serialization.Metadata;
|
||||
using ManagedCommon;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Default implementation of <see cref="IPersistenceService"/> that reads/writes
|
||||
/// JSON files with a shallow-merge strategy to preserve unknown keys.
|
||||
/// </summary>
|
||||
public sealed class PersistenceService : IPersistenceService
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public T Load<T>(string filePath, JsonTypeInfo<T> typeInfo)
|
||||
where T : new()
|
||||
{
|
||||
if (!File.Exists(filePath))
|
||||
{
|
||||
Logger.LogDebug("Settings file not found at {FilePath}", filePath);
|
||||
return new T();
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
var jsonContent = File.ReadAllText(filePath);
|
||||
var loaded = JsonSerializer.Deserialize(jsonContent, typeInfo);
|
||||
|
||||
if (loaded is null)
|
||||
{
|
||||
Logger.LogDebug("Failed to parse settings file at {FilePath}", filePath);
|
||||
}
|
||||
else
|
||||
{
|
||||
Logger.LogDebug("Successfully loaded settings file from {FilePath}", filePath);
|
||||
}
|
||||
|
||||
return loaded ?? new T();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Logger.LogError($"Failed to load settings from {filePath}:", ex);
|
||||
}
|
||||
|
||||
return new T();
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void Save<T>(T model, string filePath, JsonTypeInfo<T> typeInfo)
|
||||
{
|
||||
try
|
||||
{
|
||||
var settingsJson = JsonSerializer.Serialize(model, typeInfo);
|
||||
|
||||
if (JsonNode.Parse(settingsJson) is not JsonObject newSettings)
|
||||
{
|
||||
Logger.LogError("Failed to parse serialized model as JsonObject.");
|
||||
return;
|
||||
}
|
||||
|
||||
var directory = Path.GetDirectoryName(filePath);
|
||||
if (!string.IsNullOrEmpty(directory))
|
||||
{
|
||||
Directory.CreateDirectory(directory);
|
||||
}
|
||||
|
||||
var serialized = newSettings.ToJsonString(typeInfo.Options);
|
||||
File.WriteAllText(filePath, serialized);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Logger.LogError($"Failed to save to {filePath}:", ex);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
// Copyright (c) Microsoft Corporation
|
||||
// The Microsoft Corporation licenses this file to you under the MIT license.
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using System.Diagnostics;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Nodes;
|
||||
using System.Text.Json.Serialization.Metadata;
|
||||
using ManagedCommon;
|
||||
using Microsoft.CmdPal.Common.Services;
|
||||
using Windows.Foundation;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Default implementation of <see cref="ISettingsService"/>.
|
||||
/// Handles loading, saving, migration, and change notification for <see cref="SettingsModel"/>.
|
||||
/// </summary>
|
||||
public sealed class SettingsService : ISettingsService
|
||||
{
|
||||
private const string DeprecatedHotkeyGoesHomeKey = "HotkeyGoesHome";
|
||||
|
||||
private readonly IPersistenceService _persistence;
|
||||
private readonly IApplicationInfoService _appInfoService;
|
||||
private readonly string _filePath;
|
||||
|
||||
public SettingsService(IPersistenceService persistence, IApplicationInfoService appInfoService)
|
||||
{
|
||||
_persistence = persistence;
|
||||
_appInfoService = appInfoService;
|
||||
_filePath = SettingsJsonPath();
|
||||
Settings = _persistence.Load(_filePath, JsonSerializationContext.Default.SettingsModel);
|
||||
ApplyMigrations();
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public SettingsModel Settings { get; private set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public event TypedEventHandler<ISettingsService, SettingsModel>? SettingsChanged;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void Save(bool hotReload = true)
|
||||
{
|
||||
_persistence.Save(
|
||||
Settings,
|
||||
_filePath,
|
||||
JsonSerializationContext.Default.SettingsModel);
|
||||
|
||||
if (hotReload)
|
||||
{
|
||||
SettingsChanged?.Invoke(this, Settings);
|
||||
}
|
||||
}
|
||||
|
||||
private string SettingsJsonPath()
|
||||
{
|
||||
var directory = _appInfoService.ConfigDirectory;
|
||||
return Path.Combine(directory, "settings.json");
|
||||
}
|
||||
|
||||
private void ApplyMigrations()
|
||||
{
|
||||
var migratedAny = false;
|
||||
|
||||
try
|
||||
{
|
||||
var jsonContent = File.Exists(_filePath) ? File.ReadAllText(_filePath) : null;
|
||||
if (jsonContent is not null && JsonNode.Parse(jsonContent) is JsonObject root)
|
||||
{
|
||||
migratedAny |= TryMigrate(
|
||||
"Migration #1: HotkeyGoesHome (bool) -> AutoGoHomeInterval (TimeSpan)",
|
||||
root,
|
||||
Settings,
|
||||
nameof(SettingsModel.AutoGoHomeInterval),
|
||||
DeprecatedHotkeyGoesHomeKey,
|
||||
(model, goesHome) => model.AutoGoHomeInterval = goesHome ? TimeSpan.Zero : Timeout.InfiniteTimeSpan,
|
||||
JsonSerializationContext.Default.Boolean);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Debug.WriteLine($"Migration check failed: {ex}");
|
||||
}
|
||||
|
||||
if (migratedAny)
|
||||
{
|
||||
Save(hotReload: false);
|
||||
}
|
||||
}
|
||||
|
||||
private static bool TryMigrate<T>(
|
||||
string migrationName,
|
||||
JsonObject root,
|
||||
SettingsModel model,
|
||||
string newKey,
|
||||
string oldKey,
|
||||
Action<SettingsModel, T> apply,
|
||||
JsonTypeInfo<T> jsonTypeInfo)
|
||||
{
|
||||
try
|
||||
{
|
||||
if (root.ContainsKey(newKey) && root[newKey] is not null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (root.TryGetPropertyValue(oldKey, out var oldNode) && oldNode is not null)
|
||||
{
|
||||
var value = oldNode.Deserialize(jsonTypeInfo);
|
||||
apply(model, value!);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Logger.LogError($"Error during migration {migrationName}.", ex);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user