[HttpKernel] Add HttpException::fromStatusCode()

nicolas-grekas · nicolas-grekas · commit 5a7ca920cf8c · 2023-12-26T11:36:50.000+01:00
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add method `isKernelTerminating()` to `ExceptionEvent` that allows to check if an exception was thrown while the kernel is being terminated
+ * Add `HttpException::fromStatusCode()`
 
 7.0
 ---
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php
@@ -13,13 +13,14 @@
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Attribute\MapQueryString;
 use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Serializer\Exception\NotEncodableValueException;
 use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
@@ -124,21 +125,21 @@ public function onKernelControllerArguments(ControllerArgumentsEvent $event): vo
                 }
 
                 if (\count($violations)) {
-                    throw new HttpException($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), iterator_to_array($violations))), new ValidationFailedException($payload, $violations));
+                    throw HttpException::fromStatusCode($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), iterator_to_array($violations))), new ValidationFailedException($payload, $violations));
                 }
             } else {
                 try {
                     $payload = $this->$payloadMapper($request, $type, $argument);
                 } catch (PartialDenormalizationException $e) {
-                    throw new HttpException($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), $e->getErrors())), $e);
+                    throw HttpException::fromStatusCode($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), $e->getErrors())), $e);
                 }
             }
 
             if (null === $payload) {
                 $payload = match (true) {
                     $argument->metadata->hasDefaultValue() => $argument->metadata->getDefaultValue(),
                     $argument->metadata->isNullable() => null,
-                    default => throw new HttpException($validationFailedCode)
+                    default => throw HttpException::fromStatusCode($validationFailedCode)
                 };
             }
 
@@ -167,11 +168,11 @@ private function mapQueryString(Request $request, string $type, MapQueryString $
     private function mapRequestPayload(Request $request, string $type, MapRequestPayload $attribute): ?object
     {
         if (null === $format = $request->getContentTypeFormat()) {
-            throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, 'Unsupported format.');
+            throw new UnsupportedMediaTypeHttpException('Unsupported format.');
         }
 
         if ($attribute->acceptFormat && !\in_array($format, (array) $attribute->acceptFormat, true)) {
-            throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, sprintf('Unsupported format, expects "%s", but "%s" given.', implode('", "', (array) $attribute->acceptFormat), $format));
+            throw new UnsupportedMediaTypeHttpException(sprintf('Unsupported format, expects "%s", but "%s" given.', implode('", "', (array) $attribute->acceptFormat), $format));
         }
 
         if ($data = $request->request->all()) {
@@ -183,15 +184,15 @@ private function mapRequestPayload(Request $request, string $type, MapRequestPay
         }
 
         if ('form' === $format) {
-            throw new HttpException(Response::HTTP_BAD_REQUEST, 'Request payload contains invalid "form" data.');
+            throw new BadRequestHttpException('Request payload contains invalid "form" data.');
         }
 
         try {
             return $this->serializer->deserialize($data, $type, $format, self::CONTEXT_DESERIALIZE + $attribute->serializationContext);
         } catch (UnsupportedFormatException $e) {
-            throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, sprintf('Unsupported format: "%s".', $format), $e);
+            throw new UnsupportedMediaTypeHttpException(sprintf('Unsupported format: "%s".', $format), $e);
         } catch (NotEncodableValueException $e) {
-            throw new HttpException(Response::HTTP_BAD_REQUEST, sprintf('Request payload contains invalid "%s" data.', $format), $e);
+            throw new BadRequestHttpException(sprintf('Request payload contains invalid "%s" data.', $format), $e);
         }
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php b/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php
@@ -63,7 +63,7 @@ public function logKernelException(ExceptionEvent $event): void
             }
             if (!$throwable instanceof HttpExceptionInterface || $throwable->getStatusCode() !== $config['status_code']) {
                 $headers = $throwable instanceof HttpExceptionInterface ? $throwable->getHeaders() : [];
-                $throwable = new HttpException($config['status_code'], $throwable->getMessage(), $throwable, $headers);
+                $throwable = HttpException::fromStatusCode($config['status_code'], $throwable->getMessage(), $throwable, $headers);
                 $event->setThrowable($throwable);
             }
             break;
@@ -78,7 +78,7 @@ public function logKernelException(ExceptionEvent $event): void
                     /** @var WithHttpStatus $instance */
                     $instance = $attributes[0]->newInstance();
 
