feat(app): Replace Kint with internal tool. WIP

Author: lonnieezell

admin/framework/composer.json

@@ -20,7 +20,6 @@
         "codeigniter/coding-standard": "^1.7",
         "fakerphp/faker": "^1.24",
         "friendsofphp/php-cs-fixer": "^3.47.1",
-        "kint-php/kint": "^6.0",
         "mikey179/vfsstream": "^1.6.12",
         "nexusphp/cs-config": "^3.6",
         "phpunit/phpunit": "^10.5.16 || ^11.2",

app/Config/Boot/development.php

@@ -28,7 +28,7 @@
  | DEBUG MODE
  |--------------------------------------------------------------------------
  | Debug mode is an experimental flag that can allow changes throughout
- | the system. This will control whether Kint is loaded, and a few other
+ | the system. This will control whether the Debug Dumper is loaded, and a few other
  | items. It can always be used within your own application too.
  */
 defined('CI_DEBUG') || define('CI_DEBUG', true);

app/Config/Kint.php

@@ -19,7 +19,6 @@
     "require-dev": {
         "codeigniter/phpstan-codeigniter": "1.x-dev",
         "fakerphp/faker": "^1.24",
-        "kint-php/kint": "^6.0",
         "mikey179/vfsstream": "^1.6.12",
         "nexusphp/tachycardia": "^2.0",
         "phpstan/extension-installer": "^1.4",

composer.json

@@ -157,7 +157,6 @@
             __DIR__ . '/system/Database/SQLite3/Utils.php',
             __DIR__ . '/system/HTTP/DownloadResponse.php',
             __DIR__ . '/system/HTTP/SiteURI.php',
-            __DIR__ . '/system/Helpers/kint_helper.php',
             __DIR__ . '/tests/_support/Autoloader/FatalLocator.php',
         ],
 

rector.php

@@ -19,11 +19,7 @@
 use Composer\Autoload\ClassLoader;
 use Composer\InstalledVersions;
 use Config\Autoload;
-use Config\Kint as KintConfig;
 use Config\Modules;
-use Kint\Kint;
-use Kint\Renderer\CliRenderer;
-use Kint\Renderer\RichRenderer;
 
 /**
  * An autoloader that uses both PSR4 autoloading, and traditional classmaps.
@@ -487,76 +483,4 @@ public function loadHelpers(): void
     {
         helper($this->helpers);
     }
-
-    /**
-     * Initializes Kint
-     */
-    public function initializeKint(bool $debug = false): void
-    {
-        if ($debug) {
-            $this->autoloadKint();
-            $this->configureKint();
-        } elseif (class_exists(Kint::class)) {
-            // In case that Kint is already loaded via Composer.
-            Kint::$enabled_mode = false;
-        }
-
-        helper('kint');
-    }
-
-    private function autoloadKint(): void
-    {
-        // If we have KINT_DIR it means it's already loaded via composer
-        if (! defined('KINT_DIR')) {
-            spl_autoload_register(function ($class): void {
-                $class = explode('\\', $class);
-
-                if (array_shift($class) !== 'Kint') {
-                    return;
-                }
-
-                $file = SYSTEMPATH . 'ThirdParty/Kint/' . implode('/', $class) . '.php';
-
-                if (is_file($file)) {
-                    require_once $file;
-                }
-            });
-
-            require_once SYSTEMPATH . 'ThirdParty/Kint/init.php';
-        }
-    }
-
-    private function configureKint(): void
-    {
-        $config = new KintConfig();
-
-        Kint::$depth_limit         = $config->maxDepth;
-        Kint::$display_called_from = $config->displayCalledFrom;
-        Kint::$expanded            = $config->expanded;
-
-        if (isset($config->plugins) && is_array($config->plugins)) {
-            Kint::$plugins = $config->plugins;
-        }
-
-        $csp = service('csp');
-        if ($csp->enabled()) {
-            RichRenderer::$js_nonce  = $csp->getScriptNonce();
-            RichRenderer::$css_nonce = $csp->getStyleNonce();
-        }
-
-        RichRenderer::$theme  = $config->richTheme;
-        RichRenderer::$folder = $config->richFolder;
-
-        if (isset($config->richObjectPlugins) && is_array($config->richObjectPlugins)) {
-            RichRenderer::$value_plugins = $config->richObjectPlugins;
-        }
-        if (isset($config->richTabPlugins) && is_array($config->richTabPlugins)) {
-            RichRenderer::$tab_plugins = $config->richTabPlugins;
-        }
-
-        CliRenderer::$cli_colors         = $config->cliColors;
-        CliRenderer::$force_utf8         = $config->cliForceUTF8;
-        CliRenderer::$detect_width       = $config->cliDetectWidth;
-        CliRenderer::$min_terminal_width = $config->cliMinWidth;
-    }
 }

