fix(spec-api): ignore XML declaration in validateXmlBodyEquals#11313
Merged
Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). 1 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix XML validation to handle declaration correctly
fix(spec-api): ignore XML declaration in validateXmlBodyEquals
Jul 20, 2026
commit: |
timotheeguerin
marked this pull request as ready for review
July 22, 2026 14:44
timotheeguerin
requested review from
bterlson,
catalinaperalta,
iscai-msft,
markcowl and
witemple-msft
as code owners
July 22, 2026 14:44
Contributor
|
All changed packages have been documented.
Show changes
|
|
You can try these changes here
|
timotheeguerin
enabled auto-merge
July 22, 2026 15:33
iscai-msft
approved these changes
Jul 22, 2026
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
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.
Since the migration from
xml2jstofast-xml-parser(#10239),validateXmlBodyEqualsprepends<?xml version='1.0' encoding='UTF-8'?>to plain expected strings, andfast-xml-parser(unlikexml2js) preserves that declaration as a?xmlnode in the parsed output. This causes comparison failures when the actual request body omits the declaration.Changes
packages/spec-api/src/request-validations.ts— AddignoreDeclaration: truetoXMLParseroptions so declarations are stripped from both sides before comparison, restoring the semantic-equality behavior ofxml2js.packages/spector/test/xml-validation.test.ts— Add test for the inverse path: actual body without a declaration matching an expected string (the exact scenario failing in Spector).