update some command error handle logic

inhere · Sep 14, 2021 · 9f6c6c3 · 9f6c6c3
1 parent 58b0567
commit 9f6c6c3
Show file tree

Hide file tree

Showing 8 changed files with 132 additions and 40 deletions.
diff --git a/src/AbstractApplication.php b/src/AbstractApplication.php
@@ -28,6 +28,7 @@
 use Toolkit\Cli\Style;
 use Toolkit\Cli\Util\LineParser;
 use Toolkit\PFlag\SFlags;
+use Toolkit\Stdlib\Helper\DataHelper;
 use Toolkit\Stdlib\Helper\PhpHelper;
 use Toolkit\Stdlib\OS;
 use Toolkit\Sys\Proc\ProcessUtil;
@@ -39,7 +40,6 @@
 use function header;
 use function in_array;
 use function is_int;
-use function json_encode;
 use function memory_get_usage;
 use function microtime;
 use function register_shutdown_function;
@@ -164,7 +164,10 @@ protected function init(): void
         ];
 
         if (!$this->errorHandler) {
-            $this->errorHandler = new ErrorHandler();
+            $this->errorHandler = new ErrorHandler([
+                'rootPath'     => $this->config['rootPath'],
+                'hideRootPath' => (bool)$this->config['hideRootPath'],
+            ]);
         }
 
         $this->registerErrorHandle();
@@ -196,6 +199,8 @@ protected function initForRun(Input $input): void
         $this->logf(Console::VERB_DEBUG, 'init - begin parse global options');
         $this->flags->parse($input->getFlags());
 
+        // set debug to error handler
+        $this->errorHandler->setDebug($this->isDebug());
     }
 
     protected function prepareRun(): void
@@ -451,7 +456,7 @@ public function handleError(int $num, string $str, string $file, int $line): voi
     public function handleException(Throwable $e): void
     {
         // you can log error on sub class ...
-        $this->errorHandler->handle($e, $this);
+        $this->errorHandler->handle($e);
     }
 
     /**
@@ -538,7 +543,7 @@ protected function startInteractiveShell(): void
             }
 
             $args = LineParser::parseIt($line);
-            $this->debugf('input line: %s, parsed args: %s', $line, json_encode($args));
+            $this->debugf('input line: %s, parsed args: %s', $line, DataHelper::toString($args));
 
             // reload and parse args
             $in->parse($args);

diff --git a/src/AbstractHandler.php b/src/AbstractHandler.php
@@ -8,6 +8,7 @@
 
 namespace Inhere\Console;
 
+use Inhere\Console\Component\ErrorHandler;
 use Inhere\Console\Concern\AttachApplicationTrait;
 use Inhere\Console\Concern\CommandHelpTrait;
 use Inhere\Console\Concern\InputOutputAwareTrait;
@@ -40,7 +41,6 @@
 use function preg_replace;
 use function sprintf;
 use function ucfirst;
-use function vdump;
 use const PHP_EOL;
 use const PHP_OS;
 
@@ -269,11 +269,6 @@ protected function initForRun(Input $input): void
             $this->logf(Console::VERB_DEBUG, 'show help message by input flags: -h, --help');
             $this->showHelp();
         });
-
-        // old mode: options and arguments at method annotations
-        if ($this->compatible) {
-            $this->flags->setSkipOnUndefined(true);
-        }
     }
 
     protected function getBuiltInOptions(): array
@@ -306,12 +301,10 @@ public function run(array $args)
             return $this->doRun($args);
         } catch (Throwable $e) {
             if ($this->isDetached()) {
-                // TODO exception handle
+                ErrorHandler::new()->handle($e);
             } else {
-                // throw $e;
+                throw $e;
             }
-
-            throw $e;
         }
 
         return -1;

diff --git a/src/Application.php b/src/Application.php
@@ -17,6 +17,7 @@
 use RuntimeException;
 use SplFileInfo;
 use Throwable;
+use Toolkit\Stdlib\Helper\DataHelper;
 use function array_unshift;
 use function class_exists;
 use function implode;
@@ -271,7 +272,7 @@ public function dispatch(string $name, array $args = [])
         }
 
         $cmdId = $name;
-        $this->debugf('begin dispatch the input command: %s', $name);
+        $this->debugf('begin dispatch the input command: %s, args: %s', $name, DataHelper::toString($args));
 
         // format is: `group action`
         if (strpos($name, ' ') > 0) {

diff --git a/src/Command.php b/src/Command.php
@@ -9,6 +9,7 @@
 namespace Inhere\Console;
 
 use Inhere\Console\Contract\CommandInterface;
+use Inhere\Console\IO\Input;
 
 /**
  * Class Command
@@ -34,13 +35,15 @@ abstract class Command extends AbstractHandler implements CommandInterface
      */
     protected $parent;
 
