Merge pull request swooletw#183 from fractalzombie/develop

Added hot reload and access log to console

Author: albertcht

.travis.yml

@@ -37,4 +37,4 @@ script:
   - vendor/bin/phpunit --coverage-clover build/logs/clover.xml
 
 after_success:
-  - vendor/bin/coveralls -v
+  - vendor/bin/php-coveralls -v

composer.json

@@ -26,13 +26,17 @@
     "illuminate/contracts": "~5.3",
     "illuminate/http": "~5.3",
     "illuminate/support": "~5.3",
-    "predis/predis": "^1.1"
+    "predis/predis": "^1.1",
+    "ext-json": "*",
+    "ext-fileinfo": "*",
+    "ext-pdo": "*",
+    "ext-pcntl": "*"
   },
   "require-dev": {
     "laravel/lumen-framework": "~5.3",
-    "phpunit/phpunit": "^6.1",
-    "phpunit/php-code-coverage": "^5.2",
-    "satooshi/php-coveralls": "^1.0",
+    "phpunit/phpunit": "^7.5",
+    "phpunit/php-code-coverage": "^6.1",
+    "php-coveralls/php-coveralls": "^2.1",
     "mockery/mockery": "~1.0",
     "codedungeon/phpunit-result-printer": "^0.14.0",
     "php-mock/php-mock": "^2.0"

config/swoole_http.php

@@ -15,7 +15,7 @@
         'public_path' => base_path('public'),
         // Determine if to use swoole to respond request for static files
         'handle_static_files' => env('SWOOLE_HANDLE_STATIC', true),
-        'log' => env('SWOOLE_HTTP_LOG', true),
+        'access_log' => env('SWOOLE_HTTP_ACCESS_LOG', true),
         // You must add --enable-openssl while compiling Swoole
         // Put `SWOOLE_SOCK_TCP | SWOOLE_SSL` if you want to enable SSL
         'socket_type' => SWOOLE_SOCK_TCP,
@@ -59,11 +59,11 @@
     |--------------------------------------------------------------------------
     */
     'hot_reload' => [
-        'enabled' => env('SWOOLE_HOT_RELOAD_ENABLE', true),
-        'level' => env('SWOOLE_HOT_RELOAD_DEEP_LEVEL', 10),
+        'enabled' => env('SWOOLE_HOT_RELOAD_ENABLE', false),
+        'recursively' => env('SWOOLE_HOT_RELOAD_RECURSIVELY', true),
         'directory' => env('SWOOLE_HOT_RELOAD_DIRECTORY', base_path()),
         'log' => env('SWOOLE_HOT_RELOAD_LOG', true),
-        'files' => ['*.php'],
+        'filter' => env('SWOOLE_HOT_RELOAD_FILTER', '.php'),
     ],
 
     /*

src/Commands/HttpServerCommand.php

@@ -3,8 +3,19 @@
 namespace SwooleTW\Http\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Console\OutputStyle;
+use Illuminate\Contracts\Container\Container;
 use Illuminate\Support\Arr;
 use Swoole\Process;
+use SwooleTW\Http\Helpers\Alias;
+use SwooleTW\Http\HotReload\FSEvent;
+use SwooleTW\Http\HotReload\FSOutput;
+use SwooleTW\Http\HotReload\FSProcess;
+use SwooleTW\Http\Middlewares\AccessLog;
+use SwooleTW\Http\Server\AccessOutput;
+use SwooleTW\Http\Server\Facades\Server;
+use SwooleTW\Http\Server\Manager;
+use Symfony\Component\Console\Output\ConsoleOutput;
 use Throwable;
 
 /**
@@ -66,7 +77,7 @@ public function handle()
      */
     protected function loadConfigs()
     {
-        $this->config = $this->laravel->make('config')->get('swoole_http');
+        $this->config = $this->laravel->make(Alias::CONFIG)->get('swoole_http');
     }
 
     /**
@@ -90,17 +101,30 @@ protected function start()
 
         $host = Arr::get($this->config, 'server.host');
         $port = Arr::get($this->config, 'server.port');
+        $hotReloadEnabled = Arr::get($this->config, 'hot_reload.enabled');
+        $accessLogEnabled = Arr::get($this->config, 'server.access_log');
 
         $this->info('Starting swoole http server...');
         $this->info("Swoole http server started: <http://{$host}:{$port}>");
         if ($this->isDaemon()) {
             $this->info(
-                '> (You can run this command to ensure the '.
+                '> (You can run this command to ensure the ' .
                 'swoole_http_server process is running: ps aux|grep "swoole")'
             );
         }
 
-        $this->laravel->make('swoole.manager')->run();
+        $manager = $this->laravel->make(Manager::class);
+        $server = $this->laravel->make(Server::class);
+
+        if ($accessLogEnabled) {
+            $this->registerAccessLog();
+        }
+
+        if ($hotReloadEnabled) {
+            $manager->addProcess($this->getHotReloadProcess($server));
+        }
+
+        $manager->run();
     }
 
     /**
@@ -230,6 +254,26 @@ protected function initAction()
         }
     }
 
+    /**
+     * @param \SwooleTW\Http\Server\Facades\Server $server
+     *
+     * @return \Swoole\Process
+     */
+    protected function getHotReloadProcess($server)
+    {
+        $recursively = Arr::get($this->config, 'hot_reload.recursively');
+        $directory = Arr::get($this->config, 'hot_reload.directory');
+        $filter = Arr::get($this->config, 'hot_reload.filter');
+        $log = Arr::get($this->config, 'hot_reload.log');
+
+        $cb = function (FSEvent $event) use ($server, $log) {
+            $log ? $this->info(FSOutput::format($event)) : null;
+            $server->reload();
+        };
+
+        return (new FSProcess($filter, $recursively, $directory))->make($cb);
+    }
+
     /**
      * If Swoole process is running.
      *
@@ -292,7 +336,7 @@ protected function getCurrentPid()
         $path = $this->getPidPath();
 
         return $this->currentPid = file_exists($path)
-            ? (int)file_get_contents($path) ?? $this->removePidFile()
+            ? (int) file_get_contents($path) ?? $this->removePidFile()
             : null;
     }
 
@@ -332,19 +376,37 @@ protected function checkEnvironment()
         if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
             $this->error("Swoole extension doesn't support Windows OS yet.");
 
-            return;
-        } else {
-            if (! extension_loaded('swoole')) {
-                $this->error("Can't detect Swoole extension installed.");
+            exit(1);
+        }
 
-                return;
-            } else {
-                if (! version_compare(swoole_version(), '4.0.0', 'ge')) {
-                    $this->error("Your Swoole version must be higher than 4.0 to use coroutine.");
+        if (! extension_loaded('swoole')) {
+            $this->error("Can't detect Swoole extension installed.");
 
-                    return;
-                }
-            }
+            exit(1);
         }
+
+        if (! version_compare(swoole_version(), '4.0.0', 'ge')) {
+            $this->error("Your Swoole version must be higher than 4.0 to use coroutine.");
+
+            exit(1);
+        }
+    }
+
+    /**
+     * Register access log services.
+     */
+    protected function registerAccessLog()
+    {
+        $this->laravel->singleton(OutputStyle::class, function () {
+            return new OutputStyle($this->input, $this->output);
+        });
+
+        $this->laravel->singleton(AccessOutput::class, function () {
+            return new AccessOutput(new ConsoleOutput);
+        });
+
+        $this->laravel->singleton(AccessLog::class, function (Container $container) {
+            return new AccessLog($container->make(AccessOutput::class));
+        });
     }
 }

