feat: improve body parsing logic #72
Open
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
|
Discovered by this openwrt/openwrt#15265 Made further research and found the root of the problem! |
Ansuel
force-pushed
the
(metal-gear-)solid-parsing
branch
from
20e3584 to
7b837e5
Compare
jamacku
suggested changes
Apr 29, 2024
Ansuel
force-pushed
the
(metal-gear-)solid-parsing
branch
from
7b837e5 to
14c673f
Compare
Current body parsing logic with trim() + split("###") is too fragile and
pose problems with some body that contains case with ### in the middle
of the line or case with codeblock ``` section.
These case will cause the script to parse these as separate section and
produce wrong outputs and in some case even prints error assuming things
are checkbox and errors out on the concat function.
To make the parsing logic more solid, implement a dedicated function and
parse with this logic:
- We split the body for "\n"
- We ignore codeblock ``` section
- We check "###" only at the start of the line
- We check for "### " (with the space included) as that is the correct
section Github issue template expects.
With the following change case like:
```
root@OpenWrt:~# cat /boot/config.txt
```
Are correctly parsed as all part of a single section instead of being
wrongly treated as different empty sections.
Signed-off-by: Christian Marangi <[email protected]>
Add additional test for section with #### to prevent and catch in future code change that would produce wrong parsing. Signed-off-by: Christian Marangi <[email protected]>
Add test for codeblock ``` ignore to prevent and catch in future code change that would produce wrong parsing. Signed-off-by: Christian Marangi <[email protected]>
Add test for codeblock ```sh ignore to prevent and catch in future code change that would produce wrong parsing. This is a variant of the ``` test that makes the code block section target specific code. Signed-off-by: Christian Marangi <[email protected]>
Ansuel
force-pushed
the
(metal-gear-)solid-parsing
branch
from
14c673f to
06dd03d
Compare
|
@jamacku sorry for the delay... I fixed the comment and also add an additional test to catch this special case. We check now if line start with ``` directly. |
|
Awesome, good stuff. I will have a closer look shortly and then cut a new major version for this change. |
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.
Current body parsing logic with trim() + split("###") is too fragile and
pose problems with some body that contains case with ### in the middle
of the line or case with codeblock ``` section.
These case will cause the script to parse these as separate section and
produce wrong outputs and in some case even prints error assuming things
are checkbox and errors out on the concat function.
To make the parsing logic more solid, implement a dedicated function and
parse with this logic:
section Github issue template expects.
With the following change case like:
Are correctly parsed as all part of a single section instead of being
wrongly treated as different empty sections.
Signed-off-by: Christian Marangi [email protected]