Validate template option for grid fields#364
Open
Rafikooo wants to merge 1 commit intoSylius:1.13from
Open
Conversation
GSadee
approved these changes
Feb 14, 2025
Comment on lines
+301
to
+303
| /** | ||
| * @test | ||
| */ |
Member
There was a problem hiding this comment.
Suggested change
| /** | |
| * @test | |
| */ | |
| /** @test */ |
Member
There was a problem hiding this comment.
You can also use the PHP Attribute :)
| /** | ||
| * @test | ||
| */ | ||
| public function it_throws_exception_when_field_template_is_used_with_non_twig_type(): void |
Member
There was a problem hiding this comment.
Suggested change
| public function it_throws_exception_when_field_template_is_used_with_non_twig_type(): void | |
| public function it_throws_an_exception_when_field_template_is_used_with_non_twig_type(): void |
| ->end() | ||
| ->end() | ||
| ->validate() | ||
| ->ifTrue(fn (array $config): bool => isset($config['options']['template']) && $config['type'] !== 'twig') |
Contributor
There was a problem hiding this comment.
This seems like an overreach that can plausibly cause conflicts with custom types.
Wouldn't it be better to reset the previous options once the type changes, we'd probably need to inject the logic somewhere inside the config merging mechanism though.
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
5 participants
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.
Initial error:
The error message did not clearly indicate what was wrong.
The issue was related to grid configuration merging.
In Sylius, we have:
and in some end app:
After merging, the type was set to
string, but thetemplateoption from the base configuration remained, causing the application to break.This PR introduces validation to prevent similar issues in the future, saving users from hours of debugging.