[Yaml Parser] Fix edge cases when parsing multiple documents #38228
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
1055435 to
280797c
Compare
|
Thank you @digilist. That's indeed a good catch. 👍 Doesn't this also apply to the |
stof
reviewed
Sep 18, 2020
280797c to
a02c0a9
Compare
|
@xabbuh yes, makes sense, I adjusted the changes for 3.4 and rebased to 3.4 |
a02c0a9 to
012ee4f
Compare
fabpot
approved these changes
Sep 18, 2020
|
Thank you @digilist. |
xabbuh
reviewed
Sep 18, 2020
| $expected = ['a' => ['b' => "row\nrow2\n"], 'c' => 'd']; | ||
|
|
||
| // The parser was not used before, so there is a new line after row2 | ||
| $this->assertSame($expected, $this->parser->parse($longDocument)); |
There was a problem hiding this comment.
I just added this to show that this is the actual result. But yes, it can be removed.
There was a problem hiding this comment.
I understand though I think that's rather confusing when reading the test and trying to understand what is going on IMO.
xabbuh
reviewed
Sep 18, 2020
| // The parser was not used before, so there is a new line after row2 | ||
| $this->assertSame($expected, $this->parser->parse($longDocument)); | ||
|
|
||
| $parser = new Parser(); |
There was a problem hiding this comment.
as far as I can see we can simply use $this->parser when parsing the two documents
xabbuh
added a commit
that referenced
this pull request
Sep 18, 2020
This PR was merged into the 3.4 branch. Discussion ---------- [Yaml] simplify the test | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | #38228 (comment) | License | MIT | Doc PR | Commits ------- bb64fc9 [Yaml] simplify the test
This was referenced Sep 27, 2020
Merged
Merged
Merged
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.
I identified some edge cases when parsing multiple YAML documents with the same parser instance, because the totalNumberOfLines was not reset and so any subsequent parsing considered the number of lines of the first document.
Consider this document:
Normally,
a.bwould be parsed asrow\nrow2\n. But if the parser parsed a shorter document before, the\nafter row2 was missing, as the parser considered it as the end of the file (that's why thec: dat the end is important).So this fix resets the
totalNumberOfLinesin the YAML parser tonullso that any subsequent parsing will initialize the value for the new document and does not use the file length of the first parsed document.I stumbled upon this because of a flickering unit test that was using the translation component. Sometimes the translated string contained a trailing
\nand sometimes not. In the end it was based on this bug, as the translation files were not loaded in the same order every time (not really sure why. It's somehow related to the cache state, but even with a warm cache it was not totally deterministic).