Fix large for-loop collection #1071
Open
+13
−1
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
A large collection in a for loop results in a crash or large memory usage during render.
If a large collection is given to a for block, this may crash the render process of the template. Setting of resource_limits does not help because these are tested at a later stage. This can be prevented by adding a simple check to the Liquid::For block which makes sure that a collection size does never exceed the set render_score_limit.
ghost
added
the
|
BTW: You can checkout this branch to show the behavior for a large given collection without the fix: https://github.com/stayhero/liquid/tree/large_forloop_failing_test?files=1 |
pushrax
reviewed
Mar 12, 2019
There was a problem hiding this comment.
Great catch!
Long-term I think it would make sense to iterate ranges more efficiently without constructing the intermediate array. Some range math can be done for the common cases to handle reverse and offsets. This patch makes sense as a solution for now though.
Resource limit gets triggered without a nested loop in the test for a large collection range.
|
@pushrax Anything missing to merge the PR? |
|
@pushrax: ping |
hc0503
approved these changes
Nov 9, 2020
|
👋 Friendly bump to see what it would take to merge. |
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.
When a large Range is given in a for-loop (e.g. 1..100000000000000), it may crash the Ruby process or at least eats a lot of memory and takes a significant amount of time to render the template.
I added the following testcase to template_test.rb:
The render_score_limit does not help here because it's more of a Ruby performance problem in for.rb, where the
collection = collection.to_a if collection.is_a?(Range)happens.A fix may be to check if the given Range is larger than the given render_score_limit. I'm actually not sure if there may be a better fix (e.g. checking the resource limits somewhere else) but at least it works for the given test case.