 |
VOOZH | about |
|
VOOZH | about |
Server Management Commands provide administrative utilities for managing and inspecting the Hypervel Foundation application. These commands are automatically registered via the ConfigProvider class and include tools for server lifecycle management, application introspection, configuration inspection, and asset publishing.
The framework provides four built-in management commands:
| Command | Class | Purpose |
|---|---|---|
about | AboutCommand | Display application environment information |
config:show | ConfigShowCommand | Display configuration values |
server:reload | ServerReloadCommand | Gracefully reload worker processes |
vendor:publish | VendorPublishCommand | Publish package assets and configuration |
For information about general console command architecture and execution, see Console Kernel and Command Execution. For command discovery and registration mechanisms, see Command Discovery and Registration.
Sources: src/ConfigProvider.php31-36
All server management commands are registered through the ConfigProvider::__invoke() method, which returns a configuration array consumed by the Hyperf service container. The commands array specifies class names that are automatically instantiated and registered with the Artisan console application.
Sources: src/ConfigProvider.php31-36
The AboutCommand class provides the about command, which displays comprehensive information about the application environment, installed packages, configuration, and system details.
| Property | Value |
|---|---|
| Class | Hypervel\Foundation\Console\Commands\AboutCommand |
| Command Name | about |
| Registration | Automatic via ConfigProvider |
This command is useful for quickly inspecting the application environment during debugging or deployment verification.
Sources: src/ConfigProvider.php32
The ConfigShowCommand class provides the config:show command, which displays configuration values from the application's configuration system. This command allows developers to inspect resolved configuration without needing to access configuration files directly.
| Property | Value |
|---|---|
| Class | Hypervel\Foundation\Console\Commands\ConfigShowCommand |
| Command Name | config:show |
| Registration | Automatic via ConfigProvider |
This command is particularly useful for verifying that environment-specific configuration has been loaded correctly and for debugging configuration issues.
Sources: src/ConfigProvider.php33
The VendorPublishCommand class provides the vendor:publish command, which publishes assets and configuration files from installed packages to the application directory. This allows packages to provide default configuration that can be customized by the application.
| Property | Value |
|---|---|
| Class | Hypervel\Foundation\Console\Commands\VendorPublishCommand |
| Command Name | vendor:publish |
| Registration | Automatic via ConfigProvider |
The command works in conjunction with the publish configuration key in package ConfigProviders, which defines source and destination paths for publishable assets. For example, the Foundation package itself publishes app.php configuration src/ConfigProvider.php37-44
Sources: src/ConfigProvider.php35 src/ConfigProvider.php37-44
The ServerReloadCommand class provides the server:reload command, which gracefully reloads all worker processes without stopping the server. This is essential for deploying code changes in production environments without service interruption by sending POSIX signals to the Swoole master process.
| Property | Value |
|---|---|
| Class | Hypervel\Foundation\Console\Commands\ServerReloadCommand |
| Signature | server:reload |
| Description | Reload all workers gracefully. |
| Base Class | Hypervel\Console\Command |
The command operates by reading the master process PID from a configured file and sending POSIX signals to trigger worker reloads.
Sources: src/Console/Commands/ServerReloadCommand.php14-18
The ServerReloadCommand constructor injects three dependencies:
| Dependency | Type | Purpose |
|---|---|---|
$container | ContainerInterface | Service container access |
$config | ConfigInterface | Access to server.settings configuration |
$filesystem | Filesystem | File operations for reading PID file |
Sources: src/Console/Commands/ServerReloadCommand.php20-26
The following diagram illustrates the complete execution flow of the server:reload command:
Sources: src/Console/Commands/ServerReloadCommand.php28-70
The command requires the following configuration in config/server.php:
| Configuration Key | Type | Required | Purpose |
|---|---|---|---|
server.settings.pid_file | string | Yes | Path to file storing master process PID |
server.settings.task_worker_num | int | No | Number of task workers (0 = none) |
If pid_file is not configured, a FileNotFoundException is thrown src/Console/Commands/ServerReloadCommand.php31-33
Sources: src/Console/Commands/ServerReloadCommand.php30-40
The reload mechanism uses POSIX signals to communicate with the Swoole server master process:
| Signal | Constant | Target | Action |
|---|---|---|---|
| SIGUSR1 | User-defined signal 1 | Worker Processes | Triggers graceful restart of all worker processes |
| SIGUSR2 | User-defined signal 2 | Task Workers | Triggers graceful restart of all task worker processes |
The command uses posix_kill((int) $pid, 0) to verify the process is active before sending reload signals src/Console/Commands/ServerReloadCommand.php44-48
Sources: src/Console/Commands/ServerReloadCommand.php42-63
When SIGUSR1 or SIGUSR2 signals are received by the Swoole master process:
This ensures no requests are dropped and new code is loaded without server restart.
Sources: src/Console/Commands/ServerReloadCommand.php43-63
The command implements multiple error handling scenarios:
| Error Condition | Line Range | Handler | Exit Code |
|---|---|---|---|
| PID file not configured | 30-33 | Throws FileNotFoundException | Exception |
| PID file doesn't exist | 35-38 | Warns and exits gracefully | 0 |
| Process not active | 44-48, 57-61 | Warns but continues | 0 |
| General failure | 64-67 | Catches Throwable, displays error | 1 |
Sources: src/Console/Commands/ServerReloadCommand.php28-70
Expected output:
Reloading workers...
Done.
When task_worker_num is configured:
Reloading workers...
Reloading task workers...
Done.
PID file not configured:
FileNotFoundException: The config of pid_file is not found.
Server not running:
pid_file doesn't exist.
Sources: src/Console/Commands/ServerReloadCommand.php14-70
The server:reload command is typically used in development and deployment workflows:
Combined with file watchers, developers can automatically reload workers when code changes:
In production deployments:
The ReloadDotenvAndConfig listener works in conjunction with this command to hot-reload configuration changes when workers are restarted. The SetProcessTitle listener sets process titles that can be monitored during reloads. Both listeners are registered in the ConfigProvider.
Sources: src/ConfigProvider.php27-30
The command relies on Swoole's built-in PID file management:
server.settings.pid_file on startupThe Filesystem service provides two operations:
exists($file): Checks if PID file exists src/Console/Commands/ServerReloadCommand.php35get($file): Reads PID content src/Console/Commands/ServerReloadCommand.php41Task workers are optional in Swoole. The command checks server.settings.task_worker_num to determine if task worker reload is needed src/Console/Commands/ServerReloadCommand.php40
Sources: src/Console/Commands/ServerReloadCommand.php20-26 src/Console/Commands/ServerReloadCommand.php30-63
| Approach | Downtime | Code Reload | Configuration Reload | Command |
|---|---|---|---|---|
| Graceful Reload | None | Yes | No | server:reload |
| Server Restart | Yes | Yes | Yes | server:restart (if available) |
| Process Manager | Depends | Yes | Yes | External (e.g., systemd) |
The server:reload command is preferred for code deployments as it provides zero-downtime updates. For configuration changes requiring server restart, external process managers or manual restarts are necessary.
Refresh this wiki