mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-06-30 23:49:42 +02:00
Compare commits
4 Commits
copilot/fi
...
copilot/fi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bdab7d8da7 | ||
|
|
5a4567b771 | ||
|
|
92517fec25 | ||
|
|
6851997a5b |
@@ -52,6 +52,15 @@ public partial class AliasManager : ObservableObject
|
||||
WeakReferenceMessenger.Default.Send<PerformCommandMessage>(topLevelCommand.GetPerformCommandMessage());
|
||||
return true;
|
||||
}
|
||||
else if (_topLevelCommandManager.HasFinishedLoadingCommands)
|
||||
{
|
||||
// The command no longer exists (e.g. extension uninstalled or command renamed).
|
||||
// Only remove the orphaned alias once extension loading has fully settled,
|
||||
// otherwise valid aliases can be deleted while commands are still arriving.
|
||||
_settingsService.UpdateSettings(
|
||||
s => s with { Aliases = s.Aliases.Remove(searchText) },
|
||||
hotReload: false);
|
||||
}
|
||||
}
|
||||
catch
|
||||
{
|
||||
@@ -109,6 +118,8 @@ public partial class AliasManager : ObservableObject
|
||||
}
|
||||
|
||||
var keysToRemove = new List<string>();
|
||||
var commandsToDisassociate = new List<string>();
|
||||
|
||||
foreach (var kv in aliases)
|
||||
{
|
||||
// Look for the old aliases for the command, and remove it
|
||||
@@ -121,26 +132,32 @@ public partial class AliasManager : ObservableObject
|
||||
if (newAlias is not null && kv.Value.Alias == newAlias.Alias && kv.Value.CommandId != commandId)
|
||||
{
|
||||
keysToRemove.Add(kv.Key);
|
||||
|
||||
// Remove alias from other TopLevelViewModels it may be assigned to
|
||||
var topLevelCommand = _topLevelCommandManager.LookupCommand(kv.Value.CommandId);
|
||||
if (topLevelCommand is not null)
|
||||
{
|
||||
topLevelCommand.AliasText = string.Empty;
|
||||
}
|
||||
commandsToDisassociate.Add(kv.Value.CommandId);
|
||||
}
|
||||
}
|
||||
|
||||
// Update settings atomically before touching any ViewModels.
|
||||
_settingsService.UpdateSettings(s =>
|
||||
{
|
||||
var updatedAliases = s.Aliases.RemoveRange(keysToRemove);
|
||||
|
||||
if (newAlias is not null)
|
||||
{
|
||||
updatedAliases = updatedAliases.Add(newAlias.SearchPrefix, newAlias);
|
||||
// Use SetItem instead of Add to be resilient to any data inconsistencies
|
||||
// (e.g. orphaned aliases whose key matches the new alias's SearchPrefix).
|
||||
updatedAliases = updatedAliases.SetItem(newAlias.SearchPrefix, newAlias);
|
||||
}
|
||||
|
||||
return s with { Aliases = updatedAliases };
|
||||
});
|
||||
|
||||
// After the settings update is complete, notify conflicting ViewModels to clear
|
||||
// their alias text. Doing this after UpdateSettings avoids reentrant calls back
|
||||
// into UpdateAlias (and Save) via the AliasText setter.
|
||||
foreach (var conflictingCommandId in commandsToDisassociate)
|
||||
{
|
||||
var topLevelCommand = _topLevelCommandManager.LookupCommand(conflictingCommandId);
|
||||
topLevelCommand?.ClearAlias();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -47,6 +47,7 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
private readonly SupersedingAsyncGate _reloadCommandsGate;
|
||||
private CancellationTokenSource _extensionLoadCts = new();
|
||||
private CancellationToken _currentExtensionLoadCancellationToken;
|
||||
private int _pendingBackgroundExtensionLoads;
|
||||
|
||||
public TopLevelCommandManager(IServiceProvider serviceProvider, ICommandProviderCache commandProviderCache)
|
||||
{
|
||||
@@ -68,6 +69,8 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
[ObservableProperty]
|
||||
public partial bool IsLoading { get; private set; } = true;
|
||||
|
||||
public bool HasFinishedLoadingCommands => !IsLoading && Volatile.Read(ref _pendingBackgroundExtensionLoads) == 0;
|
||||
|
||||
public IEnumerable<CommandProviderWrapper> CommandProviders
|
||||
{
|
||||
get
|
||||
@@ -275,6 +278,7 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
_extensionLoadCts.Dispose();
|
||||
_extensionLoadCts = new();
|
||||
_currentExtensionLoadCancellationToken = _extensionLoadCts.Token;
|
||||
Interlocked.Exchange(ref _pendingBackgroundExtensionLoads, 0);
|
||||
|
||||
var extensionService = _serviceProvider.GetService<IExtensionService>()!;
|
||||
await extensionService.SignalStopExtensionsAsync().ConfigureAwait(false);
|
||||
@@ -361,6 +365,7 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
}
|
||||
else if (r.IsTimedOut)
|
||||
{
|
||||
TrackBackgroundExtensionLoad(ct);
|
||||
_ = StartExtensionWhenReadyAsync(r.Extension, r.PendingStartTask, r.Stopwatch, ct);
|
||||
}
|
||||
}
|
||||
@@ -440,6 +445,7 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
// It's weird to repeat the condition here, but it allows the compiler to track nullability of other properties
|
||||
if (r.IsTimedOut)
|
||||
{
|
||||
TrackBackgroundExtensionLoad(ct);
|
||||
_ = AppendCommandsWhenReadyAsync(r.Wrapper, r.PendingLoadTask, r.Stopwatch, ct);
|
||||
}
|
||||
}
|
||||
@@ -499,6 +505,10 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
{
|
||||
Logger.LogError($"Background start/load of extension {extension.PackageFullName} failed after {sw.ElapsedMilliseconds} ms: {ex}");
|
||||
}
|
||||
finally
|
||||
{
|
||||
CompleteBackgroundExtensionLoad(ct);
|
||||
}
|
||||
}
|
||||
|
||||
private async Task<CommandLoadResult> TryLoadCommandsAsync(CommandProviderWrapper wrapper, CancellationToken ct)
|
||||
@@ -574,6 +584,26 @@ public sealed partial class TopLevelCommandManager : ObservableObject,
|
||||
{
|
||||
Logger.LogError($"Background loading of commands and bands from {wrapper.ExtensionHost?.Extension?.PackageFullName} failed after {sw.ElapsedMilliseconds} ms: {ex}");
|
||||
}
|
||||
finally
|
||||
{
|
||||
CompleteBackgroundExtensionLoad(ct);
|
||||
}
|
||||
}
|
||||
|
||||
private void TrackBackgroundExtensionLoad(CancellationToken ct)
|
||||
{
|
||||
if (ct == _currentExtensionLoadCancellationToken)
|
||||
{
|
||||
Interlocked.Increment(ref _pendingBackgroundExtensionLoads);
|
||||
}
|
||||
}
|
||||
|
||||
private void CompleteBackgroundExtensionLoad(CancellationToken ct)
|
||||
{
|
||||
if (ct == _currentExtensionLoadCancellationToken)
|
||||
{
|
||||
Interlocked.Decrement(ref _pendingBackgroundExtensionLoads);
|
||||
}
|
||||
}
|
||||
|
||||
private void ExtensionService_OnExtensionRemoved(IExtensionService sender, IEnumerable<IExtensionWrapper> extensions)
|
||||
|
||||
@@ -331,6 +331,22 @@ public sealed partial class TopLevelViewModel : ObservableObject, IListItem, IEx
|
||||
UpdateTags();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Clears the alias for this command without triggering a recursive save back to settings.
|
||||
/// Called by <see cref="AliasManager"/> after it has already updated settings atomically,
|
||||
/// to avoid reentrant calls into <see cref="AliasManager.UpdateAlias"/> via the <see cref="AliasText"/> setter.
|
||||
/// </summary>
|
||||
internal void ClearAlias()
|
||||
{
|
||||
if (Alias is not null)
|
||||
{
|
||||
Alias = null;
|
||||
OnPropertyChanged(nameof(AliasText));
|
||||
OnPropertyChanged(nameof(IsDirectAlias));
|
||||
UpdateTags();
|
||||
}
|
||||
}
|
||||
|
||||
private void FetchAliasFromAliasManager()
|
||||
{
|
||||
var am = _serviceProvider.GetService<AliasManager>();
|
||||
|
||||
@@ -0,0 +1,148 @@
|
||||
// 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;
|
||||
using System.Collections.Immutable;
|
||||
using System.Reflection;
|
||||
using System.Threading.Tasks;
|
||||
using CommunityToolkit.Mvvm.Messaging;
|
||||
using Microsoft.CmdPal.UI.ViewModels.Services;
|
||||
using Microsoft.VisualStudio.TestTools.UnitTesting;
|
||||
using Moq;
|
||||
|
||||
namespace Microsoft.CmdPal.UI.ViewModels.UnitTests;
|
||||
|
||||
[TestClass]
|
||||
public class AliasManagerTests
|
||||
{
|
||||
[TestMethod]
|
||||
public void CheckAlias_DoesNotRemoveAliasWhileInitialLoadIsStillRunning()
|
||||
{
|
||||
var manager = CreateTopLevelCommandManager();
|
||||
try
|
||||
{
|
||||
SetIsLoading(manager, true);
|
||||
SetPendingBackgroundExtensionLoads(manager, 0);
|
||||
|
||||
var alias = new CommandAlias("test", "test.command", true);
|
||||
var settingsService = CreateSettingsService(alias, out var state);
|
||||
var aliasManager = new AliasManager(manager, settingsService.Object);
|
||||
|
||||
var handled = aliasManager.CheckAlias(alias.SearchPrefix);
|
||||
|
||||
Assert.IsFalse(handled);
|
||||
Assert.IsTrue(state.Current.Aliases.ContainsKey(alias.SearchPrefix));
|
||||
settingsService.Verify(s => s.UpdateSettings(It.IsAny<Func<SettingsModel, SettingsModel>>(), false), Times.Never);
|
||||
}
|
||||
finally
|
||||
{
|
||||
Cleanup(manager);
|
||||
}
|
||||
}
|
||||
|
||||
[TestMethod]
|
||||
public void CheckAlias_DoesNotRemoveAliasWhileBackgroundExtensionLoadsArePending()
|
||||
{
|
||||
var manager = CreateTopLevelCommandManager();
|
||||
try
|
||||
{
|
||||
SetIsLoading(manager, false);
|
||||
SetPendingBackgroundExtensionLoads(manager, 1);
|
||||
|
||||
var alias = new CommandAlias("test", "test.command", true);
|
||||
var settingsService = CreateSettingsService(alias, out var state);
|
||||
var aliasManager = new AliasManager(manager, settingsService.Object);
|
||||
|
||||
var handled = aliasManager.CheckAlias(alias.SearchPrefix);
|
||||
|
||||
Assert.IsFalse(handled);
|
||||
Assert.IsTrue(state.Current.Aliases.ContainsKey(alias.SearchPrefix));
|
||||
settingsService.Verify(s => s.UpdateSettings(It.IsAny<Func<SettingsModel, SettingsModel>>(), false), Times.Never);
|
||||
}
|
||||
finally
|
||||
{
|
||||
Cleanup(manager);
|
||||
}
|
||||
}
|
||||
|
||||
[TestMethod]
|
||||
public void CheckAlias_RemovesAliasAfterAllCommandsFinishLoading()
|
||||
{
|
||||
var manager = CreateTopLevelCommandManager();
|
||||
try
|
||||
{
|
||||
SetIsLoading(manager, false);
|
||||
SetPendingBackgroundExtensionLoads(manager, 0);
|
||||
|
||||
var alias = new CommandAlias("test", "test.command", true);
|
||||
var settingsService = CreateSettingsService(alias, out var state);
|
||||
var aliasManager = new AliasManager(manager, settingsService.Object);
|
||||
|
||||
var handled = aliasManager.CheckAlias(alias.SearchPrefix);
|
||||
|
||||
Assert.IsFalse(handled);
|
||||
Assert.IsFalse(state.Current.Aliases.ContainsKey(alias.SearchPrefix));
|
||||
settingsService.Verify(s => s.UpdateSettings(It.IsAny<Func<SettingsModel, SettingsModel>>(), false), Times.Once);
|
||||
}
|
||||
finally
|
||||
{
|
||||
Cleanup(manager);
|
||||
}
|
||||
}
|
||||
|
||||
private static TopLevelCommandManager CreateTopLevelCommandManager()
|
||||
{
|
||||
var serviceProvider = new Mock<IServiceProvider>();
|
||||
serviceProvider.Setup(p => p.GetService(typeof(TaskScheduler))).Returns(TaskScheduler.Default);
|
||||
|
||||
var commandProviderCache = new Mock<ICommandProviderCache>();
|
||||
return new TopLevelCommandManager(serviceProvider.Object, commandProviderCache.Object);
|
||||
}
|
||||
|
||||
private static Mock<ISettingsService> CreateSettingsService(CommandAlias alias, out SettingsState state)
|
||||
{
|
||||
state = new SettingsState
|
||||
{
|
||||
Current = new SettingsModel
|
||||
{
|
||||
Aliases = ImmutableDictionary<string, CommandAlias>.Empty.Add(alias.SearchPrefix, alias),
|
||||
},
|
||||
};
|
||||
|
||||
var settingsService = new Mock<ISettingsService>();
|
||||
var settingsState = state;
|
||||
settingsService.SetupGet(s => s.Settings).Returns(() => settingsState.Current);
|
||||
settingsService
|
||||
.Setup(s => s.UpdateSettings(It.IsAny<Func<SettingsModel, SettingsModel>>(), It.IsAny<bool>()))
|
||||
.Callback((Func<SettingsModel, SettingsModel> transform, bool _) => settingsState.Current = transform(settingsState.Current));
|
||||
|
||||
return settingsService;
|
||||
}
|
||||
|
||||
private sealed class SettingsState
|
||||
{
|
||||
public SettingsModel Current { get; set; } = new();
|
||||
}
|
||||
|
||||
private static void SetIsLoading(TopLevelCommandManager manager, bool isLoading)
|
||||
{
|
||||
var setter = typeof(TopLevelCommandManager)
|
||||
.GetProperty(nameof(TopLevelCommandManager.IsLoading))!
|
||||
.GetSetMethod(nonPublic: true)!;
|
||||
setter.Invoke(manager, [isLoading]);
|
||||
}
|
||||
|
||||
private static void SetPendingBackgroundExtensionLoads(TopLevelCommandManager manager, int count)
|
||||
{
|
||||
typeof(TopLevelCommandManager)
|
||||
.GetField("_pendingBackgroundExtensionLoads", BindingFlags.Instance | BindingFlags.NonPublic)!
|
||||
.SetValue(manager, count);
|
||||
}
|
||||
|
||||
private static void Cleanup(TopLevelCommandManager manager)
|
||||
{
|
||||
WeakReferenceMessenger.Default.UnregisterAll(manager);
|
||||
manager.Dispose();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user