Clean up parser error handling #473
Merged
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
jacksonj04
force-pushed
the
chore/clean-up-parser-error-handling
branch
from
fd98518 to
06d2f0e
Compare
dragon-dxw
reviewed
Nov 29, 2023
dragon-dxw
approved these changes
Nov 29, 2023
dragon-dxw
force-pushed
the
chore/clean-up-parser-error-handling
branch
from
06d2f0e to
7d99d04
Compare
dragon-dxw
approved these changes
Nov 29, 2023
This is only ever used in one place; to get the root element of the XML of a document. To help simplify understanding, move it into the scope of the `Document` class. Signed-off-by: David McKee <[email protected]>
The code to extract the root element of the XML is also responsible for identifying where a document is not XML (which is theoretically possible; MarkLogic can also store JSON, blobs and text). At the moment if this happens the fact it's not XML is silently swallowed and we pretend the root element is `error`, the same as a parser failure. This behaviour could potentially mask other problems; if we encounter a parser error then although it's unwanted it's a defined condition which we want to be able to handle within the usual user flows. Encountering a non-XML document means something has gone catastrophically wrong, and we want things to fail hard and shout about it. Signed-off-by: David McKee <[email protected]>
dragon-dxw
force-pushed
the
chore/clean-up-parser-error-handling
branch
from
7d99d04 to
6b157d6
Compare
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.
Review and merge #472 first!
Remove some unnecessary abstraction in how we identify if a document has failed to parse. At the same time, stop swallowing where a document is not XML (which should never happen) and fail hard with a specific exception instead.