bug #48451 [Translation] Fix extraction when dealing with VariadicPlaceholder parameters (Kocal)

nicolas-grekas · nicolas-grekas · commit b000c05bd675 · 2022-12-13T16:35:55.000+01:00
This PR was merged into the 6.2 branch. Discussion ---------- [Translation] Fix extraction when dealing with VariadicPlaceholder parameters | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #48422  | License | MIT | Doc PR | symfony/symfony-docs#...  I don't have the time for now to check if the command has tests or not, but dealing with raw args with + filtering for `Node\Arg` instance make the `extract` command working again. The issue is "caused by" https://github.com/symfony/symfony/blob/6.3/src/Symfony/Bridge/Twig/Extension/TranslationExtension.php#L71, the extract command is not able to deal with VariadicPlaceholder node. Changing to `[$this, 'trans']` works, but this is not the wanted solution. **Before:** ``` symfony console translation:extract fr --force -vvv Translation Messages Extractor and Dumper ========================================= // Generating "fr" translation files for "default directory" // Parsing templates... In CallLike.php line 36: [AssertionError (1)] assert(!$this->isFirstClassCallable()) Exception trace: at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/Node/Expr/CallLike.php:36 assert() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/Node/Expr/CallLike.php:36 PhpParser\Node\Expr\CallLike->getArgs() at /Users/kocal/workspace/chronos/vendor/symfony/translation/Extractor/Visitor/AbstractVisitor.php:66 Symfony\Component\Translation\Extractor\Visitor\AbstractVisitor->hasNodeNamedArguments() at /Users/kocal/workspace/chronos/vendor/symfony/translation/Extractor/Visitor/TransMethodVisitor.php:40 Symfony\Component\Translation\Extractor\Visitor\TransMethodVisitor->enterNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:123 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:114 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:146 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:114 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:146 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:114 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:114 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:114 PhpParser\NodeTraverser->traverseNode() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:223 PhpParser\NodeTraverser->traverseArray() at /Users/kocal/workspace/chronos/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php:91 PhpParser\NodeTraverser->traverse() at /Users/kocal/workspace/chronos/vendor/symfony/translation/Extractor/PhpAstExtractor.php:56 Symfony\Component\Translation\Extractor\PhpAstExtractor->extract() at /Users/kocal/workspace/chronos/vendor/symfony/translation/Extractor/ChainExtractor.php:48 Symfony\Component\Translation\Extractor\ChainExtractor->extract() at /Users/kocal/workspace/chronos/vendor/symfony/framework-bundle/Command/TranslationUpdateCommand.php:395 Symfony\Bundle\FrameworkBundle\Command\TranslationUpdateCommand->extractMessages() at /Users/kocal/workspace/chronos/vendor/symfony/framework-bundle/Command/TranslationUpdateCommand.php:200 Symfony\Bundle\FrameworkBundle\Command\TranslationUpdateCommand->execute() at /Users/kocal/workspace/chronos/vendor/symfony/console/Command/Command.php:312 Symfony\Component\Console\Command\Command->run() at /Users/kocal/workspace/chronos/vendor/symfony/console/Application.php:1038 Symfony\Component\Console\Application->doRunCommand() at /Users/kocal/workspace/chronos/vendor/symfony/framework-bundle/Console/Application.php:88 Symfony\Bundle\FrameworkBundle\Console\Application->doRunCommand() at /Users/kocal/workspace/chronos/vendor/symfony/console/Application.php:312 Symfony\Component\Console\Application->doRun() at /Users/kocal/workspace/chronos/vendor/symfony/framework-bundle/Console/Application.php:77 Symfony\Bundle\FrameworkBundle\Console\Application->doRun() at /Users/kocal/workspace/chronos/vendor/symfony/console/Application.php:168 Symfony\Component\Console\Application->run() at /Users/kocal/workspace/chronos/vendor/symfony/runtime/Runner/Symfony/ConsoleApplicationRunner.php:54 Symfony\Component\Runtime\Runner\Symfony\ConsoleApplicationRunner->run() at /Users/kocal/workspace/chronos/vendor/autoload_runtime.php:29 ``` **After:** ``` symfony console translation:extract fr --force -vvv Translation Messages Extractor and Dumper ========================================= // Generating "fr" translation files for "default directory" // Parsing templates... // Loading translation files... // Writing files... [OK] Translation files were successfully updated. ``` Commits ------- 2030c26 [Translation] Fix extraction when dealing with VariadicPlaceholder parameters
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php
@@ -42,32 +42,31 @@ protected function addMessageToCatalogue(string $message, ?string $domain, int $
 
     protected function getStringArguments(Node\Expr\CallLike|Node\Attribute|Node\Expr\New_ $node, int|string $index, bool $indexIsRegex = false): array
     {
-        $args = $node instanceof Node\Expr\CallLike ? $node->getArgs() : $node->args;
-
         if (\is_string($index)) {
             return $this->getStringNamedArguments($node, $index, $indexIsRegex);
         }
 
+        $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;
+
         if (\count($args) < $index) {
             return [];
         }
 
-        /** @var Node\Arg $arg */
-        $arg = $args[$index];
-        if (!$result = $this->getStringValue($arg->value)) {
-            return [];
+        if (($arg = $args[$index]) instanceof Node\Arg) {
+            if ($result = $this->getStringValue($arg->value)) {
+                return [$result];
+            }
         }
 
-        return [$result];
+        return [];
     }
 
     protected function hasNodeNamedArguments(Node\Expr\CallLike|Node\Attribute|Node\Expr\New_ $node): bool
     {
-        $args = $node instanceof Node\Expr\CallLike ? $node->getArgs() : $node->args;
+        $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;
 
-        /** @var Node\Arg $arg */
         foreach ($args as $arg) {
-            if (null !== $arg->name) {
+            if ($arg instanceof Node\Arg && null !== $arg->name) {
                 return true;
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -42,32 +42,31 @@ protected function addMessageToCatalogue(string $message, ?string $domain, int $`
`42`	`42`
`43`	`43`	`protected function getStringArguments(Node\Expr\CallLike\|Node\Attribute\|Node\Expr\New_ $node, int\|string $index, bool $indexIsRegex = false): array`
`44`	`44`	`{`
`45`		`- $args = $node instanceof Node\Expr\CallLike ? $node->getArgs() : $node->args;`
`46`		`-`
`47`	`45`	`if (\is_string($index)) {`
`48`	`46`	`return $this->getStringNamedArguments($node, $index, $indexIsRegex);`
`49`	`47`	`}`
`50`	`48`
	`49`	`+ $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;`
	`50`	`+`
`51`	`51`	`if (\count($args) < $index) {`
`52`	`52`	`return [];`
`53`	`53`	`}`
`54`	`54`
`55`		`- /** @var Node\Arg $arg */`
`56`		`- $arg = $args[$index];`
`57`		`- if (!$result = $this->getStringValue($arg->value)) {`
`58`		`- return [];`
	`55`	`+ if (($arg = $args[$index]) instanceof Node\Arg) {`
	`56`	`+ if ($result = $this->getStringValue($arg->value)) {`
	`57`	`+ return [$result];`
	`58`	`+ }`
`59`	`59`	`}`
`60`	`60`
`61`		`- return [$result];`
	`61`	`+ return [];`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`protected function hasNodeNamedArguments(Node\Expr\CallLike\|Node\Attribute\|Node\Expr\New_ $node): bool`
`65`	`65`	`{`
`66`		`- $args = $node instanceof Node\Expr\CallLike ? $node->getArgs() : $node->args;`
	`66`	`+ $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;`
`67`	`67`
`68`		`- /** @var Node\Arg $arg */`
`69`	`68`	`foreach ($args as $arg) {`
`70`		`- if (null !== $arg->name) {`
	`69`	`+ if ($arg instanceof Node\Arg && null !== $arg->name) {`
`71`	`70`	`return true;`
`72`	`71`	`}`
`73`	`72`	`}`