Use trait to tweak file and line of exceptions (#4118)

system/CLI/Exceptions/CLIException.php

@@ -11,13 +11,16 @@
 
 namespace CodeIgniter\CLI\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use RuntimeException;
 
 /**
  * CLIException
  */
 class CLIException extends RuntimeException
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Thrown when `$color` specified for `$type` is not within the
 	 * allowed list of colors.

system/Cache/Exceptions/CacheException.php

@@ -11,13 +11,16 @@
 
 namespace CodeIgniter\Cache\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use RuntimeException;
 
 /**
  * CacheException
  */
 class CacheException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Thrown when handler has no permission to write cache.
 	 *

system/Database/Exceptions/DataException.php

@@ -11,10 +11,13 @@
 
 namespace CodeIgniter\Database\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use RuntimeException;
 
 class DataException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Used by the Model's trigger() method when the callback cannot be found.
 	 *

system/Encryption/Exceptions/EncryptionException.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\Encryption\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use CodeIgniter\Exceptions\ExceptionInterface;
 use RuntimeException;
 
@@ -19,6 +20,8 @@
  */
 class EncryptionException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Thrown when no driver is present in the active encryption session.
 	 *

system/Exceptions/CastException.php

@@ -16,6 +16,8 @@
  */
 class CastException extends CriticalError
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Error code
 	 *

system/Exceptions/ConfigException.php

@@ -16,6 +16,8 @@
  */
 class ConfigException extends CriticalError
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Error code
 	 *

system/Exceptions/DebugTraceableTrait.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace CodeIgniter\Exceptions;
+
+use Throwable;
+
+/**
+ * This trait provides framework exceptions the ability to pinpoint
+ * accurately where the exception was raised rather than instantiated.
+ *
+ * This is used primarily for factory-instantiated exceptions.
+ */
+trait DebugTraceableTrait
+{
+	/**
+	 * Tweaks the exception's constructor to assign the file/line to where
+	 * it is actually raised rather than were it is instantiated.
+	 *
+	 * @param string         $message
+	 * @param integer        $code
+	 * @param Throwable|null $previous
+	 */
+	public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
+	{
+		parent::__construct($message, $code, $previous);
+
+		$trace = $this->getTrace()[0];
+
+		if (isset($trace['class']) && $trace['class'] === static::class)
+		{
+			['line' => $this->line, 'file' => $this->file] = $trace;
+		}
+	}
+}

system/Exceptions/DownloadException.php

@@ -18,6 +18,8 @@
  */
 class DownloadException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	public static function forCannotSetFilePath(string $path)
 	{
 		return new static(lang('HTTP.cannotSetFilepath', [$path]));

system/Exceptions/FrameworkException.php

@@ -21,6 +21,8 @@
  */
 class FrameworkException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	public static function forEnabledZlibOutputCompression()
 	{
 		return new static(lang('Core.enabledZlibOutputCompression'));

system/Exceptions/PageNotFoundException.php

@@ -15,6 +15,8 @@
 
 class PageNotFoundException extends OutOfBoundsException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Error code
 	 *

system/Files/Exceptions/FileException.php

@@ -11,11 +11,14 @@
 
 namespace CodeIgniter\Files\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use CodeIgniter\Exceptions\ExceptionInterface;
 use RuntimeException;
 
 class FileException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	public static function forUnableToMove(string $from = null, string $to = null, string $error = null)
 	{
 		return new static(lang('Files.cannotMove', [$from, $to, $error]));

system/Files/Exceptions/FileNotFoundException.php

@@ -11,11 +11,14 @@
 
 namespace CodeIgniter\Files\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use CodeIgniter\Exceptions\ExceptionInterface;
 use RuntimeException;
 
 class FileNotFoundException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	public static function forFileNotFound(string $path)
 	{
 		return new static(lang('Files.fileNotFound', [$path]));

system/Format/Exceptions/FormatException.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\Format\Exceptions;
 
+use CodeIgniter\Exceptions\DebugTraceableTrait;
 use CodeIgniter\Exceptions\ExceptionInterface;
 use RuntimeException;
 
@@ -19,6 +20,8 @@
  */
 class FormatException extends RuntimeException implements ExceptionInterface
 {
+	use DebugTraceableTrait;
+
 	/**
 	 * Thrown when the instantiated class does not exist.
 	 *

tests/system/DebugTraceableTraitTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace CodeIgniter;
+
+use CodeIgniter\Exceptions\DebugTraceableTrait;
+use CodeIgniter\Exceptions\FrameworkException;
+use CodeIgniter\Test\CIUnitTestCase;
+
+/**
+ * @covers \CodeIgniter\Exceptions\DebugTraceableTrait
+ */
+final class DebugTraceableTraitTest extends CIUnitTestCase
+{
+	public function testFactoryInstanceReturnsWhereItIsRaised(): void
+	{
+		$e1 = new FrameworkException('I am on line 16');
+		$e2 = FrameworkException::forEnabledZlibOutputCompression();
+
+		$this->assertContainsEquals(DebugTraceableTrait::class, class_uses(FrameworkException::class));
+		$this->assertSame(16, $e1->getLine());
+		$this->assertSame(__FILE__, $e1->getFile());
+		$this->assertSame(17, $e2->getLine());
+		$this->assertSame(__FILE__, $e2->getFile());
+	}
+}