[TwigBundle] Improve error when autoconfiguring a class with both `ExtensionInterface` and Twig callable attribute #60415

GromNaN · 2025-05-13T21:11:09Z

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

Reported by Javier:

I'm updating Twig extensions to use the #[AsTwig...] attributes. I removed the getFunctions() method and had this:
class FooExtension extends AbstractExtension
{
    #[AsTwigFunction('name_of_function')]
    public function foo(): string
    {
        // ...
    }
}
Then I saw this exception: Unable to register extension "App\Twig\FooExtension" as it is already registered.
My error is that I forgot to remove extends AbstractExtension
But I think that Symfony's error exception should be more helpful. A quick example of something that could've helped me: "When using the AsTwigFunction attribute, your Twig extension cannot extend AbstractExtension"

The ExtensionSet exception is thrown because the same an extension is registered twice:

It has the twig.extension tag autoconfigured because it implements Twig\Extension\ExtensionInterface
An AttributeExtension is registered for this class because it as one of the extension attributes (since [TwigBundle] Enable #[AsTwigFilter], #[AsTwigFunction] and #[AsTwigTest] attributes to configure runtime extensions #52748)

Previous exception when twig service is instanciated:

LogicException : Unable to register extension "Symfony\Bundle\TwigBundle\Tests\Functional\InvalidExtensionWithAttributes" as it is already registered.

New exception during container compilation:

Symfony\Component\DependencyInjection\Exception\LogicException : The class "Symfony\Bundle\TwigBundle\Tests\Functional\InvalidExtensionWithAttributes" cannot both extend "Twig\Extension\AbstractExtension" and use the "#[Twig\Attribute\AsTwigFilter]" attribute on method "funFilter()", choose one or the other.

Checking AbstractExtension makes the error message more specific to the code, as most extensions extend this class and doesn't implement the interface directly.

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php

javiereguiluz

Thanks a lot!

nicolas-grekas

just minor cs stuff

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php

src/Symfony/Bundle/TwigBundle/Tests/Functional/AttributeExtensionTest.php

GromNaN · 2025-05-14T09:02:31Z

minor cs stuff

Fixed.

OskarStark · 2025-05-14T11:21:54Z

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php

+        $class = $reflector->getDeclaringClass();
+        if ($class->implementsInterface(ExtensionInterface::class)) {
+            if ($class->isSubclassOf(AbstractExtension::class)) {
+                throw new LogicException(\sprintf('The class "%s" cannot both extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));


Suggested change

throw new LogicException(\sprintf('The class "%s" cannot both extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));

throw new LogicException(\sprintf('The class "%s" cannot extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));

OskarStark · 2025-05-14T11:22:10Z

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php

+            if ($class->isSubclassOf(AbstractExtension::class)) {
+                throw new LogicException(\sprintf('The class "%s" cannot both extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));
+            }
+            throw new LogicException(\sprintf('The class "%s" cannot both implement "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, ExtensionInterface::class, $attribute::class, $reflector->name));


Suggested change

throw new LogicException(\sprintf('The class "%s" cannot both implement "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, ExtensionInterface::class, $attribute::class, $reflector->name));

throw new LogicException(\sprintf('The class "%s" cannot implement "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, ExtensionInterface::class, $attribute::class, $reflector->name));

suggested it in #60415 (comment) :) what's wrong with it?

stof · 2025-05-14T11:31:24Z

src/Symfony/Bundle/TwigBundle/Tests/Functional/AttributeExtensionTest.php

 use Twig\Extension\AttributeExtension;

 class AttributeExtensionTest extends TestCase
 {
-    public function testExtensionWithAttributes()
+    /** @beforeClass */


Please also add the PHPUnit attribute, to be compatible with PHPUnit 11

Good idea, attribute added.

I've also seen the pre condition attributes, but none of them can check a composer package version or if a class exists: https://docs.phpunit.de/en/10.5/writing-tests-for-phpunit.html#skipping-tests-using-attributes

Looks weird that they don't have a RequiresClass attribute (and probably RequiresInterface). It would look consistent with the other attributes they have.

…ensionInterface and Twig callable attribute

nicolas-grekas · 2025-05-14T13:17:48Z

Thank you @GromNaN.

PhilETaylor · 2025-05-14T13:22:21Z

Just came here while researching an error on cache:warmup after moving to AsTwigFilter

Twig\Environment::addExtension(): Argument #1 ($extension) must be of type Twig\Extension\ExtensionInterface, MyJoomla\Twig\Extension\Anon given, called in /app/var/build/ContainerN7Q6vq6/App_KernelProdContainer.php on line 20408

Where MyJoomla\Twig\Extension\Anon is just

class Anon
{
    private int $anonTagIndex = 0;

    public function __construct(
        private readonly Client $client,
    ) {
    }

    #[AsTwigFilter(name: 'anon')]
    public function anon(?string $string = '', string $type = ''): string
    {
// snip
}
}

Running BETA2 in production ;-) I cant replicate it locally in dev

GromNaN · 2025-05-14T13:25:35Z

@PhilETaylor it looks like a cache issue. If you updated the class without rebuilding the container, this error is expected. On production, the cache is not automatically rebuilt when a file is modified. You should run APP_ENV=prod bin/console cache:clear.

PhilETaylor · 2025-05-14T13:27:43Z

prod is a docker container built from scratch each deploy, the build folder should be empty on deployment. I think my issue might be a shared redis cache... ignore me, I know Im at the bleeding edge here, and not looking for support, but hoping by testing the beta's to find real issues for you : )

GromNaN requested a review from yceruto as a code owner May 13, 2025 21:11

carsonbot added Status: Needs Review TwigBundle labels May 13, 2025

carsonbot added this to the 7.3 milestone May 13, 2025

chalasr reviewed May 13, 2025

View reviewed changes

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php Outdated Show resolved Hide resolved

GromNaN force-pushed the twig-attribute-error branch from a05c57b to 83f0f07 Compare May 14, 2025 07:26

javiereguiluz approved these changes May 14, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 14, 2025

nicolas-grekas approved these changes May 14, 2025

View reviewed changes

src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/AttributeExtensionPass.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/TwigBundle/Tests/Functional/AttributeExtensionTest.php Outdated Show resolved Hide resolved

GromNaN force-pushed the twig-attribute-error branch from 83f0f07 to 2abcc87 Compare May 14, 2025 09:02

OskarStark approved these changes May 14, 2025

View reviewed changes

OskarStark reviewed May 14, 2025

View reviewed changes

stof reviewed May 14, 2025

View reviewed changes

[TwigBundle] Improve error when autoconfiguring a class with both Ext…

752b41d

…ensionInterface and Twig callable attribute

nicolas-grekas merged commit 170b631 into symfony:7.3 May 14, 2025
10 of 11 checks passed

GromNaN deleted the twig-attribute-error branch May 14, 2025 13:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TwigBundle] Improve error when autoconfiguring a class with both `ExtensionInterface` and Twig callable attribute #60415

[TwigBundle] Improve error when autoconfiguring a class with both `ExtensionInterface` and Twig callable attribute #60415

	throw new LogicException(\sprintf('The class "%s" cannot both extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));
	throw new LogicException(\sprintf('The class "%s" cannot extend "%s" and use the "#[%s]" attribute on method "%s()", choose one or the other.', $class->name, AbstractExtension::class, $attribute::class, $reflector->name));

[TwigBundle] Improve error when autoconfiguring a class with both ExtensionInterface and Twig callable attribute #60415

[TwigBundle] Improve error when autoconfiguring a class with both ExtensionInterface and Twig callable attribute #60415

Conversation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[TwigBundle] Improve error when autoconfiguring a class with both `ExtensionInterface` and Twig callable attribute #60415

[TwigBundle] Improve error when autoconfiguring a class with both `ExtensionInterface` and Twig callable attribute #60415