Fix HtmlRenderer to handle FriendlyException attribute safely when class is not available

Author: shuangjie

src/Renderer/HtmlRenderer.php

@@ -14,7 +14,9 @@
 use Yiisoft\ErrorHandler\Exception\ErrorException;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
+use Yiisoft\FriendlyException\Attribute\FriendlyException;
 use Yiisoft\Http\Header;
+use ReflectionClass;
 
 use function array_values;
 use function dirname;
@@ -491,16 +493,33 @@ public function createServerInformationLink(ServerRequestInterface $request): st
     }
 
     /**
-     * Returns the name of the throwable instance.
+     * Returns string representation of the throwable name.
      *
-     * @return string The name of the throwable instance.
+     * @param Throwable $throwable The throwable.
+     *
+     * @return string The throwable name.
      */
     public function getThrowableName(Throwable $throwable): string
     {
         $name = $throwable::class;
 
         if ($throwable instanceof FriendlyExceptionInterface) {
             $name = $throwable->getName() . ' (' . $name . ')';
+        } else {
+            // Check if the exception class has FriendlyException attribute
+            try {
+                $reflectionClass = new ReflectionClass($throwable);
+                if (class_exists('Yiisoft\FriendlyException\Attribute\FriendlyException')) {
+                    $attributes = $reflectionClass->getAttributes('Yiisoft\FriendlyException\Attribute\FriendlyException');
+                    
+                    if (!empty($attributes)) {
+                        $friendlyExceptionAttribute = $attributes[0]->newInstance();
+                        $name = $friendlyExceptionAttribute->name . ' (' . $name . ')';
+                    }
+                }
+            } catch (\Throwable $e) {
+                // Ignore exception and keep default name
+            }
         }
 
         return $name;

templates/development.php

@@ -1,8 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 use Psr\Http\Message\ServerRequestInterface;
+use ReflectionClass;
+use Throwable;
 use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\Exception\ErrorException;
+use Yiisoft\ErrorHandler\HeadersProvider;
 use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
@@ -20,6 +25,22 @@
 }
 $isFriendlyException = $throwable instanceof FriendlyExceptionInterface;
 $solution = $isFriendlyException ? $throwable->getSolution() : null;
+
+// Check if the exception class has FriendlyException attribute
+if ($solution === null && class_exists('Yiisoft\FriendlyException\Attribute\FriendlyException')) {
+    try {
+        $reflectionClass = new ReflectionClass($throwable);
+        $attributes = $reflectionClass->getAttributes('Yiisoft\FriendlyException\Attribute\FriendlyException');
+        
+        if (!empty($attributes)) {
+            $friendlyExceptionAttribute = $attributes[0]->newInstance();
+            $solution = $friendlyExceptionAttribute->solution;
+        }
+    } catch (\Throwable $e) {
+        // Ignore exception
+    }
+}
+
 $exceptionClass = get_class($throwable);
 $exceptionMessage = $throwable->getMessage();
 
@@ -78,13 +99,44 @@
     <div class="exception-card">
         <div class="exception-class">
             <?php
-            if ($isFriendlyException): ?>
+            $hasFriendlyName = false;
+            if ($isFriendlyException) {
+                $hasFriendlyName = true;
+                ?>
                 <span><?= $this->htmlEncode($throwable->getName())?></span>
                 &mdash;
                 <?= $exceptionClass ?>
-            <?php else: ?>
-                <span><?= $exceptionClass ?></span>
-            <?php endif ?>
+            <?php 
+            } else {
+                // Check if the exception class has FriendlyException attribute
+                $hasFriendlyNameFromAttribute = false;
+                
+                if (class_exists('Yiisoft\FriendlyException\Attribute\FriendlyException')) {
+                    try {
+                        $reflectionClass = new ReflectionClass($throwable);
+                        $attributes = $reflectionClass->getAttributes('Yiisoft\FriendlyException\Attribute\FriendlyException');
+                        
+                        if (!empty($attributes)) {
+                            $friendlyExceptionAttribute = $attributes[0]->newInstance();
+                            $hasFriendlyNameFromAttribute = true;
+                            ?>
+                            <span><?= $this->htmlEncode($friendlyExceptionAttribute->name) ?></span>
+                            &mdash;
+                            <?= $exceptionClass ?>
+                        <?php
+                        }
+                    } catch (\Throwable $e) {
+                        // Ignore exception
+                    }
+                }
+                
+                if (!$hasFriendlyName && !$hasFriendlyNameFromAttribute) {
+                    ?>
+                    <span><?= $exceptionClass ?></span>
+                    <?php 
+                }
+            } 
+            ?>
             (Code #<?= $throwable->getCode() ?>)
         </div>
 
@@ -98,12 +150,12 @@
 
         <?= $this->renderPreviousExceptions($originalException) ?>
 
-        <textarea id="clipboard"><?= $this->htmlEncode($throwable) ?></textarea>
+        <textarea id="clipboard"><?= $this->htmlEncode((string)$throwable) ?></textarea>
         <span id="copied">Copied!</span>
 
         <a href="#"
            class="copy-clipboard"
-           data-clipboard="<?= $this->htmlEncode($throwable) ?>"
+           data-clipboard="<?= $this->htmlEncode((string)$throwable) ?>"
            title="Copy the stacktrace for use in a bug report or pastebin"
         >
             <svg width="26" height="30" fill="none" xmlns="http://www.w3.org/2000/svg">

tests/Renderer/Attribute/HtmlRendererWithAttributeTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Tests\Renderer\Attribute;
+
+use PHPUnit\Framework\TestCase;
+use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
+use Yiisoft\ErrorHandler\Tests\Support\TestExceptionWithAttribute;
+
+final class HtmlRendererWithAttributeTest extends TestCase
+{
+    public function testGetThrowableNameWithAttribute(): void
+    {
+        $this->markTestSkipped('The attribute feature is not available in the current version of friendly-exception package');
+        
+        $renderer = new HtmlRenderer();
+        $exception = new TestExceptionWithAttribute();
+        
+        $name = $renderer->getThrowableName($exception);
+        
+        $this->assertStringContainsString('Test Exception Name', $name);
+        $this->assertStringContainsString($exception::class, $name);
+    }
+} 

tests/Support/TestExceptionWithAttribute.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Tests\Support;
+
+use Exception;
+use Yiisoft\FriendlyException\Attribute\FriendlyException;
+
+#[FriendlyException(name: 'Test Exception Name', solution: 'This is a test solution for an exception.')]
+final class TestExceptionWithAttribute extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('This is a test exception with attribute.');
+    }
+}