vendor/sylius/sylius/src/Sylius/Bundle/CoreBundle/EventListener/CircularDependencyBreakingErrorListener.php line 71

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sylius package.
  5.  *
  6.  * (c) Paweł Jędrzejewski
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace Sylius\Bundle\CoreBundle\EventListener;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
  18. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  19. use Symfony\Component\HttpKernel\EventListener\ErrorListener;
  21. /**
  22.  * For Symfony 5+.
  23.  *
  24.  * `Symfony\Component\HttpKernel\EventListener\ErrorListener::onKernelException` happens to set previous
  25.  * exception for a wrapper exception. This is meant to improve DX while debugging nested exceptions,
  26.  * but also creates some issues.
  27.  *
  28.  * After upgrading to ResourceBundle v1.7 and GridBundle v1.8, the test suite started to fail
  29.  * because of a timeout. By artifically setting the previous exception, in some cases it created
  30.  * an exception with circular dependencies, so that:
  31.  *
  32.  *   `$exception->getPrevious()->getPrevious()->getPrevious() === $exception`
  33.  *
  34.  * That exception is rethrown and other listeners like `Symfony\Component\Security\Http\Firewall\ExceptionListener`
  35.  * try to deal with an exception and all their previous ones, causing infinite loops.
  36.  *
  37.  * This fix only works if "framework.templating" setting DOES NOT include "twig". Otherwise, TwigBundle
  38.  * registers deprecated `Symfony\Component\HttpKernel\EventListener\ExceptionListener`, removes the non-deprecated
  39.  * "exception_listener" service, so that the issue still persists.
  40.  *
  41.  * This listener behaves as a decorator, but also extends the original ErrorListener, because of yet another
  42.  * listener `ApiPlatform\Core\EventListener\ExceptionListener` requires the original class.
  43.  *
  44.  * @internal
  45.  *
  46.  * @see \Symfony\Component\HttpKernel\EventListener\ErrorListener
  47.  */
  48. final class CircularDependencyBreakingErrorListener extends ErrorListener
  49. {
  50.     public function __construct(private ErrorListener $decoratedListener)
  51.     {
  52.     }
  54.     public function logKernelException(ExceptionEvent $event): void
  55.     {
  56.         $this->decoratedListener->logKernelException($event);
  57.     }
  59.     public function onKernelException(ExceptionEvent $event, string $eventName = null, EventDispatcherInterface $eventDispatcher = null): void
  60.     {
  61.         try {
  62.             /** @psalm-suppress TooManyArguments */
  63.             $this->decoratedListener->onKernelException($event, $eventName, $eventDispatcher);
  64.         } catch (\Throwable $throwable) {
  65.             $this->breakCircularDependency($throwable);
  67.             throw $throwable;
  68.         }
  69.     }
  71.     public function onControllerArguments(ControllerArgumentsEvent $event): void
  72.     {
  73.         $this->decoratedListener->onControllerArguments($event);
  74.     }
  76.     private function breakCircularDependency(\Throwable $throwable): void
  77.     {
  78.         $throwables = [];
  80.         do {
  81.             $throwables[] = $throwable;
  83.             if (in_array($throwable->getPrevious(), $throwables, true)) {
  84.                 $this->removePreviousFromThrowable($throwable);
  85.             }
  87.             $throwable = $throwable->getPrevious();
  88.         } while (null !== $throwable);
  89.     }
  91.     private function removePreviousFromThrowable(\Throwable $throwable): void
  92.     {
  93.         $previous = new \ReflectionProperty($throwable instanceof \Exception ? \Exception::class : \Error::class, 'previous');
  94.         $previous->setAccessible(true);
  95.         $previous->setValue($throwable, null);
  96.     }
  97. }