Skip to content

perf: introduce source code caching to improve duplicate frames #2163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Litarnus wants to merge 1 commit into
base: master
Choose a base branch
from
Open

perf: introduce source code caching to improve duplicate frames #2163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions src/Integration/FrameContextifierIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ final class FrameContextifierIntegration implements IntegrationInterface
*/
private $logger;

/**
* @var array<string, array{
* pre_context: string[],
* context_line: string|null,
* post_context: string[]
* }> The excerpts read while processing the current event, keyed by "file:line"
*/
private $excerptCache = [];

/**
* Creates a new instance of this integration.
*
Expand Down Expand Up @@ -54,16 +63,20 @@ public function setupOnce(): void
return $event;
}

$stacktrace = $event->getStacktrace();
try {
$stacktrace = $event->getStacktrace();

if ($stacktrace !== null) {
$integration->addContextToStacktraceFrames($maxContextLines, $stacktrace);
}
if ($stacktrace !== null) {
$integration->addContextToStacktraceFrames($maxContextLines, $stacktrace);
}

foreach ($event->getExceptions() as $exception) {
if ($exception->getStacktrace() !== null) {
$integration->addContextToStacktraceFrames($maxContextLines, $exception->getStacktrace());
foreach ($event->getExceptions() as $exception) {
if ($exception->getStacktrace() !== null) {
$integration->addContextToStacktraceFrames($maxContextLines, $exception->getStacktrace());
}
}
} finally {
$integration->excerptCache = [];
}

return $event;
Expand Down Expand Up @@ -122,6 +135,12 @@ private function addContextToStacktraceFrame(int $maxContextLines, Frame $frame)
*/
private function getSourceCodeExcerpt(int $maxContextLines, string $filePath, int $lineNumber): array
{
$cacheKey = $filePath . ':' . $lineNumber;

if (isset($this->excerptCache[$cacheKey])) {
return $this->excerptCache[$cacheKey];
}

$frame = [
'pre_context' => [],
'context_line' => null,
Expand Down Expand Up @@ -156,6 +175,8 @@ private function getSourceCodeExcerpt(int $maxContextLines, string $filePath, in

$file->next();
}

$this->excerptCache[$cacheKey] = $frame;
} catch (\Throwable $exception) {
$this->logger->warning(
\sprintf('Failed to get the source code excerpt for the file "%s".', $filePath),
Expand Down
Loading