Merge pull request #22 from GeniusesOfSymfony/pnctl-stack-component

PNTCL signal handler and Stack server component

Author: Johann Saunier

.gitignore

@@ -1 +1,2 @@
-/vendor/
+/vendor/
+composer.lock

Event/ClientEventListener.php

@@ -143,7 +143,6 @@ public function onClientDisconnect(ClientEvent $event)
                 ? $user->getUsername()
                 : $user;
 
-
             $this->logger->info(sprintf(
                 '%s disconnected [%]',
                 $username,
@@ -153,7 +152,6 @@ public function onClientDisconnect(ClientEvent $event)
                 'session_id' => $conn->WAMP->sessionId,
                 'storage_id' => $conn->WAMP->clientStorageId,
             ));
-
         } catch (StorageException $e) {
             $this->logger->info(sprintf(
                 '%s disconnected [%s]',
@@ -179,7 +177,6 @@ public function onClientError(ClientErrorEvent $event)
         $conn = $event->getConnection();
         $e = $event->getException();
 
-
         $loggerContext = array(
             'connection_id' => $conn->resourceId,
             'session_id' => $conn->WAMP->sessionId,
@@ -195,7 +192,6 @@ public function onClientError(ClientErrorEvent $event)
             $e->getFile(),
             $e->getLine()
         ), $loggerContext);
-
     }
 
     /**

Event/ServerEvent.php

@@ -3,6 +3,7 @@
 namespace Gos\Bundle\WebSocketBundle\Event;
 
 use React\EventLoop\LoopInterface;
+use React\Socket\Server;
 use Symfony\Component\EventDispatcher\Event;
 
 class ServerEvent extends Event
@@ -12,12 +13,19 @@ class ServerEvent extends Event
      */
     protected $loop;
 
+    /**
+     * @var Server
+     */
+    protected $server;
+
     /**
      * @param LoopInterface $loop
+     * @param Server        $server
      */
-    public function __construct(LoopInterface $loop)
+    public function __construct(LoopInterface $loop, Server $server)
     {
         $this->loop = $loop;
+        $this->server = $server;
     }
 
     /**
@@ -29,4 +37,12 @@ public function getEventLoop()
     {
         return $this->loop;
     }
+
+    /**
+     * @return Server
+     */
+    public function getServer()
+    {
+        return $this->server;
+    }
 }

Event/StartServerListener.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Gos\Bundle\WebSocketBundle\Event;
+
+use Gos\Bundle\WebSocketBundle\Server\App\Registry\PeriodicRegistry;
+use Gos\Component\PnctlEventLoopEmitter\PnctlEmitter;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use React\EventLoop\Timer\TimerInterface;
+
+class StartServerListener
+{
+    /**
+     * @var PeriodicRegistry
+     */
+    protected $periodicRegistry;
+
+    /**
+     * @var LoggerInterface
+     */
+    protected $logger;
+
+    /**
+     * @param PeriodicRegistry $periodicRegistry
+     * @param LoggerInterface  $logger
+     */
+    public function __construct(PeriodicRegistry $periodicRegistry, LoggerInterface $logger = null)
+    {
+        $this->periodicRegistry = $periodicRegistry;
+        $this->logger = null === $logger ? new NullLogger() : $logger;
+    }
+
+    /**
+     * @param ServerEvent $event
+     */
+    public function bindPnctlEvent(ServerEvent $event)
+    {
+        if(!extension_loaded('pcntl')){
+            return;
+        }
+
+        $loop = $event->getEventLoop();
+        $server = $event->getServer();
+
+        $pnctlEmitter = new PnctlEmitter($loop);
+
+        $pnctlEmitter->on(SIGTERM, function () use ($server, $loop) {
+
+            $server->emit('end');
+            $server->shutdown();
+            $loop->stop();
+
+            $this->logger->notice('Server stopped !');
+        });
+
+        $pnctlEmitter->on(SIGINT, function () use ($server, $loop) {
+
+            $this->logger->notice('Press CTLR+C again to stop the server');
+
+            if (SIGINT === pcntl_sigtimedwait([SIGINT], $siginfo, 5)) {
+                $this->logger->notice('Stopping server ...');
+
+                $server->emit('end');
+                $server->shutdown();
+
+                foreach ($this->periodicRegistry->getPeriodics() as $periodic) {
+                    if ($periodic instanceof TimerInterface && $loop->isTimerActive($periodic)) {
+                        $loop->cancelTimer($periodic);
+                    }
+                }
+
+                $loop->stop();
+
+                $this->logger->notice('Server stopped !');
+            } else {
+                $this->logger->notice('CTLR+C not pressed, continue to run normally');
+            }
+        });
+
+    }
+}

