Merge pull request #587 from rollbar/4.0/update-filter-interface

Added typing / comments to the `FilterInterface` and removed the token argument
rollbar · Jan 12, 2023 · 2972bda · 2972bda
2 parents 44bf101 + 18fabc2
commit 2972bda
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 14 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -833,7 +833,8 @@ public function getSendMessageTrace()
         return $this->sendMessageTrace;
     }
 
-    public function checkIgnored(Payload $payload, string $accessToken, $toLog, bool $isUncaught)
+
+    public function checkIgnored(Payload $payload, $toLog, bool $isUncaught)
     {
         if (isset($this->checkIgnore)) {
             try {
@@ -856,7 +857,7 @@ public function checkIgnored(Payload $payload, string $accessToken, $toLog, bool
         }
 
         if (!is_null($this->filter)) {
-            $filter = $this->filter->shouldSend($payload, $accessToken);
+            $filter = $this->filter->shouldSend($payload, $isUncaught);
             $this->verboseLogger()->debug("Custom filter result: " . var_export($filter, true));
             return $filter;
         }

diff --git a/src/FilterInterface.php b/src/FilterInterface.php
@@ -4,7 +4,21 @@
 
 use Rollbar\Payload\Payload;
 
+/**
+ * The FilterInterface allows a custom payload filter to be used. It should be passed to the configs with the 'filter'
+ * key. A custom filter should implement this interface.
+ */
 interface FilterInterface
 {
-    public function shouldSend(Payload $payload, string $accessToken);
+    /**
+     * Method called to determine if a payload should be sent to the Rollbar service. If true is returned the payload
+     * will not be sent.
+     *
+     * @param Payload $payload    The payload instance that may be sent.
+     * @param bool    $isUncaught True if the payload represents an error that was caught by one of the Rollbar
+     *                            exception or error handlers.
+     *
+     * @return bool
+     */
+    public function shouldSend(Payload $payload, bool $isUncaught): bool;
 }
diff --git a/src/RollbarLogger.php b/src/RollbarLogger.php
@@ -242,7 +242,7 @@ public function report($level, string|Stringable $message, array $context = arra
         $payload     = $this->getPayload($accessToken, $level, $message, $context);
 
         $isUncaught = $this->isUncaughtLogData($message);
-        if ($this->config->checkIgnored($payload, $accessToken, $message, $isUncaught)) {
+        if ($this->config->checkIgnored($payload, $message, $isUncaught)) {
             $this->verboseLogger()->info('Occurrence ignored');
             $response = new Response(0, "Ignored");
         } else {

diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -341,12 +341,12 @@ public function testMinimumLevel(): void
 
     public function assertPayloadIgnored($config, $payload): void
     {
-        $this->assertTrue($config->checkIgnored($payload, 'access-token', $this->error, false));
+        $this->assertTrue($config->checkIgnored($payload, $this->error, false));
     }
 
     public function assertPayloadNotIgnored($config, $payload): void
     {
-        $this->assertFalse($config->checkIgnored($payload, 'access-token', $this->error, false));
+        $this->assertFalse($config->checkIgnored($payload, $this->error, false));
     }
 
     private function prepareMockPayload($level): Payload
@@ -421,8 +421,8 @@ public function testFilter(): void
             "environment" => $this->env,
             "filter" => $filter
         ));
-        $this->assertTrue($c->checkIgnored($p, "fake_access_token", $this->error, false));
-        $this->assertFalse($c->checkIgnored($p, "fake_access_token", $this->error, false));
+        $this->assertTrue($c->checkIgnored($p, $this->error, false));
+        $this->assertFalse($c->checkIgnored($p, $this->error, false));
     }
 
     public function testSender(): void
@@ -608,7 +608,6 @@ public function testCheckIgnore(): void
                 $data,
                 $config->getAccessToken()
             ),
-            $this->getTestAccessToken(),
             $this->error,
             false
         );
@@ -647,7 +646,6 @@ public function testCheckIgnoreParameters(): void
                 $data,
                 $config->getAccessToken()
             ),
-            $this->getTestAccessToken(),
             $this->error,
             true
         );

diff --git a/tests/VerbosityTest.php b/tests/VerbosityTest.php
@@ -612,7 +612,6 @@ function () use ($config, $unitTest) {
                 $payloadMock->method('getData')->willReturn($dataMock);
                 $config->checkIgnored(
                     $payloadMock,
-                    $unitTest->getTestAccessToken(),
                     $payloadMock,
                     false
                 );
@@ -651,7 +650,7 @@ function () use ($config, $unitTest) {
             // logic under test
                 $data = $config->getRollbarData(\Rollbar\Payload\Level::INFO, 'some message', array());
                 $payload = new \Rollbar\Payload\Payload($data, $unitTest->getTestAccessToken());
-                $config->checkIgnored($payload, $unitTest->getTestAccessToken(), 'some message', false);
+                $config->checkIgnored($payload, 'some message', false);
             },
             function () use ($unitTest) {
             // verbosity expectations
@@ -685,7 +684,7 @@ function () use ($config, $unitTest) {
             // logic under test
                 $data = $config->getRollbarData(\Rollbar\Payload\Level::INFO, 'some message', array());
                 $payload = new \Rollbar\Payload\Payload($data, $unitTest->getTestAccessToken());
-                $config->checkIgnored($payload, $unitTest->getTestAccessToken(), 'some message', false);
+                $config->checkIgnored($payload, 'some message', false);
             },
             function () use ($unitTest) {
             // verbosity expectations
@@ -722,7 +721,7 @@ function () use ($config, $unitTest) {
             // logic under test
                 $data = $config->getRollbarData(\Rollbar\Payload\Level::INFO, 'some message', array());
                 $payload = new \Rollbar\Payload\Payload($data, $unitTest->getTestAccessToken());
-                $config->checkIgnored($payload, $unitTest->getTestAccessToken(), 'some message', false);
+                $config->checkIgnored($payload, 'some message', false);
             },
             function () use ($unitTest) {
             // verbosity expectations