Merge pull request #12664 from appwrite/realtime-connection-headers

Realtime connection headers
This commit is contained in:
ArnabChatterjee20k authored and GitHub committed 2026-06-24 11:43:25 +05:30
commit 4328e75209
3 files changed
+169 -1

No files matched your search

+1 -1
View File
@@ -271,7 +271,7 @@ return function (Container $container): void {
$user = new User([]);
}
$authJWT = $request->getHeaderLine('x-appwrite-jwt', '');
$authJWT = $request->getHeaderLine('x-appwrite-jwt', (string)($request->getParam('jwt', '')));
if (!empty($authJWT) && !$project->isEmpty()) {
if (!$user->isEmpty()) {
throw new Exception(Exception::USER_JWT_AND_COOKIE_SET);
@@ -13,6 +13,7 @@ use Utopia\Database\Helpers\Permission;
use Utopia\Database\Helpers\Role;
use Utopia\Database\Query;
use WebSocket\Client as WebSocketClient;
use WebSocket\ConnectionException;
use WebSocket\TimeoutException;
final class RealtimeCustomClientQueryTestWithMessage extends Scope
@@ -657,6 +658,90 @@ final class RealtimeCustomClientQueryTestWithMessage extends Scope
);
}
public function testConnectionJWT(): void
{
$user = $this->getUser();
$userId = $user['$id'] ?? '';
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Mint a JWT for the authenticated user.
$response = $this->client->call(Client::METHOD_POST, '/account/jwt', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'cookie' => 'a_session_' . $projectId . '=' . $session,
]);
$this->assertEquals(201, $response['headers']['status-code']);
$this->assertNotEmpty($response['body']['jwt']);
$jwt = $response['body']['jwt'];
/**
* Test for SUCCESS - JWT via x-appwrite-jwt header.
* Connection authenticates at handshake time; the `connected` payload carries the user.
*/
$client = $this->getWebsocketWithCustomQuery([
'project' => $projectId,
], [
'origin' => 'http://localhost',
'x-appwrite-jwt' => $jwt,
]);
$connected = \json_decode($client->receive(), true);
$this->assertEquals('connected', $connected['type'] ?? null);
$this->assertNotEmpty($connected['data']['user']);
$this->assertEquals($userId, $connected['data']['user']['$id']);
// The authenticated user can subscribe to their account channel.
$subscribe = $this->sendSubscribeMessage($client, [[
'channels' => ['account'],
]]);
$this->assertContains('account', $subscribe['data']['subscriptions'][0]['channels']);
$client->close();
/**
* Test for SUCCESS - JWT via ?jwt= query string.
*/
$client = $this->getWebsocketWithCustomQuery([
'project' => $projectId,
'jwt' => $jwt,
], [
'origin' => 'http://localhost',
]);
$connected = \json_decode($client->receive(), true);
$this->assertEquals('connected', $connected['type'] ?? null);
$this->assertNotEmpty($connected['data']['user']);
$this->assertEquals($userId, $connected['data']['user']['$id']);
$subscribe = $this->sendSubscribeMessage($client, [[
'channels' => ['account'],
]]);
$this->assertContains('account', $subscribe['data']['subscriptions'][0]['channels']);
$client->close();
/**
* Test for FAILURE - invalid JWT via query string is rejected at handshake.
*/
$client = $this->getWebsocketWithCustomQuery([
'project' => $projectId,
'jwt' => 'invalid-token',
], [
'origin' => 'http://localhost',
]);
$error = \json_decode($client->receive(), true);
$this->assertEquals('error', $error['type'] ?? null);
$this->assertEquals(401, $error['data']['code']); // USER_JWT_INVALID
\usleep(250000); // 250ms
$this->expectException(ConnectionException::class); // server should disconnect
$client->close();
}
public function testProjectChannelWithHeaderOnly(): void
{
$user = $this->getUser();
@@ -276,6 +276,89 @@ final class RealtimeCustomClientTest extends Scope
$client->close();
}
public function testConnectionJWT()
{
$user = $this->getUser();
$userId = $user['$id'] ?? '';
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Mint a JWT for the authenticated user.
$response = $this->client->call(Client::METHOD_POST, '/account/jwt', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'cookie' => 'a_session_' . $projectId . '=' . $session,
]);
$this->assertEquals(201, $response['headers']['status-code']);
$this->assertNotEmpty($response['body']['jwt']);
$jwt = $response['body']['jwt'];
/**
* Test for SUCCESS - JWT via x-appwrite-jwt header
*/
$client = $this->getWebsocket(['account'], [
'origin' => 'http://localhost',
'x-appwrite-jwt' => $jwt,
]);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertNotEmpty($response['data']['user']);
$this->assertEquals($userId, $response['data']['user']['$id']);
$this->assertContains('account', $response['data']['channels']);
$this->assertContains('account.' . $userId, $response['data']['channels']);
$client->close();
/**
* Test for SUCCESS - JWT via ?jwt= query string
*/
$client = $this->getWebsocketWithCustomQuery([
'project' => $projectId,
'channels' => ['account'],
'jwt' => $jwt,
], [
'origin' => 'http://localhost',
]);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertNotEmpty($response['data']['user']);
$this->assertEquals($userId, $response['data']['user']['$id']);
$this->assertContains('account', $response['data']['channels']);
$this->assertContains('account.' . $userId, $response['data']['channels']);
$client->close();
/**
* Test for FAILURE - invalid JWT via query string
*/
$client = $this->getWebsocketWithCustomQuery([
'project' => $projectId,
'channels' => ['account'],
'jwt' => 'invalid-token',
], [
'origin' => 'http://localhost',
]);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertEquals('error', $response['type']);
$this->assertEquals(401, $response['data']['code']); // USER_JWT_INVALID
\usleep(250000); // 250ms
$this->expectException(ConnectionException::class); // server should disconnect
$client->close();
}
public function testConnectionPlatform()
{
/**