feat: provide context when reporting exception to psr log

Author: lindyhopchris

src/Infrastructure/ExceptionReporter/PsrLogExceptionReporter.php

@@ -13,6 +13,7 @@
 namespace CloudCreativity\Modules\Infrastructure\ExceptionReporter;
 
 use CloudCreativity\Modules\Contracts\Application\Ports\Driven\ExceptionReporter;
+use CloudCreativity\Modules\Contracts\Toolkit\Loggable\ContextProvider;
 use Psr\Log\LoggerInterface;
 use Throwable;
 
@@ -34,7 +35,25 @@ public function report(Throwable $ex): void
     {
         $this->logger->error(
             $ex->getMessage() ?: 'Unexpected error: ' . $ex::class,
-            ['exception' => $ex],
+            [...$this->context($ex), 'exception' => $ex],
         );
     }
+
+    /**
+     * @param Throwable $ex
+     * @return array<array-key, mixed>
+     */
+    private function context(Throwable $ex): array
+    {
+        if ($ex instanceof ContextProvider) {
+            return $ex->context();
+        }
+
+        if (method_exists($ex, 'context')) {
+            $context = $ex->context();
+            return is_array($context) ? $context : [];
+        }
+
+        return [];
+    }
 }

tests/Unit/Infrastructure/ExceptionReporter/PsrLogExceptionReporterTest.php

@@ -13,6 +13,7 @@
 namespace CloudCreativity\Modules\Tests\Unit\Infrastructure\ExceptionReporter;
 
 use CloudCreativity\Modules\Contracts\Application\Ports\Driven\ExceptionReporter;
+use CloudCreativity\Modules\Contracts\Toolkit\Loggable\ContextProvider;
 use CloudCreativity\Modules\Infrastructure\ExceptionReporter\PsrLogExceptionReporter;
 use LogicException;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -83,4 +84,61 @@ public function testItReportsDefaultMessageIfExceptionHasEmptyMessage(): void
 
         $this->assertInstanceOf(ExceptionReporter::class, $this->reporter);
     }
+
+    public function testItLogsContextForExceptionThatImplementsContextProvider(): void
+    {
+        $exception = new class ('Boom!') extends LogicException implements ContextProvider {
+            public function context(): array
+            {
+                return ['foo' => 'bar', 'exception' => null];
+            }
+        };
+
+        $expected = [
+            'foo' => 'bar',
+            'exception' => $exception,
+        ];
+
+        $this->logger
+            ->expects($this->once())
+            ->method('error')
+            ->with(
+                $exception->getMessage(),
+                $this->identicalTo($expected),
+            );
+
+        $this->reporter->report($exception);
+
+        $this->assertInstanceOf(ExceptionReporter::class, $this->reporter);
+    }
+
+    public function testItLogsContextForExceptionThatHasContextMethod(): void
+    {
+        $exception = new class ('Boom!') extends LogicException {
+            /**
+             * @return array<string, mixed>
+             */
+            public function context(): array
+            {
+                return ['foo' => 'bar', 'exception' => null];
+            }
+        };
+
+        $expected = [
+            'foo' => 'bar',
+            'exception' => $exception,
+        ];
+
+        $this->logger
+            ->expects($this->once())
+            ->method('error')
+            ->with(
+                $exception->getMessage(),
+                $this->identicalTo($expected),
+            );
+
+        $this->reporter->report($exception);
+
+        $this->assertInstanceOf(ExceptionReporter::class, $this->reporter);
+    }
 }