src/Framework/EventListener/APIExceptionEventListener.php line 22

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace App\Framework\EventListener;
  5. use App\Framework\Exception\APIException;
  6. use App\Framework\Exception\AssertionException;
  7. use App\Framework\Exception\TalloException;
  8. use Doctrine\ORM\EntityNotFoundException;
  9. use Symfony\Component\HttpFoundation\JsonResponse;
  10. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  11. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  13. class APIExceptionEventListener
  14. {
  15.     private string $env;
  17.     public function __construct(string $env)
  18.     {
  19.         $this->env = $env;
  20.     }
  22.     public function onException(ExceptionEvent $event): void
  23.     {
  24.         $debug = true;
  26.         // TODO: Any exception that is not a user-facing error should be logged and not sent in production environment!!!!
  28.         // Only intercept requests that are accepting json as response
  29.         $request = $event->getRequest();
  30.         if (!in_array('application/json', $request->getAcceptableContentTypes(), true)) {
  31.             return;
  32.         }
  34.         $statusCode = 500;
  35.         $result = [];
  36.         $exception = $event->getThrowable();
  38.         // Handle API Exceptions more gracefully, as 400 (Client errors)
  39.         if ($exception instanceof APIException) {
  40.             $statusCode = 400;
  41.             $result = [
  42.                 'type' => $exception->getMessage(),
  43.                 'errors' => $exception->getErrors(),
  44.             ];
  45.             if ($debug) {
  46.                 $result['debug'] = $exception->getDebugData();
  47.             }
  48.         } elseif ($exception instanceof EntityNotFoundException) {
  49.             $statusCode = 400;
  50.             $result = [
  51.                 'code' => 'error.entity.notfound',
  52.                 'message' => $exception->getMessage(),
  53.             ];
  54.         } elseif ($exception instanceof AssertionException) {
  55.             $statusCode = 500;
  56.             $result = [
  57.                 'type' => 'assert.failed',
  58.                 'errors' => $exception->getErrors(),
  59.             ];
  60.         } elseif ($exception instanceof AccessDeniedHttpException) {
  61.             $statusCode = 403;
  62.             $result = [
  63.                 'type' => 'error',
  64.                 'code' => 'error.authorization.rejected',
  65.                 'message' => $exception->getCode(),
  66.                 'errors' => $exception->getMessage(),
  67.             ];
  68.         } elseif ($exception instanceof TalloException) {
  69.             $statusCode = 400;
  70.             $result = [
  71.                 'type' => 'error',
  72.                 'code' => $exception->getCode(),
  73.                 'message' => $exception->getCode(),
  74.                 'errors' => $exception->getErrors(),
  75.             ];
  76.         } else {
  77.             // DEBUG mode?
  78.             $statusCode = 500;
  79.             $result = [
  80.                 'type' => 'Error',
  81.                 'code' => $exception->getCode(),
  82.                 'message' => $exception->getMessage(),
  83.             ];
  84.         }
  86.         // Add the stack trace in debug
  87.         if ($this->env === 'dev') {
  88.             $result['trace'] = $exception->getTraceAsString();
  89.         }
  91.         $response = new JsonResponse($result, $statusCode);
  92.         $response->setEncodingOptions(JSON_UNESCAPED_UNICODE);
  93.         $event->setResponse($response);
  94.     }
  95. }