Fix bug involving calling set on a template parameter within all branches of an if block #1665
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
davidism
reviewed
May 7, 2022
kevin-brown
commented
May 7, 2022
|
Targeting this for the 3.1.5 release. Needs to be rebased onto latest stable branch (git rebase --onto origin/stable origin/main). I'll step through it in more detail tomorrow, it looks like we only need to add some clarifying comments to the code. |
davidism
force-pushed
the
GH-1253-set-within-if
branch
from
81426ca to
0a8bbdf
Compare
There was a bug that came as the result of an early optimization done within ID tracking that caused loading parameters to fail in a very specific and rare edge case. That edge case only occurred when the parameter was being set within all 3 standard branches of an if block, since the optimization would assume that the parameter was never being referenced and was only ever being set. This would cause the variable to be set to undefined. The fix for this was to remove the optimization and still continue to load in the parameter even if it is set in all 3 branches.
davidism
force-pushed
the
GH-1253-set-within-if
branch
from
0a8bbdf to
66587ce
Compare
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.
This fixes a bug where calling
{% set %}in all 3 branches of an{% if %}block could result in the parameter being undefined sometimes. If the{% set %}call was not done in all branches or it was done outside of an{% if %}block then the bug would not appear. This was determined to be a bad assumption being made by the ID tracking for variables within the template loader where if the{% set %}occurred in all branches then it was not going to be a previously defined variable.Fixes #1253
Checklist:
CHANGES.rstsummarizing the change and linking to the issue... versionchanged::entries in any relevant code docs.pre-commithooks and fix any issues.pytestandtox, no tests failed.