[Add] Add printerLogger to PerformancePrinter

TsaiKoga · TsaiKoga · commit 609a2d628705 · 2020-09-18T23:36:35.000+08:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 <p align="center">
 <a link="https://packagist.org/packages/tsaikoga/performance-printer" style="text-decoration:none;">
-  <img src="https://img.shields.io/badge/stable-v1.0.1-brightgreen" alt="Unstable">
+  <img src="https://img.shields.io/badge/stable-v1.1.1-brightgreen" alt="Unstable">
 </a>
 <a link="https://packagist.org/packages/tsaikoga/performance-printer" style="text-decoration:none;">
   <img src="https://img.shields.io/badge/unstable-dev--master-blue" alt="Unstable">
@@ -36,11 +36,13 @@ Performance Printer is a laravel package to print each requests' performance inf
 
 ## Usage
 1. Install the package for development environment:
-Stable version:
+
+**Stable version**:
 ```bash
 composer require tsaikoga/performance-printer --dev
 ```
-Unstable version:
+
+**Unstable version**:
 ```bash
 composer require tsaikoga/performance-printer:dev-master --dev
 ```
@@ -82,6 +84,15 @@ return [
 
     // enable this package or disable it
     'enable' => true,
+
+    // log
+    'log' => [
+        // is logging enable?
+        'enable' => true,
+
+        // The path that the log file stored
+        'filepath' => '/tmp/performance_printer.log',
+    ],
 ];
 ```
 
diff --git a/src/Printer/Printer.php b/src/Printer/Printer.php
@@ -2,14 +2,15 @@
 /**
  * @package   PerformancePrinter
  * @author    TsaiKoga
- * @version   1.0.0
+ * @version   1.1.1
  *
  */
 namespace TsaiKoga\PerformancePrinter\Printer;
 
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Console\Output\ConsoleOutput;
+use TsaiKoga\PerformancePrinter\Printer\PrinterLogger;
 
 class Printer extends ConsoleOutput
 {
@@ -56,6 +57,21 @@ class Printer extends ConsoleOutput
      */
     protected $lang;
 
+
+    /**
+     * is logging enabled
+     *
+     * @var bool
+     */
+    protected $is_logging_enabled;
+
+    /**
+     * logger
+     *
+     * @var \Monolog\Logger
+     */
+    protected $logger;
+
     /**
      * Create a new Printer instance.
      *
@@ -112,6 +128,22 @@ public function setLang($lang = 'en')
         return $this;
     }
 
+    /**
+     * Enable logging
+     *
+     * @param string $filepath
+     * @return TsaiKoga\PerformancePrinter\Printer\Printer $this
+     */
+    public function enableLogging($filepath)
+    {
+        $this->is_logging_enabled = true;
+        $logger = new PrinterLogger();
+        $logger->pushHandler($logger->setFormatter($filepath));
+        $this->logger = $logger;
+        return $this;
+
+    }
+
     /**
      * Get table
      *
@@ -147,6 +179,10 @@ protected function outputTable($table, $header, $content)
             $table->setRows($content);
             $table->render();
         }
+
+        if ($this->is_logging_enabled) {
+            $this->logger->renderTable($header, $content);
+        }
     }
 
     /**
@@ -157,10 +193,10 @@ protected function outputTable($table, $header, $content)
     public function outputRequest()
     {
         $request = $this->request->server();
-        $this->writeln("<question>[ {$request['REQUEST_METHOD']} ]</question> <info>{$request['REQUEST_URI']}</info>");
+        $this->outputMsg("<question>[ {$request['REQUEST_METHOD']} ]</question> <info>{$request['REQUEST_URI']}</info>");
         if (in_array($request['REQUEST_METHOD'], ['POST', 'PUT', 'PATCH'])) {
-            if (isset($request['HTTP_CONTENT_TYPE'])) $this->writeln("<question>[ Content-Type ]</question> :  {$request['HTTP_CONTENT_TYPE']} ");
-            $this->writeln($this->request->getContent());
+            if (isset($request['HTTP_CONTENT_TYPE'])) $this->outputMsg("<question>[ Content-Type ]</question> :  {$request['HTTP_CONTENT_TYPE']} ");
+            $this->outputMsg($this->request->getContent());
         }
     }
 
@@ -173,9 +209,9 @@ public function outputFilesCount()
     {
         $included_files_count = count(get_included_files());
         if ($this->lang === 'en') {
-            $this->writeln("<question>[ Included Files Count ] </question> $included_files_count");
+            $this->outputMsg("<question>[ Included Files Count ] </question> $included_files_count");
         } else {
-            $this->writeln("<question>[ 加载文件数量 ] </question> $included_files_count");
+            $this->outputMsg("<question>[ 加载文件数量 ] </question> $included_files_count");
         }
     }
 
@@ -189,9 +225,9 @@ public function outputQueryCount()
         $total = $this->querylog->getQueriesTotal();
         $times = $this->querylog->getQueriesRunningTime();
         if ($this->lang === 'en') {
-            $this->writeln("<question>[ Total ]</question> $total queries and ran for $times ms.");
+            $this->outputMsg("<question>[ Total ]</question> $total queries and ran for $times ms.");
         } else {
-            $this->writeln("<question>[ 总计 ]</question> $total 条语句运行了 $times 毫秒。");
+            $this->outputMsg("<question>[ 总计 ]</question> $total 条语句运行了 $times 毫秒。");
         }
     }
 
@@ -217,17 +253,17 @@ protected function outputRawSql($log)
     {
         if ($this->lang === 'en') {
             if ($log['count'] > 1) {
-                $this->writeln("<info>>>>></info> There are a total of {$log['count']} same queries with different bindings:");
-                $this->writeln("<question>[ These queries ran for {$log['time']} ms totally ]</question> RAW SQL: <info>{$log['sql']}</info>");
+                $this->outputMsg("<info>>>>></info> There are a total of {$log['count']} same queries with different bindings:");
+                $this->outputMsg("<question>[ These queries ran for {$log['time']} ms totally ]</question> RAW SQL: <info>{$log['sql']}</info>");
             } else {
-                $this->writeln("<question>[ SQL ran for {$log['time']} ms ]</question> RAW SQL: <info>{$log['sql']}</info>");
+                $this->outputMsg("<question>[ SQL ran for {$log['time']} ms ]</question> RAW SQL: <info>{$log['sql']}</info>");
             }
         } else {
             if ($log['count'] > 1) {
-                $this->writeln("<info>>>>></info> 总共有 {$log['count']} 条相同的查询只是查询参数不同:");
-                $this->writeln("<question>[ 这些查询总共运行 {$log['time']} 毫秒 ]</question> 原生 SQL: <info>{$log['sql']}</info>");
+                $this->outputMsg("<info>>>>></info> 总共有 {$log['count']} 条相同的查询只是查询参数不同:");
+                $this->outputMsg("<question>[ 这些查询总共运行 {$log['time']} 毫秒 ]</question> 原生 SQL: <info>{$log['sql']}</info>");
             } else {
-                $this->writeln("<question>[ SQL 运行了 {$log['time']} 毫秒 ]</question> 原生 SQL: <info>{$log['sql']}</info>");
+                $this->outputMsg("<question>[ SQL 运行了 {$log['time']} 毫秒 ]</question> 原生 SQL: <info>{$log['sql']}</info>");
             }
         }
 
@@ -254,9 +290,9 @@ public function outputResponse()
     {
         $response = $this->response->content();
         if ($this->lang === 'en') {
-            $this->writeln("<question>[ Response Load $this->expense ms]</question> $response");
+            $this->outputMsg("<question>[ Response Load $this->expense ms]</question> $response");
         } else {
-            $this->writeln("<question>[ 响应时间 $this->expense 毫秒 ]</question> $response");
+            $this->outputMsg("<question>[ 响应时间 $this->expense 毫秒 ]</question> $response");
         }
     }
 
@@ -270,6 +306,23 @@ public function outputBlankLine($num)
     {
         foreach(range(1, $num) as $i) {
             $this->writeln('');
+            if ($this->is_logging_enabled) {
+                $this->logger->info('');
+            }
+        }
+    }
+
+    /**
+     * output message
+     *
+     * @param string $msg
+     * @return void
+     */
+    public function outputMsg($msg)
+    {
+        $this->writeln($msg);
+        if ($this->is_logging_enabled) {
+            $this->logger->info(strip_tags($msg));
         }
     }
 
@@ -285,5 +338,4 @@ public function outputBlankLine($num)
     protected function outputIndexSuggestion($sql, $query, $bindings, $explains)
     {
     }
-
 }
diff --git a/src/Printer/PrinterLogger.php b/src/Printer/PrinterLogger.php
@@ -0,0 +1,155 @@
+<?php
+/**
+ * @package   PerformancePrinter
+ * @author    TsaiKoga
+ * @version   1.1.1
+ *
+ */
+namespace TsaiKoga\PerformancePrinter\Printer;
+
+use Monolog\Logger;
+use Monolog\Formatter\LineFormatter;
+use Monolog\Handler\StreamHandler;
+
+class PrinterLogger extends Logger
+{
+
+    /**
+     * Create a new command instance.
+     *
+     * @param string $logger_name
+     */
+    public function __construct($logger_name="PrinterPerformance")
+    {
+        parent::__construct($logger_name);
+    }
+
+    /**
+     * Set formatter to Logger
+     *
+     * @param string $filepath
+     * @return Monolog\Handler\StreamHandler $debug_handler
+     */
+    public function setFormatter($filepath)
+    {
+        $formatter = new LineFormatter(
+            "%message% %context% %extra%\n", // Format of message in log
+            null,                            // Datetime format
+            true,                            // allowInlineLineBreaks option, default false
+            true                             // ignoreEmptyContextAndExtra option, default false
+        );
+        $debug_handler = new StreamHandler($filepath, Logger::DEBUG);
+        $debug_handler->setFormatter($formatter);
+        return $debug_handler;
+    }
+
+    /**
+     * build table array for rendering
+     *
+     * @param array $header
+     * @param array $content
+     * @return array
+     */
+    public function buildTable($header, $content)
+    {
+        $cols_count  = count($header);
+        $rows_count  = count($content);
+        $data        = array_merge([$header], $content);
+        $space_count = 2;
+
+        $result      = array();
+        $max_len     = $this->getMaxLenOfRows($cols_count, $rows_count, $data);
+
+        foreach (range(0, $rows_count) as $rows_index) {
+            // For header
+            if ($rows_index === 0) {
+                foreach ($data[$rows_index] as $i => $item) {
+                    $index = $rows_index;
+                    $strlen = strlen($item);
+                    // concat string and convert it to something like this: +-------+
+                    if ($i === 0){
+                        $result[$index][$i] = '+' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                        $index += 1;
+                        $space_suffix = str_repeat(' ', ($max_len[$i] - $strlen));
+                        $result[$index][$i] = '| ' . $item . $space_suffix . ' |';
+                        $index += 1;
+                        $result[$index][$i] = '+' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                        $index += 1;
+                    } else {
+                        $result[$index][$i] = '' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                        $index += 1;
+                        $space_suffix = str_repeat(' ', ($max_len[$i] - $strlen));
+                        $result[$index][$i] = ' ' . $item . $space_suffix . ' |';
+                        $index += 1;
+                        $result[$index][$i] = '' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                        $index += 1;
+                    }
+                }
+            } else {
+                // Add For Content
+                foreach ($data[$rows_index] as $i => $item) {
+                    $index = $rows_index + 3;
+                    $strlen = strlen($item);
+                    if ($i === 0) {
+                        $space_suffix = str_repeat(' ', ($max_len[$i] - $strlen));
+                        $result[$index][$i] = '| ' . $item . $space_suffix . ' |';
+                        $index += 1;
+                    } else {
+                        $space_suffix = str_repeat(' ', ($max_len[$i] - $strlen));
+                        $result[$index][$i] = ' ' . $item . $space_suffix . ' |';
+                        $index += 1;
+                    }
+                }
+            }
+
+            // Add bottom line
+            if ($rows_index >= $rows_count) {
+                foreach ($data[$rows_index] as $i => $item) {
+                    if ($i === 1) {
+                        $result[$index][$i] = '+' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                    } else {
+                        $result[$index][$i] = '' . str_repeat('-', ($max_len[$i] + $space_count)) . '+';
+                    }
+                }
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * Get max length of each field's value
+     *
+     * @param integer $cols_count
+     * @param integer $rows_count
+     * @param array   $data
+     * @return array
+     */
+    public function getMaxLenOfRows($cols_count, $rows_count, $data)
+    {
+        $length = array();
+        foreach (range(0, $cols_count - 1) as $col_index) {
+            $max_len = 0;
+            foreach(range(0, $rows_count) as $row_index) {
+                $str_len = strlen($data[$row_index][$col_index]);
+                if ($max_len <= $str_len) $max_len = $str_len;
+            }
+            $length[$col_index] = $max_len;
+        }
+        return $length;
+    }
+
+    /**
+     * render table
+     *
+     * @param array $header
+     * @param array $content
+     * @return void
+     */
+    public function renderTable($header, $content)
+    {
+        $result = $this->buildTable($header, $content);
+        foreach ($result as $i => $items) {
+            $this->info(implode('', $items));
+        }
+    }
+}
diff --git a/src/Printer/PrinterManager.php b/src/Printer/PrinterManager.php
@@ -48,6 +48,9 @@ public function print($event)
         $printer  = new Printer($event->request, $event->response, $querylog);
         $printer->setTableStyle($this->options['table_style']);
         $printer->setLang($this->options['lang']);
+        if ($this->options['log']['enable']) {
+            $printer->enableLogging($this->options['log']['filepath']);
+        }
 
         if ($this->options['request']) {
             $printer->outputRequest();