src/Concerns/InteractsWithWebsocket.php

@@ -6,7 +6,9 @@
 use Illuminate\Pipeline\Pipeline;
 use Illuminate\Support\Arr;
 use SwooleTW\Http\Exceptions\WebsocketNotSetInConfigException;
-use SwooleTW\Http\Helpers\Service;
+use SwooleTW\Http\Helpers\Alias;
+use SwooleTW\Http\Server\Facades\Server;
+use SwooleTW\Http\Server\Sandbox;
 use SwooleTW\Http\Transformers\Request;
 use SwooleTW\Http\Websocket\HandlerContract;
 use SwooleTW\Http\Websocket\Parser;
@@ -54,8 +56,8 @@ trait InteractsWithWebsocket
     public function onOpen($swooleRequest)
     {
         $illuminateRequest = Request::make($swooleRequest)->toIlluminate();
-        $websocket = $this->app->make(Service::WEBSOCKET_ALIAS);
-        $sandbox = $this->app->make(Service::SANDBOX_ALIAS);
+        $websocket = $this->app->make(Websocket::class);
+        $sandbox = $this->app->make(Sandbox::class);
 
         try {
             $websocket->reset(true)->setSender($swooleRequest->fd);
@@ -94,8 +96,8 @@ public function onMessage($server, $frame)
             return;
         }
 
-        $websocket = $this->app->make(Service::WEBSOCKET_ALIAS);
-        $sandbox = $this->app->make(Service::SANDBOX_ALIAS);
+        $websocket = $this->app->make(Websocket::class);
+        $sandbox = $this->app->make(Sandbox::class);
 
         try {
             // decode raw message via parser
@@ -132,7 +134,7 @@ public function onClose($server, $fd, $reactorId)
             return;
         }
 
-        $websocket = $this->app->make(Service::WEBSOCKET_ALIAS);
+        $websocket = $this->app->make(Websocket::class);
 
         try {
             $websocket->reset(true)->setSender($fd);
@@ -172,7 +174,7 @@ public function pushMessage($server, array $data)
 
         // push message to designated fds
         foreach ($push->getDescriptors() as $descriptor) {
-            if ($server->exist($descriptor) || ! $push->isBroadcastToDescriptor((int)$descriptor)) {
+            if ($server->exist($descriptor) || ! $push->isBroadcastToDescriptor((int) $descriptor)) {
                 $server->push($descriptor, $payload, $push->getOpcode());
             }
         }
@@ -205,7 +207,7 @@ public function getPayloadParser()
      */
     protected function prepareWebsocket()
     {
-        $config = $this->container->make(Service::CONFIG_ALIAS);
+        $config = $this->container->make(Alias::CONFIG);
         $isWebsocket = $config->get('swoole_http.websocket.enabled');
         $parser = $config->get('swoole_websocket.parser');
 
@@ -225,7 +227,7 @@ protected function prepareWebsocket()
      */
     protected function isServerWebsocket(int $fd): bool
     {
-        $info = $this->container->make(Service::SERVER_ALIAS)->connection_info($fd);
+        $info = $this->container->make(Server::class)->connection_info($fd);
 
         return Arr::has($info, 'websocket_status') && Arr::get($info, 'websocket_status');
     }
@@ -253,7 +255,7 @@ protected function filterWebsocket(array $descriptors): array
      */
     protected function prepareWebsocketHandler()
     {
-        $handlerClass = $this->container->make(Service::CONFIG_ALIAS)->get('swoole_websocket.handler');
+        $handlerClass = $this->container->make(Alias::CONFIG)->get('swoole_websocket.handler');
 
         if (! $handlerClass) {
             throw new WebsocketNotSetInConfigException;
@@ -303,15 +305,15 @@ protected function createRoom(string $class, array $settings): RoomContract
     protected function bindRoom(): void
     {
         $this->app->singleton(RoomContract::class, function (Container $container) {
-            $config = $container->make(Service::CONFIG_ALIAS);
+            $config = $container->make(Alias::CONFIG);
             $driver = $config->get('swoole_websocket.default');
             $settings = $config->get("swoole_websocket.settings.{$driver}");
             $className = $config->get("swoole_websocket.drivers.{$driver}");
 
             return $this->createRoom($className, $settings);
         });
 
-        $this->app->alias(RoomContract::class, 'swoole.room');
+        $this->app->alias(RoomContract::class, Alias::ROOM);
     }
 
     /**
@@ -320,21 +322,21 @@ protected function bindRoom(): void
     protected function bindWebsocket()
     {
         $this->app->singleton(Websocket::class, function (Container $app) {
-            return new Websocket($app->make(Service::ROOM_ALIAS), new Pipeline($app));
+            return new Websocket($app->make(RoomContract::class), new Pipeline($app));
         });
 
-        $this->app->alias(Websocket::class, Service::WEBSOCKET_ALIAS);
+        $this->app->alias(Websocket::class, 'swoole.websocket');
     }
 
     /**
      * Load websocket routes file.
      */
     protected function loadWebsocketRoutes()
     {
-        $routePath = $this->container->make(Service::CONFIG_ALIAS)->get('swoole_websocket.route_file');
+        $routePath = $this->container->make(Alias::CONFIG)->get('swoole_websocket.route_file');
 
         if (! file_exists($routePath)) {
-            $routePath = __DIR__.'/../../routes/websocket.php';
+            $routePath = __DIR__ . '/../../routes/websocket.php';
         }
 
         return require $routePath;

src/Concerns/ResetApplication.php

@@ -2,6 +2,7 @@
 
 namespace SwooleTW\Http\Concerns;
 
+use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Container\Container;
 use SwooleTW\Http\Exceptions\SandboxException;
 use SwooleTW\Http\Server\Resetters\ResetterContract;
@@ -28,7 +29,7 @@ trait ResetApplication
      */
     protected function setInitialConfig()
     {
-        $this->config = clone $this->getBaseApp()->make('config');
+        $this->config = clone $this->getBaseApp()->make(Repository::class);
     }
 
     /**
@@ -74,7 +75,7 @@ protected function setInitialResetters()
         foreach ($resetters as $resetter) {
             $resetterClass = $app->make($resetter);
             if (! $resetterClass instanceof ResetterContract) {
-                throw new SandboxException("{$resetter} must implement ".ResetterContract::class);
+                throw new SandboxException("{$resetter} must implement " . ResetterContract::class);
             }
             $this->resetters[$resetter] = $resetterClass;
         }

src/Concerns/WithApplication.php

@@ -6,7 +6,7 @@
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Support\Facades\Facade;
 use SwooleTW\Http\Exceptions\FrameworkNotSupportException;
-use SwooleTW\Http\Helpers\Service;
+use SwooleTW\Http\Helpers\Alias;
 
 /**
  * Trait WithApplication
@@ -149,7 +149,7 @@ public function getBasePath()
      */
     protected function preResolveInstances()
     {
-        $resolves = $this->container->make(Service::CONFIG_ALIAS)->get('swoole_http.pre_resolved', []);
+        $resolves = $this->container->make(Alias::CONFIG)->get('swoole_http.pre_resolved', []);
 
         foreach ($resolves as $abstract) {
             if ($this->getApplication()->offsetExists($abstract)) {

src/Controllers/SocketIOController.php

@@ -34,7 +34,7 @@ public function upgrade(Request $request)
             ]
         );
 
-        return '97:0'.$payload.'2:40';
+        return '97:0' . $payload . '2:40';
     }
 
     public function reject()