Unify debug views of immutable dictionaries#100745

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.

Sign up for GitHub

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
eiriktsarpalis merged 3 commits into from
Jul 5, 2024
Merged

Unify debug views of immutable dictionaries #100745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5617c57
Unify debug views of immutable dictionaries
arturek Apr 7, 2024
a3aa221
Fixed tests of debugger attributes with immutable and concurrent gene…
arturek Apr 14, 2024
ee89a5e
Fix ns2.0 build.
eiriktsarpalis Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 57 additions & 5 deletions src/libraries/Common/tests/System/Collections/DebugView.Tests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
new ("[\"Two\"]", "2"),
}
};
CustomKeyedCollection<string, int> collection = new();
collection.GetKeyForItemHandler = value => (2 * value).ToString();
CustomKeyedCollection<string, int> collection = new();
collection.GetKeyForItemHandler = value => (2 * value).ToString();
collection.InsertItem(0, 1);
collection.InsertItem(1, 3);
yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
new ("[\"6\"]", "3"),
}
};

yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
}

private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
{
yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
new KeyValuePair<string, string>[]
{
new ("[1]", "\"One\""),
new ("[2]", "\"Two\""),
}
};
}

private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
{
var testCases = TestDebuggerAttributes_NonGenericDictionaries()
.Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
return TestDebuggerAttributes_NonGenericDictionaries()
return testCases
.Concat(TestDebuggerAttributes_GenericDictionaries());
#else
// In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
return TestDebuggerAttributes_NonGenericDictionaries();
// In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
return testCases;
#endif
}

Expand Down
1 change: 0 additions & 1 deletion src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down
2 changes: 2 additions & 0 deletions src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
Link="System\Collections\HashHelpers.cs" />
<Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
<Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
</ItemGroup>

<ItemGroup>
Expand Down
11 changes: 8 additions & 3 deletions ...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
}

