Merge pull request #22 from 123inkt/Add-support-for-json-body

frankdekker · web-flow · commit 1e9ca54facd1 · 2023-01-03T10:58:02.000+01:00
Add support for json body
diff --git a/src/Constraint/RequestConstraint.php b/src/Constraint/RequestConstraint.php
@@ -10,12 +10,14 @@ class RequestConstraint extends Constraint
     public const WRONG_VALUE_TYPE           = '08937cc5-9ea6-460c-9917-d3f6ba912998';
     public const MISSING_QUERY_CONSTRAINT   = 'b62ab5ca-ee6f-4baf-bdef-ffbe14f674d6';
     public const MISSING_REQUEST_CONSTRAINT = 'c3990dad-3638-449b-9dd3-4dd42e90c52f';
+    public const INVALID_BODY_CONTENT       = '3b41f393-5f46-471e-8a2e-c4035d5fb3cb';
 
     /** @var array<string, string> */
     protected static $errorNames = [
         self::WRONG_VALUE_TYPE           => 'WRONG_VALUE_TYPE',
         self::MISSING_QUERY_CONSTRAINT   => 'MISSING_QUERY_CONSTRAINT',
         self::MISSING_REQUEST_CONSTRAINT => 'MISSING_REQUEST_CONSTRAINT',
+        self::INVALID_BODY_CONTENT       => 'INVALID_BODY_CONTENT',
     ];
 
     /** @var string */
@@ -24,6 +26,8 @@ class RequestConstraint extends Constraint
     public $queryMessage = 'Request::query is not empty, but there is no constraint configured.';
     /** @var string */
     public $requestMessage = 'Request::request is not empty, but there is no constraint configured.';
+    /** @var string */
+    public $invalidBodyMessage = 'Request::content cant be decoded';
 
     /** @var Constraint|Constraint[]|null */
     public $query;
diff --git a/src/Constraint/RequestConstraintValidator.php b/src/Constraint/RequestConstraintValidator.php
@@ -3,6 +3,7 @@
 
 namespace DigitalRevolution\SymfonyRequestValidation\Constraint;
 
+use Symfony\Component\HttpFoundation\Exception\JsonException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;
@@ -12,6 +13,7 @@ class RequestConstraintValidator extends ConstraintValidator
 {
     /**
      * @param mixed $value
+     *
      * @inheritDoc
      */
     public function validate($value, Constraint $constraint): void
@@ -38,43 +40,73 @@ public function validate($value, Constraint $constraint): void
         $this->validateAttributes($constraint, $value);
     }
 
-    private function validateQuery(RequestConstraint $constraint, Request $value): void
+    private function validateQuery(RequestConstraint $constraint, Request $request): void
     {
         if ($constraint->query !== null) {
             $this->context->getValidator()
                 ->inContext($this->context)
                 ->atPath('[query]')
-                ->validate($value->query->all(), $constraint->query);
-        } elseif ($constraint->allowExtraFields === false && count($value->query) > 0) {
+                ->validate($request->query->all(), $constraint->query);
+        } elseif ($constraint->allowExtraFields === false && count($request->query) > 0) {
             $this->context->buildViolation($constraint->queryMessage)
                 ->atPath('[query]')
                 ->setCode($constraint::MISSING_QUERY_CONSTRAINT)
                 ->addViolation();
         }
     }
 
