feat: new devbar web component data support

yiisoft · JiLiZART · Sep 28, 2020 · Oct 1, 2020 · Sep 28, 2020 · 722adcdebe046572f2a6aa78d286aecef15f026c
commit 722adcdebe046572f2a6aa78d286aecef15f026c
diff --git a/src/DevbarAsset.php b/src/DevbarAsset.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\debug;
+
+use yii\web\AssetBundle;
+
+/**
+ * Debugger asset bundle
+ *
+ * @author Nikolay Kostyurin <[email protected]>
+ * @since 2.0
+ */
+class DevbarAsset extends AssetBundle
+{
+    /**
+     * {@inheritdoc}
+     */
+    public $sourcePath = '@npm/yii2-devtools.js/dist';
+    /**
+     * {@inheritdoc}
+     */
+    public $js = [
+        YII_DEBUG ? 'dev-bar.js' : 'dev-bar.min.js'
+    ];
+}
diff --git a/src/Module.php b/src/Module.php
@@ -361,7 +361,7 @@ protected function resetGlobalSettings()
     public function getToolbarHtml()
     {
         $url = Url::toRoute([
-            '/' . $this->id . '/default/toolbar',
+            '/' . $this->id . '/default/toolbar-data',
             'tag' => $this->logTarget->tag,
         ]);
 
@@ -370,7 +370,10 @@ public function getToolbarHtml()
                 $this->skipAjaxRequestUrl[$key] = Url::to($route);
             }
         }
-        return '<div id="yii-debug-toolbar" data-url="' . Html::encode($url) . '" data-skip-urls="' . htmlspecialchars(json_encode($this->skipAjaxRequestUrl)) . '" style="display:none" class="yii-debug-toolbar-bottom"></div>';
+
+        DevbarAsset::register(Yii::$app->view);
+
+        return '<dev-bar url="' . Html::encode($url) . '" skip-urls="' . htmlspecialchars(json_encode($this->skipAjaxRequestUrl)) . '"></dev-bar>';
     }
 
     /**
@@ -390,8 +393,8 @@ public function renderToolbar($event)
         echo $view->renderDynamic('return Yii::$app->getModule("' . $this->id . '")->getToolbarHtml();');
 
         // echo is used in order to support cases where asset manager is not available
-        echo '<style>' . $view->renderPhpFile(__DIR__ . '/assets/css/toolbar.css') . '</style>';
-        echo '<script>' . $view->renderPhpFile(__DIR__ . '/assets/js/toolbar.js') . '</script>';
+//        echo '<style>' . $view->renderPhpFile(__DIR__ . '/assets/css/toolbar.css') . '</style>';
+//        echo '<script>__YII2_DEVTOOLS__ = ' . json_encode($data) . '</script>';
     }
 
     /**

diff --git a/src/Panel.php b/src/Panel.php
@@ -75,6 +75,14 @@ public function getSummary()
         return '';
     }
 
+    /**
+     * @return array variables for content that is displayed at debug toolbar
+     */
+    public function getSummaryData()
+    {
+        return [];
+    }
+
     /**
      * @return string content that is displayed in debugger detail view
      */

diff --git a/src/controllers/DefaultController.php b/src/controllers/DefaultController.php
@@ -9,6 +9,7 @@
 
 use Yii;
 use yii\debug\models\search\Debug;
+use yii\debug\Module;
 use yii\web\Controller;
 use yii\web\NotFoundHttpException;
 use yii\web\Response;
@@ -147,6 +148,49 @@ public function actionToolbar($tag)
         ]);
     }
 
