Skip to content

[TwigBundle] Only remove kernel exception listener if twig is used #38350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2020
Merged

[TwigBundle] Only remove kernel exception listener if twig is used #38350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExceptionListenerPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,19 @@ public function process(ContainerBuilder $container)
// register the exception listener only if it's currently used, else use the provided by FrameworkBundle
if (null === $container->getParameter('twig.exception_listener.controller') && $container->hasDefinition('exception_listener')) {
$container->removeDefinition('twig.exception_listener');
} else {
$container->removeDefinition('exception_listener');

if ($container->hasParameter('templating.engines')) {
$engines = $container->getParameter('templating.engines');
if (!\in_array('twig', $engines, true)) {
$container->removeDefinition('twig.exception_listener');
}

return;
}

if ($container->hasParameter('templating.engines')) {
$engines = $container->getParameter('templating.engines');
if (\in_array('twig', $engines, true)) {
$container->removeDefinition('exception_listener');

return;
}
}

$container->removeDefinition('twig.exception_listener');
}
}
79 changes: 79 additions & 0 deletions ...ymfony/Bundle/TwigBundle/Tests/DependencyInjection/Compiler/ExceptionListenerPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace Symfony\Bundle\TwigBundle\Tests\DependencyInjection\Compiler;

use PHPUnit\Framework\TestCase;
use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\ExceptionListenerPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Security\Http\Firewall\ExceptionListener;
use Twig\Environment;

class ExceptionListenerPassTest extends TestCase
{
public function testExitsWhenTwigIsNotAvailable(): void
{
$builder = new ContainerBuilder();
$builder->register('exception_listener', ExceptionListener::class);
$builder->register('twig.exception_listener', ExceptionListener::class);

($pass = new ExceptionListenerPass())->process($builder);

$this->assertTrue($builder->hasDefinition('exception_listener'));
$this->assertTrue($builder->hasDefinition('twig.exception_listener'));
}

public function testRemovesTwigExceptionListenerWhenNoExceptionListenerControllerExists(): void
{
$builder = new ContainerBuilder();
$builder->register('twig', Environment::class);
$builder->register('exception_listener', ExceptionListener::class);
$builder->register('twig.exception_listener', ExceptionListener::class);
$builder->setParameter('twig.exception_listener.controller', null);

($pass = new ExceptionListenerPass())->process($builder);

$this->assertTrue($builder->hasDefinition('exception_listener'));
$this->assertFalse($builder->hasDefinition('twig.exception_listener'));
}

public function testRemovesTwigExceptionListenerIfTwigIsNotUsedAsTemplateEngine(): void
{
$builder = new ContainerBuilder();
$builder->register('twig', Environment::class);
$builder->register('exception_listener', ExceptionListener::class);
$builder->register('twig.exception_listener', ExceptionListener::class);
$builder->setParameter('twig.exception_listener.controller', 'exception_controller::showAction');
$builder->setParameter('templating.engines', ['php']);

($pass = new ExceptionListenerPass())->process($builder);

$this->assertTrue($builder->hasDefinition('exception_listener'));
$this->assertFalse($builder->hasDefinition('twig.exception_listener'));
}

public function testRemovesKernelExceptionListenerIfTwigIsUsedAsTemplateEngine(): void
{
$builder = new ContainerBuilder();
$builder->register('twig', Environment::class);
$builder->register('exception_listener', ExceptionListener::class);
$builder->register('twig.exception_listener', ExceptionListener::class);
$builder->setParameter('twig.exception_listener.controller', 'exception_controller::showAction');
$builder->setParameter('templating.engines', ['twig']);

($pass = new ExceptionListenerPass())->process($builder);

$this->assertFalse($builder->hasDefinition('exception_listener'));
$this->assertTrue($builder->hasDefinition('twig.exception_listener'));
}
}