Fix dictionary deserialization crash on $-prefixed keys#9983
Merged
haiyuazhang merged 3 commits intomicrosoft:mainfrom Mar 17, 2026
Merged
Conversation
Add TryReadComplexType overload for IReadOnlyDictionary<string, T> that manually reads dictionary entries via Utf8JsonReader, bypassing the default System.Text.Json dictionary converter which rejects property names starting with '$' when ReferenceHandler is enabled. This fixes a crash when generating SDKs from specs with OData parameters (e.g. \) that appear as dictionary keys in example values. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a \ key to the existing PutStorageTask example test data and assert it deserializes correctly. Without the fix, this reproduces the JsonException: 'Properties that start with \$ are not allowed in types that support metadata.' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
haiyuazhang
requested review from
JoshLove-msft,
ShivangiReja,
christothes,
jorgerangel-msft,
joseharriaga,
jsquire and
m-nash
as code owners
microsoft-github-policy-service
bot
added
the
emitter:client:csharp
commit: |
Contributor
|
No changes needing a change description found. |
.../Microsoft.TypeSpec.Generator.Input/src/InputTypes/Serialization/Utf8JsonReaderExtensions.cs
Show resolved
Hide resolved
Member
Author
|
@jorgerangel-msft I ran RegenPreview locally against azure-sdk-for-net with The 10 failures are due to a |
jorgerangel-msft
approved these changes
Mar 17, 2026
JoshLove-msft
added a commit
to JoshLove-msft/typespec
that referenced
this pull request
Mar 20, 2026
The dictionary TryReadComplexType overload (added in microsoft#9983) manually iterated dictionary entries and called ReadWithConverter for each value. This corrupted the Utf8JsonReader position for nested InputExampleValue objects, causing a TypeInitializationException during code model loading. Fix: delegate to System.Text.Json's built-in dictionary converter via ReadWithConverter for the whole dictionary, which correctly handles reader positioning for nested objects with \/\ references. For specs with \$-prefixed dictionary keys (like \), fall back to reading without the ReferenceHandler since that is what rejects non-metadata \$-prefixed property names. Fixes regression from microsoft#9983. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JoshLove-msft
added a commit
to JoshLove-msft/typespec
that referenced
this pull request
Mar 20, 2026
The dictionary TryReadComplexType overload (added in microsoft#9983) manually iterated dictionary entries but treated \ metadata as regular dictionary keys. When a dictionary value object contains \ (for reference tracking), the manual iteration read it as a dictionary entry key and tried to parse the reference ID string as an InputExampleValue, corrupting the reader position. Fix: skip \ metadata entries (via TryReadReferenceId) when iterating dictionary keys, consistent with how other converters handle reference tracking metadata. This preserves the manual iteration needed to handle \$-prefixed user keys (like \) while correctly ignoring serialization metadata. Fixes regression from microsoft#9983. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 20, 2026
…es (#10109) The dictionary TryReadComplexType overload (added in #9983) manually iterated dictionary entries but treated \ metadata as regular dictionary keys. When a dictionary value object contains \ (for reference tracking), the manual iteration read it as a dictionary entry key and tried to parse the reference ID string as an InputExampleValue, corrupting the reader position. Fix: skip \ metadata entries (via TryReadReferenceId) when iterating dictionary keys, consistent with how other converters handle reference tracking metadata. This preserves the manual iteration needed to handle \$-prefixed user keys (like \) while correctly ignoring serialization metadata. Fixes regression from #9983. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #9982