[ErrorHander] Display exception properties in the HTML error page

Author: lyrixx

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Display exception properties in the HTML error page
+
 6.1
 ---
 

ErrorRenderer/HtmlErrorRenderer.php

@@ -17,6 +17,8 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
+use Symfony\Component\VarDumper\Cloner\VarCloner;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
 
 /**
  * @author Yonel Ceruto <[email protected]>
@@ -147,6 +149,23 @@ private function renderException(FlattenException $exception, string $debugTempl
         ]);
     }
 
+    private function dumpValue(mixed $value): string
+    {
+        $cloner = new VarCloner();
+        $data = $cloner->cloneVar($value);
+
+        $dumper = new HtmlDumper();
+        $dumper->setTheme('light');
+        $dumper->setOutput($output = fopen('php://memory', 'r+'));
+        $dumper->dump($data);
+
+        $dump = stream_get_contents($output, -1, 0);
+        rewind($output);
+        ftruncate($output, 0);
+
+        return $dump;
+    }
+
     private function formatArgs(array $args): string
     {
         $result = [];

Exception/FlattenException.php

@@ -36,6 +36,7 @@ class FlattenException
     private string $file;
     private int $line;
     private ?string $asString = null;
+    private array $properties = [];
 
     public static function create(\Exception $exception, int $statusCode = null, array $headers = []): static
     {
@@ -77,6 +78,13 @@ public static function createFromThrowable(\Throwable $exception, int $statusCod
             $e->setPrevious(static::createFromThrowable($previous));
         }
 
+        if ((new \ReflectionClass($exception::class))->isUserDefined()) {
+            $getProperties = \Closure::bind(fn (\Throwable $e) => get_object_vars($e), null, $exception::class);
+            $properties = $getProperties($exception);
+            unset($properties['message'], $properties['code'], $properties['file'], $properties['line']);
+            $e->properties = $properties;
+        }
+
         return $e;
     }
 
@@ -88,6 +96,7 @@ public function toArray(): array
                 'message' => $exception->getMessage(),
                 'class' => $exception->getClass(),
                 'trace' => $exception->getTrace(),
+                'properties' => $exception->getProperties(),
             ];
         }
 
@@ -221,6 +230,11 @@ public function setCode(int|string $code): static
         return $this;
     }
 
+    public function getProperties(): array
+    {
+        return $this->properties;
+    }
+
     public function getPrevious(): ?self
     {
         return $this->previous;

Resources/assets/css/exception.css

@@ -83,7 +83,7 @@
     --card-label-color: var(--tab-active-color);
 }
 
-html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{margin:.67em 0;font-size:2em}mark{color:#000;background:#ff0}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{height:0;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{margin:0;font:inherit;color:inherit}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-spacing:0;border-collapse:collapse}td,th{padding:0}
+html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{margin:.67em 0;font-size:2em}mark{color:#000;background:#ff0}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{height:0;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{margin:0;font:inherit;color:inherit}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-spacing:0;border-collapse:collapse}td,th{padding:0}summary{cursor: pointer}
 
 html {
     /* always display the vertical scrollbar to avoid jumps when toggling contents */
@@ -208,6 +208,10 @@ header .container { display: flex; justify-content: space-between; }
 .exception-message a { border-bottom: 1px solid rgba(255, 255, 255, 0.5); font-size: inherit; text-decoration: none; }
 .exception-message a:hover { border-bottom-color: #ffffff; }
 
+.exception-properties-wrapper { margin: .8em 0; }
+.exception-properties { background: var(--base-0); border: var(--border); box-shadow: 0px 0px 1px rgba(128, 128, 128, .2); }
+.exception-properties pre { margin: 0; padding: 0.2em 0; }
+
 .exception-illustration { flex-basis: 111px; flex-shrink: 0; height: 66px; margin-left: 15px; opacity: .7; }
 
 .trace + .trace { margin-top: 30px; }

Resources/views/exception.html.php

@@ -13,7 +13,6 @@
             </h2>
         </div>
     </div>
-
     <div class="exception-message-wrapper">
         <div class="container">
             <h1 class="break-long-words exception-message<?= mb_strlen($exceptionMessage) > 180 ? ' long' : ''; ?>"><?= $this->formatFileFromText(nl2br($exceptionMessage)); ?></h1>

Resources/views/traces.html.php

@@ -25,6 +25,14 @@
                     <p class="break-long-words trace-message"><?= $this->escape($exception['message']); ?></p>
                 <?php } ?>
             </div>
+            <?php if ($exception['properties']) { ?>
+                <details class="exception-properties-wrapper">
+                    <summary>Show exception properties</summary>
+                    <div class="exception-properties">
+                        <?= $this->dumpValue($exception['properties']) ?>
+                    </div>
+                </details>
+            <?php } ?>
         </div>
 
         <div id="trace-html-<?= $index; ?>" class="sf-toggle-content">