[TwigBridge][Validator] Add the Twig constraint and its validator by sfmok · Pull Request #58805 · symfony/symfony

sfmok · 2024-11-07T17:22:26Z

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	No
License	MIT

Add a new constraint for validating Twig content (inspired from Yaml constraint)

smnandre · 2024-11-08T02:39:29Z

src/Symfony/Component/Validator/Tests/Constraints/TwigValidatorTest.php

+            // Another syntax error example (unclosed variable)
+            ['Hello {{ name', 'Unexpected token "end of template" ("end of print statement" expected) at line 1.', 1],
+            // Unknown filter error
+            ['Hello {{ name | unknown_filter }}', 'Unknown "unknown_filter" filter at line 1.', 1],


Here, with the default environment, all the following would be invalid template, even if they are on most of the Symfony docs page.

{% form_theme form resources %}

{{ name | trans }}

{% trans_default_domain domain %}

{{ object|serialize(format = 'json', context = []) }}

{{ text|humanize }}

{{ name | trans }}

So ... what does "Twig valid" mean ?

Resolved by injecting the environment, as suggested by @derrabus #58805 (comment)

src/Symfony/Component/Validator/Constraints/TwigValidator.php

stof · 2024-11-08T12:28:25Z

What is the use case for this ?

sfmok · 2024-11-08T15:54:29Z

What is the use case for this ?

@stof the constraint is intended to validate the Twig syntax of user-customized templates (e.g., emails, reports, widgets) to prevent syntax-related runtime errors.

derrabus · 2024-11-09T17:18:56Z

The low-deps test failure appears to be caused by your changes.

src/Symfony/Bundle/TwigBundle/Resources/config/twig.php

smnandre · 2024-11-09T20:47:37Z

src/Symfony/Bridge/Twig/Tests/Validator/Constraints/TwigValidatorTest.php

+            // Another syntax error example (unclosed variable)
+            ['Hello {{ name', 'Unexpected token "end of template" ("end of print statement" expected) at line 1.', 1],
+            // Unknown filter error
+            ['Hello {{ name | unknown_filter }}', 'Unknown "unknown_filter" filter at line 1.', 1],


Yaml is a very defined syntax.

Here this is not the syntax that is validated, but the runtime Twig configuration.

And i still think it should not be exposed like this.

I agree, but the thrown exception indicates a syntax error.
See https://github.com/twigphp/Twig/blob/3.x/src/Error/SyntaxError.php

src/Symfony/Bridge/Twig/CHANGELOG.md

smnandre · 2024-11-09T20:52:26Z

src/Symfony/Bridge/Twig/Validator/Constraints/TwigValidator.php

