Correctly serialize UTF-16 documents that are longer than libxml2's internal string buffer #2434
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
and consolidate and rewrite a few tests
UTF-16 documents that are long enough to trigger an intermediate libxml2 buffer flush are now serialized correctly. This change works by setting the external encoding on the StringIO object, and then using that encoding when constructing intermediate strings from libxml2's buffer.
flavorjones
added a commit
that referenced
this pull request
Feb 8, 2022
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.
What problem is this PR intended to solve?
#752 reported a bug in serializing long UTF-16 documents.
The serialized document was corrupted when we were not being careful to use the document encoding while collecting multiple libxml2 buffer flushes. As a result, an incorrect number of bytes were written, including some garbage, as well as incorrect BOMs appearing in the middle of the serialized document.
This fix works by setting the external encoding on the StringIO object used to collecting the serialized stream, and then using that encoding when constructing intermediate strings from libxml2's buffer.
Have you included adequate test coverage?
Yes!
Does this change affect the behavior of either the C or the Java implementations?
This fixes the CRuby/libxml2 behavior which now matches the JRuby behavior.