Merge pull request #143 from signify-nz/filter-out-ipaddress

Allow client IP address to be filtered out.
MindscapeHQ · Nov 29, 2021 · 648acd7 · 648acd7
2 parents fd1b917 + 1d23df4
commit 648acd7
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/src/Raygun4php/RaygunClient.php b/src/Raygun4php/RaygunClient.php
@@ -420,6 +420,10 @@ public function filterParamsFromMessage($message, $replace = '[filtered]')
  array_walk_recursive($message->Details->Request->Data, $walkFn);
  }
 
+ if ($message->Details->Request->IpAddress) {
+ $walkFn($message->Details->Request->IpAddress, 'IpAddress');
+ }
+
  if ($message->Details->UserCustomData) {
  array_walk_recursive($message->Details->UserCustomData, $walkFn);
  }

diff --git a/tests/RaygunClientTest.php b/tests/RaygunClientTest.php
@@ -156,6 +156,31 @@ protected function getEmptyMessage()
  return $message;
  }
 
+ public function testFilterIpAddress()
+ {
+ // Ensure IP is not filtered by default.
+ $this->client->setFilterParams(array('SomethingElse' => true,));
+ $message = $this->getEmptyMessage();
+ $message->Details->Request->IpAddress = '0.0.0.0';
+
+ $filteredMessage = $this->client->filterParamsFromMessage($message);
+ $this->assertEquals(
+ $filteredMessage->Details->Request->IpAddress,
+ '0.0.0.0'
+ );
+
+ // Ensure IP can be filtered.
+ $this->client->setFilterParams(array('IpAddress' => true,));
+ $message = $this->getEmptyMessage();
+ $message->Details->Request->IpAddress = '0.0.0.0';
+
+ $filteredMessage = $this->client->filterParamsFromMessage($message);
+ $this->assertEquals(
+ $filteredMessage->Details->Request->IpAddress,
+ '[filtered]'
+ );
+ }
+
  public function testFilterParamsFromMessage()
  {
  /** @var RaygunMessage&MockObject $message */