+
+        $value = (string) $value;
+
+        $prevErrorHandler = set_error_handler(static function ($level, $message, $file, $line) use (&$prevErrorHandler) {


A deprecated function is not valid ?

If you don't want deprecated Twig syntax to be used in your templates, why not? But we should probably make this behavior configurable.

As Twig is not aligned with Symfony release cycle, this seems a bit fragile to me, but why not with a flag, indeed.

Good point. I've added the skipDeprecations option.

fabpot · 2024-11-10T09:53:02Z

src/Symfony/Bridge/Twig/Tests/Validator/Constraints/TwigValidatorTest.php

+            ['Hello {{ name }}'],
+            ['{% if condition %}Yes{% else %}No{% endif %}'],
+            ['{# Comment #}'],
+            ['Hello {{ "world" | upper }}'],


Suggested change

['Hello {{ "world" | upper }}'],

['Hello {{ "world"|upper }}'],

And everywhere else where you're using the | operator.

src/Symfony/Bridge/Twig/Validator/Constraints/TwigValidator.php

fabpot · 2025-03-26T08:32:54Z

src/Symfony/Bundle/TwigBundle/CHANGELOG.md

 CHANGELOG
 =========

+7.2


Suggested change

7.2

7.3

fabpot · 2025-03-26T08:33:12Z

src/Symfony/Bundle/TwigBundle/CHANGELOG.md

+7.2
+---
+
+ * Added support for the new `twig` validator (from Twig Bridge)


Suggested change

* Added support for the new `twig` validator (from Twig Bridge)

* Add support for the `twig` validator

fabpot · 2025-03-26T08:33:53Z

src/Symfony/Bridge/Twig/CHANGELOG.md

 ---

 * Deprecate passing a tag to the constructor of `FormThemeNode`
+ * Add the `Twig` constraint for validating Twig content


Suggested change

* Add the `Twig` constraint for validating Twig content

* Add the `Twig` constraint for validating Twig templates

fabpot · 2025-03-26T08:34:11Z

src/Symfony/Bridge/Twig/CHANGELOG.md

 ---

 * Deprecate passing a tag to the constructor of `FormThemeNode`
+ * Add the `Twig` constraint for validating Twig content


Should be moved to a new 7.3 section.

fabpot · 2025-03-28T09:12:44Z

src/Symfony/Bridge/Twig/Validator/Constraints/Twig.php

+
+    #[HasNamedArguments]
+    public function __construct(
+        public string $message = 'This value is not valid Twig.',


Suggested change

public string $message = 'This value is not valid Twig.',

public string $message = 'This value is not a valid Twig template.',

fabpot · 2025-03-28T09:20:18Z

Thank you @sfmok.

…fmok) This PR was merged into the 7.3 branch. Discussion ---------- [Validator] Add docs for bridge twig validator #20836 This pull request adds documentation for the new Twig Validator constraint introduced in the Twig Bridge. Changes: - Added a page to document the Twig validator constraint, including: - Installation instructions for the symfony/twig-bridge package. - Usage of the constraint in Symfony applications. - Detailed options available, including `message` and `skipDeprecations`. - Updated `index.rst` to include the new page under the "**Topics**" section for the **Twig Bridge.** Related Issue: [Issue #20836 - Add docs for Twig validator](#20836) Related PR: [Symfony PR #58805](symfony/symfony#58805) – Introduced the Twig validator constraint in the Twig Bridge. Commits ------- ac9e20c Add docs for bridge twig validator #20836

stof · 2025-04-29T10:55:17Z

The default error message needs to be added in the translation files, so that it gets translated in the project.

…bbuh) This PR was merged into the 6.4 branch. Discussion ---------- [Validator] add translations for the Twig constraint | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | | License | MIT add missing translation file entries for #58805 Commits ------- f12ba2e add translations for the Twig constraint

carsonbot added Status: Needs Review Feature labels Nov 7, 2024

carsonbot added this to the 7.2 milestone Nov 7, 2024

sfmok force-pushed the twig-validator branch from 5766d2b to a8f450d Compare November 7, 2024 17:46

sfmok changed the title ~~Add the twig constraint and its validator~~ [Validator] Add the twig constraint and its validator Nov 7, 2024

smnandre reviewed Nov 8, 2024

View reviewed changes

derrabus requested changes Nov 8, 2024

View reviewed changes

src/Symfony/Component/Validator/Constraints/TwigValidator.php Outdated Show resolved Hide resolved

src/Symfony/Component/Validator/Constraints/TwigValidator.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Nov 8, 2024

carsonbot changed the title ~~[Validator] Add the twig constraint and its validator~~ Add the twig constraint and its validator Nov 8, 2024

derrabus added Validator TwigBridge labels Nov 8, 2024

carsonbot changed the title ~~Add the twig constraint and its validator~~ [TwigBridge][Validator] Add the twig constraint and its validator Nov 8, 2024

sfmok force-pushed the twig-validator branch from a8f450d to a4a761d Compare November 8, 2024 15:18

sfmok force-pushed the twig-validator branch from a4a761d to e66034c Compare November 9, 2024 16:57

sfmok requested a review from yceruto as a code owner November 9, 2024 16:57

carsonbot added Status: Needs Review and removed Status: Needs Work labels Nov 9, 2024

sfmok requested a review from derrabus November 9, 2024 16:59

sfmok force-pushed the twig-validator branch from e66034c to 215b232 Compare November 9, 2024 18:59

smnandre reviewed Nov 9, 2024

View reviewed changes

src/Symfony/Bundle/TwigBundle/Resources/config/twig.php Outdated Show resolved Hide resolved

smnandre reviewed Nov 9, 2024

View reviewed changes

src/Symfony/Bridge/Twig/CHANGELOG.md Outdated Show resolved Hide resolved

smnandre reviewed Nov 9, 2024

View reviewed changes

fabpot requested changes Nov 10, 2024

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Nov 10, 2024

sfmok force-pushed the twig-validator branch 4 times, most recently from f116b44 to aab17ec Compare November 10, 2024 17:13

fabpot modified the milestones: 7.2, 7.3 Nov 20, 2024

sfmok requested a review from fabpot November 30, 2024 14:16

carsonbot added Status: Needs Review and removed Status: Needs Work labels Nov 30, 2024

fabpot requested changes Mar 26, 2025

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 26, 2025

OskarStark changed the title ~~[TwigBridge][Validator] Add the twig constraint and its validator~~ [TwigBridge][Validator] Add the Twig constraint and its validator Mar 26, 2025

fabpot requested changes Mar 28, 2025

View reviewed changes

fabpot force-pushed the twig-validator branch from aab17ec to e16a997 Compare March 28, 2025 09:16

Add the twig constraint and its validator

89eeaee

fabpot force-pushed the twig-validator branch from e16a997 to 89eeaee Compare March 28, 2025 09:20

fabpot merged commit 6ae4c85 into symfony:7.3 Mar 28, 2025
2 of 3 checks passed

fabpot mentioned this pull request Mar 28, 2025

[TwigBridge][Validator] Add the Twig constraint and its validator symfony/symfony-docs#20836

Closed

sfmok deleted the twig-validator branch April 6, 2025 19:01

sfmok mentioned this pull request Apr 7, 2025

[Validator] Add docs for bridge twig validator #20836 symfony/symfony-docs#20863

Merged

xabbuh mentioned this pull request Apr 29, 2025

[Validator] add translations for the Twig constraint #60300

Merged

fabpot mentioned this pull request May 2, 2025

Release v7.3.0-BETA1 #60327

Merged


		$value = (string) $value;

		$prevErrorHandler = set_error_handler(static function ($level, $message, $file, $line) use (&$prevErrorHandler) {

	['Hello {{ "world" \| upper }}'],
	['Hello {{ "world"\|upper }}'],

	* Added support for the new `twig` validator (from Twig Bridge)
	* Add support for the `twig` validator

	* Add the `Twig` constraint for validating Twig content
	* Add the `Twig` constraint for validating Twig templates

	public string $message = 'This value is not valid Twig.',
	public string $message = 'This value is not a valid Twig template.',

Uh oh!

Conversation

sfmok commented Nov 7, 2024 • edited by OskarStark Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stof commented Nov 8, 2024

Uh oh!

sfmok commented Nov 8, 2024

Uh oh!

derrabus commented Nov 9, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot Nov 10, 2024 • edited by OskarStark Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot commented Mar 28, 2025

Uh oh!

Uh oh!

stof commented Apr 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sfmok commented Nov 7, 2024 •

edited by OskarStark

Loading

fabpot Nov 10, 2024 •

edited by OskarStark

Loading