Improve debug views of dictionaries (#52867)

Author: JamesNK

src/Components/Components/src/Microsoft.AspNetCore.Components.csproj

@@ -19,10 +19,12 @@
     <Compile Include="$(ComponentsSharedSourceRoot)src\HotReloadManager.cs" LinkBase="HotReload" />
     <Compile Include="$(SharedSourceRoot)LinkerFlags.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)QueryStringEnumerable.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)Debugger\DictionaryItemDebugView.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)Debugger\DictionaryDebugView.cs" LinkBase="Shared" />
   </ItemGroup>
 
   <Import Project="Microsoft.AspNetCore.Components.Routing.targets" />
-  
+
   <ItemGroup>
     <Reference Include="Microsoft.Extensions.Logging.Abstractions" />
     <Reference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />

src/Extensions/Features/src/FeatureCollection.cs

@@ -161,6 +161,6 @@ private sealed class FeatureCollectionDebugView(FeatureCollection features)
         private readonly FeatureCollection _features = features;
 
         [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<string, object>[] Items => _features.Select(pair => new KeyValuePair<string, object>(pair.Key.FullName ?? string.Empty, pair.Value)).ToArray();
+        public DictionaryItemDebugView<Type, object>[] Items => _features.Select(pair => new DictionaryItemDebugView<Type, object>(pair)).ToArray();
     }
 }

src/Extensions/Features/src/Microsoft.Extensions.Features.csproj

@@ -19,6 +19,7 @@ Microsoft.AspNetCore.Http.Features.FeatureCollection
     <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentNullThrowHelper.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentOutOfRangeThrowHelper.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)CallerArgument\CallerArgumentExpressionAttribute.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)Debugger\DictionaryItemDebugView.cs" LinkBase="Shared" />
   </ItemGroup>
 
 </Project>

src/Http/Http.Abstractions/src/HttpContext.cs

@@ -108,6 +108,6 @@ private sealed class HttpContextFeatureDebugView(IFeatureCollection features)
         private readonly IFeatureCollection _features = features;
 
         [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<string, object>[] Items => _features.Select(pair => new KeyValuePair<string, object>(pair.Key.FullName ?? string.Empty, pair.Value)).ToArray();
+        public DictionaryItemDebugView<Type, object>[] Items => _features.Select(pair => new DictionaryItemDebugView<Type, object>(pair)).ToArray();
     }
 }

src/Http/Http.Abstractions/src/Microsoft.AspNetCore.Http.Abstractions.csproj

@@ -29,6 +29,8 @@ Microsoft.AspNetCore.Http.HttpResponse</Description>
     <Compile Include="$(SharedSourceRoot)Reroute.cs" />
     <Compile Include="$(SharedSourceRoot)Debugger\HttpContextDebugFormatter.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)Debugger\DebuggerHelpers.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)Debugger\DictionaryItemDebugView.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)Debugger\DictionaryDebugView.cs" LinkBase="Shared" />
   </ItemGroup>
 
   <ItemGroup>

src/Http/Http.Abstractions/src/Routing/RouteValueDictionary.cs

@@ -4,8 +4,9 @@
 using System.Collections;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
-using System.Linq;
 using System.Runtime.CompilerServices;
+using Microsoft.AspNetCore.Shared;
+
 #if !COMPONENTS
 using System.Collections.Concurrent;
 using System.Reflection.Metadata;
@@ -29,7 +30,7 @@ namespace Microsoft.AspNetCore.Routing;
 /// An <see cref="IDictionary{String, Object}"/> type for route values.
 /// </summary>
 #endif
-[DebuggerTypeProxy(typeof(RouteValueDictionaryDebugView))]
+[DebuggerTypeProxy(typeof(DictionaryDebugView<string, object?>))]
 [DebuggerDisplay("Count = {Count}")]
 #if !COMPONENTS
 public class RouteValueDictionary : IDictionary<string, object?>, IReadOnlyDictionary<string, object?>
@@ -929,12 +930,4 @@ internal static void ClearCache(Type[]? _)
         }
     }
 #endif
-
-    private sealed class RouteValueDictionaryDebugView(RouteValueDictionary dictionary)
-    {
-        private readonly RouteValueDictionary _dictionary = dictionary;
-
-        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<string, object?>[] Items => _dictionary.ToArray();
-    }
 }

src/Http/Http/src/FormCollection.cs

