Merge pull request #23 from facade/error-and-exception-filtering

Add support for error and exception filtering

Author: rubenvanassche

src/Flare.php

@@ -2,6 +2,7 @@
 
 namespace Facade\FlareClient;
 
+use Error;
 use ErrorException;
 use Exception;
 use Facade\FlareClient\Concerns\HasContext;
@@ -52,6 +53,12 @@ class Flare
     /** @var callable|null */
     protected $determineVersionCallable;
 
+    /** @var int|null */
+    protected $reportErrorLevels;
+
+    /** @var callable|null */
+    protected $filterExceptionsCallable;
+
     public static function register(string $apiKey, string $apiSecret = null, ContextDetectorInterface $contextDetector = null, Container $container = null)
     {
         $client = new Client($apiKey, $apiSecret);
@@ -64,6 +71,16 @@ public function determineVersionUsing($determineVersionCallable)
         $this->determineVersionCallable = $determineVersionCallable;
     }
 
+    public function reportErrorLevels(int $reportErrorLevels)
+    {
+        $this->reportErrorLevels = $reportErrorLevels;
+    }
+
+    public function filterExceptionsUsing(callable $filterExceptionsCallable)
+    {
+        $this->filterExceptionsCallable = $filterExceptionsCallable;
+    }
+
     /**
      * @return null|string
      */
@@ -175,6 +192,10 @@ public function applicationPath(string $applicationPath)
 
     public function report(Throwable $throwable, callable $callback = null)
     {
+        if (! $this->shouldSendReport($throwable)) {
+            return;
+        }
+
         $report = $this->createReport($throwable);
 
         if (! is_null($callback)) {
@@ -184,6 +205,23 @@ public function report(Throwable $throwable, callable $callback = null)
         $this->sendReportToApi($report);
     }
 
+    protected function shouldSendReport(Throwable $throwable): bool
+    {
+        if ($this->reportErrorLevels && $throwable instanceof Error) {
+            return $this->reportErrorLevels & $throwable->getCode();
+        }
+
+        if ($this->reportErrorLevels && $throwable instanceof ErrorException) {
+            return $this->reportErrorLevels & $throwable->getSeverity();
+        }
+
+        if ($this->filterExceptionsCallable && $throwable instanceof Exception) {
+            return call_user_func($this->filterExceptionsCallable, $throwable);
+        }
+
+        return true;
+    }
+
     public function reportMessage(string $message, string $logLevel, callable $callback = null)
     {
         $report = $this->createReportFromMessage($message, $logLevel);

tests/FlareTest.php

@@ -2,13 +2,16 @@
 
 namespace Facade\FlareClient\Tests;
 
+use Error;
+use ErrorException;
 use Facade\FlareClient\Api;
 use Facade\FlareClient\Enums\MessageLevels;
 use Facade\FlareClient\Flare;
 use Facade\FlareClient\Tests\Concerns\MatchesReportSnapshots;
 use Facade\FlareClient\Tests\Mocks\FakeClient;
 use Facade\FlareClient\Tests\TestClasses\ExceptionWithContext;
 use PHPUnit\Framework\Exception;
+use Throwable;
 
 class FlareTest extends TestCase
 {
@@ -43,6 +46,14 @@ protected function reportException()
         $this->flare->report($throwable);
     }
 
+    protected function reportError(int $code)
+    {
+        $throwable = new Error('This is a test', $code);
+
+        $this->flare->report($throwable);
+    }
+
+
     /** @test */
     public function it_can_report_an_exception()
     {
@@ -304,4 +315,60 @@ public function it_will_add_the_version_to_the_report()
 
         $this->assertEquals('123', $payload['application_version']);
     }
+
+    /** @test */
+    public function it_can_filter_exceptions_being_reported()
+    {
+        $this->reportException();
+
+        $this->fakeClient->assertRequestsSent(1);
+
+        $this->flare->filterExceptionsUsing(function (Throwable $exception) {
+            return false;
+        });
+
+        $this->reportException();
+
+        $this->fakeClient->assertRequestsSent(1);
+
+        $this->flare->filterExceptionsUsing(function (Throwable $exception) {
+            return true;
+        });
+
+        $this->reportException();
+
+        $this->fakeClient->assertRequestsSent(2);
+    }
+
+    /** @test */
+    public function it_can_filter_errors_based_on_their_level()
+    {
+        $this->reportError(E_NOTICE);
+        $this->reportError(E_WARNING);
+
+        $this->fakeClient->assertRequestsSent(2);
+
+        $this->flare->reportErrorLevels(E_ALL & ~E_NOTICE);
+
+        $this->reportError(E_NOTICE);
+        $this->reportError(E_WARNING);
+
+        $this->fakeClient->assertRequestsSent(3);
+    }
+
+    /** @test */
+    public function it_can_filter_error_exceptions_based_on_their_severity()
+    {
+        $this->flare->report(new ErrorException('test', 0, E_NOTICE));
+        $this->flare->report(new ErrorException('test', 0, E_WARNING));
+
+        $this->fakeClient->assertRequestsSent(2);
+
+        $this->flare->reportErrorLevels(E_ALL & ~E_NOTICE);
+
+        $this->flare->report(new ErrorException('test', 0, E_NOTICE));
+        $this->flare->report(new ErrorException('test', 0, E_WARNING));
+
+        $this->fakeClient->assertRequestsSent(3);
+    }
 }