Merge pull request #271 from lilianjin/master

Refactoring pid manager

Author: albertcht

src/Commands/HttpServerCommand.php

@@ -13,6 +13,7 @@
 use SwooleTW\Http\HotReload\FSOutput;
 use SwooleTW\Http\HotReload\FSProcess;
 use SwooleTW\Http\Server\AccessOutput;
+use SwooleTW\Http\Server\PidManager;
 use SwooleTW\Http\Middleware\AccessLog;
 use SwooleTW\Http\Server\Facades\Server;
 use Illuminate\Contracts\Container\Container;
@@ -59,6 +60,25 @@ class HttpServerCommand extends Command
      */
     protected $config;
 
+    /**
+     * A manager to handle pid about the application.
+     *
+     * @var PidManager
+     */
+    protected $pidManager;
+
+    /**
+     * Create a an new HttpServerCommand instance.
+     *
+     * @param PidManager $pidManager
+     */
+    public function __construct(PidManager $pidManager)
+    {
+        parent::__construct();
+
+        $this->pidManager = $pidManager;
+    }
+
     /**
      * Execute the console command.
      *
@@ -93,7 +113,7 @@ protected function runAction()
      */
     protected function start()
     {
-        if ($this->isRunning($this->getCurrentPid())) {
+        if ($this->isRunning()) {
             $this->error('Failed! swoole_http_server process is already running.');
 
             return;
@@ -132,17 +152,15 @@ protected function start()
      */
     protected function stop()
     {
-        $pid = $this->getCurrentPid();
-
-        if (! $this->isRunning($pid)) {
+        if (! $this->isRunning()) {
             $this->error("Failed! There is no swoole_http_server process running.");
 
             return;
         }
 
         $this->info('Stopping swoole http server...');
 
-        $isRunning = $this->killProcess($pid, SIGTERM, 15);
+        $isRunning = $this->killProcess(SIGTERM, 15);
 
         if ($isRunning) {
             $this->error('Unable to stop the swoole_http_server process.');
@@ -152,7 +170,7 @@ protected function stop()
 
         // I don't known why Swoole didn't trigger "onShutdown" after sending SIGTERM.
         // So we should manually remove the pid file.
-        $this->removePidFile();
+        $this->pidManager->delete();
 
         $this->info('> success');
     }
@@ -162,9 +180,7 @@ protected function stop()
      */
     protected function restart()
     {
-        $pid = $this->getCurrentPid();
-
-        if ($this->isRunning($pid)) {
+        if ($this->isRunning()) {
             $this->stop();
         }
 
@@ -176,19 +192,15 @@ protected function restart()
      */
     protected function reload()
     {
-        $pid = $this->getCurrentPid();
-
-        if (! $this->isRunning($pid)) {
+        if (! $this->isRunning()) {
             $this->error("Failed! There is no swoole_http_server process running.");
 
             return;
         }
 
         $this->info('Reloading swoole_http_server...');
 
-        $isRunning = $this->killProcess($pid, SIGUSR1);
-
-        if (! $isRunning) {
+        if (! $this->killProcess(SIGUSR1)) {
             $this->error('> failure');
 
             return;
@@ -210,8 +222,7 @@ protected function infos()
      */
     protected function showInfos()
     {
-        $pid = $this->getCurrentPid();
-        $isRunning = $this->isRunning($pid);
+        $isRunning = $this->isRunning();
         $host = Arr::get($this->config, 'server.host');
         $port = Arr::get($this->config, 'server.port');
         $reactorNum = Arr::get($this->config, 'server.options.reactor_num');
@@ -231,7 +242,7 @@ protected function showInfos()
             ['Worker Num', $workerNum],
             ['Task Worker Num', $isWebsocket ? $taskWorkerNum : 0],
             ['Websocket Mode', $isWebsocket ? 'On' : 'Off'],
-            ['PID', $isRunning ? $pid : 'None'],
+            ['PID', $isRunning ? implode(', ', $this->pidManager->read()) : 'None'],
             ['Log Path', $logFile],
         ];
 
@@ -281,83 +292,53 @@ protected function getHotReloadProcess($server)
      *
      * @return bool
      */
-    protected function isRunning($pid)
+    public function isRunning()
     {
-        if (! $pid) {
+        $pids = $this->pidManager->read();
+
+        if ([] === $pids) {
             return false;
         }
 
-        try {
-            return Process::kill($pid, 0);
-        } catch (Throwable $e) {
-            return false;
+        [$masterPid, $managerPid] = $pids;
+
+        if ($managerPid) {
+            // Swoole process mode
+            return $masterPid && $managerPid && Process::kill((int) $managerPid, 0);
         }
+
+        // Swoole base mode, no manager process
+        return $masterPid && Process::kill((int) $masterPid, 0);
     }
 
     /**
      * Kill process.
      *
-     * @param int $pid
      * @param int $sig
      * @param int $wait
      *
      * @return bool
      */
-    protected function killProcess($pid, $sig, $wait = 0)
+    protected function killProcess($sig, $wait = 0)
     {
-        Process::kill($pid, $sig);
+        Process::kill(
+            Arr::first($this->pidManager->read()),
+            $sig
+        );
 
         if ($wait) {
             $start = time();
 
             do {
-                if (! $this->isRunning($pid)) {
+                if (! $this->isRunning()) {
                     break;
                 }
 
                 usleep(100000);
             } while (time() < $start + $wait);
         }
 
-        return $this->isRunning($pid);
-    }
-
-    /**
-     * Get pid.
-     *
-     * @return int|null
-     */
-    protected function getCurrentPid()
-    {
-        if ($this->currentPid) {
-            return $this->currentPid;
-        }
-
-        $path = $this->getPidPath();
-
-        return $this->currentPid = file_exists($path)
-            ? (int) file_get_contents($path) ?? $this->removePidFile()
-            : null;
-    }
-
-    /**
-     * Get Pid file path.
-     *
-     * @return string
-     */
-    protected function getPidPath()
-    {
-        return Arr::get($this->config, 'server.options.pid_file', storage_path('logs/swoole.pid'));
-    }
-
-    /**
-     * Remove Pid file.
-     */
-    protected function removePidFile()
-    {
-        if (file_exists($this->getPidPath())) {
-            unlink($this->getPidPath());
-        }
+        return $this->isRunning();
     }
 
     /**

src/HttpServiceProvider.php

@@ -2,17 +2,19 @@
 
 namespace SwooleTW\Http;
 
-use SwooleTW\Http\Helpers\FW;
+use Illuminate\Database\DatabaseManager;
 use Illuminate\Queue\QueueManager;
-use Swoole\Http\Server as HttpServer;
 use Illuminate\Support\ServiceProvider;
-use SwooleTW\Http\Server\Facades\Server;
-use Illuminate\Database\DatabaseManager;
-use SwooleTW\Http\Coroutine\MySqlConnection;
 use SwooleTW\Http\Commands\HttpServerCommand;
-use Swoole\Websocket\Server as WebsocketServer;
-use SwooleTW\Http\Task\Connectors\SwooleTaskConnector;
 use SwooleTW\Http\Coroutine\Connectors\ConnectorFactory;
+use SwooleTW\Http\Coroutine\MySqlConnection;
+use SwooleTW\Http\Helpers\FW;
+use SwooleTW\Http\Server\Facades\Server;
+use SwooleTW\Http\Server\PidManager;
+use SwooleTW\Http\Server\PidManagerFactory;
+use SwooleTW\Http\Task\Connectors\SwooleTaskConnector;
+use Swoole\Http\Server as HttpServer;
+use Swoole\Websocket\Server as WebsocketServer;
 
 /**
  * @codeCoverageIgnore
@@ -43,6 +45,7 @@ abstract class HttpServiceProvider extends ServiceProvider
      */
     public function register()
     {
+        $this->registerPidManager();
         $this->mergeConfigs();
         $this->setIsWebsocket();
         $this->registerServer();
@@ -106,6 +109,18 @@ protected function mergeConfigs()
         $this->mergeConfigFrom(__DIR__ . '/../config/swoole_websocket.php', 'swoole_websocket');
     }
 
+    /**
+     * Register pid manager.
+     *
+     * @return void
+     */
+    protected function registerPidManager(): void
+    {
+        $this->app->singleton(PidManager::class, function() {
+            return call_user_func(new PidManagerFactory, $this->app);
+        });
+    }
+
     /**
      * Set isWebsocket.
      */

src/LaravelServiceProvider.php

@@ -2,9 +2,10 @@
 
 namespace SwooleTW\Http;
 
-use SwooleTW\Http\Server\Manager;
 use Illuminate\Contracts\Http\Kernel;
 use SwooleTW\Http\Middleware\AccessLog;
+use SwooleTW\Http\Server\Manager;
+use SwooleTW\Http\Server\PidManager;
 
 /**
  * @codeCoverageIgnore
@@ -19,7 +20,7 @@ class LaravelServiceProvider extends HttpServiceProvider
     protected function registerManager()
     {
         $this->app->singleton(Manager::class, function ($app) {
-            return new Manager($app, 'laravel');
+            return new Manager($app, 'laravel', base_path(), $this->app[PidManager::class]);
         });
 
         $this->app->alias(Manager::class, 'swoole.manager');

src/LumenServiceProvider.php

@@ -2,8 +2,9 @@
 
 namespace SwooleTW\Http;
 
-use SwooleTW\Http\Server\Manager;
 use SwooleTW\Http\Middleware\AccessLog;
+use SwooleTW\Http\Server\Manager;
+use SwooleTW\Http\Server\PidManager;
 
 /**
  * @codeCoverageIgnore
@@ -18,7 +19,7 @@ class LumenServiceProvider extends HttpServiceProvider
     protected function registerManager()
     {
         $this->app->singleton(Manager::class, function ($app) {
-            return new Manager($app, 'lumen');
+            return new Manager($app, 'lumen', base_path(), $this->app[PidManager::class]);
         });
 
         $this->app->alias(Manager::class, 'swoole.manager');