Skip to content

Commit

Permalink
don't parse nodes inside a comment tag
Browse files Browse the repository at this point in the history
Co-authored-by: Alex Coco <[email protected]>
  • Loading branch information
ggmichaelgo and alexcoco committed Nov 7, 2023
1 parent 0b93182 commit 0b5ebc3
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 0 deletions.
54 changes: 54 additions & 0 deletions lib/liquid/tags/comment.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,60 @@ def unknown_tag(_tag, _markup, _tokens)
def blank?
true
end

private

def parse_body(body, tokens)
if parse_context.depth >= MAX_DEPTH
raise StackLevelError, "Nesting too deep"
end

parse_context.depth += 1
comment_tag_depth = 1

begin
# Consume tokens without creating child nodes.
# The children tag doesn't require to be a valid Liquid except the comment and raw tag.
# The child comment and raw tag must be closed.
while (token = tokens.send(:shift))
tag_name_match = BlockBody::FullToken.match(token)

next if tag_name_match.nil?

tag_name = tag_name_match[2]

if tag_name == "raw"
# raw tags are required to be closed
raw_tag_closed = false

while (token = tokens.send(:shift))
if token =~ Raw::FullTokenPossiblyInvalid && "endraw" == Regexp.last_match(2)
raw_tag_closed = true
break
end
end

raise_tag_never_closed("raw") unless raw_tag_closed
next
end

if tag_name_match[2] == "comment"
comment_tag_depth += 1
next
elsif tag_name_match[2] == "endcomment"
comment_tag_depth -= 1

return false if comment_tag_depth.zero?
end
end

raise_tag_never_closed(block_name)
ensure
parse_context.depth -= 1
end

false
end
end

Template.register_tag('comment', Comment)
Expand Down
82 changes: 82 additions & 0 deletions test/unit/tags/comment_tag_unit_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# frozen_string_literal: true

require 'test_helper'

class CommentTagUnitTest < Minitest::Test
def test_does_not_parse_nodes_inside_a_comment
template = Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% if true %}
{% if ... %}
{%- for ? -%}
{% while true %}
{%
unless if
%}
{% endcase %}
{% endcomment %}
LIQUID

assert_equal("", template.render)
end

def test_child_comment_tags_need_to_be_closed
template = Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% comment %}
{% comment %}{% endcomment %}
{% endcomment %}
{% endcomment %}
LIQUID

assert_equal("", template.render)

assert_raises(SyntaxError) do
Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% comment %}
{% comment %}
{% endcomment %}
{% endcomment %}
LIQUID
end
end

def test_child_raw_tags_need_to_be_closed
template = Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% raw %}
{% endcomment %}
{% endraw %}
{% endcomment %}
LIQUID

assert_equal("", template.render)

assert_raises(SyntaxError) do
Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% raw %}
{% endcomment %}
{% endcomment %}
LIQUID
end
end

def test_error_line_number_is_correct
template = Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% comment %}
{% if true %}
{% endcomment %}
{{ errors.standard_error }}
LIQUID

output = template.render('errors' => ErrorDrop.new)
expected = <<~TEXT.chomp
Liquid error (line 4): standard error
TEXT

assert_equal(expected, output)
end
end

0 comments on commit 0b5ebc3

Please sign in to comment.