-
Notifications
You must be signed in to change notification settings - Fork 8.5k
CmdPal: Avoid all-stripe locking in the adaptive icon cache #49737
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Mike Griese (zadjii-msft)
merged 2 commits into
main
from
dev/jpolasek/f/cmdpal-adaptive-cache-reentrancy
Aug 7, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
src/modules/cmdpal/Tests/Microsoft.CmdPal.UI.UnitTests/AdaptiveCacheTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| // 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.Concurrent; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CmdPal.UI.Helpers; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| namespace Microsoft.CmdPal.UI.UnitTests; | ||
|
|
||
| [TestClass] | ||
| public class AdaptiveCacheTests | ||
| { | ||
| [TestMethod] | ||
| public void ApproximateCountChangesOnlyForSuccessfulMutations() | ||
| { | ||
| var cache = new AdaptiveCache<int, int>(capacity: 8); | ||
|
|
||
| cache.Add(1, 1); | ||
| cache.Add(1, 2); | ||
| _ = cache.GetOrAdd(1, static (key, _) => key, 0); | ||
|
|
||
| Assert.AreEqual(1, cache.ApproximateCount); | ||
| Assert.IsFalse(cache.TryRemove(2)); | ||
| Assert.AreEqual(1, cache.ApproximateCount); | ||
| Assert.IsTrue(cache.TryRemove(1)); | ||
| Assert.AreEqual(0, cache.ApproximateCount); | ||
|
|
||
| _ = cache.GetOrAdd(2, static (key, _) => key, 0); | ||
| Assert.AreEqual(1, cache.ApproximateCount); | ||
|
|
||
| cache.Clear(); | ||
| Assert.AreEqual(0, cache.ApproximateCount); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| [Timeout(15_000)] | ||
| public async Task ConcurrentCleanupAndFailedLoadsKeepApproximateCountConsistent() | ||
| { | ||
| const int capacity = 1; | ||
| const int workerCount = 8; | ||
| const int itemsPerWorker = 256; | ||
| var cache = new AdaptiveCache<int, Task<int>>(capacity, TimeSpan.FromHours(1)); | ||
| var faultRemovals = new ConcurrentBag<Task>(); | ||
|
|
||
| cache.Add(-2, Task.FromResult(-2)); | ||
| cache.Add(-1, Task.FromResult(-1)); | ||
|
|
||
| Assert.IsTrue( | ||
| SpinWait.SpinUntil(() => cache.ApproximateCount <= capacity, TimeSpan.FromSeconds(5)), | ||
| "Capacity cleanup did not run."); | ||
|
|
||
| var workers = Enumerable.Range(0, workerCount) | ||
| .Select(worker => Task.Run(() => | ||
| { | ||
| for (var item = 0; item < itemsPerWorker; item++) | ||
| { | ||
| var key = (worker * itemsPerWorker) + item; | ||
|
|
||
| if (item % 4 == 0) | ||
| { | ||
| var completionSource = new TaskCompletionSource<int>(TaskCreationOptions.RunContinuationsAsynchronously); | ||
| cache.Add(key, completionSource.Task); | ||
|
|
||
| faultRemovals.Add(completionSource.Task.ContinueWith( | ||
| completedTask => | ||
| { | ||
| _ = completedTask.Exception; | ||
| cache.TryRemove(key); | ||
| }, | ||
| CancellationToken.None, | ||
| TaskContinuationOptions.OnlyOnFaulted, | ||
| TaskScheduler.Default)); | ||
|
|
||
| completionSource.SetException(new InvalidOperationException("Icon load failed.")); | ||
| } | ||
| else | ||
| { | ||
| _ = cache.GetOrAdd(key, static (currentKey, _) => Task.FromResult(currentKey), 0); | ||
| } | ||
|
|
||
| _ = cache.TryGet(key, out _); | ||
| } | ||
| })) | ||
| .ToArray(); | ||
|
|
||
| await Task.WhenAll(workers); | ||
| await Task.WhenAll(faultRemovals); | ||
|
|
||
| cache.Clear(); | ||
|
|
||
| Assert.AreEqual(0, cache.ApproximateCount); | ||
| for (var key = 0; key < workerCount * itemsPerWorker; key++) | ||
| { | ||
| Assert.IsFalse(cache.TryGet(key, out _), $"Cache still contains key {key} after Clear."); | ||
| } | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
src/modules/cmdpal/Tests/Microsoft.CmdPal.UI.UnitTests/Microsoft.CmdPal.UI.UnitTests.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <!-- Look at Directory.Build.props in root for common stuff as well --> | ||
| <Import Project="$(RepoRoot)src\Common.Dotnet.CsWinRT.props" /> | ||
|
|
||
| <PropertyGroup> | ||
| <IsPackable>false</IsPackable> | ||
| <IsTestProject>true</IsTestProject> | ||
| <RootNamespace>Microsoft.CmdPal.UI.UnitTests</RootNamespace> | ||
| <OutputPath>$(RepoRoot)$(Platform)\$(Configuration)\WinUI3Apps\CmdPal\tests\</OutputPath> | ||
| <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath> | ||
| <AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <LangVersion>preview</LangVersion> | ||
| <Nullable>enable</Nullable> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="MSTest" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\Microsoft.CmdPal.Common\Microsoft.CmdPal.Common.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Compile Include="..\..\Microsoft.CmdPal.UI\Helpers\AdaptiveCache`2.cs" Link="Helpers\AdaptiveCache`2.cs" /> | ||
| </ItemGroup> | ||
| </Project> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.