Merge branch 'develop' into 3.x

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,14 @@
 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
+
+## [2.1.0] - 2023-11-08
+
+### Added
+
+- Debug exception output now includes any previous exceptions.
+
 ## [2.0.1] - 2023-07-29
 
 ### Fixed

src/ExceptionParser.php

@@ -28,6 +28,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Enumerable;
 use LaravelJsonApi\Core\Document\Error;
+use LaravelJsonApi\Core\Document\ErrorList;
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
 use LaravelJsonApi\Core\Responses\ErrorResponse;
 use Throwable;
@@ -297,20 +298,38 @@ private function mustAccept(Throwable $ex, $request): bool
      * Get the default JSON API error.
      *
      * @param Throwable $ex
-     * @return Error
+     * @return Error|ErrorList
      */
-    private function getDefaultError(Throwable $ex): Error
+    private function getDefaultError(Throwable $ex): Error|ErrorList
     {
         if ($this->default) {
             return $this->default;
         }
 
+        $errors = [];
+        $debug = config('app.debug');
+
+        do {
+            $errors[] = $this->convertExceptionToError($ex, $debug);
+        } while ($ex = $ex->getPrevious());
+
+        return new ErrorList(...$errors);
+    }
+
+    /**
+     * @param Throwable $ex
+     * @param bool $debug
+     * @return Error
+     */
+    private function convertExceptionToError(Throwable $ex, bool $debug): Error
+    {
         $error = Error::make()
             ->setStatus(500)
             ->setTitle(__(Response::$statusTexts[500]));
 
-        if (config('app.debug')) {
-            $error->setCode($ex->getCode())
+        if ($debug) {
+            $error
+                ->setCode($ex->getCode())
                 ->setDetail($ex->getMessage())
                 ->setMeta($this->convertExceptionToMeta($ex));
         }
@@ -325,13 +344,13 @@ private function getDefaultError(Throwable $ex): Error
      * puts into its JSON representation of an exception when in debug mode.
      *
      * @param Throwable $ex
-     * @return array
+     * @return array<string, mixed>
      * @see \Illuminate\Foundation\Exceptions\Handler::convertExceptionToArray()
      */
     private function convertExceptionToMeta(Throwable $ex): array
     {
         return [
-            'exception' => get_class($ex),
+            'exception' => $ex::class,
             'file' => $ex->getFile(),
             'line' => $ex->getLine(),
             'trace' => Collection::make($ex->getTrace())

tests/Integration/ExceptionsTest.php

@@ -541,6 +541,9 @@ public function testDefaultExceptionWithoutDebug(): void
             ->assertExactJson($expected);
     }
 
+    /**
+     * @return void
+     */
     public function testDefaultExceptionWithDebug(): void
     {
         config()->set('app.debug', true);
@@ -569,10 +572,87 @@ public function testDefaultExceptionWithDebug(): void
             ],
         ];
 
-        $this->get('/test', ['Accept' => 'application/vnd.api+json'])
+        $this
+            ->get('/test', ['Accept' => 'application/vnd.api+json'])
             ->assertStatus(500)
             ->assertHeader('Content-Type', 'application/vnd.api+json')
             ->assertExactJson($expected);
     }
 
+    /**
+     * @return void
+     */
+    public function testDefaultExceptionWithPreviousExceptionAndWithDebug(): void
+    {
+        config()->set('app.debug', true);
+
+        $this->ex = $ex = new \LogicException(
+            message: 'Boom.',
+            code: 99,
+            previous: $previous1 = new \RuntimeException(
+                message: 'Blah!',
+                code: 98,
+                previous: $previous2 = new \Exception(
+                    message: 'Baz!',
+                    code: 97
+                ),
+            ),
+        );
+
+        $expected = [
+            'errors' => [
+                [
+                    'code' => (string) $ex->getCode(),
+                    'detail' => $ex->getMessage(),
+                    'meta' => [
+                        'exception' => $ex::class,
+                        'file' => $ex->getFile(),
+                        'line' => $ex->getLine(),
+                        'trace' => Collection::make($ex->getTrace())
+                            ->map(fn($trace) => Arr::except($trace, ['args']))
+                            ->all(),
+                    ],
+                    'status' => '500',
+                    'title' => 'Internal Server Error',
+                ],
+                [
+                    'code' => (string) $previous1->getCode(),
+                    'detail' => $previous1->getMessage(),
+                    'meta' => [
+                        'exception' => $previous1::class,
+                        'file' => $previous1->getFile(),
+                        'line' => $previous1->getLine(),
+                        'trace' => Collection::make($previous1->getTrace())
+                            ->map(fn($trace) => Arr::except($trace, ['args']))
+                            ->all(),
+                    ],
+                    'status' => '500',
+                    'title' => 'Internal Server Error',
+                ],
+                [
+                    'code' => (string) $previous2->getCode(),
+                    'detail' => $previous2->getMessage(),
+                    'meta' => [
+                        'exception' => $previous2::class,
+                        'file' => $previous2->getFile(),
+                        'line' => $previous2->getLine(),
+                        'trace' => Collection::make($previous2->getTrace())
+                            ->map(fn($trace) => Arr::except($trace, ['args']))
+                            ->all(),
+                    ],
+                    'status' => '500',
+                    'title' => 'Internal Server Error',
+                ],
+            ],
+            'jsonapi' => [
+                'version' => '1.0',
+            ],
+        ];
+
+        $this
+            ->get('/test', ['Accept' => 'application/vnd.api+json'])
+            ->assertStatus(500)
+            ->assertHeader('Content-Type', 'application/vnd.api+json')
+            ->assertExactJson($expected);
+    }
 }