[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public KeyValuePair<TKey, TValue>[] Items
public DebugViewDictionaryItem<TKey, TValue>[] Items
{
get
{
var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
_dictionary.CopyTo(items, 0);
var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
_dictionary.CopyTo(keyValuePairs, 0);
var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
for (int i = 0; i < items.Length; i++)
{
items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
}
return items;
}
}
Expand Down
21 changes: 0 additions & 21 deletions ...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
Assert.Equal(2, dictionary.Count);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public static void TestDebuggerAttributes()
{
DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
dict.TryAdd("One", 1);
dict.TryAdd("Two", 2);
DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
Assert.Equal(dict, items);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public static void TestDebuggerAttributes_Null()
{
Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
Assert.IsType<ArgumentNullException>(tie.InnerException);
}

[Fact]
public static void TestNullComparer()
{
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

<ItemGroup>
<Compile Include="Properties\InternalsVisibleTo.cs" />

<Compile Include="System\Polyfills.cs" />
<Compile Include="System\Collections\ThrowHelper.cs" />
<Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

<Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
<Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
<Compile Include="System\Collections\Frozen\Constants.cs" />
<Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
<Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down
34 changes: 1 addition & 33 deletions ...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
/// </para>
/// </remarks>
[DebuggerDisplay("Count = {Count}")]
[DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
[DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
{
/// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
}
}
}

/// <summary>
/// A simple view of the immutable collection that the debugger can show to the developer.
/// </summary>
internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
{
/// <summary>
/// The collection to be enumerated.
/// </summary>
private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

/// <summary>
/// The simple view of the collection.
/// </summary>
private KeyValuePair<TKey, TValue>[]? _contents;

/// <summary>
/// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
/// </summary>
/// <param name="map">The collection to display in the debugger</param>
public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
{
Requires.NotNull(map, nameof(map));
_map = map;
}

/// <summary>
/// Gets a simple debugger-viewable collection.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
}
}
28 changes: 25 additions & 3 deletions ...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
/// </summary>
/// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
/// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
/// <remarks>
/// This class should only be used with immutable dictionaries, since it
/// caches the dictionary into an array for display in the debugger.
/// </remarks>
internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
{
/// <summary>
/// The dictionary to show to the debugger.
/// </summary>
private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

/// <summary>
/// The contents of the dictionary, cached into an array.
/// </summary>
private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

/// <summary>
/// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
/// </summary>
/// <param name="dictionary">The enumerable to show in the debugger.</param>
/// <param name="dictionary">The dictionary to show in the debugger.</param>
public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
: base(enumerable: dictionary)
{
Requires.NotNull(dictionary, nameof(dictionary));
_dictionary = dictionary;
}

/// <summary>
/// Gets the contents of the dictionary for display in the debugger.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
}

/// <summary>
Expand Down
33 changes: 1 addition & 32 deletions ...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
/// </para>
/// </remarks>
[DebuggerDisplay("Count = {Count}")]
[DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
[DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
{
/// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
#endregion
}
}
/// <summary>
/// A simple view of the immutable collection that the debugger can show to the developer.
/// </summary>
internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
{
/// <summary>
/// The collection to be enumerated.
/// </summary>
private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

/// <summary>
/// The simple view of the collection.
/// </summary>
private KeyValuePair<TKey, TValue>[]? _contents;

/// <summary>
/// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
/// </summary>
/// <param name="map">The collection to display in the debugger</param>
public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
{
Requires.NotNull(map, nameof(map));
_map = map;
}

/// <summary>
/// Gets a simple debugger-viewable collection.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
}
}
21 changes: 0 additions & 21 deletions src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
Assert.Equal(5, populated.GetValueOrDefault("a", 1));
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public void DebuggerAttributesValid()
{
DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
builder.Add(1, "One");
builder.Add(2, "Two");
DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
Assert.Equal(builder, items);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public static void TestDebuggerAttributes_Null()
{
Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
Assert.IsType<ArgumentNullException>(tie.InnerException);
}

[Fact]
public void ToImmutableDictionary()
{
Expand Down
22 changes: 0 additions & 22 deletions src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
enumerator.Dispose();
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public void DebuggerAttributesValid()
{
DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
Assert.Equal(dict, items);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public static void TestDebuggerAttributes_Null()
{
Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
Assert.IsType<ArgumentNullException>(tie.InnerException);
}

[Fact]
public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
{
Expand Down
21 changes: 0 additions & 21 deletions src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
Assert.Equal(5, populated.GetValueOrDefault("a", 1));
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public void DebuggerAttributesValid()
{
DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
builder.Add(1, "One");
builder.Add(2, "Two");
DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
Assert.Equal(builder, items);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
public static void TestDebuggerAttributes_Null()
{
Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
Assert.IsType<ArgumentNullException>(tie.InnerException);
}

[Fact]
public void ValueRef()
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Unify debug views of immutable dictionaries#100745

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.

 Sign up for GitHub

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

eiriktsarpalis
merged 3 commits into

from

Jul 5, 2024
 Merged


Unify debug views of immutable dictionaries
#100745
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5617c57

Unify debug views of immutable dictionaries


arturek Apr 7, 2024
a3aa221

Fixed tests of debugger attributes with immutable and concurrent gene…


arturek Apr 14, 2024
ee89a5e

Fix ns2.0 build.


eiriktsarpalis Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


62 changes: 57 additions & 5 deletions
src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;
Expand DownExpand Up@@ -47,8 +50,8 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"Two\"]", "2"),
 }
 };
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 CustomKeyedCollection<string, int> collection = new();
 collection.GetKeyForItemHandler = value => (2 * value).ToString();
 collection.InsertItem(0, 1);
 collection.InsertItem(1, 3);
 yield return new object[] { collection,
Expand All@@ -58,6 +61,53 @@ private static IEnumerable<object[]> TestDebuggerAttributes_GenericDictionaries(
 new ("[\"6\"]", "3"),
 }
 };

 yield return new object[] { new ConcurrentDictionary<int, string>(new KeyValuePair<int, string>[] { new(1, "One"), new(2, "Two") }),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_AdditionalGenericDictionaries()
 {
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToFrozenDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 yield return new object[] { new Dictionary<int, string> { { 1, "One" }, { 2, "Two" } }.ToImmutableSortedDictionary().ToBuilder(),
 new KeyValuePair<string, string>[]
 {
 new ("[1]", "\"One\""),
 new ("[2]", "\"Two\""),
 }
 };
 }

 private static IEnumerable<object[]> TestDebuggerAttributes_NonGenericDictionaries()
Expand DownExpand Up@@ -162,12 +212,14 @@ private static IEnumerable<object[]> TestDebuggerAttributes_ListInputs()

 public static IEnumerable<object[]> TestDebuggerAttributes_InputsPresentedAsDictionary()
 {
 var testCases = TestDebuggerAttributes_NonGenericDictionaries()
 .Concat(TestDebuggerAttributes_AdditionalGenericDictionaries());
#if !NETFRAMEWORK
 return TestDebuggerAttributes_NonGenericDictionaries()
 return testCases
 .Concat(TestDebuggerAttributes_GenericDictionaries());
#else
 // In .Net Framework only non-generic dictionaries are displayed in a dictionary format by the debugger.
 return TestDebuggerAttributes_NonGenericDictionaries();
 // In .Net Framework, the generic dictionaries that are part of the framework are displayed in a list format by the debugger.
 return testCases;
#endif
 }

Expand Down

1 change: 0 additions & 1 deletion
src/libraries/Common/tests/System/Diagnostics/DebuggerAttributes.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down

2 changes: 2 additions & 0 deletions
src/libraries/System.Collections.Concurrent/src/System.Collections.Concurrent.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@
 Link="System\Collections\HashHelpers.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs"
 Link="System\Collections\Concurrent\IProducerConsumerCollectionDebugView.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs"
 Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 </ItemGroup>

 <ItemGroup>
Expand Down

11 changes: 8 additions & 3 deletions
...s/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2733,12 +2733,17 @@ public IDictionaryDebugView(IDictionary<TKey, TValue> dictionary)
 }

 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Items
 public DebugViewDictionaryItem<TKey, TValue>[] Items
 {
 get
 {
 var items = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(items, 0);
 var keyValuePairs = new KeyValuePair<TKey, TValue>[_dictionary.Count];
 _dictionary.CopyTo(keyValuePairs, 0);
 var items = new DebugViewDictionaryItem<TKey, TValue>[keyValuePairs.Length];
 for (int i = 0; i < items.Length; i++)
 {
 items[i] = new DebugViewDictionaryItem<TKey, TValue>(keyValuePairs[i]);
 }
 return items;
 }
 }
Expand Down

21 changes: 0 additions & 21 deletions
...ies/System.Collections.Concurrent/tests/ConcurrentDictionary/ConcurrentDictionaryTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -629,27 +629,6 @@ public static void TestConstructor_ConcurrencyLevel(int concurrencyLevel)
 Assert.Equal(2, dictionary.Count);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(new ConcurrentDictionary<string, int>());
 ConcurrentDictionary<string, int> dict = new ConcurrentDictionary<string, int>();
 dict.TryAdd("One", 1);
 dict.TryAdd("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(new ConcurrentDictionary<string, int>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public static void TestNullComparer()
 {
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,11 @@ The System.Collections.Immutable library is built-in as part of the shared frame

 <ItemGroup>
 <Compile Include="Properties\InternalsVisibleTo.cs" />

 <Compile Include="System\Polyfills.cs" />
 <Compile Include="System\Collections\ThrowHelper.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\HashHelpers.cs" Link="System\Collections\HashHelpers.cs" />

 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\DebugViewDictionaryItem.cs" Link="Common\System\Collections\Generic\DebugViewDictionaryItem.cs" />
 <Compile Include="$(CoreLibSharedDir)System\Collections\Generic\IDictionaryDebugView.cs" Link="Common\System\Collections\Generic\IDictionaryDebugView.cs" />
 <Compile Include="System\Collections\Frozen\Constants.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenDictionary.cs" />
 <Compile Include="System\Collections\Frozen\DefaultFrozenSet.cs" />
Expand Down

34 changes: 1 addition & 33 deletions
...m.Collections.Immutable/src/System/Collections/Immutable/ImmutableDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ public sealed partial class ImmutableDictionary<TKey, TValue>
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -709,36 +709,4 @@ private bool Apply(MutationResult result)
 }
 }
 }

 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableDictionaryBuilderDebuggerProxy(ImmutableDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

28 changes: 25 additions & 3 deletions
...ollections.Immutable/src/System/Collections/Immutable/ImmutableEnumerableDebuggerProxy.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,16 +12,38 @@ namespace System.Collections.Immutable
 /// </summary>
 /// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
 /// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> : ImmutableEnumerableDebuggerProxy<KeyValuePair<TKey, TValue>> where TKey : notnull
 /// <remarks>
 /// This class should only be used with immutable dictionaries, since it
 /// caches the dictionary into an array for display in the debugger.
 /// </remarks>
 internal sealed class ImmutableDictionaryDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The dictionary to show to the debugger.
 /// </summary>
 private readonly IReadOnlyDictionary<TKey, TValue> _dictionary;

 /// <summary>
 /// The contents of the dictionary, cached into an array.
 /// </summary>
 private DebugViewDictionaryItem<TKey, TValue>[]? _cachedContents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableDictionaryDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="dictionary">The enumerable to show in the debugger.</param>
 /// <param name="dictionary">The dictionary to show in the debugger.</param>
 public ImmutableDictionaryDebuggerProxy(IReadOnlyDictionary<TKey, TValue> dictionary)
 : base(enumerable: dictionary)
 {
 Requires.NotNull(dictionary, nameof(dictionary));
 _dictionary = dictionary;
 }

 /// <summary>
 /// Gets the contents of the dictionary for display in the debugger.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public DebugViewDictionaryItem<TKey, TValue>[] Contents => _cachedContents
 ??= _dictionary.Select(kv => new DebugViewDictionaryItem<TKey, TValue>(kv)).ToArray(_dictionary.Count);
 }

 /// <summary>
Expand Down

33 changes: 1 addition & 32 deletions
...ections.Immutable/src/System/Collections/Immutable/ImmutableSortedDictionary_2.Builder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public sealed partial class ImmutableSortedDictionary<TKey, TValue> where TKey :
 /// </para>
 /// </remarks>
 [DebuggerDisplay("Count = {Count}")]
 [DebuggerTypeProxy(typeof(ImmutableSortedDictionaryBuilderDebuggerProxy<,>))]
 [DebuggerTypeProxy(typeof(IDictionaryDebugView<,>))]
 public sealed class Builder : IDictionary<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IDictionary
 {
 /// <summary>
Expand DownExpand Up@@ -645,35 +645,4 @@ public ImmutableSortedDictionary<TKey, TValue> ToImmutable()
 #endregion
 }
 }
 /// <summary>
 /// A simple view of the immutable collection that the debugger can show to the developer.
 /// </summary>
 internal sealed class ImmutableSortedDictionaryBuilderDebuggerProxy<TKey, TValue> where TKey : notnull
 {
 /// <summary>
 /// The collection to be enumerated.
 /// </summary>
 private readonly ImmutableSortedDictionary<TKey, TValue>.Builder _map;

 /// <summary>
 /// The simple view of the collection.
 /// </summary>
 private KeyValuePair<TKey, TValue>[]? _contents;

 /// <summary>
 /// Initializes a new instance of the <see cref="ImmutableSortedDictionaryBuilderDebuggerProxy{TKey, TValue}"/> class.
 /// </summary>
 /// <param name="map">The collection to display in the debugger</param>
 public ImmutableSortedDictionaryBuilderDebuggerProxy(ImmutableSortedDictionary<TKey, TValue>.Builder map)
 {
 Requires.NotNull(map, nameof(map));
 _map = map;
 }

 /// <summary>
 /// Gets a simple debugger-viewable collection.
 /// </summary>
 [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
 public KeyValuePair<TKey, TValue>[] Contents => _contents ??= _map.ToArray(_map.Count);
 }
}

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.CreateBuilder<string, int>());
 ImmutableDictionary<int, string>.Builder builder = ImmutableDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ToImmutableDictionary()
 {
Expand Down

22 changes: 0 additions & 22 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableDictionaryTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,28 +349,6 @@ public void EnumeratorRecyclingMisuse()
 enumerator.Dispose();
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableDictionary.Create<int, int>());
 ImmutableDictionary<string, int> dict = ImmutableDictionary.Create<string, int>().Add("One", 1).Add("Two", 2);
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(dict);

 object rootNode = DebuggerAttributes.GetFieldValue(ImmutableDictionary.Create<string, string>(), "_root");
 DebuggerAttributes.ValidateDebuggerDisplayReferences(rootNode);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<string, int>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<string, int>[];
 Assert.Equal(dict, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableHashSet.Create<string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void Clear_NoComparer_ReturnsEmptyWithoutComparer()
 {
Expand Down

21 changes: 0 additions & 21 deletions
src/libraries/System.Collections.Immutable/tests/ImmutableSortedDictionaryBuilderTest.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -255,27 +255,6 @@ public void GetValueOrDefaultOfConcreteType()
 Assert.Equal(5, populated.GetValueOrDefault("a", 1));
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public void DebuggerAttributesValid()
 {
 DebuggerAttributes.ValidateDebuggerDisplayReferences(ImmutableSortedDictionary.CreateBuilder<string, int>());
 ImmutableSortedDictionary<int, string>.Builder builder = ImmutableSortedDictionary.CreateBuilder<int, string>();
 builder.Add(1, "One");
 builder.Add(2, "Two");
 DebuggerAttributeInfo info = DebuggerAttributes.ValidateDebuggerTypeProxyProperties(builder);
 PropertyInfo itemProperty = info.Properties.Single(pr => pr.GetCustomAttribute<DebuggerBrowsableAttribute>().State == DebuggerBrowsableState.RootHidden);
 KeyValuePair<int, string>[] items = itemProperty.GetValue(info.Instance) as KeyValuePair<int, string>[];
 Assert.Equal(builder, items);
 }

 [ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsDebuggerTypeProxyAttributeSupported))]
 public static void TestDebuggerAttributes_Null()
 {
 Type proxyType = DebuggerAttributes.GetProxyType(ImmutableSortedDictionary.CreateBuilder<int, string>());
 TargetInvocationException tie = Assert.Throws<TargetInvocationException>(() => Activator.CreateInstance(proxyType, (object)null));
 Assert.IsType<ArgumentNullException>(tie.InnerException);
 }

 [Fact]
 public void ValueRef()
 {
Expand Down
Loading