fix: make parseXMLAsync and parseXML have the same defaults for encoding #668
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
Member
|
Nice work, thanks!! |
axel-capodaglio
pushed a commit
to axel-capodaglio/libxmljs
that referenced
this pull request
Apr 11, 2025
…ing (libxmljs#668) (cherry picked from commit 39092a9)
|
Hey @rchipka, will there be a new release any time soon? Would love to get some of the recent updates in without having to import the github repo instead of the package |
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.
Context
We're currently using
libxmljsto parse XML for SAML IDP metadata. When we fetch the metadata from the service, theresponse.bodymay sometimes come back as a string with the following invisible first character:\uFEFF.This character is the Unicode Byte Order Mark (BOM). It’s a special invisible character that's often used at the beginning of text files to indicate the byte order (endianness) of the file, and it is particularly common for UTF-8 encoded files.
I noticed that the behavior between
libxmljs.parseXmlandlibxmljs.parseXmlAsynchandled this invisible character differently.libxmljs.parseXmlsucceeds with no issue because if thebufferis astring, it will default to an encoding ofUTF-8.However,
libxmljs.parseXmlAsyncfails because it only usesDEFAULT_XML_PARSE_OPTIONS.encoding. This is not defined, which then it throws with the following error:Error: Start tag expected, '<' not found.The Change
libxmljs.parseXmlandlibxmljs.parseXmlAsyncboth now have the following as its encoding argument:options.encoding || DEFAULT_XML_PARSE_OPTIONS.encoding || (typeof buffer === "string" ? "UTF-8" : null),which should handle this invisible character case.