@@ -2,13 +2,17 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using System.Diagnostics;
+using Microsoft.AspNetCore.Shared;
 using Microsoft.Extensions.Primitives;
 
 namespace Microsoft.AspNetCore.Http;
 
 /// <summary>
 /// Contains the parsed HTTP form values.
 /// </summary>
+[DebuggerDisplay("Count = {Count}")]
+[DebuggerTypeProxy(typeof(StringValuesDictionaryDebugView))]
 public class FormCollection : IFormCollection
 {
     /// <summary>

src/Http/Http/src/HeaderDictionary.cs

@@ -4,7 +4,7 @@
 using System.Collections;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
-using System.Linq;
+using Microsoft.AspNetCore.Shared;
 using Microsoft.Extensions.Primitives;
 using Microsoft.Net.Http.Headers;
 
@@ -13,8 +13,8 @@ namespace Microsoft.AspNetCore.Http;
 /// <summary>
 /// Represents a wrapper for RequestHeaders and ResponseHeaders.
 /// </summary>
-[DebuggerTypeProxy(typeof(HeaderDictionaryDebugView))]
 [DebuggerDisplay("{DebuggerToString(),nq}")]
+[DebuggerTypeProxy(typeof(StringValuesDictionaryDebugView))]
 public class HeaderDictionary : IHeaderDictionary
 {
     private static readonly string[] EmptyKeys = Array.Empty<string>();
@@ -455,12 +455,4 @@ void IEnumerator.Reset()
             }
         }
     }
-
-    private sealed class HeaderDictionaryDebugView(HeaderDictionary dictionary)
-    {
-        private readonly HeaderDictionary _dictionary = dictionary;
-
-        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<string, string>[] Items => _dictionary.Select(pair => new KeyValuePair<string, string>(pair.Key, pair.Value.ToString())).ToArray();
-    }
 }

src/Http/Http/src/Internal/ItemsDictionary.cs

@@ -4,11 +4,11 @@
 using System.Collections;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
-using System.Linq;
+using Microsoft.AspNetCore.Shared;
 
 namespace Microsoft.AspNetCore.Http;
 
-[DebuggerTypeProxy(typeof(ItemsDictionaryDebugView))]
+[DebuggerTypeProxy(typeof(DictionaryDebugView<object, object>))]
 [DebuggerDisplay("Count = {Items.Count}")]
 internal sealed class ItemsDictionary : IDictionary<object, object?>
 {
@@ -142,7 +142,7 @@ private void EnsureDictionary()
 
     private sealed class EmptyEnumerator : IEnumerator<KeyValuePair<object, object?>>
     {
-        // In own class so only initalized if GetEnumerator is called on an empty ItemsDictionary
+        // In own class so only initialized if GetEnumerator is called on an empty ItemsDictionary
         public static readonly IEnumerator<KeyValuePair<object, object?>> Instance = new EmptyEnumerator();
         public KeyValuePair<object, object?> Current => default;
 
@@ -159,16 +159,8 @@ public void Reset()
 
     private static class EmptyDictionary
     {
-        // In own class so only initalized if CopyTo is called on an empty ItemsDictionary
+        // In own class so only initialized if CopyTo is called on an empty ItemsDictionary
         public static readonly IDictionary<object, object?> Dictionary = new Dictionary<object, object?>();
         public static ICollection<KeyValuePair<object, object?>> Collection => Dictionary;
     }
-
-    private sealed class ItemsDictionaryDebugView(ItemsDictionary dictionary)
-    {
-        private readonly ItemsDictionary _dictionary = dictionary;
-
-        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<object, object?>[] Items => _dictionary.ToArray();
-    }
 }

src/Http/Http/src/Internal/RequestCookieCollection.cs

@@ -6,6 +6,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using Microsoft.AspNetCore.Internal;
+using Microsoft.AspNetCore.Shared;
 using Microsoft.Extensions.Primitives;
 using Microsoft.Net.Http.Headers;
 
@@ -231,6 +232,6 @@ private sealed class RequestCookieCollectionDebugView(RequestCookieCollection co
         private readonly RequestCookieCollection _collection = collection;
 
         [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
-        public KeyValuePair<string, string>[] Items => _collection.ToArray();
+        public DictionaryItemDebugView<string, string>[] Items => _collection.Select(pair => new DictionaryItemDebugView<string, string>(pair)).ToArray();
     }
 }