Format error details & violations

ArthurJCQ · Feb 2, 2024 · 82c92f0 · 82c92f0
1 parent 80bbb89
commit 82c92f0
Show file tree

Hide file tree

Showing 21 changed files with 88 additions and 77 deletions.
diff --git a/src/Api/Controller/MissionController.php b/src/Api/Controller/MissionController.php
@@ -5,7 +5,6 @@
 namespace App\Api\Controller;
 
 use App\Api\Exception\KillerBadRequestHttpException;
-use App\Api\Exception\KillerValidationException;
 use App\Domain\KillerSerializerInterface;
 use App\Domain\KillerValidatorInterface;
 use App\Domain\Mission\Entity\Mission;
@@ -46,7 +45,7 @@ public function createMission(
         $room = $player->getRoom();
 
         if (!$room || $room->getStatus() !== Room::PENDING) {
-            throw new KillerBadRequestHttpException('KILLER_CAN_NOT_ADD_MISSIONS');
+            throw new KillerBadRequestHttpException('CAN_NOT_ADD_MISSIONS');
         }
 
         $player->addAuthoredMission($mission);
@@ -82,11 +81,7 @@ public function patchMission(Request $request, Mission $mission): JsonResponse
             ],
         );
 
-        try {
-            $this->validator->validate($mission);
-        } catch (KillerValidationException $e) {
-            throw new KillerBadRequestHttpException($e->getMessage());
-        }
+        $this->validator->validate($mission);
 
         $this->persistenceAdapter->flush();
 

diff --git a/src/Api/Controller/PlayerController.php b/src/Api/Controller/PlayerController.php
@@ -4,8 +4,6 @@
 
 namespace App\Api\Controller;
 
-use App\Api\Exception\KillerBadRequestHttpException;
-use App\Api\Exception\KillerValidationException;
 use App\Application\UseCase\Player\ChangeRoomUseCase;
 use App\Domain\KillerSerializerInterface;
 use App\Domain\KillerValidatorInterface;
@@ -155,11 +153,7 @@ public function patchPlayer(Request $request, Player $player): JsonResponse
             ],
         );
 
-        try {
-            $this->validator->validate($player);
-        } catch (KillerValidationException $e) {
-            throw new KillerBadRequestHttpException($e->getMessage());
-        }
+        $this->validator->validate($player);
 
         $this->logger->info('KILLER : player target : {player_target}', ['player_target' => $player->getTarget()]);
 

diff --git a/src/Api/Controller/RoomController.php b/src/Api/Controller/RoomController.php
@@ -5,7 +5,6 @@
 namespace App\Api\Controller;
 
 use App\Api\Exception\KillerBadRequestHttpException;
-use App\Api\Exception\KillerValidationException;
 use App\Application\UseCase\Player\ChangeRoomUseCase;
 use App\Domain\KillerSerializerInterface;
 use App\Domain\KillerValidatorInterface;
@@ -89,7 +88,7 @@ public function patchRoom(Request $request, Room $room): JsonResponse
 
                 if (!$transitionSuccess) {
                     // CAN_NOT_MOVE_TO_IN_GAME or CAN_NO_MOVE_TO_ENDED
-                    throw new KillerBadRequestHttpException(sprintf('KILLER_CAN_NOT_MOVE_TO_%s', $data['status']));
+                    throw new KillerBadRequestHttpException(sprintf('CAN_NOT_MOVE_TO_%s', $data['status']));
                 }
             } catch (\DomainException $e) {
                 throw new BadRequestHttpException($e->getMessage());
@@ -106,11 +105,7 @@ public function patchRoom(Request $request, Room $room): JsonResponse
             ],
         );
 
-        try {
-            $this->validator->validate($room);
-        } catch (KillerValidationException $e) {
-            throw new KillerBadRequestHttpException($e->getMessage());
-        }
+        $this->validator->validate($room);
 
         $this->persistenceAdapter->flush();
 

diff --git a/src/Api/Exception/KillerBadRequestHttpException.php b/src/Api/Exception/KillerBadRequestHttpException.php
@@ -4,7 +4,9 @@
 
 namespace App\Api\Exception;
 
