[Bugfix] Fix parsing exceptions in exception parser class

See #566

Author: lindyhopchris

CHANGELOG.md

@@ -2,6 +2,20 @@
 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/).
 
+## Unreleased
+
+### Added
+- [#563](https://github.com/cloudcreativity/laravel-json-api/pull/563)
+Added Dutch translation files for validation and errors.
+
+### Fixed
+- [#566](https://github.com/cloudcreativity/laravel-json-api/issues/566)
+Ensure the exception parser correctly parses an instance of this package's `JsonApiException`.
+- Exception parser now correctly uses the Symfony `HttpExceptionInterface` instead of the
+actual `HttpException` instance. Although this change would break consuming applications
+that have extended the `ExceptionParser` class, it is considered a bug fix as it should
+have been type-hinting the interface in `v3.0.0`.
+
 ## [3.0.1] - 2020-10-14
 
 ### Fixed

src/Exceptions/ExceptionParser.php

@@ -21,16 +21,14 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Exceptions\ExceptionParserInterface;
 use CloudCreativity\LaravelJsonApi\Document\Error\Translator;
 use CloudCreativity\LaravelJsonApi\Encoder\Neomerx\Document\Errors as NeomerxErrors;
-use Exception;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Http\Response;
 use Illuminate\Session\TokenMismatchException;
 use Illuminate\Validation\ValidationException as IlluminateValidationException;
 use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
 use Neomerx\JsonApi\Document\Error;
-use Neomerx\JsonApi\Exceptions\JsonApiException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Neomerx\JsonApi\Exceptions\JsonApiException as NeomerxJsonApiException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
 /**
@@ -62,6 +60,10 @@ public function __construct(Translator $translator)
     public function parse(\Throwable $e): DocumentInterface
     {
         if ($e instanceof JsonApiException) {
+            return $e->getErrors();
+        }
+
+        if ($e instanceof NeomerxJsonApiException) {
             return NeomerxErrors::cast($e);
         }
 
@@ -95,7 +97,7 @@ protected function getErrors(\Throwable $e): array
             return [$this->translator->tokenMismatch()];
         }
 
-        if ($e instanceof HttpException) {
+        if ($e instanceof HttpExceptionInterface) {
             return [$this->getHttpError($e)];
         }
 
@@ -112,10 +114,10 @@ protected function getValidationError(IlluminateValidationException $e): array
     }
 
     /**
-     * @param HttpException $e
+     * @param HttpExceptionInterface $e
      * @return ErrorInterface
      */
-    protected function getHttpError(HttpException $e): ErrorInterface
+    protected function getHttpError(HttpExceptionInterface $e): ErrorInterface
     {
         $status = $e->getStatusCode();
         $title = $this->getDefaultTitle($status);

src/Exceptions/JsonApiException.php

@@ -92,13 +92,22 @@ public function getHeaders()
         return $this->headers;
     }
 
+    /**
+     * @return Errors
+     */
+    public function getErrors(): Errors
+    {
+        return $this->errors
+            ->withHeaders($this->headers);
+    }
+
     /**
      * @inheritDoc
      */
     public function toResponse($request)
     {
-        return $this->errors
-            ->withHeaders($this->headers)
+        return $this
+            ->getErrors()
             ->toResponse($request);
     }
 

tests/lib/Integration/ErrorsTest.php

@@ -26,6 +26,7 @@
 use DummyApp\Post;
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
+use Illuminate\Http\Response;
 use Illuminate\Session\TokenMismatchException;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\MessageBag;
@@ -261,7 +262,7 @@ public function testNeomerxJsonApiException()
             ->assertSee('My foobar error message.');
     }
 
-    public function testJsonApiException(): void
+    public function testJsonApiException1(): void
     {
         Route::get('/test', function () {
             throw JsonApiException::make(Error::fromArray([
@@ -286,6 +287,35 @@ public function testJsonApiException(): void
             ->assertExactJson($expected);
     }
 
+    /**
+     * @see https://github.com/cloudcreativity/laravel-json-api/issues/566
+     */
+    public function testJsonApiException2(): void
+    {
+        Route::get('/test', function () {
+            $error = Error::fromArray([
+                'title' => 'The language you want to use is not active',
+                'status' => Response::HTTP_UNPROCESSABLE_ENTITY,
+            ]);
+
+            throw new JsonApiException($error);
+        });
+
+        $expected = [
+            'errors' => [
+                [
+                    'status' => '422',
+                    'title' => 'The language you want to use is not active',
+                ],
+            ],
+        ];
+
+        $this->get('/test')
+            ->assertStatus(422)
+            ->assertHeader('Content-Type', 'application/vnd.api+json')
+            ->assertExactJson($expected);
+    }
+
     public function testMaintenanceMode()
     {
         $ex = new MaintenanceModeException(Carbon::now()->getTimestamp(), 60, "We'll be back soon.");

tests/lib/Integration/Issue566/Adapter.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright 2020 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Tests\Integration\Issue566;
+
+use CloudCreativity\LaravelJsonApi\Document\Error\Error;
+use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
+use CloudCreativity\LaravelJsonApi\Exceptions\JsonApiException;
+use DummyApp\JsonApi\Posts\Adapter as PostAdapter;
+use DummyApp\Post;
+use Illuminate\Http\Response;
+
+class Adapter extends PostAdapter
+{
+
+    /**
+     * @param Post $post
+     * @param ResourceObject $resource
+     * @throws JsonApiException
+     */
+    protected function creating(Post $post, ResourceObject $resource): void
+    {
+        $error = Error::fromArray([
+            'title'     => 'The language you want to use is not active',
+            'status'    => Response::HTTP_UNPROCESSABLE_ENTITY,
+        ]);
+
+        throw new JsonApiException($error);
+    }
+}

tests/lib/Integration/Issue566/Test.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright 2020 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Tests\Integration\Issue566;
+
+use CloudCreativity\LaravelJsonApi\Tests\Integration\TestCase;
+use DummyApp\Post;
+
+class Test extends TestCase
+{
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app->bind(\DummyApp\JsonApi\Posts\Adapter::class, Adapter::class);
+    }
+
+    public function test(): void
+    {
+        $model = factory(Post::class)->make();
+
+        $data = [
+            'type' => 'posts',
+            'attributes' => [
+                'title' => $model->title,
+                'slug' => $model->slug,
+                'content' => $model->content,
+            ],
+            'relationships' => [
+                'author' => [
+                    'data' => [
+                        'type' => 'users',
+                        'id' => (string) $model->author->getRouteKey(),
+                    ],
+                ],
+            ],
+        ];
+
+        $expected = [
+            'title' => 'The language you want to use is not active',
+            'status' => '422',
+        ];
+
+        $response = $this->jsonApi()->withData($data)->post('/api/v1/posts');
+        $response->assertExactErrorStatus($expected);
+    }
+}