Add index to OrderedDictionary debugger display by Copilot · Pull Request #120885 · dotnet/runtime

Copilot · 2025-10-19T20:07:03Z

Changed OrderedDictionary debugger display to use a list-style view where items are shown as KeyValuePairs with implicit indexing from array position. The debugger will display:

[0] = {["One", "1"]}
[1] = {["Two", "2"]}

Changes Made

OrderedDictionaryDebugView.cs: New custom debugger type proxy that returns a KeyValuePair<TKey, TValue>[] array. Simplified implementation uses CopyTo for better performance.
OrderedDictionary.cs: Updated DebuggerTypeProxy attribute to always use OrderedDictionaryDebugView
System.Collections.csproj: Added new debug view file to compilation
System.Text.Json.csproj: Added OrderedDictionaryDebugView.cs as a polyfill to ensure consistent debug view behavior across all projects that compile OrderedDictionary internally
DebugView.Tests.cs:
- Added OrderedDictionary to list-style tests with string keys ("One", "Two") to distinguish array indices [0], [1] from dictionary keys
- Added dedicated test TestDebuggerAttributes_OrderedDictionary that validates the debug view returns KeyValuePair array items in the correct order
- Wrapped OrderedDictionary test cases with #if !NETFRAMEWORK to prevent compilation errors on .NET Framework where the type is not available

The list-style view shows index information implicitly through array position ([0], [1], [2]) while keeping the key/value relationship clear with standard KeyValuePair display. This matches the display pattern used by Queue, Stack, and List.

Testing

✅ All 3,782 OrderedDictionary tests pass
✅ All DebugView tests pass (including new dedicated test)
✅ System.Collections builds successfully
✅ System.Text.Json builds successfully (all target frameworks)
✅ CodeQL security analysis: No issues found
✅ Fixed .NET Framework build errors

Fixes #118590

Original prompt

This section details on the original issue you should resolve

<issue_title>Add index to debugging display of OrderedDictionary<TKey, TValue></issue_title>
<issue_description>Since .NET 9 the new display info for dictionaries is [KEY, VALUE] coming from previous [INDEX, KEY/VALUE].

But index information is important here, so please add index => [INDEX/KEY, VALUE].</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #118590

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

dotnet-policy-service · 2025-10-19T21:17:09Z

Tagging subscribers to this area: @dotnet/area-system-collections
See info in area-owners.md if you want to be subscribed.

src/libraries/Common/tests/System/Collections/DebugView.Tests.cs

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

stephentoub · 2025-10-20T19:36:41Z

@copilot:

Build FAILED.

D:\a\_work\1\s\src\libraries\System.Collections\src\System\Collections\Generic\OrderedDictionary.cs(26,31): error CS0246: The type or namespace name 'OrderedDictionaryDebugView<,>' could not be found (are you missing a using directive or an assembly reference?) [D:\a\_work\1\s\src\libraries\System.Text.Json\src\System.Text.Json.csproj::TargetFramework=netstandard2.0]
    0 Warning(s)
    1 Error(s)

Copilot · 2025-10-20T20:02:12Z

@copilot:
Build FAILED.

...

Fixed build error by making the DebuggerTypeProxy attribute conditional. When SYSTEM_COLLECTIONS is defined (System.Collections project), it uses OrderedDictionaryDebugView. Otherwise (e.g., System.Text.Json for netstandard2.0), it falls back to IDictionaryDebugView.

Commit: TBD (in progress)

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

eiriktsarpalis

@copilot could you add back testing that validates the expected display format?

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

Copilot · 2025-10-21T06:45:22Z

@copilot could you add back testing that validates the expected display format?

Added TestDebuggerAttributes_OrderedDictionary test that validates the debug view returns KeyValuePair array items in the correct order. The test confirms that OrderedDictionary displays as a list of KeyValuePairs with implicit indexing from array position.

Commit: TBD (in progress)

eiriktsarpalis

@copilot please fix the failing builds

Copilot · 2025-10-22T07:49:46Z

@copilot please fix the failing builds

I've verified that both System.Collections and System.Text.Json build successfully locally, and the ./build.sh libs command also succeeds. Could you provide the specific error messages or logs from the failing builds so I can identify and fix the issue?

eiriktsarpalis · 2025-10-22T08:31:40Z

@copilot take a look at CI logs:

D:\a\_work\1\s\src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(169,45): error CS0246: The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?) [D:\a\_work\1\s\src\libraries\System.Collections.Immutable\tests\System.Collections.Immutable.Tests.csproj::TargetFramework=net481]
##[error]src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(169,45): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?)
D:\a\_work\1\s\src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(197,45): error CS0246: The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?) [D:\a\_work\1\s\src\libraries\System.Collections.Immutable\tests\System.Collections.Immutable.Tests.csproj::TargetFramework=net481]
##[error]src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(197,45): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?)
D:\a\_work\1\s\src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(287,28): error CS0246: The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?) [D:\a\_work\1\s\src\libraries\System.Collections.Immutable\tests\System.Collections.Immutable.Tests.csproj::TargetFramework=net481]
##[error]src\libraries\Common\tests\System\Collections\DebugView.Tests.cs(287,28): error CS0246: (NETCORE_ENGINEERING_TELEMETRY=Build) The type or namespace name 'OrderedDictionary<,>' could not be found (are you missing a using directive or an assembly reference?)

