Trace for error (#96)

Co-authored-by: Sergei Predvoditelev <[email protected]>

Author: xepozz

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 3.1.1 under development
 
 - New #98: Add ability to execute `getBody()` on response when `ExceptionResponder` middleware is processing (@vjik)
+- Enh #96: Trace PHP errors (@xepozz, @vjik)
 
 ## 3.1.0 January 07, 2024
 

src/ErrorHandler.php

@@ -128,7 +128,8 @@ public function register(): void
                 return true;
             }
 
-            throw new ErrorException($message, $severity, $severity, $file, $line);
+            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+            throw new ErrorException($message, $severity, $severity, $file, $line, null, $backtrace);
         });
 
         $this->enabled = true;
@@ -169,7 +170,16 @@ private function initializeOnce(): void
             $e = error_get_last();
 
             if ($e !== null && ErrorException::isFatalError($e)) {
-                $error = new ErrorException($e['message'], $e['type'], $e['type'], $e['file'], $e['line']);
+                $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+                $error = new ErrorException(
+                    $e['message'],
+                    $e['type'],
+                    $e['type'],
+                    $e['file'],
+                    $e['line'],
+                    null,
+                    $backtrace
+                );
                 $this->renderThrowableAndTerminate($error);
             }
         });

src/Exception/ErrorException.php

@@ -14,6 +14,8 @@
 
 /**
  * `ErrorException` represents a PHP error.
+ *
+ * @psalm-type DebugBacktraceType = list<array{args?:list<mixed>,class?:class-string,file?:string,function:string,line?:int,object?:object,type?:string}>
  */
 class ErrorException extends \ErrorException implements FriendlyExceptionInterface
 {
@@ -35,14 +37,11 @@ class ErrorException extends \ErrorException implements FriendlyExceptionInterfa
         E_USER_DEPRECATED => 'PHP User Deprecated Warning',
     ];
 
-    public function __construct(
-        string $message = '',
-        int $code = 0,
-        int $severity = 1,
-        string $filename = __FILE__,
-        int $line = __LINE__,
-        Exception $previous = null
-    ) {
+    /**
+     * @psalm-param DebugBacktraceType $backtrace
+     */
+    public function __construct(string $message = '', int $code = 0, int $severity = 1, string $filename = __FILE__, int $line = __LINE__, Exception $previous = null, private array $backtrace = [])
+    {
         parent::__construct($message, $code, $severity, $filename, $line, $previous);
         $this->addXDebugTraceToFatalIfAvailable();
     }
@@ -76,6 +75,14 @@ public function getSolution(): ?string
         return null;
     }
 
+    /**
+     * @psalm-return DebugBacktraceType
+     */
+    public function getBacktrace(): array
+    {
+        return $this->backtrace;
+    }
+
     /**
      * Fatal errors normally do not provide any trace making it harder to debug. In case XDebug is installed, we
      * can get a trace using `xdebug_get_function_stack()`.

src/Renderer/HtmlRenderer.php

@@ -11,6 +11,7 @@
 use Throwable;
 use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\ErrorData;
+use Yiisoft\ErrorHandler\Exception\ErrorException;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
@@ -46,6 +47,8 @@
 
 /**
  * Formats throwable into HTML string.
+ *
+ * @psalm-import-type DebugBacktraceType from ErrorException
  */
 final class HtmlRenderer implements ThrowableRendererInterface
 {
@@ -237,13 +240,16 @@ public function renderPreviousExceptions(Throwable $t): string
      * @throws Throwable
      *
      * @return string HTML content of the rendered call stack.
+     *
+     * @psalm-param DebugBacktraceType $trace
      */
-    public function renderCallStack(Throwable $t): string
+    public function renderCallStack(Throwable $t, array $trace = []): string
     {
         $application = $vendor = [];
         $application[1] = $this->renderCallStackItem($t->getFile(), $t->getLine(), null, null, [], 1, false);
 
-        for ($i = 0, $trace = $t->getTrace(), $length = count($trace); $i < $length; ++$i) {
+        $length = count($trace);
+        for ($i = 0; $i < $length; ++$i) {
             $file = !empty($trace[$i]['file']) ? $trace[$i]['file'] : null;
             $line = !empty($trace[$i]['line']) ? $trace[$i]['line'] : null;
             $class = !empty($trace[$i]['class']) ? $trace[$i]['class'] : null;

templates/development.php

@@ -1,6 +1,7 @@
 <?php
 
 use Yiisoft\ErrorHandler\CompositeException;
+use Yiisoft\ErrorHandler\Exception\ErrorException;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
 /**
@@ -97,7 +98,12 @@
 
 <main>
     <div class="call-stack">
-        <?= $this->renderCallStack($throwable) ?>
+        <?= $this->renderCallStack(
+            $throwable,
+            $originalException === $throwable && $originalException instanceof ErrorException
+                ? $originalException->getBacktrace()
+                : $throwable->getTrace()
+        ) ?>
     </div>
     <?php if ($request && ($requestInfo = $this->renderRequest($request)) !== ''): ?>
         <div class="request">

tests/ErrorHandlerTest.php

@@ -99,14 +99,17 @@ public function testHandleErrorWithCatching(): void
         $this->errorHandler->register();
         $array = ['type' => 'undefined'];
 
+        $exception = null;
         try {
             $array['undefined'];
-        } catch (Throwable $e) {
-            $this->assertInstanceOf(ErrorException::class, $e);
-            $this->assertFalse($e::isFatalError($array));
-            $this->assertNull($e->getSolution());
+        } catch (Throwable $exception) {
         }
 
+        $this->assertInstanceOf(ErrorException::class, $exception);
+        $this->assertFalse($exception::isFatalError($array));
+        $this->assertNull($exception->getSolution());
+        $this->assertNotEmpty($exception->getBacktrace());
+
         $this->errorHandler->unregister();
     }
 }

tests/Event/ApplicationErrorTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Tests\Event;
+
+use LogicException;
+use PHPUnit\Framework\TestCase;
+use Yiisoft\ErrorHandler\Event\ApplicationError;
+
+final class ApplicationErrorTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $exception = new LogicException();
+
+        $error = new ApplicationError($exception);
+
+        $this->assertSame($exception, $error->getThrowable());
+    }
+}