-    private function validateRequest(RequestConstraint $constraint, Request $value): void
+    private function validateRequest(RequestConstraint $constraint, Request $request): void
     {
-        if ($constraint->request !== null) {
-            $this->context->getValidator()
-                ->inContext($this->context)
-                ->atPath('[request]')
-                ->validate($value->request->all(), $constraint->request);
-        } elseif ($constraint->allowExtraFields === false && count($value->request) > 0) {
-            $this->context->buildViolation($constraint->requestMessage)
+        if ($constraint->request === null) {
+            if ($constraint->allowExtraFields === false && count($request->request) > 0) {
+                $this->context->buildViolation($constraint->requestMessage)
+                    ->atPath('[request]')
+                    ->setCode($constraint::MISSING_REQUEST_CONSTRAINT)
+                    ->addViolation();
+            }
+
+            return;
+        }
+
+        if (in_array($request->getContentType(), ['json', 'jsonld'], true)) {
+            $data = $this->validateAndGetJsonBody($constraint, $request);
+            if ($data === null) {
+                return;
+            }
+        } else {
+            $data = $request->request->all();
+        }
+
+        $this->context->getValidator()
+            ->inContext($this->context)
+            ->atPath('[request]')
+            ->validate($data, $constraint->request);
+    }
+
+    /**
+     * @return mixed[]|null
+     */
+    private function validateAndGetJsonBody(RequestConstraint $constraint, Request $request): ?array
+    {
+        try {
+            return $request->toArray();
+        } catch (JsonException $exception) {
+            $this->context->buildViolation($constraint->invalidBodyMessage)
                 ->atPath('[request]')
-                ->setCode($constraint::MISSING_REQUEST_CONSTRAINT)
+                ->setCode($constraint::INVALID_BODY_CONTENT)
                 ->addViolation();
+
+            return null;
         }
     }
 
-    private function validateAttributes(RequestConstraint $constraint, Request $value): void
+    private function validateAttributes(RequestConstraint $constraint, Request $request): void
     {
         if ($constraint->attributes !== null) {
             $this->context->getValidator()
                 ->inContext($this->context)
                 ->atPath('[attributes]')
-                ->validate($value->attributes->all(), $constraint->attributes);
+                ->validate($request->attributes->all(), $constraint->attributes);
         }
     }
 }
diff --git a/tests/Unit/Constraint/RequestConstraintValidatorTest.php b/tests/Unit/Constraint/RequestConstraintValidatorTest.php
@@ -6,6 +6,7 @@
 use DigitalRevolution\SymfonyRequestValidation\Constraint\RequestConstraint;
 use DigitalRevolution\SymfonyRequestValidation\Constraint\RequestConstraintValidator;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Exception\JsonException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Validator\Constraints as Assert;
 use Symfony\Component\Validator\Context\ExecutionContext;