system/Autoloader/Autoloader.php

@@ -54,7 +54,7 @@ public static function bootWeb(Paths $paths): int
         static::loadCommonFunctions();
         static::loadAutoloader();
         static::setExceptionHandler();
-        static::initializeKint();
+        static::initializeDebug();
 
         $configCacheEnabled = class_exists(Optimize::class)
             && (new Optimize())->configCacheEnabled;
@@ -96,7 +96,7 @@ public static function bootConsole(Paths $paths): void
         static::loadCommonFunctions();
         static::loadAutoloader();
         static::setExceptionHandler();
-        static::initializeKint();
+        static::initializeDebug();
         static::autoloadHelpers();
 
         // We need to force the request to be a CLIRequest since we're in console
@@ -124,7 +124,7 @@ public static function bootSpark(Paths $paths): int
         static::loadCommonFunctions();
         static::loadAutoloader();
         static::setExceptionHandler();
-        static::initializeKint();
+        static::initializeDebug();
         static::autoloadHelpers();
 
         static::initializeCodeIgniter();
@@ -147,7 +147,7 @@ public static function bootTest(Paths $paths): void
         static::loadCommonFunctions();
         static::loadAutoloader();
         static::setExceptionHandler();
-        static::initializeKint();
+        static::initializeDebug();
         static::autoloadHelpers();
     }
 
@@ -326,9 +326,17 @@ protected static function checkMissingExtensions(): void
         exit(EXIT_ERROR);
     }
 
-    protected static function initializeKint(): void
+    protected static function initializeDebug(): void
     {
-        service('autoloader')->initializeKint(CI_DEBUG);
+        // Always load the debug helper unless in a protected environment
+        $debugConfig = config('Debug');
+        $isProtected = in_array(ENVIRONMENT, $debugConfig->forbiddenEnvironments, true);
+
+        if ($isProtected) {
+            return;
+        }
+
+        helper('debug');
     }
 
     protected static function loadConfigCache(): FactoriesCache

system/Boot.php

@@ -34,12 +34,8 @@
 use Config\App;
 use Config\Cache;
 use Config\Feature;
-use Config\Kint as KintConfig;
 use Config\Services;
 use Exception;
-use Kint;
-use Kint\Renderer\CliRenderer;
-use Kint\Renderer\RichRenderer;
 use Locale;
 use Throwable;
 
@@ -192,89 +188,6 @@ public function initialize()
         date_default_timezone_set($this->config->appTimezone ?? 'UTC');
     }
 