-class KillerBadRequestHttpException extends KillerHttpException
+use App\Domain\KillerExceptionInterface;
+
+class KillerBadRequestHttpException extends KillerHttpException implements KillerExceptionInterface
 {
     public function __construct(string $message = '', ?\Throwable $previous = null, int $code = 0, array $headers = [])
     {

diff --git a/src/Api/Exception/KillerHttpException.php b/src/Api/Exception/KillerHttpException.php
@@ -4,8 +4,9 @@
 
 namespace App\Api\Exception;
 
+use App\Domain\KillerExceptionInterface;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
-class KillerHttpException extends HttpException
+class KillerHttpException extends HttpException implements KillerExceptionInterface
 {
 }
diff --git a/src/Application/UseCase/Player/ChangeRoomUseCase.php b/src/Application/UseCase/Player/ChangeRoomUseCase.php
@@ -19,7 +19,7 @@ public function __construct(private EventDispatcherInterface $eventDispatcher)
     public function execute(Player $player, ?Room $newRoom = null): void
     {
         if ($newRoom?->getStatus() === Room::IN_GAME) {
-            throw new PlayerCanNotJoinRoomException('KILLER_ROOM_ALREADY_IN_GAME');
+            throw new PlayerCanNotJoinRoomException('ROOM_ALREADY_IN_GAME');
         }
 
         $previousRoom = $player->getRoom();

diff --git a/src/Domain/KillerExceptionInterface.php b/src/Domain/KillerExceptionInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain;
+
+interface KillerExceptionInterface
+{
+    public function getMessage(): string;
+}
diff --git a/src/Domain/Mission/Entity/Mission.php b/src/Domain/Mission/Entity/Mission.php
@@ -25,8 +25,8 @@ class Mission
     #[Assert\Length(
         min: 5,
         max: 1000,
-        minMessage: 'KILLER_MISSION_TOO_SHORT_CONTENT',
-        maxMessage: 'KILLER_MISSION_TOO_LONG_CONTENT',
+        minMessage: 'MISSION_TOO_SHORT_CONTENT',
+        maxMessage: 'MISSION_TOO_LONG_CONTENT',
     )]
     #[Groups(['get-mission', 'get-player', 'post-mission', 'me'])]
     private string $content;

diff --git a/src/Domain/Player/Entity/Player.php b/src/Domain/Player/Entity/Player.php
@@ -34,8 +34,8 @@ class Player implements UserInterface
     #[Assert\Length(
         min: 2,
         max: 30,
-        minMessage: 'KILLER_PLAYER_NAME_TOO_SHORT_CONTENT',
-        maxMessage: 'KILLER_PLAYER_NAME_TOO_LONG_CONTENT',
+        minMessage: 'PLAYER_NAME_TOO_SHORT_CONTENT',
+        maxMessage: 'PLAYER_NAME_TOO_LONG_CONTENT',
     )]
     private string $name;
 

diff --git a/src/Domain/Player/Exception/PlayerCanNotJoinRoomException.php b/src/Domain/Player/Exception/PlayerCanNotJoinRoomException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Player\Exception;
 
-class PlayerCanNotJoinRoomException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class PlayerCanNotJoinRoomException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Player/Exception/PlayerHasNoKillerOrTargetException.php b/src/Domain/Player/Exception/PlayerHasNoKillerOrTargetException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Player\Exception;
 
-class PlayerHasNoKillerOrTargetException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class PlayerHasNoKillerOrTargetException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Player/Exception/PlayerNotFoundException.php b/src/Domain/Player/Exception/PlayerNotFoundException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Player\Exception;
 
-class PlayerNotFoundException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class PlayerNotFoundException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Player/Exception/PlayerNotInRoomException.php b/src/Domain/Player/Exception/PlayerNotInRoomException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Player\Exception;
 
-class PlayerNotInRoomException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class PlayerNotInRoomException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Room/Entity/Room.php b/src/Domain/Room/Entity/Room.php
@@ -33,7 +33,7 @@ class Room
 
     #[ORM\Column(type: 'string', length: 255)]
     #[Groups(['get-room', 'me', 'patch-room', 'publish-mercure'])]
-    #[Assert\Length(min: 2, max: 50, minMessage: 'KILLER_TOO_SHORT_CONTENT', maxMessage: 'KILLER_TOO_LONG_CONTENT')]
+    #[Assert\Length(min: 2, max: 50, minMessage: 'TOO_SHORT_CONTENT', maxMessage: 'TOO_LONG_CONTENT')]
     private string $name;
 
     #[ORM\Column(type: 'string', length: 255, options: ['default' => self::PENDING])]

