Add limit to BacktraceProcessor

alexandre-daubois · Nov 8, 2023 · d7a56db · d7a56db
1 parent 605697e
commit d7a56db
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/BacktraceProcessor.php b/src/BacktraceProcessor.php
@@ -19,6 +19,10 @@ final class BacktraceProcessor implements ProcessorInterface
 {
     private const MONOLOG_VENDOR_DIRNAME = 'vendor/monolog/monolog';
 
+    public function __construct(private readonly int|false $limit = false)
+    {
+    }
+
     public function __invoke(LogRecord $record): LogRecord
     {
         $trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
@@ -35,6 +39,10 @@ public function __invoke(LogRecord $record): LogRecord
             }
 
             $stack[] = \sprintf('%s(%d)', $file, $call['line']);
+
+            if ($this->limit && \count($stack) >= $this->limit) {
+                break;
+            }
         }
 
         $record['extra']['backtrace'] = $stack;

diff --git a/tests/BacktraceProcessorTest.php b/tests/BacktraceProcessorTest.php
@@ -32,4 +32,19 @@ public function testItWorks(): void
         $this->assertStringContainsString(__FILE__, $record->extra['backtrace'][0]);
         $this->assertStringMatchesFormat('%s/vendor/bin/phpunit(%d)', $record->extra['backtrace'][\count($record->extra['backtrace']) - 1]);
     }
+
+    public function testLimit(): void
+    {
+        $processor = new BacktraceProcessor(2);
+
+        $handler = new TestHandler();
+        $handler->pushProcessor($processor);
+        $handler->handle($this->createRecord(Level::Notice));
+
+        $this->assertTrue($handler->hasNoticeRecords());
+        $record = $handler->getRecords()[0];
+
+        $this->assertArrayHasKey('backtrace', $record->extra);
+        $this->assertCount(2, $record->extra['backtrace']);
+    }
 }