Merge pull request #11 from Naoray/feat/enhance-templates

feat: enhance templates

Author: Naoray

README.md

@@ -118,6 +118,8 @@ This will copy the templates to `resources/views/vendor/github-monolog/` where y
 - `comment.md`: Template for comments on existing issues
 - `previous_exception.md`: Template for previous exceptions in the chain
 
+> **Important**: The templates use HTML comments as section markers (e.g. `<!-- stacktrace:start -->` and `<!-- stacktrace:end -->`). These markers are used to intelligently remove empty sections from the rendered output. Please keep these markers intact when customizing the templates.
+
 Available template variables:
 - `{level}`: Log level (error, warning, etc.)
 - `{message}`: The error message or log content

phpstan-baseline.neon

@@ -0,0 +1,7 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Parameter \#1 \$callback of method Illuminate\\Support\\Collection\<int,string\>\:\:filter\(\) expects \(callable\(string, int\)\: bool\)\|null, Closure\(string, string\)\: bool given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/Issues/SectionMapping.php

resources/views/comment.md

@@ -1,28 +1,50 @@
-# New Occurrence
+## Error Details
+**Type:** {level}
+**Message:** {message}
 
-**Log Level:** {level}
+<!-- stacktrace:start -->
+---
 
-{message}
-
-**Simplified Stack Trace:**
-```php
+## Stack Trace
+```shell
 {simplified_stack_trace}
 ```
 
 <details>
-<summary>Complete Stack Trace</summary>
+<summary>📋 View Complete Stack Trace</summary>
 
-```php
+```shell
 {full_stack_trace}
 ```
 </details>
 
+<!-- prev-stacktrace:start -->
 <details>
-<summary>Previous Exceptions</summary>
+<summary>🔍 View Previous Exceptions</summary>
 
+```shell
 {previous_exceptions}
+```
 </details>
+<!-- prev-stacktrace:end -->
+<!-- stacktrace:end -->
 
+<!-- context:start -->
+---
+
+## Context
+```json
 {context}
+```
+<!-- context:end -->
 
+<!-- extra:start -->
+---
+
+## Extra Data
+```json
 {extra}
+```
+<!-- extra:end -->
+
+<!-- Signature: {signature} -->

resources/views/issue.md

@@ -1,28 +1,50 @@
+## Error Details
 **Log Level:** {level}
+**Class:** {class}
+**Message:** {message}
 
-{message}
+<!-- stacktrace:start -->
+---
 
-**Simplified Stack Trace:**
-```php
+## Stack Trace
+```shell
 {simplified_stack_trace}
 ```
 
 <details>
-<summary>Complete Stack Trace</summary>
+<summary>📋 View Complete Stack Trace</summary>
 
-```php
+```shell
 {full_stack_trace}
 ```
 </details>
 
+<!-- prev-stacktrace:start -->
 <details>
-<summary>Previous Exceptions</summary>
+<summary>🔍 View Previous Exceptions</summary>
 
 {previous_exceptions}
+
 </details>
+<!-- prev-stacktrace:end -->
+<!-- stacktrace:end -->
+
+<!-- context:start -->
+---
 
+## Context
+```json
 {context}
+```
+<!-- context:end -->
 
+<!-- extra:start -->
+---
+
+## Extra Data
+```json
 {extra}
+```
+<!-- extra:end -->
 
 <!-- Signature: {signature} -->

resources/views/previous_exception.md

@@ -1,15 +1,14 @@
-### Previous Exception #{count}
-**Type:** {type}
+## Previous Exception #{count}
+{message}
 
-**Simplified Stack Trace:**
-```php
+<!-- prev-exception-stacktrace:start -->
+```shell
 {simplified_stack_trace}
 ```
 
-<details>
-<summary>Complete Stack Trace</summary>
+---
 
-```php
+```shell
 {full_stack_trace}
 ```
-</details>
+<!-- prev-exception-stacktrace:end -->

src/GithubMonologServiceProvider.php

@@ -5,25 +5,38 @@
 use Illuminate\Support\ServiceProvider;
 use Naoray\LaravelGithubMonolog\Issues\Formatters\ExceptionFormatter;
 use Naoray\LaravelGithubMonolog\Issues\Formatters\IssueFormatter;
+use Naoray\LaravelGithubMonolog\Issues\Formatters\PreviousExceptionFormatter;
 use Naoray\LaravelGithubMonolog\Issues\Formatters\StackTraceFormatter;
 use Naoray\LaravelGithubMonolog\Issues\StubLoader;
 use Naoray\LaravelGithubMonolog\Issues\TemplateRenderer;