@@ -45,6 +46,7 @@ public function testValidateUnexpectedTypeException(): void
 
     /**
      * @param array<mixed> $data
+     *
      * @dataProvider \DigitalRevolution\SymfonyRequestValidation\Tests\DataProvider\Constraint\RequestConstraintValidatorDataProvider::dataProvider
      * @covers ::validate
      * @covers ::validateQuery
@@ -60,6 +62,7 @@ public function testValidateQuery(array $data, bool $success): void
 
     /**
      * @param array<mixed> $data
+     *
      * @dataProvider \DigitalRevolution\SymfonyRequestValidation\Tests\DataProvider\Constraint\RequestConstraintValidatorDataProvider::dataProvider
      * @covers ::validate
      * @covers ::validateRequest
@@ -75,6 +78,42 @@ public function testValidateRequest(array $data, bool $success): void
 
     /**
      * @param array<mixed> $data
+     *
+     * @dataProvider \DigitalRevolution\SymfonyRequestValidation\Tests\DataProvider\Constraint\RequestConstraintValidatorDataProvider::dataProvider
+     * @covers ::validate
+     * @covers ::validateRequest
+     * @covers ::validateAndGetJsonBody
+     * @throws JsonException
+     */
+    public function testValidateJson(array $data, bool $success): void
+    {
+        $request    = new Request([], [], [], [], [], ['HTTP_CONTENT_TYPE' => 'application/json'], json_encode($data, JSON_THROW_ON_ERROR));
+        $constraint = new RequestConstraint(['request' => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())])]);
+        $this->context->setConstraint($constraint);
+        $this->validator->validate($request, $constraint);
+        static::assertCount($success ? 0 : 1, $this->context->getViolations());
+    }
+
+    /**
+     * @covers ::validate
+     * @covers ::validateRequest
+     * @covers ::validateAndGetJsonBody
+     */
+    public function testValidateInvalidJson(): void
+    {
+        $request    = new Request([], [], [], [], [], ['HTTP_CONTENT_TYPE' => 'application/json'], '{invalid');
+        $constraint = new RequestConstraint(['request' => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())])]);
+        $this->context->setConstraint($constraint);
+        $this->validator->validate($request, $constraint);
+
+        $violations = $this->context->getViolations();
+        static::assertCount(1, $violations);
+        static::assertSame('Request::content cant be decoded', $violations->get(0)->getMessageTemplate());
+    }
+
+    /**
+     * @param array<mixed> $data
+     *
      * @dataProvider \DigitalRevolution\SymfonyRequestValidation\Tests\DataProvider\Constraint\RequestConstraintValidatorDataProvider::dataProvider
      * @covers ::validate
      * @covers ::validateAttributes
@@ -90,6 +129,7 @@ public function testValidateAttributes(array $data, bool $success): void
 
     /**
      * @param array<mixed> $data
+     *
      * @dataProvider \DigitalRevolution\SymfonyRequestValidation\Tests\DataProvider\Constraint\RequestConstraintValidatorDataProvider::dataProvider
      * @covers ::validate
      * @covers ::validateQuery
@@ -99,19 +139,20 @@ public function testValidateAttributes(array $data, bool $success): void
     public function testValidateQueryRequestAttributes(array $data, bool $success): void
     {
         $request    = new Request($data, $data, $data);
-        $constraint = new RequestConstraint([
-            'query'      => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())]),
-            'request'    => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())]),
-            'attributes' => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())])
-        ]);
+        $constraint = new RequestConstraint(
+            [
+                'query'      => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())]),
+                'request'    => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())]),
+                'attributes' => new Assert\Collection(['email' => new Assert\Required(new Assert\Email())])
+            ]
+        );
         $this->context->setConstraint($constraint);
         $this->validator->validate($request, $constraint);
         static::assertCount($success ? 0 : 3, $this->context->getViolations());
     }
 
     /**
      * Test that 'null' request should be ignored
-     *
      * @covers ::validate
      */
     public function testValidateNullRequest(): void
@@ -125,7 +166,6 @@ public function testValidateNullRequest(): void
 
     /**
      * Test that 'null' request should be ignored
-     *
      * @covers ::validate
      */
     public function testValidateWrongTypeViolation(): void
@@ -141,7 +181,6 @@ public function testValidateWrongTypeViolation(): void
 
     /**
      * Test that if no constraints have been specified. the request's query _must_ be empty
-     *
      * @covers ::validate
      * @covers ::validateQuery
      */
@@ -158,14 +197,13 @@ public function testValidateEmptyConstraintsFilledQuery(): void
 
     /**
      * Test that if no constraints have been specified. the request's query _must_ not be empty
-     *
      * @covers ::validate
      * @covers ::validateQuery
      */
     public function testValidateEmptyConstraintsFilledQueryAllowed(): void
     {
-        $request    = new Request(['a']);
-        $constraint = new RequestConstraint();
+        $request                      = new Request(['a']);
+        $constraint                   = new RequestConstraint();
         $constraint->allowExtraFields = true;
         $this->context->setConstraint($constraint);
         $this->validator->validate($request, $constraint);
@@ -175,7 +213,6 @@ public function testValidateEmptyConstraintsFilledQueryAllowed(): void
 
     /**
      * Test that if no constraints have been specified. the request's request _must_ be empty
-     *
      * @covers ::validate
      * @covers ::validateRequest
      */
@@ -192,14 +229,13 @@ public function testValidateEmptyConstraintsFilledRequest(): void
 
     /**
      * Test that if no constraints have been specified, and extra fields are allowed. the request's request _must_ not be empty
-     *
      * @covers ::validate
      * @covers ::validateRequest
      */
     public function testValidateEmptyConstraintsFilledRequestAllowed(): void
     {
-        $request    = new Request([], ['b']);
-        $constraint = new RequestConstraint();
+        $request                      = new Request([], ['b']);
+        $constraint                   = new RequestConstraint();
         $constraint->allowExtraFields = true;
 
         $this->context->setConstraint($constraint);
