Merge branch 'develop' into 3.x

lindyhopchris · lindyhopchris · commit a35ca04dfe78 · 2023-07-29T13:24:30.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.0.1] - 2023-07-29
+
+### Fixed
+
+- [#3](https://github.com/laravel-json-api/exceptions/issues/3) Ensure HTTP status is correctly set when the status on a
+  validation exception is not `422`.
+
 ## [2.0.0] - 2023-02-14
 
 ### Changed
diff --git a/src/Pipes/Concerns/SetsHttpTitle.php b/src/Pipes/Concerns/SetsHttpTitle.php
@@ -24,11 +24,10 @@
 
 trait SetsHttpTitle
 {
-
     /**
-     * @var Translator
+     * @var Translator|null
      */
-    private Translator $translator;
+    private ?Translator $translator = null;
 
     /**
      * @param int|null $status
@@ -37,7 +36,8 @@ trait SetsHttpTitle
     private function getTitle(?int $status): ?string
     {
         if ($status && isset(Response::$statusTexts[$status])) {
-            return $this->translator->get(Response::$statusTexts[$status]);
+            $title = Response::$statusTexts[$status];
+            return $this->translator?->get($title) ?? $title;
         }
 
         return null;
diff --git a/src/Pipes/ValidationExceptionHandler.php b/src/Pipes/ValidationExceptionHandler.php
@@ -20,28 +20,33 @@
 namespace LaravelJsonApi\Exceptions\Pipes;
 
 use Closure;
+use Illuminate\Contracts\Translation\Translator;
 use Illuminate\Validation\ValidationException;
 use LaravelJsonApi\Contracts\ErrorProvider;
+use LaravelJsonApi\Core\Document\Error;
+use LaravelJsonApi\Core\Document\ErrorList;
 use LaravelJsonApi\Core\Responses\ErrorResponse;
+use LaravelJsonApi\Exceptions\Pipes\Concerns\SetsHttpTitle;
 use LaravelJsonApi\Validation\Factory;
+use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
 class ValidationExceptionHandler
 {
-
-    /**
-     * @var Factory
-     */
-    private Factory $factory;
+    use SetsHttpTitle;
 
     /**
      * ValidationExceptionHandler constructor.
      *
      * @param Factory $factory
+     * @param Translator|null $translator
+     * @TODO next major version, make translator compulsory.
      */
-    public function __construct(Factory $factory)
-    {
-        $this->factory = $factory;
+    public function __construct(
+        private readonly Factory $factory,
+        Translator $translator = null,
+    ) {
+        $this->translator = $translator;
     }
 
     /**
@@ -55,7 +60,7 @@ public function handle(Throwable $ex, Closure $next): ErrorResponse
     {
         if ($ex instanceof ValidationException) {
             return new ErrorResponse(
-                $this->toErrors($ex)
+                $this->toErrors($ex),
             );
         }
 
@@ -64,12 +69,43 @@ public function handle(Throwable $ex, Closure $next): ErrorResponse
 
     /**
      * @param ValidationException $ex
-     * @return ErrorProvider
+     * @return ErrorProvider|ErrorList
      */
-    private function toErrors(ValidationException $ex): ErrorProvider
+    private function toErrors(ValidationException $ex): ErrorProvider|ErrorList
     {
-        return $this->factory->createErrors(
+        $errors = $this->factory->createErrors(
             $ex->validator
         );
+
+        if (Response::HTTP_UNPROCESSABLE_ENTITY !== $ex->status) {
+            $errors = $errors->toErrors();
+            $this->withStatus($ex->status, $errors);
+        }
+
+        return $errors;
+    }
+
+    /**
+     * Override the status and title of the provided error list.
+     *
+     * As the validation exception can have a custom HTTP status, we sometimes need to override
+     * the HTTP status and title on each JSON:API error.
+     *
+     * This could be improved by allowing the status and title to be overridden on the
+     * `ValidatorErrorIterator` class (in the validation package).
+     *
+     * @param int $status
+     * @param ErrorList $errors
+     * @return void
+     */
+    private function withStatus(int $status, ErrorList $errors): void
+    {
+        $title = $this->getTitle($status);
+
+        /** @var Error $error */
+        foreach ($errors as $error) {
+            /** This works as error is mutable; note a future version might make error immutable. */
+            $error->setStatus($status)->setTitle($title);
+        }
     }
 }
diff --git a/tests/Integration/ExceptionsTest.php b/tests/Integration/ExceptionsTest.php
@@ -455,6 +455,68 @@ public function testValidationException(): void
             ->assertExactJson($expected);
     }
 
+    /**
+     * If the validator has a status set, we ensure the response and JSON:API errors have that status.
+     *
+     * @see https://github.com/laravel-json-api/exceptions/issues/3
+     */
+    public function testValidationExceptionWithStatus(): void
+    {
+        $this->ex = ValidationException::withMessages([
+            'data.email' => 'Hello teapot@example.com',
+        ])->status(418);
+
+        $expected = [
+            'errors' => [
+                [
+                    'detail' => 'Hello teapot@example.com',
+                    'source' => ['pointer' => '/data/email'],
+                    'status' => '418',
+                    'title' => "I'm a teapot",
+                ],
+            ],
+            'jsonapi' => [
+                'version' => '1.0',
+            ],
+        ];
+
+        $this
+            ->get('/test', ['Accept' => 'application/vnd.api+json'])
+            ->assertStatus(418)
+            ->assertHeader('Content-Type', 'application/vnd.api+json')
+            ->assertExactJson($expected);
+    }
+
+    /**
+     * If the validator has a status set, we ensure the response and JSON:API errors have that status.
+     *
+     * @see https://github.com/laravel-json-api/exceptions/issues/3
+     */
+    public function testValidationExceptionWithStatusThatDoesNotHaveTitle(): void
+    {
+        $this->ex = ValidationException::withMessages([
+            'data.email' => 'Too many attempts',
+        ])->status(419);
+
+        $expected = [
+            'errors' => [
+                [
+                    'detail' => 'Too many attempts',
+                    'source' => ['pointer' => '/data/email'],
+                    'status' => '419',
+                ],
+            ],
+            'jsonapi' => [
+                'version' => '1.0',
+            ],
+        ];
+
+        $this->get('/test', ['Accept' => 'application/vnd.api+json'])
+            ->assertStatus(419)
+            ->assertHeader('Content-Type', 'application/vnd.api+json')
+            ->assertExactJson($expected);
+    }
+
     public function testDefaultExceptionWithoutDebug(): void
     {
         config()->set('app.debug', false);
