Update TryGet to combine arrays only when an Append exists #54289
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug in the JsonPatch.TryGetEncodedValueInternal method where non-Append patch operations (property sets, item removals, and item property removals) incorrectly assumed they needed to normalize array indexers. The fix ensures that array index normalization only occurs when an Append operation exists on the ancestor array path.
Key Changes:
- Added a check to return early when accessing removed array items (line 75-78)
- Removed premature optimization for empty array paths that was preventing correct behavior
- Added a condition to break from array index adjustment loop when the ancestor array is not an Append operation (lines 110-114)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/core/System.ClientModel/src/ModelReaderWriter/JsonPatch.Implementation.cs | Fixed the TryGetEncodedValueInternal method to properly handle non-Append patch operations by breaking out of index normalization when ancestor arrays aren't Append operations |
| sdk/core/System.ClientModel/tests/ModelReaderWriterTests/JsonPatchTests.cs | Added comprehensive regression tests covering array iteration with property modifications, item removals, item property removals, and append operations |
jsquire
approved these changes
Dec 3, 2025
Member
jsquire
left a comment
jsquire
left a comment
There was a problem hiding this comment.
This covers the scenario that we talked about and a couple of additional corners.
Member
Author
|
/check-enforcer evaluate |
jsquire
approved these changes
Dec 4, 2025
christothes
reviewed
Dec 4, 2025
sdk/core/System.ClientModel/tests/ModelReaderWriterTests/JsonPatchTests.cs
Show resolved
Hide resolved
christothes
approved these changes
Dec 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If a non Append patch is set for a given path, any child path will mistakenly assume it needs to normalize the indexers across the root and patch array items.
This can occur for property sets as well as item removals and item property removals.
This PR fixes this and adds corresponding test cases for regression.