Fix CborWriter.Reset. #121188
Merged
Fix CborWriter.Reset. #121188
+29
−1
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
The first issue is that Reset did not correctly set _definiteLength back after a reset. If allowMultipleRootLevelValues from the constructor is false, the default, it should be initialized to 1. However Reset set it as null, which behaves as if allowMultipleRootLevelValues is true. This sets _definiteLength back to the same way the constructor does. The second is that _currentIndefiniteLengthStringRanges is not cleared during Reset. This means if a Reset occurred while in the middle of writing an indefinite length value and convertIndefiniteLengthEncodings is true, the next time an encode tried to re-encode segments as definite encoding where the list indicated would be pointing to incorrect locations.
|
Tagging subscribers to this area: @dotnet/area-system-formats-cbor, @bartonjs, @vcsjones |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug in the CborWriter.Reset() method where two important writer state fields were not being properly reset. The fix ensures that after calling Reset(), the writer behaves correctly for both multiple root level value restrictions and indefinite-length string encoding conversions.
Key changes:
- Fixed
_definiteLengthto properly restore the initial state based onAllowMultipleRootLevelValuessetting - Added clearing of
_currentIndefiniteLengthStringRangesto prevent stale data from affecting subsequent writes - Added two test cases to verify the reset behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/libraries/System.Formats.Cbor/src/System/Formats/Cbor/Writer/CborWriter.cs | Fixed Reset() to properly restore _definiteLength based on writer configuration and clear indefinite-length string tracking data |
| src/libraries/System.Formats.Cbor/tests/Writer/CborWriterTests.cs | Added test coverage for Reset() preserving multiple root level restrictions and clearing indefinite-length string ranges |
Open
3 tasks
bartonjs
approved these changes
Oct 30, 2025
|
/ba-g Android and Windows NAOT pipelines are timing out, but other pipelines validate the behavior. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The first issue is that Reset did not correctly set _definiteLength back after a reset. If allowMultipleRootLevelValues from the constructor is false, the default, it should be initialized to 1. However Reset set it as null, which behaves as if allowMultipleRootLevelValues is true. This sets _definiteLength back to the same way the constructor does.
The second is that _currentIndefiniteLengthStringRanges is not cleared during Reset. This means if a Reset occurred while in the middle of writing an indefinite length value and convertIndefiniteLengthEncodings is true, the next time an encode tried to re-encode segments as definite encoding where the list indicated would be pointing to incorrect locations.
Fixes #121183
Fixes #121182