fix(caddyfile): {block} in snippet#7558
Open
prettysunflower wants to merge 2 commits intocaddyserver:masterfrom
Open
fix(caddyfile): {block} in snippet#7558prettysunflower wants to merge 2 commits intocaddyserver:masterfrom
prettysunflower wants to merge 2 commits intocaddyserver:masterfrom
Conversation
Resolve issue caddyserver#7557 So, here is the situation: - Pull request caddyserver#7206 included some changes to the doImport's function of Caddyfile's parser. What it does is that if there is no token within a block that follows the import, and the import contains `{block}`, then the `{block}` token is discarded. - After this pull request: - Issue caddyserver#7518 noticed that in cases that `{block}` was not imported, a runtime error was raised due to the assumption that tokens were always added to `tokensCopy` on every iteration of `importedTokens`. This was fixed by pull request caddyserver#7543. - Issue caddyserver#7557 notices that {block} can be ignored when imported from a certain file. There, it's again an issue with how the import works. When `import snippets` is called, this import instruction doesn't contains any nested blocks. And when the argument replacer that is the `importedTokens` loop is called and finds `{block}`, it uses the block from the file's import (which in this case is nothing), `{block}` is erased, and unavailable when the import directive is called for the imported snippet. The changed in this commit addresses the second issue by checking before replacing `{block}` if we're currently in a snippet definition, and appending the `{block}` token to `tokensCopy` if we are. With this changes, when importing those snippets, the `{block}` token will be available to be replaced by the nested blocks in `tokensToAdd` if needed, or erased if there are no nested blocks and `tokensToAdd` is empty. Tests added in pull requests caddyserver#7206 and caddyserver#7543 passes with this new implementation, confirming that unused `{block}` are accepted if nothing is passed to `import`, as well as the other usual tests. A new test was also added based on issue caddyserver#7557 reporting, and also passes. Signed-off-by: prettysunflower <me@prettysunflower.moe>
Contributor
Author
|
(Fun fact, I did a previous attempt at solving this problem by keeping the |
This file contains hidden or 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
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.
Resolve issue #7557
So, here is the situation:
blockto do nothing if nothing passed toimport#7206 included some changes to thedoImport's function of Caddyfile's parser. What it does is that if there is no token within a block that follows the import, and the import contains{block}, then the{block}token is discarded.{block}was not imported, a runtime error was raised due to the assumption that tokens were always added totokensCopyon every iteration ofimportedTokens. This was fixed by pull request fix(caddyfile): Prevent parser to panic when no token were added by empty {block} #7543.{block}is ignored when imported from a separate file #7557 notices that {block} can be ignored when imported from a certain file. There, it's again an issue with how the import works. Whenimport snippetsis called, this import instruction doesn't contains any nested blocks. And when the argument replacer that is theimportedTokensloop is called and finds{block}, it uses the block from the file's import (which in this case is nothing),{block}is erased, and unavailable when the import directive is called for the imported snippet.The changed in this
commitpull request addresses the second issue by checking before replacing{block}if we're currently in a snippet definition, and appending the{block}token totokensCopyif we are.With this changes, when importing those snippets, the
{block}token will be available to be replaced by the nested blocks intokensToAddif needed, or erased if there are no nested blocks andtokensToAddis empty.Tests added in pull requests #7206 and #7543 passes with this new implementation, confirming that unused
{block}are accepted if nothing is passed toimport, as well as the other usual tests. A new test was also added based on issue #7557 reporting, and also passes.Assistance Disclosure
No AI was used. (I still wish I was a cute robot, though~)