Merge pull request #90 from spatie/feature/use-custom-exception-context

Use context from custom exceptions

src/FlareMiddleware/AddExceptionInformation.php

@@ -12,6 +12,8 @@ public function handle(Report $report, $next)
     {
         $throwable = $report->getThrowable();
 
+        $this->addUserDefinedContext($report);
+
         if (! $throwable instanceof QueryException) {
             return $next($report);
         }
@@ -22,4 +24,27 @@ public function handle(Report $report, $next)
 
         return $next($report);
     }
+
+    private function addUserDefinedContext(Report $report): void
+    {
+        $throwable = $report->getThrowable();
+
+        if ($throwable === null) {
+            return;
+        }
+
+        if (! method_exists($throwable, 'context')) {
+            return;
+        }
+
+        $context = $throwable->context();
+
+        if (! is_array($context)) {
+            return;
+        }
+
+        foreach ($context as $key => $value) {
+            $report->context($key, $value);
+        }
+    }
 }

tests/FlareMiddleware/AddExceptionInformationTest.php

@@ -25,3 +25,33 @@
 
     $this->assertArrayNotHasKey('exception', $context);
 });
+
+it('will add user context when provided on a custom exception', function () {
+    $report = Flare::createReport(new class extends Exception {
+        public function context()
+        {
+            return [
+                'hello' => 'world',
+            ];
+        }
+    });
+
+    $context = $report->toArray()['context'];
+
+    expect($context['context']['hello'])->toBe('world');
+});
+
+it('will only add arrays as user provided context', function () {
+    $report = Flare::createReport(new class extends Exception {
+        public function context()
+        {
+            return (object) [
+                'hello' => 'world',
+            ];
+        }
+    });
+
+    $context = $report->toArray()['context'];
+
+    expect($context)->not()->toHaveKey('context');
+});