Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-04-26 16:07:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
appwrite/tests/e2e/Services/Realtime/RealtimeCustomClientQueryTest.php

2454 lines
98 KiB
PHP
Raw Normal View History

re
2025-12-24 13:26:55 +00:00
<?php
namespace Tests\E2E\Services\Realtime;
use CURLFile;
use Tests\E2E\Client;
use Tests\E2E\Scopes\ProjectCustom;
use Tests\E2E\Scopes\Scope;
use Tests\E2E\Scopes\SideClient;
use Tests\E2E\Services\Functions\FunctionsBase;
use Utopia\Database\Helpers\ID;
use Utopia\Database\Helpers\Permission;
use Utopia\Database\Helpers\Role;
use Utopia\Database\Query;
use WebSocket\TimeoutException;
class RealtimeCustomClientQueryTest extends Scope
{
use FunctionsBase;
use RealtimeBase;
use ProjectCustom;
use SideClient;
public function testAccountChannelWithQuery()
{
$user = $this->getUser();
$userId = $user['$id'] ?? '';
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Subscribe with query that matches current user
$client = $this->getWebsocket(['account'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::equal('$id', [$userId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Update account name - should receive event (matches query)
$name = "Test User " . uniqid();
$this->client->call(Client::METHOD_PATCH, '/account/name', array_merge([
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'cookie' => 'a_session_' . $projectId . '=' . $session,
]), [
'name' => $name
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($name, $event['data']['payload']['name']);
$client->close();
$user = $this->getUser();
$userId = $user['$id'] ?? '';
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Subscribe with query that does NOT match current user
$client = $this->getWebsocket(['account'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::notEqual('$id', [$userId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Update account name - should NOT receive event (doesn't match query)
$name = "Test User " . uniqid();
$this->client->call(Client::METHOD_PATCH, '/account/name', array_merge([
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'cookie' => 'a_session_' . $projectId . '=' . $session,
]), [
'name' => $name
]);
// Should timeout - no event should be received
try {
updated to new slot based filtering for realtime
2026-02-02 16:20:23 +00:00
$data = $client->receive();
re
2025-12-24 13:26:55 +00:00
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
}
public function testDatabaseChannelWithQuery()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Query Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$targetDocumentId = ID::unique();
// Subscribe with query for specific document ID
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::equal('$id', [$targetDocumentId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with matching ID - should receive event
$document = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $targetDocumentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($targetDocumentId, $event['data']['payload']['$id']);
// Create document with different ID - should NOT receive event
$otherDocumentId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $otherDocumentId,
'data' => [
'status' => 'inactive'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'NotEqual Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$excludedDocumentId = ID::unique();
// Subscribe with query that excludes specific document ID
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::notEqual('$id', [$excludedDocumentId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with different ID - should receive event
$allowedDocumentId = ID::unique();
$document = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $allowedDocumentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($allowedDocumentId, $event['data']['payload']['$id']);
// Create document with excluded ID - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $excludedDocumentId,
'data' => [
'status' => 'inactive'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'GreaterThan Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'score',
'required' => false,
]);
sleep(2);
// Subscribe with query for score > 50
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::greaterThan('score', 50)->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with score > 50 - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'score' => 75
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(75, $event['data']['payload']['score']);
// Create document with score <= 50 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'score' => 30
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'LesserThan Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'age',
'required' => false,
]);
sleep(2);
// Subscribe with query for age < 18
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::lessThan('age', 18)->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with age < 18 - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'age' => 15
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(15, $event['data']['payload']['age']);
// Create document with age >= 18 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'age' => 25
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'GreaterEqual Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'priority',
'required' => false,
]);
sleep(2);
// Subscribe with query for priority >= 5
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::greaterThanEqual('priority', 5)->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with priority = 5 - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'priority' => 5
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(5, $event['data']['payload']['priority']);
// Create document with priority > 5 - should receive event
$document2 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'priority' => 8
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(8, $event['data']['payload']['priority']);
// Create document with priority < 5 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'priority' => 3
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'LesserEqual Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'level',
'required' => false,
]);
sleep(2);
// Subscribe with query for level <= 10
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::lessThanEqual('level', 10)->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with level = 10 - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'level' => 10
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(10, $event['data']['payload']['level']);
// Create document with level < 10 - should receive event
$document2 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'level' => 7
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals(7, $event['data']['payload']['level']);
// Create document with level > 10 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'level' => 15
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'IsNull Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'description',
'size' => 256,
'required' => false,
]);
sleep(2);
// Subscribe with query for description IS NULL
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::isNull('description')->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document without description - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'description' => null
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
// Create document with description - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'description' => 'Has description'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'IsNotNull Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'email',
'size' => 256,
'required' => false,
]);
sleep(2);
// Subscribe with query for email IS NOT NULL
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::isNotNull('email')->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with email - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'email' => 'test@example.com'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('test@example.com', $event['data']['payload']['email']);
// Create document without email - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'And Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'priority',
'required' => false,
]);
sleep(2);
// Subscribe with AND query: status = 'active' AND priority > 5
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::and([
Query::equal('status', ['active']),
Query::greaterThan('priority', 5)
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document matching both conditions - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'status' => 'active',
'priority' => 8
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('active', $event['data']['payload']['status']);
$this->assertEquals(8, $event['data']['payload']['priority']);
// Create document with status = 'active' but priority <= 5 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'status' => 'active',
'priority' => 3
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
// Create document with priority > 5 but status != 'active' - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'status' => 'inactive',
'priority' => 9
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Or Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'type',
'size' => 256,
'required' => false,
]);
sleep(2);
// Subscribe with OR query: type = 'urgent' OR type = 'critical'
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::or([
Query::equal('type', ['urgent']),
Query::equal('type', ['critical'])
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with type = 'urgent' - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'type' => 'urgent'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('urgent', $event['data']['payload']['type']);
// Create document with type = 'critical' - should receive event
$document2 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'type' => 'critical'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('critical', $event['data']['payload']['type']);
// Create document with type = 'normal' - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'type' => 'normal'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Complex Query Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'category',
'size' => 256,
'required' => false,
]);
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/integer', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'score',
'required' => false,
]);
sleep(2);
// Subscribe with complex query: (category = 'premium' OR category = 'vip') AND score >= 80
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::and([
Query::or([
Query::equal('category', ['premium']),
Query::equal('category', ['vip'])
]),
Query::greaterThanEqual('score', 80)
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create document with category = 'premium' and score >= 80 - should receive event
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'category' => 'premium',
'score' => 85
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('premium', $event['data']['payload']['category']);
$this->assertEquals(85, $event['data']['payload']['score']);
// Create document with category = 'vip' and score >= 80 - should receive event
$document2 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'category' => 'vip',
'score' => 90
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals('vip', $event['data']['payload']['category']);
$this->assertEquals(90, $event['data']['payload']['score']);
// Create document with category = 'premium' but score < 80 - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'category' => 'premium',
'score' => 70
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
// Create document with score >= 80 but category != 'premium' or 'vip' - should NOT receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => ID::unique(),
'data' => [
'category' => 'standard',
'score' => 85
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
}
added dot escaping fix for channel names
2026-02-03 13:03:35 +00:00
public function testCollectionScopedDocumentsChannelReceivesEvents()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Scoped Channel DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Scoped Channel Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
// Subscribe only to the fully-qualified documents channel for this collection
$scopedChannel = 'databases.' . $databaseId . '.collections.' . $collectionId . '.documents';
$client = $this->getWebsocket([$scopedChannel], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains($scopedChannel, $response['data']['channels']);
// Create document in that collection - should receive event on the scoped channel
$documentId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $documentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($documentId, $event['data']['payload']['$id']);
$client->close();
}
public function testCollectionScopedDocumentsChannelWithQuery()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Scoped Channel Query DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Scoped Channel Query Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$targetDocumentId = ID::unique();
// Subscribe with query for specific document ID on the fully-qualified documents channel
$scopedChannel = 'databases.' . $databaseId . '.collections.' . $collectionId . '.documents';
$client = $this->getWebsocket([$scopedChannel], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::equal('$id', [$targetDocumentId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains($scopedChannel, $response['data']['channels']);
// Create document with matching ID - should receive event
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $targetDocumentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($targetDocumentId, $event['data']['payload']['$id']);
// Create document with different ID - should NOT receive event
$otherDocumentId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $otherDocumentId,
'data' => [
'status' => 'inactive'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered for scoped channel query');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
}
re
2025-12-24 13:26:55 +00:00
public function testFilesChannelWithQuery()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Create bucket
$bucket = $this->client->call(Client::METHOD_POST, '/storage/buckets', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'bucketId' => ID::unique(),
'name' => 'Query Test Bucket',
'permissions' => [
Permission::read(Role::any()),
Permission::create(Role::any()),
]
]);
$bucketId = $bucket['body']['$id'];
$targetFileId = ID::unique();
// Subscribe with query for specific file ID
$client = $this->getWebsocket(['files'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::equal('$id', [$targetFileId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
// Create file with matching ID - should receive event
$file = $this->client->call(Client::METHOD_POST, '/storage/buckets/' . $bucketId . '/files', array_merge([
'content-type' => 'multipart/form-data',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'fileId' => $targetFileId,
'file' => new CURLFile(realpath(__DIR__ . '/../../../resources/logo.png'), 'image/png', 'logo.png'),
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($targetFileId, $event['data']['payload']['$id']);
// Create file with different ID - should NOT receive event
$otherFileId = ID::unique();
$this->client->call(Client::METHOD_POST, '/storage/buckets/' . $bucketId . '/files', array_merge([
'content-type' => 'multipart/form-data',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'fileId' => $otherFileId,
'file' => new CURLFile(realpath(__DIR__ . '/../../../resources/logo.png'), 'image/png', 'logo2.png'),
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
$this->fail('Expected TimeoutException - event should be filtered');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$client->close();
}
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
public function testMultipleQueriesWithAndLogic()
re
2025-12-24 13:26:55 +00:00
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Multiple Queries Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Test Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
$targetDocId = ID::unique();
re
2025-12-24 13:26:55 +00:00
added realtime query new channel and channel wise filters
2026-02-02 14:15:21 +00:00
// Subscribe with multiple 'queries' (AND logic - ALL 'queries' must match for event to be received)
re
2025-12-24 13:26:55 +00:00
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
Query::equal('$id', [$targetDocId])->toString(),
Query::equal('status', ['active'])->toString(),
re
2025-12-24 13:26:55 +00:00
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
added realtime query new channel and channel wise filters
2026-02-02 14:15:21 +00:00
// Create document matching BOTH 'queries' - should receive event
re
2025-12-24 13:26:55 +00:00
$document1 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
'documentId' => $targetDocId,
re
2025-12-24 13:26:55 +00:00
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
$this->assertEquals($targetDocId, $event['data']['payload']['$id']);
$this->assertEquals('active', $event['data']['payload']['status']);
re
2025-12-24 13:26:55 +00:00
updated tests
2026-01-29 08:50:05 +00:00
// Create document matching NEITHER query - should not receive event
// keeping it here as below are the documents created with status=>active
// so it will also receive it but the querykey can be used to distinction
$anotherDocId = ID::unique();
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
re
2025-12-24 13:26:55 +00:00
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
updated tests
2026-01-29 08:50:05 +00:00
'documentId' => $anotherDocId,
re
2025-12-24 13:26:55 +00:00
'data' => [
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
'status' => 'inactive'
re
2025-12-24 13:26:55 +00:00
],
'permissions' => [
Permission::read(Role::any()),
],
]);
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
try {
$client->receive();
updated tests
2026-01-29 08:50:05 +00:00
$this->fail('Expected TimeoutException - event should be filtered (neither query matches)');
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
re
2025-12-24 13:26:55 +00:00
updated tests
2026-01-29 08:50:05 +00:00
// Create document with matching ID but wrong status - should NOT receive event (only one query matches)
re
2025-12-24 13:26:55 +00:00
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
updated tests
2026-01-29 08:50:05 +00:00
'documentId' => $targetDocId,
re
2025-12-24 13:26:55 +00:00
'data' => [
updated tests
2026-01-29 08:50:05 +00:00
'status' => 'inactive'
re
2025-12-24 13:26:55 +00:00
],
'permissions' => [
Permission::read(Role::any()),
],
]);
try {
$client->receive();
updated tests
2026-01-29 08:50:05 +00:00
$this->fail('Expected TimeoutException - event should be filtered (ID matches but status does not)');
updated query logic in array to be of and format
2026-01-16 13:36:55 +00:00
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
re
2025-12-24 13:26:55 +00:00
$client->close();
}
updated query conversion for nested query
2026-01-16 12:48:24 +00:00
public function testInvalidQueryShouldNotSubscribe()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Test 1: Simple invalid query method (contains is not allowed)
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::contains('status', ['active'])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('not supported in Realtime queries', $response['data']['message']);
$this->assertStringContainsString('contains', $response['data']['message']);
// Test 2: Invalid query method in nested AND query
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::and([
Query::equal('status', ['active']),
Query::search('name', 'test') // search is not allowed
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('not supported in Realtime queries', $response['data']['message']);
$this->assertStringContainsString('search', $response['data']['message']);
// Test 3: Invalid query method in nested OR query
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::or([
Query::equal('status', ['active']),
Query::between('score', 0, 100) // between is not allowed
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('not supported in Realtime queries', $response['data']['message']);
$this->assertStringContainsString('between', $response['data']['message']);
// Test 4: Deeply nested invalid query (AND -> OR -> invalid)
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::and([
Query::equal('status', ['active']),
Query::or([
Query::greaterThan('score', 50),
Query::startsWith('name', 'test') // startsWith is not allowed
])
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('not supported in Realtime queries', $response['data']['message']);
$this->assertStringContainsString('startsWith', $response['data']['message']);
added realtime query new channel and channel wise filters
2026-02-02 14:15:21 +00:00
// Test 5: Multiple invalid 'queries' in nested structure
updated query conversion for nested query
2026-01-16 12:48:24 +00:00
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::and([
Query::contains('tags', ['important']), // contains is not allowed
Query::or([
Query::endsWith('email', '@example.com'), // endsWith is not allowed
Query::equal('status', ['active'])
])
])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('not supported in Realtime queries', $response['data']['message']);
// Should catch the first invalid method encountered
$this->assertTrue(
str_contains($response['data']['message'], 'contains') ||
str_contains($response['data']['message'], 'endsWith')
);
}
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
public function testQueryKeys()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Query Keys Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Query Keys Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
added realtime query new channel and channel wise filters
2026-02-02 14:15:21 +00:00
// Attributes used by 'queries'
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'category',
'size' => 256,
'required' => false,
]);
sleep(2);
$queryStatusActive = Query::equal('status', ['active'])->toString();
$queryStatusPending = Query::equal('status', ['pending'])->toString();
$queryComplex = Query::and([
Query::equal('status', ['active']),
Query::equal('category', ['gold']),
])->toString();
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// Subscribe with no 'queries' -> should receive all events (has select("*") subscription)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$clientAll = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
]);
// Subscribe with query1 (status == active)
$clientQ1 = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
$queryStatusActive,
]);
// Subscribe with query2 (status == pending)
$clientQ2 = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
$queryStatusPending,
]);
// Subscribe with complex query (status == active AND category == gold)
$clientComplex = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
$queryComplex,
]);
// All clients should be connected
foreach ([$clientAll, $clientQ1, $clientQ2, $clientComplex] as $client) {
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
}
// 1) Create active/gold document -> should match Q1 and complex, and be seen by all
$docActiveGoldId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $docActiveGoldId,
'data' => [
'status' => 'active',
'category' => 'gold',
],
'permissions' => [
Permission::read(Role::any()),
],
]);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// clientAll: should receive event, subscriptions should not be empty (has select("*") subscription that matches)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$eventAll = json_decode($clientAll->receive(), true);
$this->assertEquals('event', $eventAll['type']);
$this->assertEquals($docActiveGoldId, $eventAll['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventAll['data']);
$this->assertIsArray($eventAll['data']['subscriptions']);
// clientAll has select("*") subscription that matches all events, so subscriptions should not be empty
$this->assertNotEmpty($eventAll['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// clientQ1: should receive event, subscriptions should not be empty (query matched)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$eventQ1 = json_decode($clientQ1->receive(), true);
$this->assertEquals('event', $eventQ1['type']);
$this->assertEquals($docActiveGoldId, $eventQ1['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventQ1['data']);
$this->assertIsArray($eventQ1['data']['subscriptions']);
// clientQ1 has a query that matches, so subscriptions should not be empty
$this->assertNotEmpty($eventQ1['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
// clientQ2: should NOT receive event (status is active, not pending)
try {
$clientQ2->receive();
$this->fail('Expected TimeoutException - event should be filtered for clientQ2 (active document)');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// clientComplex: should receive event, subscriptions should not be empty (query matched)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$eventComplex = json_decode($clientComplex->receive(), true);
$this->assertEquals('event', $eventComplex['type']);
$this->assertEquals($docActiveGoldId, $eventComplex['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventComplex['data']);
$this->assertIsArray($eventComplex['data']['subscriptions']);
// clientComplex has a query that matches, so subscriptions should not be empty
$this->assertNotEmpty($eventComplex['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
// 2) Create pending/silver document -> should match Q2 only, and be seen by all
$docPendingSilverId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $docPendingSilverId,
'data' => [
'status' => 'pending',
'category' => 'silver',
],
'permissions' => [
Permission::read(Role::any()),
],
]);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// clientAll: should receive event, subscriptions should not be empty (has select("*") subscription that matches)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$eventAll2 = json_decode($clientAll->receive(), true);
$this->assertEquals('event', $eventAll2['type']);
$this->assertEquals($docPendingSilverId, $eventAll2['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventAll2['data']);
$this->assertIsArray($eventAll2['data']['subscriptions']);
// clientAll has select("*") subscription that matches all events, so subscriptions should not be empty
$this->assertNotEmpty($eventAll2['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
// clientQ1: should NOT receive event (status is pending)
try {
$clientQ1->receive();
$this->fail('Expected TimeoutException - event should be filtered for clientQ1 (pending document)');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
// clientQ2: should receive event, subscriptions should not be empty (query matched)
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$eventQ2 = json_decode($clientQ2->receive(), true);
$this->assertEquals('event', $eventQ2['type']);
$this->assertEquals($docPendingSilverId, $eventQ2['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventQ2['data']);
$this->assertIsArray($eventQ2['data']['subscriptions']);
// clientQ2 has a query that matches, so subscriptions should not be empty
$this->assertNotEmpty($eventQ2['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
// clientComplex: should NOT receive event (status is pending, category silver)
try {
$clientComplex->receive();
$this->fail('Expected TimeoutException - event should be filtered for complex subscription (pending document)');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$clientAll->close();
$clientQ1->close();
$clientQ2->close();
$clientComplex->close();
}
/**
* Ensure two separate subscriptions with different query keys
* only see their own matching events and expose the correct
* queryKey in queryKeys.
*/
public function testMultipleSubscriptionsDifferentQueryKeys()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Multiple Query Keys Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Multiple Query Keys Collection',
'permissions' => [
Permission::create(Role::user($user['$id'])),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
added realtime query new channel and channel wise filters
2026-02-02 14:15:21 +00:00
// Attribute used by 'queries'
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$queryStatusActive = Query::equal('status', ['active'])->toString();
$queryStatusPending = Query::equal('status', ['pending'])->toString();
// Two subscriptions on the same channel with different query keys
$clientQ1 = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
$queryStatusActive,
]);
$clientQ2 = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
$queryStatusPending,
]);
// Both should connect
$response = json_decode($clientQ1->receive(), true);
$this->assertEquals('connected', $response['type']);
$response = json_decode($clientQ2->receive(), true);
$this->assertEquals('connected', $response['type']);
// 1) active document -> only queryStatusActive subscription should see it
$docActiveId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $docActiveId,
'data' => [
'status' => 'active',
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$eventQ1 = json_decode($clientQ1->receive(), true);
$this->assertEquals('event', $eventQ1['type']);
$this->assertEquals($docActiveId, $eventQ1['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventQ1['data']);
$this->assertIsArray($eventQ1['data']['subscriptions']);
// clientQ1 has a query that matches, so subscriptions should not be empty
$this->assertNotEmpty($eventQ1['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
try {
$clientQ2->receive();
$this->fail('Expected TimeoutException - clientQ2 should not receive active document');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
// 2) pending document -> only queryStatusPending subscription should see it
$docPendingId = ID::unique();
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $docPendingId,
'data' => [
'status' => 'pending',
],
'permissions' => [
Permission::read(Role::any()),
],
]);
$eventQ2 = json_decode($clientQ2->receive(), true);
$this->assertEquals('event', $eventQ2['type']);
$this->assertEquals($docPendingId, $eventQ2['data']['payload']['$id']);
updated tests and empty subscriptionsid issue
2026-02-03 05:16:01 +00:00
$this->assertArrayHasKey('subscriptions', $eventQ2['data']);
$this->assertIsArray($eventQ2['data']['subscriptions']);
// clientQ2 has a query that matches, so subscriptions should not be empty
$this->assertNotEmpty($eventQ2['data']['subscriptions']);
added query per subscription and queryKeys along with the messages
2026-01-28 13:10:30 +00:00
try {
$clientQ1->receive();
$this->fail('Expected TimeoutException - clientQ1 should not receive pending document');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$clientQ1->close();
$clientQ2->close();
}
updated subscription after permission change
2026-02-03 08:16:05 +00:00
public function testSubscriptionPreservedAfterPermissionChange()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
$userId = $user['$id'] ?? '';
// Setup database and collection
$database = $this->client->call(Client::METHOD_POST, '/databases', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'databaseId' => ID::unique(),
'name' => 'Permission Change Test DB',
]);
$databaseId = $database['body']['$id'];
$collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => ID::unique(),
'name' => 'Permission Change Collection',
'permissions' => [
Permission::create(Role::user($userId)),
Permission::read(Role::user($userId)),
],
'documentSecurity' => true,
]);
$collectionId = $collection['body']['$id'];
$this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'status',
'size' => 256,
'required' => false,
]);
sleep(2);
$targetDocumentId = ID::unique();
// Subscribe with query for specific document ID
$client = $this->getWebsocket(['documents'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], null, [
Query::equal('$id', [$targetDocumentId])->toString(),
]);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertArrayHasKey('subscriptions', $response['data']);
$this->assertIsArray($response['data']['subscriptions']);
// Store the original subscription mapping (index => subscriptionId)
$originalSubscriptionMapping = $response['data']['subscriptions'];
$this->assertNotEmpty($originalSubscriptionMapping);
// Get the first subscription ID and its index
$originalIndex = array_key_first($originalSubscriptionMapping);
$originalSubscriptionId = $originalSubscriptionMapping[$originalIndex];
// Create document with matching ID - should receive event
$document = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $targetDocumentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::user($userId)),
Permission::update(Role::user($userId)),
],
]);
$event = json_decode($client->receive(), true);
$this->assertEquals('event', $event['type']);
$this->assertEquals($targetDocumentId, $event['data']['payload']['$id']);
$this->assertArrayHasKey('subscriptions', $event['data']);
$this->assertContains($originalSubscriptionId, $event['data']['subscriptions']);
// Trigger permission change by creating a team owned by a DIFFERENT user,
$teamOwnerEmail = uniqid() . 'owner@localhost.test';
$teamOwnerPassword = 'password';
$teamOwner = $this->client->call(Client::METHOD_POST, '/account', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], [
'userId' => ID::unique(),
'email' => $teamOwnerEmail,
'password' => $teamOwnerPassword,
'name' => 'Team Owner',
]);
$this->assertEquals(201, $teamOwner['headers']['status-code']);
$teamOwnerSession = $this->client->call(Client::METHOD_POST, '/account/sessions/email', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], [
'email' => $teamOwnerEmail,
'password' => $teamOwnerPassword,
]);
$teamOwnerSession = $teamOwnerSession['cookies']['a_session_' . $projectId] ?? '';
$team = $this->client->call(Client::METHOD_POST, '/teams', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'cookie' => 'a_session_' . $projectId . '=' . $teamOwnerSession,
], [
'teamId' => ID::unique(),
'name' => 'Test Team',
]);
$teamId = $team['body']['$id'];
$this->client->call(Client::METHOD_POST, '/teams/' . $teamId . '/memberships', [
'origin' => 'http://localhost',
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey'],
], [
'email' => $user['email'],
'roles' => ['member'],
'url' => 'http://localhost',
]);
sleep(3);
// Verify subscription is still working after permission change
$nonMatchingDocumentId = ID::unique();
$document2 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $nonMatchingDocumentId,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::user($userId)),
Permission::update(Role::user($userId)),
],
]);
// This document doesn't match the query, so we shouldn't receive it
try {
$data = $client->receive();
$this->fail('Expected TimeoutException - document does not match query after permission change');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
// Create a NEW document with a different ID - should NOT receive event
$targetDocumentId2 = ID::unique();
$document3 = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'documentId' => $targetDocumentId2,
'data' => [
'status' => 'active'
],
'permissions' => [
Permission::read(Role::user($userId)),
Permission::update(Role::user($userId)),
],
]);
sleep(2);
// This should NOT receive event because the query is for $targetDocumentId, not $targetDocumentId2
// This verifies the query is preserved after permission change
try {
$data = $client->receive();
$this->fail('Expected TimeoutException - new document does not match original query after permission change');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
// Create a document with the ORIGINAL matching ID - should receive event
$document4 = $this->client->call(Client::METHOD_PATCH, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents/' . $targetDocumentId, array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), [
'data' => [
'status' => 'updated-after-permission-change'
],
]);
// Wait a bit for the event to be processed
sleep(3);
// Verify the event is received with the preserved subscription
$event2 = json_decode($client->receive(), true);
$this->assertEquals('event', $event2['type']);
$this->assertEquals($targetDocumentId, $event2['data']['payload']['$id']);
$this->assertEquals('updated-after-permission-change', $event2['data']['payload']['status']);
$this->assertArrayHasKey('subscriptions', $event2['data']);
$this->assertIsArray($event2['data']['subscriptions']);
$this->assertNotEmpty($event2['data']['subscriptions']);
// Subscription ID should remain stable after permission change
$this->assertContains($originalSubscriptionId, $event2['data']['subscriptions']);
$client->close();
}
Enhance Realtime channel handling for project queries and improve test coverage
2026-02-09 06:18:04 +00:00
public function testProjectChannelWithQuery()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Test OLD SDK behavior: project=projectId (string) in query param
Enhance reserved parameter handling in Realtime adapter and update related tests
2026-02-09 07:37:11 +00:00
// For reserved \"project\" param, string is treated as routing-only (project ID),
// and is not used as queries for the project channel. We should fall back to select(*).
Enhance Realtime channel handling for project queries and improve test coverage
2026-02-09 06:18:04 +00:00
$clientOldSdk = $this->getWebsocket(['project'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
], $projectId, null);
$response = json_decode($clientOldSdk->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains('project', $response['data']['channels']);
// Should have default select(['*']) subscription since project param was treated as project ID, not queries
$this->assertArrayHasKey('subscriptions', $response['data']);
$this->assertIsArray($response['data']['subscriptions']);
$this->assertNotEmpty($response['data']['subscriptions']);
$clientOldSdk->close();
// Test NEW SDK behavior: project=Query array in query param, project ID in header
// The reserved param logic should use Query array as subscription queries for project channel
$queryArray = [Query::select(['*'])->toString()];
$clientNewSdk = $this->getWebsocketWithCustomQuery(
[
'channels' => ['project'],
'project' => [
0 => [
0 => $queryArray[0]
]
]
],
[
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
'x-appwrite-project' => $projectId,
]
);
$response = json_decode($clientNewSdk->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains('project', $response['data']['channels']);
// Should have subscription with the provided query
$this->assertArrayHasKey('subscriptions', $response['data']);
$this->assertIsArray($response['data']['subscriptions']);
$this->assertNotEmpty($response['data']['subscriptions']);
$clientNewSdk->close();
Enhance reserved parameter handling in Realtime adapter and update related tests
2026-02-09 07:37:11 +00:00
// Test edge case: project param is array but not a valid Query array
// This should now fail with an invalid query error rather than silently falling back.
Enhance Realtime channel handling for project queries and improve test coverage
2026-02-09 06:18:04 +00:00
$clientEdgeCase = $this->getWebsocketWithCustomQuery(
[
'channels' => ['project'],
'project' => ['invalid', 'array']
],
[
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
'x-appwrite-project' => $projectId,
]
);
$response = json_decode($clientEdgeCase->receive(), true);
Enhance reserved parameter handling in Realtime adapter and update related tests
2026-02-09 07:37:11 +00:00
$this->assertEquals('error', $response['type']);
$this->assertStringContainsString('Invalid query', $response['data']['message']);
Enhance Realtime channel handling for project queries and improve test coverage
2026-02-09 06:18:04 +00:00
}
public function testProjectChannelWithHeaderOnly()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = $this->getProject()['$id'];
// Test: project ID only in header, no project query param
// This simulates a client that only uses x-appwrite-project header
$client = $this->getWebsocketWithCustomQuery(
[
'channels' => ['project']
],
[
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
'x-appwrite-project' => $projectId,
]
);
$response = json_decode($client->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains('project', $response['data']['channels']);
// Should have default select(['*']) subscription since no project query param
$this->assertArrayHasKey('subscriptions', $response['data']);
$this->assertIsArray($response['data']['subscriptions']);
$this->assertNotEmpty($response['data']['subscriptions']);
$client->close();
// Test: project channel with queries, project ID only in header
$queryArray = [Query::select(['*'])->toString()];
$clientWithQuery = $this->getWebsocketWithCustomQuery(
[
'channels' => ['project'],
'project' => [
0 => [
0 => $queryArray[0]
]
]
],
[
'origin' => 'http://localhost',
'cookie' => 'a_session_' . $projectId . '=' . $session,
'x-appwrite-project' => $projectId,
]
);
$response = json_decode($clientWithQuery->receive(), true);
$this->assertEquals('connected', $response['type']);
$this->assertContains('project', $response['data']['channels']);
$this->assertArrayHasKey('subscriptions', $response['data']);
$this->assertIsArray($response['data']['subscriptions']);
$this->assertNotEmpty($response['data']['subscriptions']);
$clientWithQuery->close();
}
updated tests
2026-02-09 06:25:39 +00:00
public function testTestsChannelWithQueries()
{
$projectId = 'console';
// Subscribe without queries - should receive all events
$clientNoQuery = $this->getWebsocket(['tests'], [
'origin' => 'http://localhost',
], $projectId);
$response = json_decode($clientNoQuery->receive(), true);
$this->assertEquals('connected', $response['type']);
// Subscribe with matching query - should receive events
$clientWithMatchingQuery = $this->getWebsocket(['tests'], [
'origin' => 'http://localhost',
], $projectId, [
Query::equal('response', ['WS:/v1/realtime:passed'])->toString(),
]);
$response = json_decode($clientWithMatchingQuery->receive(), true);
$this->assertEquals('connected', $response['type']);
// Subscribe with non-matching query - should NOT receive events
$clientWithNonMatchingQuery = $this->getWebsocket(['tests'], [
'origin' => 'http://localhost',
], $projectId, [
Query::equal('response', ['failed'])->toString(),
]);
$response = json_decode($clientWithNonMatchingQuery->receive(), true);
$this->assertEquals('connected', $response['type']);
sleep(6);
// Client without query should receive event
$eventNoQuery = json_decode($clientNoQuery->receive(), true);
$this->assertEquals('event', $eventNoQuery['type']);
$this->assertEquals('test.event', $eventNoQuery['data']['events'][0]);
$this->assertEquals('WS:/v1/realtime:passed', $eventNoQuery['data']['payload']['response']);
// Client with matching query should receive event
$eventMatching = json_decode($clientWithMatchingQuery->receive(), true);
$this->assertEquals('event', $eventMatching['type']);
$this->assertEquals('test.event', $eventMatching['data']['events'][0]);
$this->assertEquals('WS:/v1/realtime:passed', $eventMatching['data']['payload']['response']);
// Client with non-matching query should NOT receive event
try {
$clientWithNonMatchingQuery->receive();
$this->fail('Expected TimeoutException - client with non-matching query should not receive event');
} catch (TimeoutException $e) {
$this->assertTrue(true);
}
$clientNoQuery->close();
$clientWithMatchingQuery->close();
$clientWithNonMatchingQuery->close();
}
re
2025-12-24 13:26:55 +00:00
}
Reference in a new issue Copy permalink