From 5999c3971c80dcb09bac8432c47c95a585c5cbd8 Mon Sep 17 00:00:00 2001 From: ArnabChatterjee20k Date: Sat, 6 Jun 2026 18:20:27 +0530 Subject: [PATCH] feat: integrate EventTailRegistry for enhanced realtime event handling --- app/realtime.php | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/app/realtime.php b/app/realtime.php index c99e4c0857..3203a66430 100644 --- a/app/realtime.php +++ b/app/realtime.php @@ -9,6 +9,7 @@ use Appwrite\Messaging\Adapter\Realtime; use Appwrite\Network\Validator\Origin; use Appwrite\Presences\State as PresenceState; use Appwrite\PubSub\Adapter\Pool as PubSubPool; +use Appwrite\Realtime\EventTailRegistry; use Appwrite\Realtime\Message\Dispatcher as MessageDispatcher; use Appwrite\Realtime\Message\Handlers\Authentication as AuthenticationHandler; use Appwrite\Realtime\Message\Handlers\Ping as PingHandler; @@ -336,6 +337,9 @@ if (!function_exists('checkForProjectUsage')) { $realtime = getRealtime(); $presenceState = new PresenceState(); +$eventTailRegistry = new EventTailRegistry( + rate: (int) System::getEnv('_APP_REALTIME_TAIL_RATE', 50) +); $messageDispatcher = (new MessageDispatcher()) ->addHandler(new PingHandler()) @@ -496,7 +500,7 @@ $server->onStart(function () use ($stats, $containerId, &$statsDocument) { } }); -$server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, $realtime) { +$server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, $realtime, $eventTailRegistry) { Console::success('Worker ' . $workerId . ' started successfully'); $telemetry = getTelemetry($workerId); @@ -525,6 +529,13 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, $attempts = 0; $start = time(); + // Flush coalesced console live-tail buffers to their connections (~150ms). + // Must run per-worker: the registry is mutated by this worker's subscribe handler + // and pub/sub ingest, which are not visible to the master process. + Timer::tick(150, function () use ($server, $eventTailRegistry) { + $eventTailRegistry->flush($server); + }); + Timer::tick(5000, function () use ($server, $realtime, $stats) { /** * Sending current connections to project channels on the console project every 5 seconds. @@ -634,7 +645,7 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, Console::error('Pub/sub failed (worker: ' . $workerId . ')'); } - $pubsub->subscribe(['realtime'], function (mixed $redis, string $channel, string $payload) use ($server, $workerId, $stats, $register, $realtime) { + $pubsub->subscribe(['realtime'], function (mixed $redis, string $channel, string $payload) use ($server, $workerId, $stats, $register, $realtime, $eventTailRegistry) { $event = json_decode($payload, true); $eventTimestamp = $event['data']['timestamp'] ?? null; @@ -790,6 +801,16 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, triggerStats($metrics, $projectId); } + + } + + // Console live event tail: runs for EVERY firehose event, regardless of + // whether it had regular subscribers ($total). The firehose is published + // unconditionally, so a project tailed from the console with no other + // realtime clients must still be observed here. + $src = $event['project'] ?? ''; + if ($src !== '' && $src !== 'console' && $eventTailRegistry->isTailed($src)) { + $eventTailRegistry->ingest($src, Realtime::toTailMetadata($event), \microtime(true)); } }); } catch (Throwable $th) { @@ -1071,7 +1092,7 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, } }); -$server->onMessage(function (int $connection, string $message) use ($container, $server, $realtime, $containerId, $register, $presenceState, $messageDispatcher) { +$server->onMessage(function (int $connection, string $message) use ($container, $server, $realtime, $containerId, $register, $presenceState, $messageDispatcher, $eventTailRegistry) { $project = null; $authorization = null; $projectId = $realtime->connections[$connection]['projectId'] ?? null; @@ -1191,6 +1212,8 @@ $server->onMessage(function (int $connection, string $message) use ($container, $messageContainer->set('projectId', fn () => $projectId); $messageContainer->set('queueForEvents', fn () => getQueueForEvents()); $messageContainer->set('queueForRealtime', fn () => getQueueForRealtime()); + $messageContainer->set('eventTailRegistry', fn () => $eventTailRegistry); + $messageContainer->set('dbForConsole', fn () => getConsoleDB()); $responsePayload = $messageDispatcher->dispatch($messageContainer, $message); @@ -1263,7 +1286,7 @@ $server->onMessage(function (int $connection, string $message) use ($container, } }); -$server->onClose(function (int $connection) use ($realtime, $stats, $register, $container, $presenceState) { +$server->onClose(function (int $connection) use ($realtime, $stats, $register, $container, $presenceState, $eventTailRegistry) { $projectId = null; $userId = null; $subscriptionsBeforeClose = 0; @@ -1401,6 +1424,13 @@ $server->onClose(function (int $connection) use ($realtime, $stats, $register, $ Span::error($th); } + try { + $eventTailRegistry->removeConnection($connection); + } catch (\Throwable $th) { + Console::error('Realtime onClose tail cleanup error: ' . $th->getMessage()); + Span::error($th); + } + Span::add('realtime.success', $success); if (!empty($projectId)) { Span::add('project.id', $projectId);