Merge pull request #186 from armanist/master

Error Page Injected into View Content
softberg · Dec 29, 2024 · e99676a · e99676a
2 parents d620511 + f6cf56d
commit e99676a
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 24 deletions.
diff --git a/src/Http/Response/HttpResponse.php b/src/Http/Response/HttpResponse.php
@@ -116,6 +116,12 @@ public static function flush()
      */
     public static function send()
     {
+        $level = ob_get_level();
+
+        for ($i = 0; $i < $level; $i++) {
+            ob_end_clean();
+        }
+
         foreach (self::$__headers as $key => $value) {
             header($key . ': ' . $value);
         }

diff --git a/src/Tracer/ErrorHandler.php b/src/Tracer/ErrorHandler.php
@@ -14,7 +14,6 @@
 
 namespace Quantum\Tracer;
 
-use Quantum\Exceptions\StopExecutionException;
 use Quantum\Libraries\Storage\FileSystem;
 use Quantum\Exceptions\ViewException;
 use Quantum\Exceptions\DiException;
@@ -67,11 +66,9 @@ class ErrorHandler
     private $logger;
 
     /**
-     * @var array
+     * @var ErrorHandler|null
      */
-    private $trace = [];
-
-    private static $instance;
+    private static $instance = null;
 
     private function __construct()
     {
@@ -86,7 +83,7 @@ private function __clone()
     /**
      * @return ErrorHandler
      */
-    public static function getInstance(): ErrorHandler
+    public static function getInstance(): ?ErrorHandler
     {
         if (self::$instance === null) {
             self::$instance = new self();
@@ -131,27 +128,24 @@ public function handleError($severity, $message, $file, $line)
      * @throws RuntimeError
      * @throws SyntaxError
      * @throws ViewException
-     * @throws StopExecutionException
      */
     public function handleException(Throwable $e): void
     {
-        $this->composeStackTrace($e);
-
         $view = ViewFactory::getInstance();
-
         $errorType = $this->getErrorType($e);
 
         if (is_debug_mode()) {
-            Response::html($view->renderPartial('errors' . DS . 'trace', [
-                'stackTrace' => $this->trace,
+            $errorPage = $view->renderPartial('errors' . DS . 'trace', [
+                'stackTrace' => $this->composeStackTrace($e),
                 'errorMessage' => $e->getMessage(),
                 'severity' => ucfirst($errorType),
-            ]));
+            ]);
         } else {
+            $errorPage = $view->renderPartial('errors' . DS . '500');
             $this->logError($e, $errorType);
-            Response::html($view->renderPartial('errors' . DS . '500'));
         }
 
+        Response::html($errorPage);
         Response::send();
     }
 
@@ -162,22 +156,21 @@ public function handleException(Throwable $e): void
      */
     private function logError(Throwable $e, string $errorType): void
     {
-        if (method_exists($this->logger, $errorType)) {
-            $this->logger->$errorType($e->getMessage(), ['trace' => $e->getTraceAsString()]);
-        } else {
-            $this->logger->error($e->getMessage(), ['trace' => $e->getTraceAsString()]);
-        }
+        $logMethod = method_exists($this->logger, $errorType) ? $errorType : 'error';
+
+        $this->logger->$logMethod($e->getMessage(), ['trace' => $e->getTraceAsString()]);
     }
 
     /**
      * Composes the stack trace
      * @param Throwable $e
+     * @return array
      * @throws DiException
      * @throws ReflectionException
      */
-    private function composeStackTrace(Throwable $e)
+    private function composeStackTrace(Throwable $e): array
     {
-        $this->trace[] = [
+        $trace[] = [
             'file' => $e->getFile(),
             'code' => $this->getSourceCode($e->getFile(), $e->getLine(), 'error-line'),
         ];
@@ -188,12 +181,14 @@ private function composeStackTrace(Throwable $e)
             }
 
             if (isset($item['file'])) {
-                $this->trace[] = [
+                $trace[] = [
                     'file' => $item['file'],
                     'code' => $this->getSourceCode($item['file'], $item['line'] ?? 1, 'switch-line'),
                 ];
             }
         }
+
+        return $trace;
     }
 
     /**
@@ -209,20 +204,44 @@ private function getSourceCode(string $filename, int $lineNumber, string $classN
     {
         $fs = Di::get(FileSystem::class);
 
+        $lineNumber--;
+
         $start = max($lineNumber - floor(self::NUM_LINES / 2), 1);
 
         $lines = $fs->getLines($filename, $start, self::NUM_LINES);
 
         $code = '<ol start="' . key($lines) . '">';
+
         foreach ($lines as $currentLineNumber => $line) {
-            $highlight = $currentLineNumber === $lineNumber ? ' class="' . $className . '"' : '';
-            $code .= '<li' . $highlight . '><pre>' . htmlspecialchars($line, ENT_QUOTES) . '</pre></li>';
+            $code .= $this->formatLineItem($currentLineNumber, $line, $lineNumber, $className);
         }
+
         $code .= '</ol>';
 
         return $code;
     }
 
+    /**
+     * Formats the line item
+     * @param int $currentLineNumber
+     * @param string $line
+     * @param int $lineNumber
+     * @param string $className
+     * @return string
+     */
+    private function formatLineItem(int $currentLineNumber, string $line, int $lineNumber, string $className): string
+    {
+        $highlightClass = $currentLineNumber === $lineNumber ? " class=\"{$className}\"" : '';
+
+        $encodedLine = htmlspecialchars($line, ENT_QUOTES);
+
+        return sprintf(
+            '<li%s><pre>%s</pre></li>',
+            $highlightClass,
+            $encodedLine
+        );
+    }
+
     /**
      * Gets the error type based on the exception class
      * @param Throwable $e