Strip path prefixes on profile frames (#1568)

src/FrameBuilder.php

@@ -5,6 +5,7 @@
 namespace Sentry;
 
 use Sentry\Serializer\RepresentationSerializerInterface;
+use Sentry\Util\PrefixStripper;
 
 /**
  * This class builds a {@see Frame} object out of a backtrace's raw frame.
@@ -22,6 +23,8 @@
  */
 final class FrameBuilder
 {
+    use PrefixStripper;
+
     /**
      * @var Options The SDK client options
      */
@@ -66,13 +69,13 @@ public function buildFromBacktraceFrame(string $file, int $line, array $backtrac
 
         $functionName = null;
         $rawFunctionName = null;
-        $strippedFilePath = $this->stripPrefixFromFilePath($file);
+        $strippedFilePath = $this->stripPrefixFromFilePath($this->options, $file);
 
         if (isset($backtraceFrame['class']) && isset($backtraceFrame['function'])) {
             $functionName = $backtraceFrame['class'];
 
             if (str_starts_with($functionName, Frame::ANONYMOUS_CLASS_PREFIX)) {
-                $functionName = Frame::ANONYMOUS_CLASS_PREFIX . $this->stripPrefixFromFilePath(substr($backtraceFrame['class'], \strlen(Frame::ANONYMOUS_CLASS_PREFIX)));
+                $functionName = Frame::ANONYMOUS_CLASS_PREFIX . $this->stripPrefixFromFilePath($this->options, substr($backtraceFrame['class'], \strlen(Frame::ANONYMOUS_CLASS_PREFIX)));
             }
 
             $rawFunctionName = sprintf('%s::%s', $backtraceFrame['class'], $backtraceFrame['function']);
@@ -92,22 +95,6 @@ public function buildFromBacktraceFrame(string $file, int $line, array $backtrac
         );
     }
 
-    /**
-     * Removes from the given file path the specified prefixes.
-     *
-     * @param string $filePath The path to the file
-     */
-    private function stripPrefixFromFilePath(string $filePath): string
-    {
-        foreach ($this->options->getPrefixes() as $prefix) {
-            if (str_starts_with($filePath, $prefix)) {
-                return mb_substr($filePath, mb_strlen($prefix));
-            }
-        }
-
-        return $filePath;
-    }
-
     /**
      * Checks whether a certain frame should be marked as "in app" or not.
      *

src/Profiling/Profile.php

@@ -8,6 +8,8 @@
 use Sentry\Context\RuntimeContext;
 use Sentry\Event;
 use Sentry\EventId;
+use Sentry\Options;
+use Sentry\Util\PrefixStripper;
 use Sentry\Util\SentryUid;
 
 /**
@@ -73,6 +75,8 @@
  */
 final class Profile
 {
+    use PrefixStripper;
+
     /**
      * @var string The version of the profile format
      */
@@ -108,6 +112,16 @@ final class Profile
      */
     private $eventId;
 
+    /**
+     * @var Options|null
+     */
+    private $options;
+
+    public function __construct(?Options $options = null)
+    {
+        $this->options = $options;
+    }
+
     public function setStartTimeStamp(float $startTimeStamp): void
     {
         $this->startTimeStamp = $startTimeStamp;
@@ -160,8 +174,7 @@ public function getFormattedData(Event $event): ?array
         foreach ($loggedStacks as $stackId => $stack) {
             foreach ($stack['trace'] as $frame) {
                 $absolutePath = (string) $frame['file'];
-                // TODO(michi) Strip the file path based on the `prefixes` option
-                $file = $absolutePath;
+                $file = $this->stripPrefixFromFilePath($this->options, $absolutePath);
                 $module = null;
 
                 if (isset($frame['class'], $frame['function'])) {

src/Profiling/Profiler.php

@@ -4,6 +4,8 @@
 
 namespace Sentry\Profiling;
 
+use Sentry\Options;
+
 /**
  * @internal
  */
@@ -29,9 +31,9 @@ final class Profiler
      */
     private const MAX_STACK_DEPTH = 128;
 
-    public function __construct()
+    public function __construct(?Options $options = null)
     {
-        $this->profile = new Profile();
+        $this->profile = new Profile($options);
 
         $this->initProfiler();
     }

src/Tracing/Transaction.php

@@ -121,7 +121,10 @@ public function detachSpanRecorder(): void
     public function initProfiler(): void
     {
         if (null === $this->profiler) {
-            $this->profiler = new Profiler();
+            $client = $this->hub->getClient();
+            $options = null !== $client ? $client->getOptions() : null;
+
+            $this->profiler = new Profiler($options);
         }
     }
 

src/Util/PrefixStripper.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Util;
+
+use Sentry\Options;
+
+trait PrefixStripper
+{
+    /**
+     * Removes from the given file path the specified prefixes in the SDK options.
+     */
+    protected function stripPrefixFromFilePath(?Options $options, string $filePath): string
+    {
+        if (null === $options) {
+            return $filePath;
+        }
+
+        foreach ($options->getPrefixes() as $prefix) {
+            if (str_starts_with($filePath, $prefix)) {
+                return mb_substr($filePath, mb_strlen($prefix));
+            }
+        }
+
+        return $filePath;
+    }
+}