Trigger the macro parentheses deprecation only once, at parse time

Author: fabpot

CHANGELOG

@@ -7,7 +7,6 @@
  * Fix duplicated macro argument names triggering a PHP fatal error instead of a `SyntaxError`
  * Deprecate defining a macro more than once in the same template
  * Deprecate `TemplateVariable` and `AssignTemplateVariable`; use `MacroVariable` and `AssignMacroVariable` instead
- * Deprecate omitting parentheses when calling a macro; it will throw a `SyntaxError` in 4.0
  * Deprecate calling or testing a macro with a name whose case differs from its definition; macro names will be case-sensitive in 4.0
  * Deprecate omitting parentheses when calling or testing a macro; it will throw a `SyntaxError` in 4.0
  * Deprecate calling a macro without a value for an argument that has no default value; the argument will be required in 4.0

doc/deprecated.rst

@@ -324,12 +324,6 @@ Macros
   3.29 and will throw a ``SyntaxError`` in Twig 4.0. Give each macro a unique
   name.
 
-* Omitting parentheses when calling a macro (e.g. ``macros.input`` or
-  ``macros.(name)``) is deprecated as of Twig 3.29 and will throw a
-  ``SyntaxError`` in Twig 4.0. Add parentheses after the macro name (e.g.
-  ``macros.input()`` or ``macros.(name)()``). Parentheses remain optional when
-  testing whether a macro is defined.
-
 * Passing more arguments to a macro than it declares is deprecated as of Twig
   3.29 and will throw in Twig 4.0. Declare an explicit variadic argument
   (``{% macro foo(a, ...rest) %}``) to accept extra positional and named

src/ExpressionParser/Infix/DotExpressionParser.php

@@ -73,14 +73,12 @@ public function parse(Parser $parser, AbstractExpression $expr, Token $token): A
 
         if ($isMacroTarget) {
             if (Template::METHOD_CALL !== $type) {
-                trigger_deprecation('twig/twig', '3.29', 'Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.');
+                trigger_deprecation('twig/twig', '3.29', 'Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "%s" at line %d.', $stream->getSourceContext()->getName(), $expr->getTemplateLine());
             }
 
             $name = $attribute instanceof ConstantExpression ? (string) $attribute->getAttribute('value') : $attribute;
-            $node = new MacroReferenceExpression(new MacroVariable($expr->getAttribute('name'), $expr->getTemplateLine()), $name, $arguments, $expr->getTemplateLine());
-            $node->setHasParentheses(Template::METHOD_CALL === $type);
 
-            return $node;
+            return new MacroReferenceExpression(new MacroVariable($expr->getAttribute('name'), $expr->getTemplateLine()), $name, $arguments, $expr->getTemplateLine());
         }
 
         return new GetAttrExpression($expr, $attribute, $arguments, $type, $lineno, $nullSafe);

src/Node/Expression/MacroReferenceExpression.php

@@ -25,8 +25,6 @@ class MacroReferenceExpression extends AbstractExpression implements SupportDefi
     use SupportDefinedTestDeprecationTrait;
     use SupportDefinedTestTrait;
 
-    private bool $hasParentheses = true;
-
     /**
      * @param string|AbstractExpression $name The bare macro name (a static identifier) or, for a dynamic
      *                                        call, an expression resolving to the macro name
@@ -45,14 +43,6 @@ public function __construct(MacroVariable $template, string|AbstractExpression $
         parent::__construct($nodes, $attributes, $lineno);
     }
 
-    /**
-     * @internal
-     */
-    public function setHasParentheses(bool $hasParentheses): void
-    {
-        $this->hasParentheses = $hasParentheses;
-    }
-
     public function __clone()
     {
         // The template node must not be deep-cloned because its name is
@@ -65,10 +55,6 @@ public function __clone()
 
     public function compile(Compiler $compiler): void
     {
-        if (!$this->hasParentheses && !$this->definedTest) {
-            trigger_deprecation('twig/twig', '3.29', 'Omitting parentheses when calling a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "%s" at line %d.', $this->getTemplateName(), $this->getTemplateLine());
-        }
-
         $compiler->subcompile($this->getNode('template'));
 
         if ($this->definedTest) {

tests/Extension/SandboxTest.php

@@ -1250,7 +1250,7 @@ public function testMacrosInASandbox(): void
 
     public function testSelfMacroReferenceWithStringLiteralDoesNotInjectPhp(): void
     {
-        $twig = $this->getEnvironment(true, [], ['index' => '{{ _self.(\'foo + 1; trigger_error("BAD-MACRO-REF") //\') }}']);
+        $twig = $this->getEnvironment(true, [], ['index' => '{{ _self.(\'foo + 1; trigger_error("BAD-MACRO-REF") //\')() }}']);
 
         $compiled = $twig->compileSource($twig->getLoader()->getSourceContext('index'));
         $this->assertStringNotContainsString('trigger_error("BAD-MACRO-REF")', $compiled, 'Attacker-controlled string must not appear raw in compiled PHP source.');
@@ -1278,7 +1278,7 @@ public function testSelfMacroReferenceWithStringLiteralDoesNotInjectPhp(): void
 
     public function testImportedTemplateMacroReferenceWithBadIdentifierDoesNotInjectPhp(): void
     {
-        $payload = '{% import "m" as m %}{{ m.(\'foo + 1; trigger_error("BAD-IMPORT-REF") //\') }}';
+        $payload = '{% import "m" as m %}{{ m.(\'foo + 1; trigger_error("BAD-IMPORT-REF") //\')() }}';
         $twig = $this->getEnvironment(true, [], [
             'index' => $payload,
             'm' => '{% macro greet() %}hi{% endmacro %}',

tests/Fixtures/macros/call_without_parentheses.legacy.test

@@ -1,8 +1,8 @@
 --TEST--
 Omitting parentheses when calling macros is deprecated
 --DEPRECATION--
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 4.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 5.
 --TEMPLATE--
 {% import _self as macros %}
 {% set name = 'hello' %}

tests/Fixtures/tests/defined_for_macros_dynamic_name_without_parentheses.legacy.test

@@ -1,8 +1,8 @@
 --TEST--
 Omitting parentheses when testing dynamic macro names is deprecated
 --DEPRECATION--
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 5.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 6.
 --TEMPLATE--
 {% import _self as macros %}
 {% set known = 'hello' %}

tests/Fixtures/tests/defined_for_macros_without_parentheses.legacy.test

@@ -1,8 +1,8 @@
 --TEST--
 Omitting parentheses when testing static macro names is deprecated
 --DEPRECATION--
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
-Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 3.
+Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index.twig" at line 4.
 --TEMPLATE--
 {% import _self as macros %}
 {{ macros.hello is defined ? 'OK' : 'KO' }}

tests/ParserTest.php

@@ -157,7 +157,7 @@ public function testMacroTargetsWithoutParenthesesAreDeprecated(string $expressi
     {
         $twig = new Environment(new ArrayLoader());
 
-        $this->expectDeprecation('Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name.');
+        $this->expectDeprecation('Since twig/twig 3.29: Omitting parentheses when calling or testing a macro is deprecated and will throw a SyntaxError in Twig 4.0; add parentheses after the macro name in "index" at line 1.');
 
         $module = $twig->parse($twig->tokenize(new Source("{% import _self as macros %}{{ $expression }}", 'index')));
         $macroReferences = [];