hhxsv5 / laravel-s

src/Swoole/Process/CustomProcessTrait.php

<?php

Missing file doc comment

namespace Hhxsv5\LaravelS\Swoole\Process;

use Swoole\Http\Server;
use Swoole\Process;

trait CustomProcessTrait

Missing doc comment for trait CustomProcessTrait

{
    private $customProcessPidFile = 'laravels-custom-processes.pid';

Private member variable "customProcessPidFile" must be prefixed with an underscore

    public function addCustomProcesses(Server $swoole, $processPrefix, array $processes, array $laravelConfig)

Missing doc comment for function addCustomProcesses()

    {
        $pidfile = dirname($swoole->setting['pid_file']) . '/' . $this->customProcessPidFile;
        if (file_exists($pidfile)) {
            unlink($pidfile);
        }

        /**@var []CustomProcessInterface $processList */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $processList = [];
        foreach ($processes as $name => $item) {
            if (empty($item['class'])) {
                throw new \InvalidArgumentException(sprintf('The class of process %s must be specified', $name));
            }
            if (isset($item['enable']) && !$item['enable']) {
                continue;
            }
            $processClass = $item['class'];
            $restartInterval = isset($item['restart_interval']) ? (int)$item['restart_interval'] : 5;
            $callback = function (Process $worker) use ($pidfile, $swoole, $processPrefix, $processClass, $restartInterval, $name, $laravelConfig) {
                file_put_contents($pidfile, $worker->pid . "\n", FILE_APPEND | LOCK_EX);
                $this->initLaravel($laravelConfig, $swoole);

It seems like initLaravel() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                if (!isset(class_implements($processClass)[CustomProcessInterface::class])) {
                    throw new \InvalidArgumentException(
                        sprintf(
                            '%s must implement the interface %s',
                            $processClass,
                            CustomProcessInterface::class
                        )
                    );
                }
                /**@var CustomProcessInterface $processClass */

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

Missing short description in doc comment

                $this->setProcessTitle(sprintf('%s laravels: %s process', $processPrefix, $name));

It seems like setProcessTitle() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                Process::signal(SIGUSR1, function ($signo) use ($name, $processClass, $worker, $pidfile, $swoole) {

The parameter $signo is not used and could be removed.

The import $pidfile is not used and could be removed.

The opening parenthesis of a multi-line function call should be the last content on the line.

                    $this->info(sprintf('Reloading %s process[PID=%d].', $name, $worker->pid));

It seems like info() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $processClass::onReload($swoole, $worker);
                });

For multi-line function calls, the closing parenthesis should be on a new line.

                if (method_exists($processClass, 'onStop')) {
                    Process::signal(SIGTERM, function ($signo) use ($name, $processClass, $worker, $pidfile, $swoole) {

The parameter $signo is not used and could be removed.

The opening parenthesis of a multi-line function call should be the last content on the line.

The import $pidfile is not used and could be removed.

                        $this->info(sprintf('Stopping %s process[PID=%d].', $name, $worker->pid));
                        $processClass::onStop($swoole, $worker);
                    });

For multi-line function calls, the closing parenthesis should be on a new line.

                }

                if (class_exists('Swoole\Runtime')) {
                    \Swoole\Runtime::enableCoroutine();
                }

                $this->callWithCatchException([$processClass, 'callback'], [$swoole, $worker]);

It seems like callWithCatchException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                // Avoid frequent process creation
                if (class_exists('Swoole\Coroutine')) {
                    \Swoole\Coroutine::sleep($restartInterval);
                } else {
                    sleep($restartInterval);
                }
            };

            if (isset($item['num']) && $item['num'] > 1) { // For multiple processes
                for ($i = 0; $i < $item['num']; $i++) {
                    $process = $this->makeProcess($callback, $item);
                    $swoole->addProcess($process);
                    $processList[$name . $i] = $process;
                }
            } else {  // For single process
                $process = $this->makeProcess($callback, $item);
                $swoole->addProcess($process);
                $processList[$name] = $process;
            }
        }
        return $processList;
    }

    /**

Missing short description in doc comment

     * @param callable $callback

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array $config

Expected 4 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return Process

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function makeProcess(callable $callback, array $config)
    {
        $redirect = isset($config['redirect']) ? $config['redirect'] : false;
        $pipe = isset($config['pipe']) ? $config['pipe'] : 0;
        $process = version_compare(SWOOLE_VERSION, '4.3.0', '>=')
            ? new Process($callback, $redirect, $pipe, class_exists('Swoole\Coroutine'))
            : new Process($callback, $redirect, $pipe);
        if (isset($config['queue'])) {
            if (empty($config['queue'])) {
                $process->useQueue();
            } else {
                $msgKey = isset($config['queue']['msg_key']) ? $config['queue']['msg_key'] : 0;
                $mode = isset($config['queue']['mode']) ? $config['queue']['mode'] : 2;
                $capacity = isset($config['queue']['capacity']) ? $config['queue']['capacity'] : -1;
                $process->useQueue($msgKey, $mode, $capacity);
            }
        }

        return $process;
    }
}