…dDictionary tests Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

Copilot · 2025-10-22T08:56:41Z

@copilot take a look at CI logs:

...

Fixed by wrapping OrderedDictionary test cases with #if !NETFRAMEWORK since OrderedDictionary<TKey, TValue> is not available in .NET Framework.

Commit: TBD (in progress)

stephentoub · 2025-10-23T14:07:49Z

@eiriktsarpalis, my sign-off doesn't count; can you review?

tarekgh · 2025-10-23T15:54:48Z

@eiriktsarpalis, my sign-off doesn't count; can you review?

I signed off, I think @eiriktsarpalis is not available today.

eiriktsarpalis · 2025-10-24T05:34:14Z

/ba-g test failures unrelated.

Initial plan

bb6f5f2

Copilot AI assigned Copilot and stephentoub Oct 19, 2025

Copilot started work on behalf of stephentoub October 19, 2025 20:07 View session

github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Oct 19, 2025

Add index to OrderedDictionary debugger display

2626dfa

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add index to debugging display of OrderedDictionary~~ Add index to OrderedDictionary debugger display Oct 19, 2025

Copilot AI requested a review from stephentoub October 19, 2025 20:47

Copilot finished work on behalf of stephentoub October 19, 2025 20:47

stephentoub added area-System.Collections and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Oct 19, 2025

eiriktsarpalis reviewed Oct 20, 2025

View reviewed changes

src/libraries/Common/tests/System/Collections/DebugView.Tests.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of stephentoub October 20, 2025 12:09 View session

Change OrderedDictionary debug view to list-style format

284d2e9

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Copilot finished work on behalf of stephentoub October 20, 2025 12:40

Copilot started work on behalf of eiriktsarpalis October 20, 2025 14:07 View session

Use string keys in OrderedDictionary test to distinguish from indices

9a0bf3c

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

Copilot AI requested a review from eiriktsarpalis October 20, 2025 14:30

Copilot finished work on behalf of eiriktsarpalis October 20, 2025 14:30

Copilot started work on behalf of stephentoub October 20, 2025 19:37 View session

Fix build error: Use conditional DebuggerTypeProxy for OrderedDictionary

55a3368

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

Copilot finished work on behalf of stephentoub October 20, 2025 20:04

eiriktsarpalis reviewed Oct 21, 2025

View reviewed changes

Copilot started work on behalf of eiriktsarpalis October 21, 2025 06:23 View session

Add test to validate OrderedDictionary debugger display format

1a46e03

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

Copilot finished work on behalf of eiriktsarpalis October 21, 2025 06:47

Copilot AI requested a review from stephentoub October 21, 2025 21:43

eiriktsarpalis reviewed Oct 22, 2025

View reviewed changes

Copilot started work on behalf of eiriktsarpalis October 22, 2025 07:08 View session

Copilot AI requested a review from eiriktsarpalis October 22, 2025 07:51

Copilot finished work on behalf of eiriktsarpalis October 22, 2025 07:51

Copilot started work on behalf of eiriktsarpalis October 22, 2025 08:32 View session

Fix build errors for .NET Framework by conditionally compiling Ordere…

d7bade6

…dDictionary tests Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

Copilot finished work on behalf of eiriktsarpalis October 22, 2025 08:58

Merge branch 'main' into copilot/add-index-to-ordered-dictionary

18654b3

stephentoub approved these changes Oct 23, 2025

View reviewed changes

stephentoub enabled auto-merge (squash) October 23, 2025 14:07

tarekgh approved these changes Oct 23, 2025

View reviewed changes

Merge branch 'main' into copilot/add-index-to-ordered-dictionary

baf8591

eiriktsarpalis approved these changes Oct 24, 2025

View reviewed changes

stephentoub merged commit 784f893 into main Oct 24, 2025
80 of 86 checks passed

dotnet-maestro bot mentioned this pull request Oct 25, 2025

[main] Source code updates from dotnet/runtime dotnet/dotnet#3103

Merged

jkotas deleted the copilot/add-index-to-ordered-dictionary branch November 2, 2025 03:42

github-actions bot locked and limited conversation to collaborators Dec 2, 2025

Conversation

Copilot AI commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Testing

Comments on the Issue (you are @copilot in this section)

Uh oh!

dotnet-policy-service bot commented Oct 19, 2025

Uh oh!

Uh oh!

stephentoub commented Oct 20, 2025

Uh oh!

Copilot AI commented Oct 20, 2025

Uh oh!

eiriktsarpalis left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 21, 2025

Uh oh!

eiriktsarpalis left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 22, 2025

Uh oh!

eiriktsarpalis commented Oct 22, 2025

Uh oh!

Copilot AI commented Oct 22, 2025

Uh oh!

stephentoub commented Oct 23, 2025

Uh oh!

tarekgh commented Oct 23, 2025

Uh oh!

eiriktsarpalis commented Oct 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Oct 19, 2025 •

edited

Loading