Merge pull request #427 from facade/feature/query-exception-recording

Add support for recording raw sql queries

resources/js/components/Tabs/ContextTab.vue

@@ -69,6 +69,7 @@ const predefinedContextItemGroups = [
     'context',
     'logs',
     'dumps',
+    'exception',
 ];
 
 export default {

src/Actions/ShareReportAction.php

@@ -150,6 +150,7 @@ protected function getCustomContextGroups(array $contextItems): array
             'context',
             'logs',
             'dumps',
+            'exception',
         ];
 
         return Collection::make($contextItems)

src/IgnitionServiceProvider.php

@@ -27,6 +27,7 @@
 use Facade\Ignition\LogRecorder\LogRecorder;
 use Facade\Ignition\Middleware\AddDumps;
 use Facade\Ignition\Middleware\AddEnvironmentInformation;
+use Facade\Ignition\Middleware\AddExceptionInformation;
 use Facade\Ignition\Middleware\AddGitInformation;
 use Facade\Ignition\Middleware\AddJobInformation;
 use Facade\Ignition\Middleware\AddLogs;
@@ -392,6 +393,7 @@ protected function registerBuiltInMiddleware()
         $middlewares = [
             SetNotifierName::class,
             AddEnvironmentInformation::class,
+            AddExceptionInformation::class,
         ];
 
         if (config('flare.reporting.report_logs')) {

src/Middleware/AddExceptionInformation.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Facade\Ignition\Middleware;
+
+use Facade\FlareClient\Report;
+use Illuminate\Database\QueryException;
+
+class AddExceptionInformation
+{
+    public function handle(Report $report, $next)
+    {
+        $throwable = $report->getThrowable();
+
+        if (! $throwable instanceof QueryException) {
+            return $next($report);
+        }
+
+        $report->group('exception', [
+            'raw_sql' => $throwable->getSql(),
+        ]);
+
+        return $next($report);
+    }
+}

tests/Middleware/AddExceptionInformationTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Facade\Ignition\Tests\Middleware;
+
+use Exception;
+use Facade\Ignition\Facades\Flare;
+use Facade\Ignition\Tests\TestCase;
+use Illuminate\Database\QueryException;
+
+class AddExceptionInformationTest extends TestCase
+{
+    /** @test */
+    public function it_will_add_query_information_with_a_query_exception()
+    {
+        $sql = 'select * from users where emai = "[email protected]"';
+
+        $report = Flare::createReport(new QueryException(
+            '' . $sql . '',
+            [],
+            new Exception()
+        ));
+
+        $context = $report->toArray()['context'];
+
+        $this->assertArrayHasKey('exception', $context);
+        $this->assertSame($sql, $context['exception']['raw_sql']);
+    }
+
+    /** @test */
+    public function it_wont_add_query_information_without_a_query_exception()
+    {
+        $report = Flare::createReport(new Exception());
+
+        $context = $report->toArray()['context'];
+
+        $this->assertArrayNotHasKey('exception', $context);
+    }
+}