don't allow invalid syntax inside comment tag #1770
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
54996ab to
8b4bb21
Compare
8b4bb21 to
3c5ad7d
Compare
Comment on lines
+49
to
+72
| assert_raises(Liquid::SyntaxError) do | ||
| assert_template_result("", <<~LIQUID.chomp) | ||
| {% comment %} | ||
| {% assign foo = "1" | ||
| {% endcomment %} | ||
| LIQUID | ||
| end | ||
|
|
||
| assert_raises(Liquid::SyntaxError) do | ||
| assert_template_result("", <<~LIQUID.chomp) | ||
| {% comment %} | ||
| {% comment %} | ||
| {% invalid | ||
| {% endcomment %} | ||
| {% endcomment %} | ||
| LIQUID | ||
| end | ||
|
|
||
| assert_raises(Liquid::SyntaxError) do | ||
| assert_template_result("", <<~LIQUID.chomp) | ||
| {% comment %} | ||
| {% {{ {%- endcomment %} | ||
| LIQUID | ||
| end |
There was a problem hiding this comment.
I think these should be valid templates right? Incomplete tags should be allowed inside of a comment block.
There was a problem hiding this comment.
I agree, however, we can't introduce a change that will break existing Liquid templates.
For an example,
{% comment %}
{% assign a = 123
{% endcomment %}
{% endcomment %}This Liquid template is a valid with version 5.4.0 because the assign tag is captured as {% assign a = 123 {% endcomment %}. (Liquid allows extra string inside a tag)
So, if we parse comment tag like the raw tag, we would capture, we would ignore the {% assign a = 123 and capture {% endcomment %} from line 3 as the comment tag's delimiter. Since the template has an extra {% endcomment %} tag delimiter, the template is no longer valid.
peterzhu2118
approved these changes
Dec 14, 2023
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.
What are you trying to solve?
#1755 introduced a new feature that allows invalid code to be inside a
commenttag.For Liquid version
5.4.0, this is a valid template, and not with our currentmainbranch:The
assigntag is not closed immediately,{% assign a = 1 {% endcomment %}is parsed as theassigntag.Since the #1755 changed the
commenttag parser to use theBlockBody::FullTokenPossiblyInvalidregex pattern, it parses{% assign a = 1 {% endcomment %}to be thecommenttag delimiter, and it raises a syntax error by the extra{% endcomment %}token.How are you solving this issue?
In order to remove this breaking change, this PR updates the
commentto parse tokens likeBlockBodyand not likerawtag.However, the
commenttag will still allow unclosed tags such as this example: