Merge pull request #1006 from cakephp/merge-request-session

Merge request & session and environment & include panels

Author: markstory

psalm-baseline.xml

@@ -80,6 +80,12 @@
       <code>$vendorName</code>
     </RiskyTruthyFalsyComparison>
   </file>
+  <file src="src/Panel/EnvironmentPanel.php">
+    <RiskyTruthyFalsyComparison>
+      <code>$pluginName</code>
+      <code>$vendorName</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
   <file src="src/Panel/IncludePanel.php">
     <RiskyTruthyFalsyComparison>
       <code>$pluginName</code>

src/Panel/EnvironmentPanel.php

@@ -15,14 +15,31 @@
 namespace DebugKit\Panel;
 
 use Cake\Core\Configure;
+use Cake\Error\Debugger;
 use Cake\Event\EventInterface;
+use DebugKit\DebugInclude;
 use DebugKit\DebugPanel;
 
 /**
  * Provides information about your PHP and CakePHP environment to assist with debugging.
  */
 class EnvironmentPanel extends DebugPanel
 {
+    /**
+     * instance of DebugInclude
+     *
+     * @var \DebugKit\DebugInclude
+     */
+    protected DebugInclude $_debug;
+
+    /**
+     * construct
+     */
+    public function __construct()
+    {
+        $this->_debug = new DebugInclude();
+    }
+
     /**
      * Get necessary data about environment to pass back to controller
      *
@@ -75,6 +92,10 @@ protected function _prepare(): array
         $var = get_defined_constants(true);
         $return['app'] = array_diff_key($var['user'], $return['cake'], $hiddenCakeConstants);
 
+        // Included files data
+        $return['includePaths'] = $this->_debug->includePaths();
+        $return['includedFiles'] = $this->prepareIncludedFiles();
+
         return $return;
     }
 
@@ -88,4 +109,57 @@ public function shutdown(EventInterface $event): void
     {
         $this->_data = $this->_prepare();
     }
+
+    /**
+     * Build the list of files segmented by app, cake, plugins, vendor and other
+     *
+     * @return array
+     */
+    protected function prepareIncludedFiles(): array
+    {
+        $return = ['cake' => [], 'app' => [], 'plugins' => [], 'vendor' => [], 'other' => []];
+
+        foreach (get_included_files() as $file) {
+            /** @var string|false $pluginName */
+            $pluginName = $this->_debug->getPluginName($file);
+
+            if ($pluginName) {
+                $return['plugins'][$pluginName][$this->_debug->getFileType($file)][] = $this->_debug->niceFileName(
+                    $file,
+                    'plugin',
+                    $pluginName
+                );
+            } elseif ($this->_debug->isAppFile($file)) {
+                $return['app'][$this->_debug->getFileType($file)][] = $this->_debug->niceFileName($file, 'app');
+            } elseif ($this->_debug->isCakeFile($file)) {
+                $return['cake'][$this->_debug->getFileType($file)][] = $this->_debug->niceFileName($file, 'cake');
+            } else {
+                /** @var string|false $vendorName */
+                $vendorName = $this->_debug->getComposerPackageName($file);
+
+                if ($vendorName) {
+                    $return['vendor'][$vendorName][] = $this->_debug->niceFileName($file, 'vendor', $vendorName);
+                } else {
+                    $return['other'][] = $this->_debug->niceFileName($file, 'root');
+                }
+            }
+        }
+
+        $return['paths'] = $this->_debug->includePaths();
+
+        ksort($return['app']);
+        ksort($return['cake']);
+        ksort($return['plugins']);
+        ksort($return['vendor']);
+
+        foreach ($return['plugins'] as &$plugin) {
+            ksort($plugin);
+        }
+
+        foreach ($return as $k => $v) {
+            $return[$k] = Debugger::exportVarAsNodes($v);
+        }
+
+        return $return;
+    }
 }

src/Panel/IncludePanel.php

@@ -19,6 +19,7 @@
 use Cake\Utility\Hash;
 use DebugKit\DebugInclude;
 use DebugKit\DebugPanel;