+    /**
+     * Toolbar action
+     *
+     * @param string $tag
+     * @return string
+     * @throws NotFoundHttpException
+     */
+    public function actionToolbarData($tag)
+    {
+        $this->loadData($tag, 5);
+
+        Yii::$app->response->format = Response::FORMAT_JSON;
+
+        $tabs = [];
+        foreach ($this->module->panels as $panel) {
+            $data = $panel->getSummaryData();
+
+            if (!empty($data)) {
+                $tabs[] = $data;
+            } else {
+                $html = $panel->hasError() ? $panel->getError()->getMessage() : $panel->getSummary();
+
+                if ($html) {
+                    $tabs[] = [
+                        "title" => $panel->getName(),
+                        "iframe" => $panel->getUrl(),
+                        "html" => $panel->hasError() ? $panel->getError()->getMessage() : $panel->getSummary()
+                    ];
+                }
+            }
+        }
+
+        return new Response([
+            "format" => "json",
+            "data" => [
+                "title" => "Yii 2 Devtools",
+                "logo" => Module::getYiiLogo(),
+                "placement" => "bottom-right",
+                "tabs" => $tabs,
+            ]
+        ]);
+    }
+
     /**
      * Download mail action
      *

diff --git a/src/panels/AssetPanel.php b/src/panels/AssetPanel.php
@@ -37,6 +37,27 @@ public function getSummary()
         return Yii::$app->view->render('panels/assets/summary', ['panel' => $this]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getSummaryData()
+    {
+
+        return [
+            "title" => "Assets",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "text" => "Asset Bundles",
+                ],
+                [
+                    "label" => count($this->data),
+                    "type" => "info"
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/ConfigPanel.php b/src/panels/ConfigPanel.php
@@ -37,6 +37,44 @@ public function getSummary()
         return Yii::$app->view->render('panels/config/summary', ['panel' => $this]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getSummaryData()
+    {
+//        {
+//            "title": "Version",
+//      "route": "config",
+//      "content": [
+//        {
+//            "label": "2.0.15-dev"
+//        },
+//        {
+//            "text": "PHP"
+//        },
+//        {
+//            "label": "7.1.13"
+//        }
+//      ]
+//    },
+
+        return [
+            "title" => "Config",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "label" => $this->data['application']['yii']
+                ],
+                [
+                    "text" => "PHP",
+                ],
+                [
+                    "label" => $this->data['php']['version']
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/DbPanel.php b/src/panels/DbPanel.php
@@ -104,6 +104,30 @@ public function getSummary()
         ]);
     }
 
+    public function getSummaryData()
+    {
+        $timings = $this->calculateTimings();
+        $queryCount = count($timings);
+        $queryTime = number_format($this->getTotalQueryTime($timings) * 1000) . ' ms';
+
+        return [
+            "title" => "DB",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "text" => $this->getSummaryName(),
+                ],
+                [
+                    "label" => (string) $queryCount,
+                    "type" => "info"
+                ],
+                [
+                    "label" => (string) $queryTime,
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      * @throws InvalidConfigException

diff --git a/src/panels/DumpPanel.php b/src/panels/DumpPanel.php
@@ -65,6 +65,23 @@ public function getSummary()
         return Yii::$app->view->render('panels/dump/summary', ['panel' => $this]);
     }
 
+    public function getSummaryData()
+    {
+        return [
+            "title" => "Dump",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "text" => "Dump",
+                ],
+                [
+                    "label" => (string) count($this->data),
+                    "type" => "info"
+                ],
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/EventPanel.php b/src/panels/EventPanel.php
@@ -68,6 +68,22 @@ public function getSummary()
         ]);
     }
 
+    public function getSummaryData()
+    {
+        return [
+            "title" => "Events",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "text" => "Events"
+                ],
+                [
+                    "label" => count($this->data)
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/LogPanel.php b/src/panels/LogPanel.php
@@ -11,6 +11,7 @@
 use yii\debug\models\search\Log;
 use yii\debug\Panel;
 use yii\log\Logger;
+use yii\log\Target;
 
 /**
  * Debugger panel that collects and displays logs.
@@ -42,6 +43,43 @@ public function getSummary()
         return Yii::$app->view->render('panels/log/summary', ['data' => $this->data, 'panel' => $this]);
     }
 
+    public function getSummaryData()
+    {
+        $errorCount = count(Target::filterMessages($this->data['messages'], Logger::LEVEL_ERROR));
+        $warningCount = count(Target::filterMessages($this->data['messages'], Logger::LEVEL_WARNING));
+
+        $content = [
+            [
+                "text" => "Logs"
+            ],
+            [
+                "label" => count($this->data['messages'])
+            ]
+        ];
+
+        if ($errorCount) {
+            $content[] = [
+                "url" => $this->getUrl(['Log[level]' => Logger::LEVEL_ERROR]),
+                "label" => $errorCount,
+                "type" => "danger",
+            ];
+        }
+
+        if ($warningCount) {
+            $content[] = [
+                "url" => $this->getUrl(['Log[level]' => Logger::LEVEL_WARNING]),
+                "label" => $warningCount,
+                "type" => "warning"
+            ];
+        }
+
+        return [
+            "title" => "Logs",
+            "iframe" => $this->getUrl(),
+            "content" => $content
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/MailPanel.php b/src/panels/MailPanel.php
@@ -112,6 +112,24 @@ public function getSummary()
         ]);
     }
 
+    public function getSummaryData()
+    {
+        $mailCount = is_array($this->data) ? count($this->data) : '⚠';
+
+        return [
+            "title" => "Mail",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "text" => "Mail"
+                ],
+                [
+                    "label" => $mailCount,
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/panels/ProfilingPanel.php b/src/panels/ProfilingPanel.php
@@ -46,6 +46,33 @@ public function getSummary()
         ]);
     }
 
+    public function getSummaryData()
+    {
+        $time = number_format($this->data['time'] * 1000) . ' ms';
+        $memory = sprintf('%.3f MB', $this->data['memory'] / 1048576);
+
+        return [
+            "title" => "Profile",
+            "iframe" => $this->getUrl(),
+            "content" => [
+                [
+                    "icon" => "timer",
+                ],
+                [
+                    "label" => $time,
+                    "type" => "info"
+                ],
+                [
+                    "icon" => "memory",
+                ],
+                [
+                    "label" => $memory,
+                    "type" => "info"
+                ]
+            ]
+        ];
+    }
+
     /**
      * {@inheritdoc}
      */