-                    $throwable = new HttpException($instance->statusCode, $throwable->getMessage(), $throwable, $instance->headers);
+                    $throwable = HttpException::fromStatusCode($instance->statusCode, $throwable->getMessage(), $throwable, $instance->headers);
                     $event->setThrowable($throwable);
                     break;
                 }
diff --git a/src/Symfony/Component/HttpKernel/Exception/HttpException.php b/src/Symfony/Component/HttpKernel/Exception/HttpException.php
@@ -29,6 +29,27 @@ public function __construct(int $statusCode, string $message = '', \Throwable $p
         parent::__construct($message, $code, $previous);
     }
 
+    public static function fromStatusCode(int $statusCode, string $message = '', \Throwable $previous = null, array $headers = [], int $code = 0): self
+    {
+        return match ($statusCode) {
+            400 => new BadRequestHttpException($message, $previous, $code, $headers),
+            403 => new AccessDeniedHttpException($message, $previous, $code, $headers),
+            404 => new NotFoundHttpException($message, $previous, $code, $headers),
+            406 => new NotAcceptableHttpException($message, $previous, $code, $headers),
+            409 => new ConflictHttpException($message, $previous, $code, $headers),
+            410 => new GoneHttpException($message, $previous, $code, $headers),
+            411 => new LengthRequiredHttpException($message, $previous, $code, $headers),
+            412 => new PreconditionFailedHttpException($message, $previous, $code, $headers),
+            423 => new LockedHttpException($message, $previous, $code, $headers),
+            415 => new UnsupportedMediaTypeHttpException($message, $previous, $code, $headers),
+            422 => new UnprocessableEntityHttpException($message, $previous, $code, $headers),
+            428 => new PreconditionRequiredHttpException($message, $previous, $code, $headers),
+            429 => new TooManyRequestsHttpException(null, $message, $previous, $code, $headers),
+            503 => new ServiceUnavailableHttpException(null, $message, $previous, $code, $headers),
+            default => new static($statusCode, $message, $previous, $headers, $code),
+        };
+    }
+
     public function getStatusCode(): int
     {
         return $this->statusCode;

Original file line number	Diff line number	Diff line change
`@@ -13,13 +13,14 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`15`	`15`	`use Symfony\Component\HttpFoundation\Request;`
`16`		`-use Symfony\Component\HttpFoundation\Response;`
`17`	`16`	`use Symfony\Component\HttpKernel\Attribute\MapQueryString;`
`18`	`17`	`use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;`
`19`	`18`	`use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;`
`20`	`19`	`use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;`
`21`	`20`	`use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;`
	`21`	`+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;`
`22`	`22`	`use Symfony\Component\HttpKernel\Exception\HttpException;`
	`23`	`+use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;`
`23`	`24`	`use Symfony\Component\HttpKernel\KernelEvents;`
`24`	`25`	`use Symfony\Component\Serializer\Exception\NotEncodableValueException;`
`25`	`26`	`use Symfony\Component\Serializer\Exception\PartialDenormalizationException;`
`@@ -124,21 +125,21 @@ public function onKernelControllerArguments(ControllerArgumentsEvent $event): vo`
`124`	`125`	`}`
`125`	`126`
`126`	`127`	`if (\count($violations)) {`
`127`		`- throw new HttpException($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), iterator_to_array($violations))), new ValidationFailedException($payload, $violations));`
	`128`	`+ throw HttpException::fromStatusCode($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), iterator_to_array($violations))), new ValidationFailedException($payload, $violations));`
`128`	`129`	`}`
`129`	`130`	`} else {`
`130`	`131`	`try {`
`131`	`132`	`$payload = $this->$payloadMapper($request, $type, $argument);`
`132`	`133`	`} catch (PartialDenormalizationException $e) {`
`133`		`- throw new HttpException($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), $e->getErrors())), $e);`
	`134`	`+ throw HttpException::fromStatusCode($validationFailedCode, implode("\n", array_map(static fn ($e) => $e->getMessage(), $e->getErrors())), $e);`
`134`	`135`	`}`
`135`	`136`	`}`
`136`	`137`
`137`	`138`	`if (null === $payload) {`
`138`	`139`	`$payload = match (true) {`
`139`	`140`	`$argument->metadata->hasDefaultValue() => $argument->metadata->getDefaultValue(),`
`140`	`141`	`$argument->metadata->isNullable() => null,`
`141`		`- default => throw new HttpException($validationFailedCode)`
	`142`	`+ default => throw HttpException::fromStatusCode($validationFailedCode)`
`142`	`143`	`};`
`143`	`144`	`}`
`144`	`145`
`@@ -167,11 +168,11 @@ private function mapQueryString(Request $request, string $type, MapQueryString $`
`167`	`168`	`private function mapRequestPayload(Request $request, string $type, MapRequestPayload $attribute): ?object`
`168`	`169`	`{`
`169`	`170`	`if (null === $format = $request->getContentTypeFormat()) {`
`170`		`- throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, 'Unsupported format.');`
	`171`	`+ throw new UnsupportedMediaTypeHttpException('Unsupported format.');`
`171`	`172`	`}`
`172`	`173`
`173`	`174`	`if ($attribute->acceptFormat && !\in_array($format, (array) $attribute->acceptFormat, true)) {`
`174`		`- throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, sprintf('Unsupported format, expects "%s", but "%s" given.', implode('", "', (array) $attribute->acceptFormat), $format));`
	`175`	`+ throw new UnsupportedMediaTypeHttpException(sprintf('Unsupported format, expects "%s", but "%s" given.', implode('", "', (array) $attribute->acceptFormat), $format));`
`175`	`176`	`}`
`176`	`177`
`177`	`178`	`if ($data = $request->request->all()) {`
`@@ -183,15 +184,15 @@ private function mapRequestPayload(Request $request, string $type, MapRequestPay`
`183`	`184`	`}`
`184`	`185`
`185`	`186`	`if ('form' === $format) {`
`186`		`- throw new HttpException(Response::HTTP_BAD_REQUEST, 'Request payload contains invalid "form" data.');`
	`187`	`+ throw new BadRequestHttpException('Request payload contains invalid "form" data.');`
`187`	`188`	`}`
`188`	`189`
`189`	`190`	`try {`
`190`	`191`	`return $this->serializer->deserialize($data, $type, $format, self::CONTEXT_DESERIALIZE + $attribute->serializationContext);`
`191`	`192`	`} catch (UnsupportedFormatException $e) {`
`192`		`- throw new HttpException(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, sprintf('Unsupported format: "%s".', $format), $e);`
	`193`	`+ throw new UnsupportedMediaTypeHttpException(sprintf('Unsupported format: "%s".', $format), $e);`
`193`	`194`	`} catch (NotEncodableValueException $e) {`
`194`		`- throw new HttpException(Response::HTTP_BAD_REQUEST, sprintf('Request payload contains invalid "%s" data.', $format), $e);`
	`195`	`+ throw new BadRequestHttpException(sprintf('Request payload contains invalid "%s" data.', $format), $e);`
`195`	`196`	`}`
`196`	`197`	`}`
`197`	`198`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function logKernelException(ExceptionEvent $event): void`
`63`	`63`	`}`
`64`	`64`	`if (!$throwable instanceof HttpExceptionInterface \|\| $throwable->getStatusCode() !== $config['status_code']) {`
`65`	`65`	`$headers = $throwable instanceof HttpExceptionInterface ? $throwable->getHeaders() : [];`
`66`		`- $throwable = new HttpException($config['status_code'], $throwable->getMessage(), $throwable, $headers);`
	`66`	`+ $throwable = HttpException::fromStatusCode($config['status_code'], $throwable->getMessage(), $throwable, $headers);`
`67`	`67`	`$event->setThrowable($throwable);`
`68`	`68`	`}`
`69`	`69`	`break;`
`@@ -78,7 +78,7 @@ public function logKernelException(ExceptionEvent $event): void`
`78`	`78`	`/** @var WithHttpStatus $instance */`
`79`	`79`	`$instance = $attributes[0]->newInstance();`
`80`	`80`
`81`		`- $throwable = new HttpException($instance->statusCode, $throwable->getMessage(), $throwable, $instance->headers);`
	`81`	`+ $throwable = HttpException::fromStatusCode($instance->statusCode, $throwable->getMessage(), $throwable, $instance->headers);`
`82`	`82`	`$event->setThrowable($throwable);`
`83`	`83`	`break;`
`84`	`84`	`}`