Resources/config/services/services.yml

@@ -36,6 +36,8 @@ services:
 
     gos_web_socket.ws.server:
         class: Gos\Bundle\WebSocketBundle\Server\Type\WebSocketServer
+        public: false
+        lazy: true
         arguments:
             - %web_socket_server.host%
             - %web_socket_server.port%
@@ -61,6 +63,7 @@ services:
 
     gos_web_socket.topic.dispatcher:
         class: Gos\Bundle\WebSocketBundle\Server\App\Dispatcher\TopicDispatcher
+        lazy: true
         arguments:
             - @gos_web_socket.topic.registry
             - @gos_web_socket.router.wamp
@@ -77,6 +80,8 @@ services:
 
     gos_web_socket_server.wamp_application:
         class: Gos\Bundle\WebSocketBundle\Server\App\WampApplication
+        public: false
+        lazy: true
         arguments:
             - @gos_web_socket.rpc.dispatcher
             - @gos_web_socket.topic.dispatcher
@@ -92,13 +97,18 @@ services:
 
     gos_web_socket.client_storage.doctrine.decorator:
         class: Gos\Bundle\WebSocketBundle\Client\Driver\DoctrineCacheDriverDecorator
+        lazy: true
+        public: false
+        # argument are set via compiler pass
 
     gos_web_socket.client_event.listener:
         class: Gos\Bundle\WebSocketBundle\Event\ClientEventListener
         arguments:
             - @gos_web_socket.client_storage
             - @security.context
             - @?monolog.logger.websocket
+            # other are set via compiler pass
+        lazy: true
         tags:
             - { name: kernel.event_listener, event: 'gos_web_socket.client_connected', method: onClientConnect }
             - { name: kernel.event_listener, event: 'gos_web_socket.client_disconnected', method: onClientDisconnect }
@@ -113,18 +123,30 @@ services:
 
     gos_web_socket.router.wamp:
         class: Gos\Bundle\WebSocketBundle\Router\WampRouter
+        lazy: true
         arguments:
             - @gos_web_socket.null.pubsub.router
             - %kernel.debug%
             - @?monolog.logger.websocket
 
     gos_web_socket.pdo.periodic_ping:
         class: Gos\Bundle\WebSocketBundle\Periodic\PdoPeriodicPing
+        lazy: true
         arguments:
             - @?pdo
             - @?monolog.logger.websocket
 
     gos_web_socket.memory_usage.periodic:
         class: Gos\Bundle\WebSocketBundle\Periodic\PeriodicMemoryUsage
+        lazy: true
         arguments:
             - @?monolog.logger.websocket
+
+    gos_web_socket.pnctl_event.listener:
+        class: Gos\Bundle\WebSocketBundle\Event\StartServerListener
+        lazy: true
+        arguments:
+            - @gos_web_socket.periodic.registry
+            - @?monolog.logger.websocket
+        tags:
+            - { name: kernel.event_listener, event: 'gos_web_socket.server_launched', method: bindPnctlEvent }

Server/App/Registry/OriginRegistry.php

@@ -14,7 +14,7 @@ class OriginRegistry
 
     public function __construct()
     {
-        $this->origins = array();
+        $this->origins = [];
     }
 
     /**

Server/App/Registry/RpcRegistry.php

@@ -16,7 +16,7 @@ class RpcRegistry
 
     public function __construct()
     {
-        $this->rpcHandlers = array();
+        $this->rpcHandlers = [];
     }
 
     /**

Server/App/Registry/ServerRegistry.php

@@ -14,6 +14,11 @@ class ServerRegistry
      */
     protected $servers;
 
+    public function __construct()
+    {
+        $this->servers = [];
+    }
+
     /**
      * @param ServerInterface $server
      */

Server/App/Registry/TopicRegistry.php

@@ -16,7 +16,7 @@ class TopicRegistry
 
     public function __construct()
     {
-        $this->topics = array();
+        $this->topics = [];
     }
 
     /**