az_json_writer_append_json_text does not take into account required buffer space for commas #1905
Conversation
This file contains 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
hwmaier
requested review from
ahsonkhan,
antkmsft,
gearama,
RickWinter and
vhvb1989
as code owners
ghost
added
the
customer-reported
|
Thank you for your contribution hwmaier! We will review the pull request and get back to you soon. |
ahsonkhan
reviewed
Sep 8, 2021
| @@ -799,7 +801,7 @@ az_json_writer_append_json_text(az_json_writer* ref_json_writer, az_span json_te | |||
| // Therefore, need_comma must be true after appending the json_text. | |||
|
|
|||
| // We already tracked and updated bytes_written while writing, so no need to update it here. | |||
| _az_update_json_writer_state(ref_json_writer, 0, az_span_size(json_text), true, last_token_kind); | |||
| _az_update_json_writer_state(ref_json_writer, 0, required_size, true, last_token_kind); | |||
There was a problem hiding this comment.
Though this fixes up _internal.total_bytes_written, this seems to be incrementing _internal.bytes_written by one more than necessary, because it is already being incremented on line 789.
There was a problem hiding this comment.
Nevermind, I see the bytes_written increment parameter continues to be 0.
ahsonkhan
reviewed
Sep 8, 2021
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.
The
az_json_writer_append_json_text()function does not take into account required buffer space for commas when tracking buffer size with_az_update_json_writer_state().So for example if 5 array elements are written using
az_json_writer_append_json_text(), the resulting JSON span is short of 4 (5-1) characters and the resulting JSON string is incomplete, typically the closing braces and a few last characters show missing in the stream.This patch fixes this issue.