code challenge 7 solution

CODING-CHALLENGE-8.md

@@ -0,0 +1,13 @@
+# RESTful Webservices in Symfony
+
+## Coding Challenge 8 - Error Handling
+
+### Tasks
+
+- centralize the error handling
+
+### Solution
+
+- throw a `ValidationFailedException` on validation errors
+- introduce an `ExceptionListener` to catch the `ValidationFailedException`
+- in the `ExceptionListener` create an error representation of the caught exception and fill the response content with it

composer.json

@@ -22,6 +22,7 @@
         "symfony/property-info": "6.3.*",
         "symfony/runtime": "6.3.*",
         "symfony/serializer": "6.3.*",
+        "symfony/validator": "6.3.*",
         "symfony/yaml": "6.3.*",
         "webmozart/assert": "^1.11",
         "willdurand/negotiation": "^3.1"

config/packages/validator.yaml

@@ -0,0 +1,13 @@
+framework:
+    validation:
+        email_validation_mode: html5
+
+        # Enables validator auto-mapping support.
+        # For instance, basic validation constraints will be inferred from Doctrine's metadata.
+        #auto_mapping:
+        #    App\Entity\: []
+
+when@test:
+    framework:
+        validation:
+            not_compromised_password: false

config/services.yaml

@@ -26,3 +26,11 @@ services:
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
+
+
+
+when@test:
+    services:
+        Psr\Log\NullLogger: ~
+        # Disable logger to avoid showing errors during tests
+        logger: '@Psr\Log\NullLogger'

src/ArgumentValueResolver/CreateAttendeeModelResolver.php

@@ -8,12 +8,15 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
 use Symfony\Component\Serializer\SerializerInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 final class CreateAttendeeModelResolver implements ArgumentValueResolverInterface
 {
     public function __construct(
         private readonly SerializerInterface $serializer,
+        private readonly ValidatorInterface $validator
     ) {
     }
 
@@ -29,10 +32,23 @@ public function resolve(Request $request, ArgumentMetadata $argument): iterable
     {
         // it returns an iterable, because the controller method argument could be variadic
 
-        yield $this->serializer->deserialize(
-            $request->getContent(),
-            CreateAttendeeModel::class,
-            $request->getRequestFormat(),
-        );
+        try {
+            $model = $this->serializer->deserialize(
+                $request->getContent(),
+                CreateAttendeeModel::class,
+                $request->getRequestFormat(),
+            );
+        } catch (\Exception $exception) {
+            throw new UnprocessableEntityHttpException();
+        }
+
+        $validationErrors = $this->validator->validate($model);
+
+        if (\count($validationErrors) > 0) {
+            // throw a UnprocessableEntityHttpException for now, we will introduce proper ApiExceptions later
+            throw new UnprocessableEntityHttpException();
+        }
+
+        yield $model;
     }
 }

src/ArgumentValueResolver/UpdateAttendeeModelResolver.php

@@ -8,12 +8,15 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
 use Symfony\Component\Serializer\SerializerInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 final class UpdateAttendeeModelResolver implements ArgumentValueResolverInterface
 {
     public function __construct(
         private readonly SerializerInterface $serializer,
+        private readonly ValidatorInterface $validator
     ) {
     }
 
@@ -27,10 +30,23 @@ public function supports(Request $request, ArgumentMetadata $argument): bool
      */
     public function resolve(Request $request, ArgumentMetadata $argument): iterable
     {
-        yield $this->serializer->deserialize(
-            $request->getContent(),
-            UpdateAttendeeModel::class,
-            $request->getRequestFormat(),
-        );
+        try {
+            $model = $this->serializer->deserialize(
+                $request->getContent(),
+                UpdateAttendeeModel::class,
+                $request->getRequestFormat(),
+            );
+        } catch (\Exception $exception) {
+            throw new UnprocessableEntityHttpException();
+        }
+
+        $validationErrors = $this->validator->validate($model);
+
+        if (\count($validationErrors) > 0) {
+            // throw a UnprocessableEntityHttpException for now, we will introduce proper ApiExceptions later
+            throw new UnprocessableEntityHttpException();
+        }
+
+        yield $model;
     }
 }

src/Domain/Model/CreateAttendeeModel.php

@@ -4,9 +4,18 @@
 
 namespace App\Domain\Model;
 
+use Symfony\Component\Validator\Constraints\Email;
+use Symfony\Component\Validator\Constraints\NotBlank;
+
 final class CreateAttendeeModel
 {
+    #[NotBlank]
     public string $firstname;
+
+    #[NotBlank]
     public string $lastname;
+
+    #[NotBlank]
+    #[Email]
     public string $email;
 }

src/Domain/Model/UpdateAttendeeModel.php

@@ -4,9 +4,18 @@
 
 namespace App\Domain\Model;
 
+use Symfony\Component\Validator\Constraints\Email;
+use Symfony\Component\Validator\Constraints\NotBlank;
+
 final class UpdateAttendeeModel
 {
+    #[NotBlank(allowNull: true)]
     public ?string $firstname = null;
+
+    #[NotBlank(allowNull: true)]
     public ?string $lastname = null;
+
+    #[NotBlank(allowNull: true)]
+    #[Email]
     public ?string $email = null;
 }

symfony.lock

@@ -160,6 +160,18 @@
             "config/routes.yaml"
         ]
     },
+    "symfony/validator": {
+        "version": "6.3",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "5.3",
+            "ref": "c32cfd98f714894c4f128bb99aa2530c1227603c"
+        },
+        "files": [
+            "config/packages/validator.yaml"
+        ]
+    },
     "theofidry/alice-data-fixtures": {
         "version": "1.6",
         "recipe": {