Add command-benchmark component (#844)

huangdijia · web-flow · commit df740c3085dc · 2025-02-26T18:06:00.000+08:00
* Add `command-benchmark` component

* feat: add default case to command output formatting

---------

Co-authored-by: Deeka Wong &lt;8337659+huangdijia@users.noreply.github.com&gt;
diff --git a/composer.json b/composer.json
@@ -114,6 +114,7 @@
     "replace": {
         "friendsofhyperf/amqp-job": "*",
         "friendsofhyperf/cache": "*",
+        "friendsofhyperf/command-benchmark": "*",
         "friendsofhyperf/command-signals": "*",
         "friendsofhyperf/command-validation": "*",
         "friendsofhyperf/compoships": "*",
@@ -168,6 +169,7 @@
         "psr-4": {
             "FriendsOfHyperf\\AmqpJob\\": "src/amqp-job/src/",
             "FriendsOfHyperf\\Cache\\": "src/cache/src/",
+            "FriendsOfHyperf\\CommandBenchmark\\": "src/command-benchmark/src/",
             "FriendsOfHyperf\\CommandSignals\\": "src/command-signals/src/",
             "FriendsOfHyperf\\CommandValidation\\": "src/command-validation/src/",
             "FriendsOfHyperf\\Compoships\\": "src/compoships/src/",
@@ -253,6 +255,7 @@
             "config": [
                 "FriendsOfHyperf\\AmqpJob\\ConfigProvider",
                 "FriendsOfHyperf\\Cache\\ConfigProvider",
+                "FriendsOfHyperf\\CommandBenchmark\\ConfigProvider",
                 "FriendsOfHyperf\\CommandSignals\\ConfigProvider",
                 "FriendsOfHyperf\\CommandValidation\\ConfigProvider",
                 "FriendsOfHyperf\\Compoships\\ConfigProvider",
@@ -303,7 +306,7 @@
         "cs-fix": "@php vendor/bin/php-cs-fixer fix $1 --verbose",
         "gen:readme": [
             "./bin/regenerate-readme.sh > src/.github/profile/README.md",
-            "./bin/regenerate-readme.sh > docs/zh_CN/guide/start/components.md"
+            "./bin/regenerate-readme.sh > docs/zh-cn/guide/start/components.md"
         ],
         "json-fix": [
             "@php ./bin/composer-json-fixer",
diff --git a/docs/zh-cn/guide/start/components.md b/docs/zh-cn/guide/start/components.md
@@ -6,6 +6,7 @@
 |--|--|--|--|
 |[amqp-job](https://github.com/friendsofhyperf/amqp-job)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/amqp-job/v)](https://packagist.org/packages/friendsofhyperf/amqp-job)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/amqp-job/downloads)](https://packagist.org/packages/friendsofhyperf/amqp-job)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/amqp-job/d/monthly)](https://packagist.org/packages/friendsofhyperf/amqp-job)|
 |[cache](https://github.com/friendsofhyperf/cache)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/cache/v)](https://packagist.org/packages/friendsofhyperf/cache)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/cache/downloads)](https://packagist.org/packages/friendsofhyperf/cache)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/cache/d/monthly)](https://packagist.org/packages/friendsofhyperf/cache)|
+|[command-benchmark](https://github.com/friendsofhyperf/command-benchmark)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-benchmark/v)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-benchmark/downloads)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-benchmark/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|
 |[command-signals](https://github.com/friendsofhyperf/command-signals)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-signals/v)](https://packagist.org/packages/friendsofhyperf/command-signals)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-signals/downloads)](https://packagist.org/packages/friendsofhyperf/command-signals)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-signals/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-signals)|
 |[command-validation](https://github.com/friendsofhyperf/command-validation)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-validation/v)](https://packagist.org/packages/friendsofhyperf/command-validation)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-validation/downloads)](https://packagist.org/packages/friendsofhyperf/command-validation)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-validation/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-validation)|
 |[compoships](https://github.com/friendsofhyperf/compoships)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/compoships/v)](https://packagist.org/packages/friendsofhyperf/compoships)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/compoships/downloads)](https://packagist.org/packages/friendsofhyperf/compoships)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/compoships/d/monthly)](https://packagist.org/packages/friendsofhyperf/compoships)|
diff --git a/src/.github/profile/README.md b/src/.github/profile/README.md
@@ -6,6 +6,7 @@
 |--|--|--|--|
 |[amqp-job](https://github.com/friendsofhyperf/amqp-job)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/amqp-job/v)](https://packagist.org/packages/friendsofhyperf/amqp-job)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/amqp-job/downloads)](https://packagist.org/packages/friendsofhyperf/amqp-job)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/amqp-job/d/monthly)](https://packagist.org/packages/friendsofhyperf/amqp-job)|
 |[cache](https://github.com/friendsofhyperf/cache)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/cache/v)](https://packagist.org/packages/friendsofhyperf/cache)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/cache/downloads)](https://packagist.org/packages/friendsofhyperf/cache)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/cache/d/monthly)](https://packagist.org/packages/friendsofhyperf/cache)|
+|[command-benchmark](https://github.com/friendsofhyperf/command-benchmark)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-benchmark/v)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-benchmark/downloads)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-benchmark/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-benchmark)|
 |[command-signals](https://github.com/friendsofhyperf/command-signals)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-signals/v)](https://packagist.org/packages/friendsofhyperf/command-signals)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-signals/downloads)](https://packagist.org/packages/friendsofhyperf/command-signals)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-signals/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-signals)|
 |[command-validation](https://github.com/friendsofhyperf/command-validation)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/command-validation/v)](https://packagist.org/packages/friendsofhyperf/command-validation)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/command-validation/downloads)](https://packagist.org/packages/friendsofhyperf/command-validation)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/command-validation/d/monthly)](https://packagist.org/packages/friendsofhyperf/command-validation)|
 |[compoships](https://github.com/friendsofhyperf/compoships)|[![Latest Stable Version](https://poser.pugx.org/friendsofhyperf/compoships/v)](https://packagist.org/packages/friendsofhyperf/compoships)|[![Total Downloads](https://poser.pugx.org/friendsofhyperf/compoships/downloads)](https://packagist.org/packages/friendsofhyperf/compoships)|[![Monthly Downloads](https://poser.pugx.org/friendsofhyperf/compoships/d/monthly)](https://packagist.org/packages/friendsofhyperf/compoships)|
diff --git a/src/command-benchmark/.gitattributes b/src/command-benchmark/.gitattributes
@@ -0,0 +1,4 @@
+/.github export-ignore
+/.vscode export-ignore
+/tests export-ignore
+.gitattributes export-ignore
diff --git a/src/command-benchmark/.github/FUNDING.yml b/src/command-benchmark/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github: huangdijia
+custom: https://hdj.me/sponsors/
diff --git a/src/command-benchmark/.github/workflows/close-pull-request.yml b/src/command-benchmark/.github/workflows/close-pull-request.yml
@@ -0,0 +1,9 @@
+name: Close Pull Request
+
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  run:
+    uses: friendsofhyperf/.github/.github/workflows/close-pull-request.yml@main
diff --git a/src/command-benchmark/.github/workflows/release.yaml b/src/command-benchmark/.github/workflows/release.yaml
@@ -0,0 +1,10 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build:
+    uses: friendsofhyperf/.github/.github/workflows/release.yaml@main
diff --git a/src/command-benchmark/LICENSE b/src/command-benchmark/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) D.J.Hwang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/command-benchmark/README.md b/src/command-benchmark/README.md
@@ -0,0 +1,22 @@
+# Command Signals
+
+[![Latest Stable Version](https://img.shields.io/packagist/v/friendsofhyperf/command-benchmark)](https://packagist.org/packages/friendsofhyperf/command-benchmark)
+[![Total Downloads](https://img.shields.io/packagist/dt/friendsofhyperf/command-benchmark)](https://packagist.org/packages/friendsofhyperf/command-benchmark)
+[![License](https://img.shields.io/packagist/l/friendsofhyperf/command-benchmark)](https://github.com/friendsofhyperf/command-benchmark)
+
+The benchmark component for Hyperf Command.
+
+## Installation
+
+```shell
+composer require friendsofhyperf/command-benchmark
+```
+
+## Contact
+
+- [Twitter](https://twitter.com/huangdijia)
+- [Gmail](mailto:huangdijia@gmail.com)
+
+## License
+
+[MIT](LICENSE)
diff --git a/src/command-benchmark/composer.json b/src/command-benchmark/composer.json
@@ -0,0 +1,45 @@
+{
+    "name": "friendsofhyperf/command-benchmark",
+    "description": "The benchmark component for Hyperf Command.",
+    "license": "MIT",
+    "type": "library",
+    "keywords": [
+        "hyperf",
+        "v3.1"
+    ],
+    "authors": [
+        {
+            "name": "huangdijia",
+            "email": "huangdijia@gmail.com"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/friendsofhyperf/components/issues",
+        "source": "https://github.com/friendsofhyperf/components",
+        "docs": "https://hyperf.fans",
+        "pull-request": "https://github.com/friendsofhyperf/components/pulls"
+    },
+    "require": {
+        "php": ">=8.1",
+        "hyperf/collection": "~3.1.0",
+        "hyperf/command": "~3.1.0",
+        "hyperf/event": "^3.1.0"
+    },
+    "minimum-stability": "dev",
+    "autoload": {
+        "psr-4": {
+            "FriendsOfHyperf\\CommandBenchmark\\": "src/"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "3.1-dev"
+        },
+        "hyperf": {
+            "config": "FriendsOfHyperf\\CommandBenchmark\\ConfigProvider"
+        }
+    }
+}
diff --git a/src/command-benchmark/src/ConfigProvider.php b/src/command-benchmark/src/ConfigProvider.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of friendsofhyperf/components.
+ *
+ * @link     https://github.com/friendsofhyperf/components
+ * @document https://github.com/friendsofhyperf/components/blob/main/README.md
+ * @contact  huangdijia@gmail.com
+ */
+
+namespace FriendsOfHyperf\CommandBenchmark;
+
+class ConfigProvider
+{
+    public function __invoke()
+    {
+        return [
+            'listeners' => [
+                Listener\CommandExecutedListener::class,
+            ],
+        ];
+    }
+}
diff --git a/src/command-benchmark/src/Listener/CommandExecutedListener.php b/src/command-benchmark/src/Listener/CommandExecutedListener.php
@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of friendsofhyperf/components.
+ *
+ * @link     https://github.com/friendsofhyperf/components
+ * @document https://github.com/friendsofhyperf/components/blob/main/README.md
+ * @contact  huangdijia@gmail.com
+ */
+
+namespace FriendsOfHyperf\CommandBenchmark\Listener;
+
+use Hyperf\Collection\Collection;
+use Hyperf\Command\Command;
+use Hyperf\Command\Event\AfterHandle;
+use Hyperf\Command\Event\BeforeHandle;
+use Hyperf\Database\Events\QueryExecuted;
+use Hyperf\Event\Contract\ListenerInterface;
+use Hyperf\Event\ListenerProvider;
+use Psr\Container\ContainerInterface;
+use Psr\EventDispatcher\ListenerProviderInterface;
+use WeakMap;
+
+use function Hyperf\Collection\collect;
+
+class CommandExecutedListener implements ListenerInterface
+{
+    private WeakMap $metrics;
+
+    public function __construct(private ContainerInterface $container)
+    {
+        $this->metrics = new WeakMap();
+    }
+
+    public function listen(): array
+    {
+        return [
+            BeforeHandle::class,
+            AfterHandle::class,
+        ];
+    }
+
+    /**
+     * @param BeforeHandle|AfterHandle $event
+     */
+    public function process(object $event): void
+    {
+        $command = $event->getCommand();
+        if ($event instanceof BeforeHandle) {
+            $this->metrics[$command] = [
+                'start_at' => microtime(true),
+                'start_memory' => memory_get_usage(true),
+                'queries' => 0,
+            ];
+
+            /** @var ListenerProvider $listenerProvider */
+            $listenerProvider = $this->container->get(ListenerProviderInterface::class);
+            $listenerProvider->on(QueryExecuted::class, function () use ($command) {
+                ++$this->metrics[$command]['queries'];
+            });
+        }
+        if ($event instanceof AfterHandle) {
+            $metrics = collect([
+                'time' => $this->formatExecutionTime(microtime(true) - $this->metrics[$command]['start_at']),
+                'memory' => round((memory_get_usage() - $this->metrics[$command]['start_memory']) / 1024 / 1024, 2) . 'MB',
+                'queries' => $this->metrics[$command]['queries'],
+            ]);
+            $this->renderBenchmarkResults($command, $metrics);
+            $this->metrics->offsetUnset($command);
+        }
+    }
+
+    private function formatExecutionTime(float $executionTime): string
+    {
+        return match (true) {
+            $executionTime >= 60 => sprintf('%dm %ds', floor($executionTime / 60), $executionTime % 60),
+            $executionTime >= 1 => round($executionTime, 2) . 's',
+            default => round($executionTime * 1000) . 'ms',
+        };
+    }
+
+    private function renderBenchmarkResults(Command $command, Collection $metrics): void
+    {
+        $output = $metrics->map(fn ($value, $key) => match ($key) {
+            'time' => "<bg=blue;fg=black> TIME: {$value} </>",
+            'memory' => "<bg=green;fg=black> MEM: {$value} </>",
+            'queries' => "<bg=yellow;fg=black> SQL: {$value} </>",
+            'rows' => "<bg=magenta;fg=black> ROWS: {$value} </>",
+            default => '',
+        });
+
+        $command->newLine();
+        $command->line('⚡ ' . $output->join(' '));
+        $command->newLine();
+    }
+}
diff --git a/src/command-signals/README.md b/src/command-signals/README.md
@@ -6,11 +6,6 @@
 
 The signals component for Hyperf Command.
 
-## Requirements
-
-- PHP >= 8.0
-- Hyperf >= 3.0
-
 ## Installation
 
 ```shell

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+github: huangdijia`
	`2`	`+custom: https://hdj.me/sponsors/`