column('projectId', Table::TYPE_STRING, 64); $stats->column('teamId', Table::TYPE_STRING, 64); $stats->column('connections', Table::TYPE_INT); $stats->column('connectionsTotal', Table::TYPE_INT); $stats->column('messages', Table::TYPE_INT); $stats->create(); $containerId = uniqid(); $statsDocument = null; $adapter = new Adapter\Swoole(port: App::getEnv('PORT', 80)); $adapter->setPackageMaxLength(64000); // Default maximum Package Size (64kb) $server = new Server($adapter); function getDatabase(Registry &$register, string $namespace) { $db = $register->get('dbPool')->get(); $redis = $register->get('redisPool')->get(); $cache = new Cache(new RedisCache($redis)); $database = new Database(new MariaDB($db), $cache); $database->setNamespace($namespace); return [ $database, function () use ($register, $db, $redis) { $register->get('dbPool')->put($db); $register->get('redisPool')->put($redis); } ]; }; $server->onStart(function () use ($stats, $register, $containerId, &$statsDocument) { Console::success('Server started succefully'); /** * Create document for this worker to share stats across Containers. */ go(function () use ($register, $containerId, &$statsDocument) { try { [$database, $returnDatabase] = getDatabase($register, 'project_console_internal'); $document = new Document([ '$id' => $database->getId(), '$collection' => 'realtime', '$read' => [], '$write' => [], 'container' => $containerId, 'timestamp' => time(), 'value' => '{}' ]); $statsDocument = Authorization::skip(function () use ($database, $document) { return $database->createDocument('realtime', $document); }); } catch (\Throwable $th) { Console::error('[Error] Type: ' . get_class($th)); Console::error('[Error] Message: ' . $th->getMessage()); Console::error('[Error] File: ' . $th->getFile()); Console::error('[Error] Line: ' . $th->getLine()); } finally { call_user_func($returnDatabase); } }); /** * Save current connections to the Database every 5 seconds. */ Timer::tick(5000, function () use ($register, $stats, $containerId, &$statsDocument) { /** @var Document $statsDocument */ foreach ($stats as $projectId => $value) { if (empty($value['connections']) && empty($value['messages'])) { continue; } $connections = $stats->get($projectId, 'connections'); $messages = $stats->get($projectId, 'messages'); $usage = new Event('v1-usage', 'UsageV1'); $usage ->setParam('projectId', $projectId) ->setParam('realtimeConnections', $connections) ->setParam('realtimeMessages', $messages) ->setParam('networkRequestSize', 0) ->setParam('networkResponseSize', 0); $stats->set($projectId, [ 'messages' => 0, 'connections' => 0 ]); if (App::getEnv('_APP_USAGE_STATS', 'enabled') == 'enabled') { $usage->trigger(); } } $payload = []; foreach ($stats as $projectId => $value) { if (!empty($value['connectionsTotal'])) { $payload[$projectId] = $stats->get($projectId, 'connectionsTotal'); } } if (empty($payload) || empty($statsDocument)) { return; } try { [$database, $returnDatabase] = getDatabase($register, 'project_console_internal'); $statsDocument ->setAttribute('timestamp', time()) ->setAttribute('value', json_encode($payload)); Authorization::skip(function () use ($database, $statsDocument) { $database->updateDocument('realtime', $statsDocument->getId(), $statsDocument); }); } catch (\Throwable $th) { Console::error('[Error] Type: ' . get_class($th)); Console::error('[Error] Message: ' . $th->getMessage()); Console::error('[Error] File: ' . $th->getFile()); Console::error('[Error] Line: ' . $th->getLine()); } finally { call_user_func($returnDatabase); } }); }); $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, $realtime) { Console::success('Worker ' . $workerId . ' started succefully'); $attempts = 0; $start = time(); Timer::tick(5000, function () use ($server, $register, $realtime, $stats) { /** * Sending current connections to project channels on the console project every 5 seconds. */ if ($realtime->hasSubscriber('console', 'role:member', 'project')) { [$database, $returnDatabase] = getDatabase($register, 'project_console_internal'); $payload = []; $list = Authorization::skip(function () use ($database) { return $database->find('realtime', [ new Query('timestamp', Query::TYPE_GREATER, [(time() - 15)]) ]); }); /** * Aggregate stats across containers. */ foreach ($list as $document) { foreach (json_decode($document->getAttribute('value')) as $projectId => $value) { if (array_key_exists($projectId, $payload)) { $payload[$projectId] += $value; } else { $payload[$projectId] = $value; } } } foreach ($stats as $projectId => $value) { if (!array_key_exists($projectId, $payload)) { continue; } $event = [ 'project' => 'console', 'roles' => ['team:' . $stats->get($projectId, 'teamId')], 'data' => [ 'event' => 'stats.connections', 'channels' => ['project'], 'timestamp' => time(), 'payload' => [ $projectId => $payload[$projectId] ] ] ]; $server->send($realtime->getSubscribers($event), json_encode([ 'type' => 'event', 'data' => $event['data'] ])); } call_user_func($returnDatabase); } /** * Sending test message for SDK E2E tests every 5 seconds. */ if ($realtime->hasSubscriber('console', 'role:guest', 'tests')) { $payload = ['response' => 'WS:/v1/realtime:passed']; $event = [ 'project' => 'console', 'roles' => ['role:guest'], 'data' => [ 'event' => 'test.event', 'channels' => ['tests'], 'timestamp' => time(), 'payload' => $payload ] ]; $server->send($realtime->getSubscribers($event), json_encode([ 'type' => 'event', 'data' => $event['data'] ])); } }); while ($attempts < 300) { try { if ($attempts > 0) { Console::error('Pub/sub connection lost (lasted ' . (time() - $start) . ' seconds, worker: ' . $workerId . '). Attempting restart in 5 seconds (attempt #' . $attempts . ')'); sleep(5); // 5 sec delay between connection attempts } $start = time(); /** @var Redis $redis */ $redis = $register->get('redisPool')->get(); $redis->setOption(Redis::OPT_READ_TIMEOUT, -1); if ($redis->ping(true)) { $attempts = 0; Console::success('Pub/sub connection established (worker: ' . $workerId . ')'); } else { Console::error('Pub/sub failed (worker: ' . $workerId . ')'); } $redis->subscribe(['realtime'], function (Redis $redis, string $channel, string $payload) use ($server, $workerId, $stats, $register, $realtime) { $event = json_decode($payload, true); if ($event['permissionsChanged'] && isset($event['userId'])) { $projectId = $event['project']; $userId = $event['userId']; if ($realtime->hasSubscriber($projectId, 'user:' . $userId)) { $connection = array_key_first(reset($realtime->subscriptions[$projectId]['user:' . $userId])); } else { return; } [$database, $returnDatabase] = getDatabase($register, 'project_' . $projectId . '_internal'); $user = $database->getDocument('users', $userId); $roles = Auth::getRoles($user); $realtime->subscribe($projectId, $connection, $roles, $realtime->connections[$connection]['channels']); call_user_func($returnDatabase); } $receivers = $realtime->getSubscribers($event); if (App::isDevelopment() && !empty($receivers)) { Console::log("[Debug][Worker {$workerId}] Receivers: " . count($receivers)); Console::log("[Debug][Worker {$workerId}] Receivers Connection IDs: " . json_encode($receivers)); Console::log("[Debug][Worker {$workerId}] Event: " . $payload); } $server->send( $receivers, json_encode([ 'type' => 'event', 'data' => $event['data'] ]) ); if (($num = count($receivers)) > 0) { $stats->incr($event['project'], 'messages', $num); } }); } catch (\Throwable $th) { Console::error('Pub/sub error: ' . $th->getMessage()); $register->get('redisPool')->put($redis); $attempts++; continue; } $attempts++; } Console::error('Failed to restart pub/sub...'); }); $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, $register, $stats, &$realtime) { $app = new App('UTC'); $request = new Request($request); $response = new Response(new SwooleResponse()); /** @var PDO $db */ $db = $register->get('dbPool')->get(); /** @var Redis $redis */ $redis = $register->get('redisPool')->get(); Console::info("Connection open (user: {$connection})"); App::setResource('db', function () use (&$db) { return $db; }); App::setResource('cache', function () use (&$redis) { return $redis; }); App::setResource('request', function () use ($request) { return $request; }); App::setResource('response', function () use ($response) { return $response; }); try { /** @var \Utopia\Database\Document $user */ $user = $app->getResource('user'); /** @var \Utopia\Database\Document $project */ $project = $app->getResource('project'); /** @var \Utopia\Database\Document $console */ $console = $app->getResource('console'); $cache = new Cache(new RedisCache($redis)); $database = new Database(new MariaDB($db), $cache); $database->setNamespace('project_' . $project->getId() . '_internal'); /* * Project Check */ if (empty($project->getId())) { throw new Exception('Missing or unknown project ID', 1008); } /* * Abuse Check * * Abuse limits are connecting 128 times per minute and ip address. */ $timeLimit = new TimeLimit('url:{url},ip:{ip}', 128, 60, $database); $timeLimit ->setParam('{ip}', $request->getIP()) ->setParam('{url}', $request->getURI()); $abuse = new Abuse($timeLimit); if ($abuse->check() && App::getEnv('_APP_OPTIONS_ABUSE', 'enabled') === 'enabled') { throw new Exception('Too many requests', 1013); } /* * Validate Client Domain - Check to avoid CSRF attack. * Adding Appwrite API domains to allow XDOMAIN communication. * Skip this check for non-web platforms which are not required to send an origin header. */ $origin = $request->getOrigin(); $originValidator = new Origin(\array_merge($project->getAttribute('platforms', []), $console->getAttribute('platforms', []))); if (!$originValidator->isValid($origin) && $project->getId() !== 'console') { throw new Exception($originValidator->getDescription(), 1008); } $roles = Auth::getRoles($user); $channels = Realtime::convertChannels($request->getQuery('channels', []), $user->getId()); /** * Channels Check */ if (empty($channels)) { throw new Exception('Missing channels', 1008); } $realtime->subscribe($project->getId(), $connection, $roles, $channels); $user = empty($user->getId()) ? null : $response->output($user, Response::MODEL_USER); $server->send([$connection], json_encode([ 'type' => 'connected', 'data' => [ 'channels' => array_keys($channels), 'user' => $user ] ])); $stats->set($project->getId(), [ 'projectId' => $project->getId(), 'teamId' => $project->getAttribute('teamId') ]); $stats->incr($project->getId(), 'connections'); $stats->incr($project->getId(), 'connectionsTotal'); } catch (\Throwable $th) { $response = [ 'type' => 'error', 'data' => [ 'code' => $th->getCode(), 'message' => $th->getMessage() ] ]; $server->send([$connection], json_encode($response)); $server->close($connection, $th->getCode()); if (App::isDevelopment()) { Console::error('[Error] Connection Error'); Console::error('[Error] Code: ' . $response['data']['code']); Console::error('[Error] Message: ' . $response['data']['message']); } if ($th instanceof PDOException) { $db = null; } } finally { /** * Put used PDO and Redis Connections back into their pools. */ $register->get('dbPool')->put($db); $register->get('redisPool')->put($redis); } }); $server->onMessage(function (int $connection, string $message) use ($server, $register, $realtime, $containerId) { try { $response = new Response(new SwooleResponse()); $db = $register->get('dbPool')->get(); $redis = $register->get('redisPool')->get(); $cache = new Cache(new RedisCache($redis)); $database = new Database(new MariaDB($db), $cache); $database->setNamespace('project_' . $realtime->connections[$connection]['projectId'] . '_internal'); /* * Abuse Check * * Abuse limits are sending 32 times per minute and connection. */ $timeLimit = new TimeLimit('url:{url},connection:{connection}', 32, 60, $database); $timeLimit ->setParam('{connection}', $connection) ->setParam('{container}', $containerId); $abuse = new Abuse($timeLimit); if ($abuse->check() && App::getEnv('_APP_OPTIONS_ABUSE', 'enabled') === 'enabled') { throw new Exception('Too many messages', 1013); } $message = json_decode($message, true); if (is_null($message) || (!array_key_exists('type', $message) && !array_key_exists('data', $message))) { throw new Exception('Message format is not valid.', 1003); } switch ($message['type']) { /** * This type is used to authenticate. */ case 'authentication': if (!array_key_exists('session', $message['data'])) { throw new Exception('Payload is not valid.', 1003); } $session = Auth::decodeSession($message['data']['session']); Auth::$unique = $session['id'] ?? ''; Auth::$secret = $session['secret'] ?? ''; $user = $database->getDocument('users', Auth::$unique); if ( empty($user->getId()) // Check a document has been found in the DB || !Auth::sessionVerify($user->getAttribute('sessions', []), Auth::$secret) // Validate user has valid login token ) { // cookie not valid throw new Exception('Session is not valid.', 1003); } $roles = Auth::getRoles($user); $channels = Realtime::convertChannels(array_flip($realtime->connections[$connection]['channels']), $user->getId()); $realtime->subscribe($realtime->connections[$connection]['projectId'], $connection, $roles, $channels); $user = $response->output($user, Response::MODEL_USER); $server->send([$connection], json_encode([ 'type' => 'response', 'data' => [ 'to' => 'authentication', 'success' => true, 'user' => $user ] ])); break; default: throw new Exception('Message type is not valid.', 1003); break; } } catch (\Throwable $th) { $response = [ 'type' => 'error', 'data' => [ 'code' => $th->getCode(), 'message' => $th->getMessage() ] ]; $server->send([$connection], json_encode($response)); if ($th->getCode() === 1008) { $server->close($connection, $th->getCode()); } } finally { $register->get('dbPool')->put($db); $register->get('redisPool')->put($redis); } }); $server->onClose(function (int $connection) use ($realtime, $stats) { if (array_key_exists($connection, $realtime->connections)) { $stats->decr($realtime->connections[$connection]['projectId'], 'connectionsTotal'); } $realtime->unsubscribe($connection); Console::info('Connection close: ' . $connection); }); $server->start();