-    /**
-     * Initializes Kint
-     *
-     * @return void
-     *
-     * @deprecated 4.5.0 Moved to Autoloader.
-     */
-    protected function initializeKint()
-    {
-        if (CI_DEBUG) {
-            $this->autoloadKint();
-            $this->configureKint();
-        } elseif (class_exists(Kint::class)) {
-            // In case that Kint is already loaded via Composer.
-            Kint::$enabled_mode = false;
-            // @codeCoverageIgnore
-        }
-
-        helper('kint');
-    }
-
-    /**
-     * @deprecated 4.5.0 Moved to Autoloader.
-     */
-    private function autoloadKint(): void
-    {
-        // If we have KINT_DIR it means it's already loaded via composer
-        if (! defined('KINT_DIR')) {
-            spl_autoload_register(function ($class): void {
-                $class = explode('\\', $class);
-
-                if (array_shift($class) !== 'Kint') {
-                    return;
-                }
-
-                $file = SYSTEMPATH . 'ThirdParty/Kint/' . implode('/', $class) . '.php';
-
-                if (is_file($file)) {
-                    require_once $file;
-                }
-            });
-
-            require_once SYSTEMPATH . 'ThirdParty/Kint/init.php';
-        }
-    }
-
-    /**
-     * @deprecated 4.5.0 Moved to Autoloader.
-     */
-    private function configureKint(): void
-    {
-        $config = new KintConfig();
-
-        Kint::$depth_limit         = $config->maxDepth;
-        Kint::$display_called_from = $config->displayCalledFrom;
-        Kint::$expanded            = $config->expanded;
-
-        if (isset($config->plugins) && is_array($config->plugins)) {
-            Kint::$plugins = $config->plugins;
-        }
-
-        $csp = Services::csp();
-        if ($csp->enabled()) {
-            RichRenderer::$js_nonce  = $csp->getScriptNonce();
-            RichRenderer::$css_nonce = $csp->getStyleNonce();
-        }
-
-        RichRenderer::$theme  = $config->richTheme;
-        RichRenderer::$folder = $config->richFolder;
-
-        if (isset($config->richObjectPlugins) && is_array($config->richObjectPlugins)) {
-            RichRenderer::$value_plugins = $config->richObjectPlugins;
-        }
-        if (isset($config->richTabPlugins) && is_array($config->richTabPlugins)) {
-            RichRenderer::$tab_plugins = $config->richTabPlugins;
-        }
-
-        CliRenderer::$cli_colors         = $config->cliColors;
-        CliRenderer::$force_utf8         = $config->cliForceUTF8;
-        CliRenderer::$detect_width       = $config->cliDetectWidth;
-        CliRenderer::$min_terminal_width = $config->cliMinWidth;
-    }
-
     /**
      * Launch the application!
      *

system/CodeIgniter.php

@@ -42,15 +42,6 @@ final class ComposerScripts
      * @var array<string, array<string, string>>
      */
     private static array $dependencies = [
-        'kint-src' => [
-            'license' => __DIR__ . '/../vendor/kint-php/kint/LICENSE',
-            'from'    => __DIR__ . '/../vendor/kint-php/kint/src/',
-            'to'      => __DIR__ . '/ThirdParty/Kint/',
-        ],
-        'kint-resources' => [
-            'from' => __DIR__ . '/../vendor/kint-php/kint/resources/',
-            'to'   => __DIR__ . '/ThirdParty/Kint/resources/',
-        ],
         'escaper' => [
             'license' => __DIR__ . '/../vendor/laminas/laminas-escaper/LICENSE.md',
             'from'    => __DIR__ . '/../vendor/laminas/laminas-escaper/src/',
@@ -72,20 +63,13 @@ public static function postUpdate(): void
         self::recursiveDelete(self::$path);
 
         foreach (self::$dependencies as $key => $dependency) {
-            // Kint may be removed.
-            if (! is_dir($dependency['from']) && str_starts_with($key, 'kint')) {
-                continue;
-            }
-
             self::recursiveMirror($dependency['from'], $dependency['to']);
 
             if (isset($dependency['license'])) {
                 $license = basename($dependency['license']);
                 copy($dependency['license'], $dependency['to'] . '/' . $license);
             }
         }
-
-        self::copyKintInitFiles();
     }
 
     /**
@@ -158,17 +142,4 @@ private static function recursiveMirror(string $originDir, string $targetDir): v
             }
         }
     }
-
-    /**
-     * Copy Kint's init files into `system/ThirdParty/Kint/`
-     */
-    private static function copyKintInitFiles(): void
-    {
-        $originDir = self::$dependencies['kint-src']['from'] . '../';
-        $targetDir = self::$dependencies['kint-src']['to'];
-
-        foreach (['init.php', 'init_helpers.php'] as $kintInit) {
-            @copy($originDir . $kintInit, $targetDir . $kintInit);
-        }
-    }
 }