+use function Cake\Core\deprecationWarning;
 
 /**
  * Provides a list of included files for the current request
@@ -38,6 +39,10 @@ class IncludePanel extends DebugPanel
     public function __construct()
     {
         $this->_debug = new DebugInclude();
+        deprecationWarning(
+            '5.1.0',
+            'Include panel is deprecated. Remove it from your panel configuration, and use Environment Panel instead.'
+        );
     }
 
     /**

src/Panel/RequestPanel.php

@@ -55,6 +55,7 @@ public function shutdown(EventInterface $event): void
             'data' => Debugger::exportVarAsNodes($request->getData(), $maxDepth),
             'cookie' => Debugger::exportVarAsNodes($request->getCookieParams(), $maxDepth),
             'get' => Debugger::exportVarAsNodes($_GET, $maxDepth),
+            'session' => Debugger::exportVarAsNodes($request->getSession()->read(), $maxDepth),
             'matchedRoute' => $request->getParam('_matchedRoute'),
             'headers' => [
                 'response' => headers_sent($file, $line),

src/Panel/SessionPanel.php

@@ -18,6 +18,7 @@
 use Cake\Error\Debugger;
 use Cake\Event\EventInterface;
 use DebugKit\DebugPanel;
+use function Cake\Core\deprecationWarning;
 
 /**
  * Provides debug information on the Session contents.
@@ -32,6 +33,10 @@ class SessionPanel extends DebugPanel
      */
     public function shutdown(EventInterface $event): void
     {
+        deprecationWarning(
+            '5.1.0',
+            'SessionPanel is deprecated. Remove it from your panel list, and use Request panel instead.'
+        );
         /** @var \Cake\Controller\Controller $controller */
         $controller = $event->getSubject();
         $request = $controller->getRequest();

src/ToolbarService.php

@@ -55,14 +55,12 @@ class ToolbarService
     protected array $_defaultConfig = [
         'panels' => [
             'DebugKit.Cache' => true,
-            'DebugKit.Session' => true,
             'DebugKit.Request' => true,
             'DebugKit.SqlLog' => true,
             'DebugKit.Timer' => true,
             'DebugKit.Log' => true,
             'DebugKit.Variables' => true,
             'DebugKit.Environment' => true,
-            'DebugKit.Include' => true,
             'DebugKit.History' => true,
             'DebugKit.Routes' => true,
             'DebugKit.Packages' => true,

templates/element/environment_panel.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * Environment Panel Element
  *
@@ -15,17 +17,19 @@
  * @license       https://www.opensource.org/licenses/mit-license.php MIT License
  */
 use Cake\Error\Debugger;
+use function Cake\Core\h;
 
 /**
  * @var \DebugKit\View\AjaxView $this
  * @var array $app
  * @var array $cake
  * @var array $php
+ * @var array $includedFiles
+ * @var array $includePaths
+ * @var \DebugKit\View\Helper\ToolbarHelper $this->Toolbar
+ * @var \DebugKit\View\Helper\CredentialsHelper $this->Credentials
  */
-
-use function Cake\Core\h;
 ?>
-
 <div class="c-environment-panel">
     <h2>Application Constants</h2>
 
@@ -126,4 +130,12 @@
             PHP environment unavailable.
         </div>
     <?php endif; ?>
+
+    <h2>Included Files</h2>
+
+    <h4>Include Paths</h4>
+    <?= $this->Toolbar->dumpNodes($includePaths) ?>
+
+    <h4>Included Files</h4>
+    <?= $this->Toolbar->dumpNodes($includedFiles) ?>
 </div>

templates/element/request_panel.php

@@ -56,7 +56,7 @@
         <code><?php echo h($routePath); ?></code>
     </div>
     <p>
-        <i>[Plugin].[Prefix]/[Controller]::[action]</i>
+        <i class="o-help">Route path grammar: [Plugin].[Prefix]/[Controller]::[action]</i>
     </p>
 
     <h4>Attributes</h4>
@@ -93,6 +93,13 @@
         <p class="c-flash c-flash--info">No Cookie data.</p>
     <?php endif; ?>
 
+    <h4>Session</h4>
+    <?php if (isset($session)) : ?>
+        <?= $this->Toolbar->dumpNode($session) ?>
+    <?php else : ?>
+        <p class="c-flash c-flash--info">No Session data.</p>
+    <?php endif; ?>
+
     <?php if (!empty($matchedRoute)) : ?>
     <h4>Matched Route</h4>
         <p><?= $this->Toolbar->dumpNode(Debugger::exportVarAsNodes(['template' => $matchedRoute])) ?></p>

tests/TestCase/Middleware/DebugKitMiddlewareTest.php

@@ -126,10 +126,10 @@ public function testInvokeSaveData()
         $this->assertSame(200, $result->status_code);
         $this->assertGreaterThan(1, $result->panels);
 
-        $this->assertSame('SqlLog', $result->panels[11]->panel);
-        $this->assertSame('DebugKit.sql_log_panel', $result->panels[11]->element);
-        $this->assertNotNull($result->panels[11]->summary);
-        $this->assertSame('Sql Log', $result->panels[11]->title);
+        $this->assertSame('Timer', $result->panels[10]->panel);
+        $this->assertSame('DebugKit.timer_panel', $result->panels[10]->element);
+        $this->assertNotNull($result->panels[10]->summary);
+        $this->assertSame('Timer', $result->panels[10]->title);
 
         $timeStamp = filectime(Plugin::path('DebugKit') . 'webroot' . DS . 'js' . DS . 'inject-iframe.js');
 

tests/TestCase/Panel/EnvironmentPanelTest.php

@@ -65,7 +65,7 @@ public function testShutdown()
         $this->panel->shutdown($event);
         $output = $this->panel->data();
         $this->assertIsArray($output);
-        $this->assertSame(['php', 'ini', 'cake', 'app'], array_keys($output));
+        $this->assertSame(['php', 'ini', 'cake', 'app', 'includePaths', 'includedFiles'], array_keys($output));
         $this->assertSame('mysql://user:password@localhost/my_db', $output['php']['TEST_URL_1']);
     }
 }