diff --git a/src/Domain/Room/Exception/CanNotApplyRoomTransitionException.php b/src/Domain/Room/Exception/CanNotApplyRoomTransitionException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Room\Exception;
 
-class CanNotApplyRoomTransitionException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class CanNotApplyRoomTransitionException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Room/Exception/NotEnoughMissionsInRoomException.php b/src/Domain/Room/Exception/NotEnoughMissionsInRoomException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Room\Exception;
 
-class NotEnoughMissionsInRoomException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class NotEnoughMissionsInRoomException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Room/Exception/NotEnoughPlayersInRoomException.php b/src/Domain/Room/Exception/NotEnoughPlayersInRoomException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Room\Exception;
 
-class NotEnoughPlayersInRoomException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class NotEnoughPlayersInRoomException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Domain/Room/Exception/RoomNotInGameException.php b/src/Domain/Room/Exception/RoomNotInGameException.php
@@ -4,6 +4,8 @@
 
 namespace App\Domain\Room\Exception;
 
-class RoomNotInGameException extends \DomainException
+use App\Domain\KillerExceptionInterface;
+
+class RoomNotInGameException extends \DomainException implements KillerExceptionInterface
 {
 }
diff --git a/src/Infrastructure/Serializer/KillerProblemNormalizer.php b/src/Infrastructure/Serializer/KillerProblemNormalizer.php
@@ -4,16 +4,20 @@
 
 namespace App\Infrastructure\Serializer;
 
+use App\Domain\KillerExceptionInterface;
 use Symfony\Component\DependencyInjection\Attribute\AsDecorator;
 use Symfony\Component\DependencyInjection\Attribute\AutowireDecorated;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\ProblemNormalizer;
-use Symfony\Component\Validator\Exception\ValidationFailedException;
+use Symfony\Component\Serializer\SerializerAwareInterface;
+use Symfony\Component\Serializer\SerializerAwareTrait;
 
 #[AsDecorator(decorates: ProblemNormalizer::class)]
-readonly class KillerProblemNormalizer implements NormalizerInterface
+class KillerProblemNormalizer implements NormalizerInterface, SerializerAwareInterface
 {
+    use SerializerAwareTrait;
+
     public const CUSTOM_ERROR_PREFIX = 'KILLER';
 
     public function __construct(#[AutowireDecorated] private ProblemNormalizer $inner)
@@ -25,22 +29,20 @@ public function normalize(
         ?string $format = null,
         array $context = [],
     ): float|int|bool|\ArrayObject|array|string|null {
+        $this->inner->setSerializer($this->serializer);
         $normalizedException = $this->inner->normalize($object, $format, $context);
 
-        if ($context['exception'] instanceof HttpExceptionInterface) {
-            $errorDetail = $context['exception']->getMessage();
-        }
-
-        if ($context['exception'] instanceof ValidationFailedException) {
-            $errorDetail = $context['exception']->getValue();
+        if ($context['exception'] instanceof KillerExceptionInterface) {
+            $normalizedException['detail'] = $context['exception']->getMessage();
         }
 
-        if (isset($errorDetail) && is_string($errorDetail)) {
+        if ($context['exception'] instanceof HttpExceptionInterface) {
+            $errorDetail = $context['exception']->getMessage();
             $errorDetail = explode('_', $errorDetail, 2);
-        }
 
-        if (isset($errorDetail[0]) && $errorDetail[0] === self::CUSTOM_ERROR_PREFIX) {
-            $normalizedException['detail'] = $errorDetail[1];
+            if (isset($errorDetail[0]) && $errorDetail[0] === self::CUSTOM_ERROR_PREFIX) {
+                $normalizedException['detail'] = $errorDetail[1];
+            }
         }
 
         return $normalizedException;

diff --git a/src/Infrastructure/Validator/KillerValidator.php b/src/Infrastructure/Validator/KillerValidator.php
@@ -22,6 +22,6 @@ public function validate(object $entity): void
             return;
         }
 
-        throw new KillerValidationException('KILLER_VALIDATION_ERROR', $violations);
+        throw new KillerValidationException('VALIDATION_ERROR', $violations);
     }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,6 @@ public function validate(object $entity): void @@
                 return;
             }
-            throw new KillerValidationException('KILLER_VALIDATION_ERROR', $violations);
+            throw new KillerValidationException('VALIDATION_ERROR', $violations);
         }
     }