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

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.     private ErrorListener $decoratedListener;
  52.     public function __construct(ErrorListener $decoratedListener)
  53.     {
  54.         $this->decoratedListener = $decoratedListener;
  55.     }
  57.     public function logKernelException(ExceptionEvent $event): void
  58.     {
  59.         $this->decoratedListener->logKernelException($event);
  60.     }
  62.     public function onKernelException(ExceptionEvent $event, string $eventName = null, EventDispatcherInterface $eventDispatcher = null): void
  63.     {
  64.         try {
  65.             /** @psalm-suppress TooManyArguments */
  66.             $this->decoratedListener->onKernelException($event, $eventName, $eventDispatcher);
  67.         } catch (\Throwable $throwable) {
  68.             $this->breakCircularDependency($throwable);
  70.             throw $throwable;
  71.         }
  72.     }
  74.     public function onControllerArguments(ControllerArgumentsEvent $event): void
  75.     {
  76.         $this->decoratedListener->onControllerArguments($event);
  77.     }
  79.     private function breakCircularDependency(\Throwable $throwable): void
  80.     {
  81.         $throwables = [];
  83.         do {
  84.             $throwables[] = $throwable;
  86.             if (in_array($throwable->getPrevious(), $throwables, true)) {
  87.                 $this->removePreviousFromThrowable($throwable);
  88.             }
  90.             $throwable = $throwable->getPrevious();
  91.         } while (null !== $throwable);
  92.     }
  94.     private function removePreviousFromThrowable(\Throwable $throwable): void
  95.     {
  96.         $previous = new \ReflectionProperty($throwable instanceof \Exception ? \Exception::class : \Error::class, 'previous');
  97.         $previous->setAccessible(true);
  98.         $previous->setValue($throwable, null);
  99.     }
  100. }