-    /*
-     * Do execute command
-     */
-    // protected function execute($input, $output)
-    // {
-    //      // something logic ...
-    // }
+    protected function initForRun(Input $input): void
+    {
+        parent::initForRun($input);
+
+        // old mode: options and arguments at method annotations
+        if ($this->compatible) {
+            $this->flags->setSkipOnUndefined(true);
+        }
+    }
 
     protected function doRun(array $args)
     {

diff --git a/src/Component/ErrorHandler.php b/src/Component/ErrorHandler.php
@@ -12,7 +12,9 @@
 use Inhere\Console\Contract\ErrorHandlerInterface;
 use InvalidArgumentException;
 use Throwable;
+use Toolkit\Cli\Cli;
 use Toolkit\Cli\Util\Highlighter;
+use Toolkit\Stdlib\Obj\ObjectHelper;
 use function file_get_contents;
 use function get_class;
 use function sprintf;
@@ -25,20 +27,55 @@
  */
 class ErrorHandler implements ErrorHandlerInterface
 {
+    /**
+     * @var bool
+     */
+    protected $debug = false;
+
+    /**
+     * @var string
+     */
+    protected $rootPath = '';
+
+    /**
+     * @var bool
+     */
+    protected $hideRootPath = false;
+
+    /**
+     * @param array $config
+     *
+     * @return static
+     */
+    public static function new(array $config = []): self
+    {
+        return new self($config);
+    }
+
+    /**
+     * Class constructor.
+     *
+     * @param array $config
+     */
+    public function __construct(array $config = [])
+    {
+        ObjectHelper::init($this, $config);
+    }
+
     /**
      * @inheritdoc
      */
-    public function handle(Throwable $e, AbstractApplication $app): void
+    public function handle(Throwable $e): void
     {
         if ($e instanceof InvalidArgumentException) {
-            $app->getOutput()->error($e->getMessage());
+            Cli::error($e->getMessage());
             return;
         }
 
         $class = get_class($e);
 
         // open debug, throw exception
-        if ($app->isDebug()) {
+        if ($this->isDebug()) {
             $tpl  = <<<ERR
 \n<error> Error </error> <mga>%s</mga>
 
@@ -60,16 +97,64 @@ public function handle(Throwable $e, AbstractApplication $app): void
                 $e->getTraceAsString()// \str_replace('):', '): -', $e->getTraceAsString())
             );
 
-            if ($app->getParam('hideRootPath') && ($rootPath = $app->getParam('rootPath'))) {
+            if ($this->hideRootPath && ($rootPath = $this->rootPath)) {
                 $message = str_replace($rootPath, '{ROOT}', $message);
             }
 
-            $app->write($message, false);
+            Cli::write($message, false);
             return;
         }
 
         // simple output
-        $app->getOutput()->error($e->getMessage() ?: 'unknown error');
-        $app->write("\nYou can use '--debug 4' to see error details.");
+        Cli::error($e->getMessage() ?: 'unknown error');
+        Cli::write("\nYou can use '--debug 4' to see error details.");
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDebug(): bool
+    {
+        return $this->debug;
+    }
+
+    /**
+     * @param bool $debug
+     */
+    public function setDebug(bool $debug): void
+    {
+        $this->debug = $debug;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRootPath(): string
+    {
+        return $this->rootPath;
+    }
+
+    /**
+     * @param string $rootPath
+     */
+    public function setRootPath(string $rootPath): void
+    {
+        $this->rootPath = $rootPath;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isHideRootPath(): bool
+    {
+        return $this->hideRootPath;
+    }
+
+    /**
+     * @param bool $hideRootPath
+     */
+    public function setHideRootPath(bool $hideRootPath): void
+    {
+        $this->hideRootPath = $hideRootPath;
     }
 }
diff --git a/src/Contract/ErrorHandlerInterface.php b/src/Contract/ErrorHandlerInterface.php
@@ -8,8 +8,6 @@
 
 namespace Inhere\Console\Contract;
 
-use Inhere\Console\AbstractApplication;
-use Inhere\Console\Application;
 use Throwable;
 
 /**
@@ -20,8 +18,7 @@
 interface ErrorHandlerInterface
 {
     /**
-     * @param Throwable                       $e
-     * @param Application|AbstractApplication $app
+     * @param Throwable $e
      */
-    public function handle(Throwable $e, AbstractApplication $app): void;
+    public function handle(Throwable $e): void;
 }
diff --git a/src/Controller.php b/src/Controller.php
@@ -202,10 +202,11 @@ protected function disabledCommands(): array
      * Will call it on action(sub-command) not found on the group.
      *
      * @param string $action
+     * @param array  $args
      *
      * @return bool if return True, will stop goon render group help.
      */
-    protected function onNotFound(string $action): bool
+    protected function onNotFound(string $action, array $args): bool
     {
         // you can add custom logic on sub-command not found.
         return false;
@@ -277,7 +278,7 @@ public function doRun(array $args)
         // check method not exist
         // - if command method not exists.
         if (!method_exists($this, $method)) {
-            return $this->handleNotFound($name, $action);
+            return $this->handleNotFound($name, $action, $args);
         }
 
         // init flags for subcommand
@@ -290,7 +291,7 @@ public function doRun(array $args)
         // load input definition configure
         $this->configure();
 
-        $this->log(Console::VERB_DEBUG, "run subcommand '$command' - parse options", ['args' => $args]);
+        $this->log(Console::VERB_DEBUG, "run subcommand '$name.$command' - parse options", ['args' => $args]);
 
         // parse subcommand flags.
         if (!$fs->parse($args)) {
@@ -400,13 +401,14 @@ final public function execute($input, $output)
     /**
      * @param string $group
      * @param string $action
+     * @param array  $args
      *
      * @return int
      */
-    protected function handleNotFound(string $group, string $action): int
+    protected function handleNotFound(string $group, string $action, array $args): int
     {
         // if user custom handle not found logic.
-        if ($this->onNotFound($action)) {
+        if ($this->onNotFound($action, $args)) {
             $this->debugf('user custom handle the "%s" action "%s" not found', $group, $action);
             return 0;
         }

diff --git a/src/GlobalOption.php b/src/GlobalOption.php
@@ -2,6 +2,7 @@
 
 namespace Inhere\Console;
 
+use Toolkit\PFlag\FlagType;
 use function array_merge;
 
 /**
@@ -46,7 +47,12 @@ class GlobalOption
      * @psalm-var array<string, string>
      */
     private static $options = [
-        '--debug'          => 'int;Setting the runtime log debug level(quiet 0 - 5 crazy);no;1',
+        // '--debug'          => 'int;Setting the runtime log debug level(quiet 0 - 5 crazy);no;1',
+        '--debug'          => [
+            'type'   => FlagType::INT,
+            'desc'   => 'Setting the runtime log debug level(quiet 0 - 5 crazy)',
+            'envVar' => Console::DEBUG_ENV_KEY,
+        ],
         // '--debug'          => 'Setting the runtime log debug level(quiet 0 - 5 crazy)',
         '--ishell'         => 'bool;Run application an interactive shell environment',
         // '--ishell'         => 'Run application an interactive shell environment',