bug #52990 [TwigBridge] don't use deprecated and internal Twig functions (xabbuh)

fabpot · fabpot · commit 85b3a05f3e4e · 2023-12-15T13:33:34.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [TwigBridge] don't use deprecated and internal Twig functions | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | Fix #52987 | License | MIT `twig_test_empty()` and `twig_escape_filter()` are deprecated since Twig 3.9 Commits ------- 25b14ba don't use deprecated and internal Twig functions
diff --git a/src/Symfony/Bridge/Twig/Node/SearchAndRenderBlockNode.php b/src/Symfony/Bridge/Twig/Node/SearchAndRenderBlockNode.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bridge\Twig\Node;
 
 use Twig\Compiler;
+use Twig\Extension\CoreExtension;
 use Twig\Node\Expression\ArrayExpression;
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\FunctionExpression;
@@ -50,7 +51,7 @@ public function compile(Compiler $compiler): void
                         $labelIsExpression = false;
 
                         // Only insert the label into the array if it is not empty
-                        if (!twig_test_empty($label->getAttribute('value'))) {
+                        if (null !== $label->getAttribute('value') && false !== $label->getAttribute('value') && '' !== (string) $label->getAttribute('value')) {
                             $originalVariables = $variables;
                             $variables = new ArrayExpression([], $lineno);
                             $labelKey = new ConstantExpression('label', $lineno);
@@ -97,7 +98,12 @@ public function compile(Compiler $compiler): void
 
                         // Check at runtime whether the label is empty.
                         // If not, add it to the array at runtime.
-                        $compiler->raw('(twig_test_empty($_label_ = ');
+                        if (method_exists(CoreExtension::class, 'testEmpty')) {
+                            $compiler->raw('(CoreExtension::testEmpty($_label_ = ');
+                        } else {
+                            $compiler->raw('(twig_test_empty($_label_ = ');
+                        }
+
                         $compiler->subcompile($label);
                         $compiler->raw(') ? [] : ["label" => $_label_])');
                     }
diff --git a/src/Symfony/Bridge/Twig/Tests/Node/SearchAndRenderBlockNodeTest.php b/src/Symfony/Bridge/Twig/Tests/Node/SearchAndRenderBlockNodeTest.php
@@ -15,6 +15,7 @@
 use Symfony\Bridge\Twig\Node\SearchAndRenderBlockNode;
 use Twig\Compiler;
 use Twig\Environment;
+use Twig\Extension\CoreExtension;
 use Twig\Loader\LoaderInterface;
 use Twig\Node\Expression\ArrayExpression;
 use Twig\Node\Expression\ConditionalExpression;
@@ -226,8 +227,9 @@ public function testCompileLabelWithLabelThatEvaluatesToNull()
         // https://github.com/symfony/symfony/issues/5029
         $this->assertEquals(
             sprintf(
-                '$this->env->getRuntime(\'Symfony\Component\Form\FormRenderer\')->searchAndRenderBlock(%s, \'label\', (twig_test_empty($_label_ = ((true) ? (null) : (null))) ? [] : ["label" => $_label_]))',
-                $this->getVariableGetter('form')
+                '$this->env->getRuntime(\'Symfony\Component\Form\FormRenderer\')->searchAndRenderBlock(%s, \'label\', (%s($_label_ = ((true) ? (null) : (null))) ? [] : ["label" => $_label_]))',
+                $this->getVariableGetter('form'),
+                method_exists(CoreExtension::class, 'testEmpty') ? 'CoreExtension::testEmpty' : 'twig_test_empty'
             ),
             trim($compiler->compile($node)->getSource())
         );
@@ -263,8 +265,9 @@ public function testCompileLabelWithLabelThatEvaluatesToNullAndAttributes()
         // https://github.com/symfony/symfony/issues/5029
         $this->assertEquals(
             sprintf(
-                '$this->env->getRuntime(\'Symfony\Component\Form\FormRenderer\')->searchAndRenderBlock(%s, \'label\', ["foo" => "bar", "label" => "value in attributes"] + (twig_test_empty($_label_ = ((true) ? (null) : (null))) ? [] : ["label" => $_label_]))',
-                $this->getVariableGetter('form')
+                '$this->env->getRuntime(\'Symfony\Component\Form\FormRenderer\')->searchAndRenderBlock(%s, \'label\', ["foo" => "bar", "label" => "value in attributes"] + (%s($_label_ = ((true) ? (null) : (null))) ? [] : ["label" => $_label_]))',
+                $this->getVariableGetter('form'),
+                method_exists(CoreExtension::class, 'testEmpty') ? 'CoreExtension::testEmpty' : 'twig_test_empty'
             ),
             trim($compiler->compile($node)->getSource())
         );
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Tests/Twig/WebProfilerExtensionTest.php b/src/Symfony/Bundle/WebProfilerBundle/Tests/Twig/WebProfilerExtensionTest.php
@@ -15,8 +15,6 @@
 use Symfony\Bundle\WebProfilerBundle\Twig\WebProfilerExtension;
 use Symfony\Component\VarDumper\Cloner\VarCloner;
 use Twig\Environment;
-use Twig\Extension\CoreExtension;
-use Twig\Extension\EscaperExtension;
 
 class WebProfilerExtensionTest extends TestCase
 {
@@ -25,9 +23,6 @@ class WebProfilerExtensionTest extends TestCase
      */
     public function testDumpHeaderIsDisplayed(string $message, array $context, bool $dump1HasHeader, bool $dump2HasHeader)
     {
-        class_exists(CoreExtension::class); // Load twig_convert_encoding()
-        class_exists(EscaperExtension::class); // Load twig_escape_filter()
-
         $twigEnvironment = $this->mockTwigEnvironment();
         $varCloner = new VarCloner();
 
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Twig/WebProfilerExtension.php b/src/Symfony/Bundle/WebProfilerBundle/Twig/WebProfilerExtension.php
@@ -14,6 +14,7 @@
 use Symfony\Component\VarDumper\Cloner\Data;
 use Symfony\Component\VarDumper\Dumper\HtmlDumper;
 use Twig\Environment;
+use Twig\Extension\EscaperExtension;
 use Twig\Extension\ProfilerExtension;
 use Twig\Profiler\Profile;
 use Twig\TwigFunction;
@@ -60,9 +61,6 @@ public function leave(Profile $profile): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getFunctions(): array
     {
         return [
@@ -87,12 +85,12 @@ public function dumpData(Environment $env, Data $data, int $maxDepth = 0)
 
     public function dumpLog(Environment $env, string $message, Data $context = null)
     {
-        $message = twig_escape_filter($env, $message);
+        $message = self::escape($env, $message);
         $message = preg_replace('/&quot;(.*?)&quot;/', '&quot;<b>$1</b>&quot;', $message);
 
         $replacements = [];
         foreach ($context ?? [] as $k => $v) {
-            $k = '{'.twig_escape_filter($env, $k).'}';
+            $k = '{'.self::escape($env, $k).'}';
             if (str_contains($message, $k)) {
                 $replacements[$k] = $v;
             }
@@ -109,11 +107,18 @@ public function dumpLog(Environment $env, string $message, Data $context = null)
         return '<span class="dump-inline">'.strtr($message, $replacements).'</span>';
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName()
     {
         return 'profiler';
     }
+
+    private static function escape(Environment $env, string $s): string
+    {
+        if (method_exists(EscaperExtension::class, 'escape')) {
+            return EscaperExtension::escape($env, $s);
+        }
+
+        // to be removed when support for Twig 3 is dropped
+        return twig_escape_filter($env, $s);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Symfony\Component\VarDumper\Cloner\Data;`
`15`	`15`	`use Symfony\Component\VarDumper\Dumper\HtmlDumper;`
`16`	`16`	`use Twig\Environment;`
	`17`	`+use Twig\Extension\EscaperExtension;`
`17`	`18`	`use Twig\Extension\ProfilerExtension;`
`18`	`19`	`use Twig\Profiler\Profile;`
`19`	`20`	`use Twig\TwigFunction;`
`@@ -60,9 +61,6 @@ public function leave(Profile $profile): void`
`60`	`61`	`}`
`61`	`62`	`}`
`62`	`63`
`63`		`- /**`
`64`		`- * {@inheritdoc}`
`65`		`- */`
`66`	`64`	`public function getFunctions(): array`
`67`	`65`	`{`
`68`	`66`	`return [`
`@@ -87,12 +85,12 @@ public function dumpData(Environment $env, Data $data, int $maxDepth = 0)`
`87`	`85`
`88`	`86`	`public function dumpLog(Environment $env, string $message, Data $context = null)`
`89`	`87`	`{`
`90`		`- $message = twig_escape_filter($env, $message);`
	`88`	`+ $message = self::escape($env, $message);`
`91`	`89`	`$message = preg_replace('/"(.*?)"/', '"<b>$1</b>"', $message);`
`92`	`90`
`93`	`91`	`$replacements = [];`
`94`	`92`	`foreach ($context ?? [] as $k => $v) {`
`95`		`- $k = '{'.twig_escape_filter($env, $k).'}';`
	`93`	`+ $k = '{'.self::escape($env, $k).'}';`
`96`	`94`	`if (str_contains($message, $k)) {`
`97`	`95`	`$replacements[$k] = $v;`
`98`	`96`	`}`
`@@ -109,11 +107,18 @@ public function dumpLog(Environment $env, string $message, Data $context = null)`
`109`	`107`	`return '<span class="dump-inline">'.strtr($message, $replacements).'</span>';`
`110`	`108`	`}`
`111`	`109`
`112`		`- /**`
`113`		`- * {@inheritdoc}`
`114`		`- */`
`115`	`110`	`public function getName()`
`116`	`111`	`{`
`117`	`112`	`return 'profiler';`
`118`	`113`	`}`
	`114`	`+`
	`115`	`+ private static function escape(Environment $env, string $s): string`
	`116`	`+ {`
	`117`	`+ if (method_exists(EscaperExtension::class, 'escape')) {`
	`118`	`+ return EscaperExtension::escape($env, $s);`
	`119`	`+ }`
	`120`	`+`
	`121`	`+ // to be removed when support for Twig 3 is dropped`
	`122`	`+ return twig_escape_filter($env, $s);`
	`123`	`+ }`
`119`	`124`	`}`