+use Naoray\LaravelGithubMonolog\Issues\TemplateSectionCleaner;
 
 class GithubMonologServiceProvider extends ServiceProvider
 {
     public function register(): void
     {
         $this->app->bind(StackTraceFormatter::class);
         $this->app->bind(StubLoader::class);
+        $this->app->bind(TemplateSectionCleaner::class);
+
         $this->app->bind(ExceptionFormatter::class, function ($app) {
             return new ExceptionFormatter(
                 stackTraceFormatter: $app->make(StackTraceFormatter::class),
             );
         });
 
+        $this->app->bind(PreviousExceptionFormatter::class, function ($app) {
+            return new PreviousExceptionFormatter(
+                exceptionFormatter: $app->make(ExceptionFormatter::class),
+                stubLoader: $app->make(StubLoader::class),
+            );
+        });
+
         $this->app->singleton(TemplateRenderer::class, function ($app) {
             return new TemplateRenderer(
                 exceptionFormatter: $app->make(ExceptionFormatter::class),
+                previousExceptionFormatter: $app->make(PreviousExceptionFormatter::class),
+                sectionCleaner: $app->make(TemplateSectionCleaner::class),
                 stubLoader: $app->make(StubLoader::class),
             );
         });

src/Issues/Formatter.php

@@ -5,7 +5,6 @@
 use Monolog\Formatter\FormatterInterface;
 use Monolog\LogRecord;
 use Naoray\LaravelGithubMonolog\Issues\TemplateRenderer;
-use Throwable;
 
 class IssueFormatter implements FormatterInterface
 {
@@ -19,29 +18,15 @@ public function format(LogRecord $record): Formatted
             throw new \RuntimeException('Record is missing github_issue_signature in extra data. Make sure the DeduplicationHandler is configured correctly.');
         }
 
-        $exception = $this->getException($record);
-
         return new Formatted(
-            title: $this->templateRenderer->renderTitle($record, $exception),
-            body: $this->templateRenderer->render($this->templateRenderer->getIssueStub(), $record, $record->extra['github_issue_signature'], $exception),
-            comment: $this->templateRenderer->render($this->templateRenderer->getCommentStub(), $record, null, $exception),
+            title: $this->templateRenderer->renderTitle($record),
+            body: $this->templateRenderer->render($this->templateRenderer->getIssueStub(), $record, $record->extra['github_issue_signature']),
+            comment: $this->templateRenderer->render($this->templateRenderer->getCommentStub(), $record, null),
         );
     }
 
     public function formatBatch(array $records): array
     {
         return array_map([$this, 'format'], $records);
     }
-
-    private function hasErrorException(LogRecord $record): bool
-    {
-        return $record->level->value >= \Monolog\Level::Error->value
-            && isset($record->context['exception'])
-            && $record->context['exception'] instanceof Throwable;
-    }
-
-    private function getException(LogRecord $record): ?Throwable
-    {
-        return $this->hasErrorException($record) ? $record->context['exception'] : null;
-    }
 }

src/Issues/Formatters/IssueFormatter.php

@@ -5,7 +5,6 @@
 use Monolog\Formatter\FormatterInterface;
 use Monolog\LogRecord;
 use Naoray\LaravelGithubMonolog\Issues\TemplateRenderer;
-use Throwable;
 
 class IssueFormatter implements FormatterInterface
 {
@@ -19,29 +18,15 @@ public function format(LogRecord $record): Formatted
             throw new \RuntimeException('Record is missing github_issue_signature in extra data. Make sure the DeduplicationHandler is configured correctly.');
         }
 
-        $exception = $this->getException($record);
-
         return new Formatted(
-            title: $this->templateRenderer->renderTitle($record, $exception),
-            body: $this->templateRenderer->render($this->templateRenderer->getIssueStub(), $record, $record->extra['github_issue_signature'], $exception),
-            comment: $this->templateRenderer->render($this->templateRenderer->getCommentStub(), $record, null, $exception),
+            title: $this->templateRenderer->renderTitle($record),
+            body: $this->templateRenderer->render($this->templateRenderer->getIssueStub(), $record, $record->extra['github_issue_signature']),
+            comment: $this->templateRenderer->render($this->templateRenderer->getCommentStub(), $record, null),
         );
     }
 
     public function formatBatch(array $records): array
     {
         return array_map([$this, 'format'], $records);
     }
-
-    private function hasErrorException(LogRecord $record): bool
-    {
-        return $record->level->value >= \Monolog\Level::Error->value
-            && isset($record->context['exception'])
-            && $record->context['exception'] instanceof Throwable;
-    }
-
-    private function getException(LogRecord $record): ?Throwable
-    {
-        return $this->hasErrorException($record) ? $record->context['exception'] : null;
-    }
 }

src/Issues/Formatters/PreviousExceptionFormatter.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Naoray\LaravelGithubMonolog\Issues\Formatters;
+
+use Illuminate\Support\Str;
+use Monolog\LogRecord;
+use Naoray\LaravelGithubMonolog\Issues\InteractsWithLogRecord;
+use Naoray\LaravelGithubMonolog\Issues\StubLoader;
+use Throwable;
+
+class PreviousExceptionFormatter
+{
+    use InteractsWithLogRecord;
+
+    private const MAX_PREVIOUS_EXCEPTIONS = 3;
+
+    private string $previousExceptionStub;
+
+    public function __construct(
+        private readonly ExceptionFormatter $exceptionFormatter,
+        private readonly StubLoader $stubLoader,
+    ) {
+        $this->previousExceptionStub = $this->stubLoader->load('previous_exception');
+    }
+
+    public function format(LogRecord $record): string
+    {
+        $exception = $this->getException($record);
+
+        if (! $exception instanceof Throwable) {
+            return '';
+        }
+
+        if (! $previous = $exception->getPrevious()) {
+            return '';
+        }
+
+        $exceptions = collect()
+            ->range(1, self::MAX_PREVIOUS_EXCEPTIONS)
+            ->map(function ($count) use (&$previous, $record) {
+                if (! $previous) {
+                    return null;
+                }
+
+                $current = $previous;
+                $previous = $previous->getPrevious();
+
+                $details = $this->exceptionFormatter->format(
+                    $record->with(
+                        context: ['exception' => $current],
+                        extra: []
+                    )
+                );
+
+                return Str::of($this->previousExceptionStub)
+                    ->replace(
+                        ['{count}', '{message}', '{simplified_stack_trace}', '{full_stack_trace}'],
+                        [$count, $current->getMessage(), $details['simplified_stack_trace'], str_replace(base_path(), '', $details['full_stack_trace'])]
+                    )
+                    ->toString();
+            })
+            ->filter()
+            ->join("\n\n");
+
+        if (empty($exceptions)) {
+            return '';
+        }
+
+        if ($previous) {
+            $exceptions .= "\n\n> Note: Additional previous exceptions were truncated\n";
+        }
+
+        return $exceptions;
+    }
+}

src/Issues/Formatters/StackTraceFormatter.php

@@ -28,7 +28,11 @@ public function format(string $stackTrace): string
 
                 $line = str_replace(base_path(), '', $line);
 
-                if (str_contains((string) $line, '/vendor/') && ! Str::isMatch("/BoundMethod\.php\([0-9]+\): App/", $line)) {
+                // Stack trace lines start with #\d. Here we pad the numbers 0-9
+                // with a preceding zero to keep everything in line visually.
+                $line = preg_replace('/^(\e\[0m)#(\d)(?!\d)/', '$1#0$2', $line);
+
+                if ($this->isVendorFrame($line)) {
                     return self::VENDOR_FRAME_PLACEHOLDER;
                 }
 
@@ -48,19 +52,30 @@ private function formatInitialException(string $line): array
         ];
     }
 
+    private function isVendorFrame($line): bool
+    {
+        return str_contains((string) $line, self::VENDOR_FRAME_PLACEHOLDER)
+            || str_contains((string) $line, '/vendor/') && ! Str::isMatch("/BoundMethod\.php\([0-9]+\): App/", $line)
+            || str_ends_with($line, '{main}');
+    }
+
     private function collapseVendorFrames(Collection $lines): Collection
     {
         $hasVendorFrame = false;
 
         return $lines->filter(function ($line) use (&$hasVendorFrame) {
-            $isVendorFrame = str_contains($line, '[Vendor frames]');
+            $isVendorFrame = $this->isVendorFrame($line);
 
             if ($isVendorFrame) {
+                // Skip the line if a vendor frame has already been added.
                 if ($hasVendorFrame) {
                     return false;
                 }
+
+                // Otherwise, mark that a vendor frame has been added.
                 $hasVendorFrame = true;
             } else {
+                // Reset the flag if the current line is not a vendor frame.
                 $hasVendorFrame = false;
             }