diff --git a/tests/e2e/Services/Realtime/RealtimeBase.php b/tests/e2e/Services/Realtime/RealtimeBase.php index 7bd6de4e1..3449e8941 100644 --- a/tests/e2e/Services/Realtime/RealtimeBase.php +++ b/tests/e2e/Services/Realtime/RealtimeBase.php @@ -2,7 +2,382 @@ namespace Tests\E2E\Services\Realtime; +use Tests\E2E\Client; +use WebSocket\Client as WebSocketClient; +use WebSocket\ConnectionException; + trait RealtimeBase { + private function getWebsocket($channels = [], $headers = []) + { + $headers = array_merge([ + 'Origin' => 'appwrite.test' + ], $headers); + + $query = [ + 'project' => $this->getProject()['$id'], + 'channels' => $channels + ]; + return new WebSocketClient('ws://appwrite-traefik/v1/realtime?' . http_build_query($query), [ + 'headers' => $headers, + 'timeout' => 5, + ]); + } + + public function testConnection() + { + /** + * Test for SUCCESS + */ + $client = $this->getWebsocket(['documents']); + $this->assertEquals(json_encode([ + 'documents' => 0 + ]), $client->receive()); + $client->close(); + + /** + * Test for FAILURE + */ + $client = $this->getWebsocket(['documents'], ['origin' => 'http://appwrite.unknown']); + $this->assertEquals('Invalid Origin. Register your new client (appwrite.unknown) as a new Web platform on your project console dashboard', $client->receive()); + $this->expectException(ConnectionException::class); // Check if server disconnnected client + $client->close(); + + $client = $this->getWebsocket(); + $this->assertEquals('Missing channels', $client->receive()); + $this->expectException(ConnectionException::class); // Check if server disconnnected client + $client->close(); + + $client = new WebSocketClient('ws://appwrite-traefik/v1/realtime', [ + 'headers' => [ + 'Origin' => 'appwrite.test' + ] + ]); + $this->assertEquals('Missing or unknown project ID', $client->receive()); + $this->expectException(ConnectionException::class); // Check if server disconnnected client + $client->close(); + + $client = new WebSocketClient('ws://appwrite-traefik/v1/realtime?project=123', [ + 'headers' => [ + 'Origin' => 'appwrite.test' + ] + ]); + $this->assertEquals('Missing or unknown project ID', $client->receive()); + $this->expectException(ConnectionException::class); // Check if server disconnnected client + $client->close(); + } + + public function testChannelParsing() + { + $user = $this->getUser(); + $userId = $user['$id'] ?? ''; + $session = $user['session'] ?? ''; + $headers = [ + 'origin' => 'http://localhost', + 'cookie' => 'a_session_'.$this->getProject()['$id'].'=' . $session + ]; + + /** + * Test for SUCCESS + */ + $client = $this->getWebsocket(['documents']); + $response = json_decode($client->receive(), true); + $this->assertCount(1, $response); + $this->assertArrayHasKey('documents', $response); + $client->close(); + + $client = $this->getWebsocket(['account'], $headers); + $response = json_decode($client->receive(), true); + $this->assertCount(1, $response); + $this->assertArrayHasKey('account.' . $userId, $response); + $client->close(); + + $client = $this->getWebsocket(['account', 'documents', 'account.123'], $headers); + $response = json_decode($client->receive(), true); + $this->assertCount(2, $response); + $this->assertArrayHasKey('documents', $response); + $this->assertArrayHasKey('account.' . $userId, $response); + $client->close(); + + $client = $this->getWebsocket([ + 'account', + 'files', + 'files.1', + 'collections', + 'collections.1', + 'collections.1.documents', + 'collections.2', + 'collections.2.documents', + 'documents', + 'documents.1', + 'documents.2', + ], $headers); + $response = json_decode($client->receive(), true); + + $this->assertCount(11, $response); + $this->assertArrayHasKey('account.' . $userId, $response); + $this->assertArrayHasKey('files', $response); + $this->assertArrayHasKey('files.1', $response); + $this->assertArrayHasKey('collections', $response); + $this->assertArrayHasKey('collections.1', $response); + $this->assertArrayHasKey('collections.1.documents', $response); + $this->assertArrayHasKey('collections.2', $response); + $this->assertArrayHasKey('collections.2.documents', $response); + $this->assertArrayHasKey('documents', $response); + $this->assertArrayHasKey('documents.1', $response); + $this->assertArrayHasKey('documents.2', $response); + $client->close(); + } + + public function testChannelAccount() + { + $user = $this->getUser(); + $userId = $user['$id'] ?? ''; + $session = $user['session'] ?? ''; + $projectId = $this->getProject()['$id']; + + $client = $this->getWebsocket(['account'], [ + 'origin' => 'http://localhost', + 'cookie' => 'a_session_'.$projectId.'=' . $session + ]); + $response = json_decode($client->receive(), true); + $this->assertCount(1, $response); + $this->assertArrayHasKey('account.' . $userId, $response); + + /** + * Test Account Name Event + */ + $name = "Torsten Dittmann"; + + $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 + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.update.name', $response['event']); + + $this->assertArrayHasKey('$id', $response['payload']); + $this->assertArrayHasKey('name', $response['payload']); + $this->assertArrayHasKey('registration', $response['payload']); + $this->assertArrayHasKey('status', $response['payload']); + $this->assertArrayHasKey('email', $response['payload']); + $this->assertArrayHasKey('emailVerification', $response['payload']); + $this->assertArrayHasKey('prefs', $response['payload']); + + $this->assertEquals($name, $response['payload']['name']); + + + /** + * Test Account Password Event + */ + $this->client->call(Client::METHOD_PATCH, '/account/password', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $session, + ]), [ + 'password' => 'new-password', + 'oldPassword' => 'password', + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.update.password', $response['event']); + + $this->assertArrayHasKey('$id', $response['payload']); + $this->assertArrayHasKey('name', $response['payload']); + $this->assertArrayHasKey('registration', $response['payload']); + $this->assertArrayHasKey('status', $response['payload']); + $this->assertArrayHasKey('email', $response['payload']); + $this->assertArrayHasKey('emailVerification', $response['payload']); + $this->assertArrayHasKey('prefs', $response['payload']); + + $this->assertEquals($name, $response['payload']['name']); + + /** + * Test Account Email Update + */ + $this->client->call(Client::METHOD_PATCH, '/account/email', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $session, + ]), [ + 'email' => 'torsten@appwrite.io', + 'password' => 'new-password', + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.update.email', $response['event']); + $this->assertNotEmpty($response['payload']); + + $this->assertEquals('torsten@appwrite.io', $response['payload']['email']); + + /** + * Test Account Verification Create + */ + $this->client->call(Client::METHOD_POST, '/account/verification', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $session, + ]), [ + 'url' => 'http://localhost/verification', + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.verification.create', $response['event']); + + $lastEmail = $this->getLastEmail(); + $verification = substr($lastEmail['text'], strpos($lastEmail['text'], '&secret=', 0) + 8, 256); + + /** + * Test Account Verification Complete + */ + $response = $this->client->call(Client::METHOD_PUT, '/account/verification', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $session, + ]), [ + 'userId' => $userId, + 'secret' => $verification, + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.verification.update', $response['event']); + + /** + * Test Acoount Prefs Update + */ + $this->client->call(Client::METHOD_PATCH, '/account/prefs', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $session, + ]), [ + 'prefs' => [ + 'prefKey1' => 'prefValue1', + 'prefKey2' => 'prefValue2', + ] + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.update.prefs', $response['event']); + $this->assertNotEmpty($response['payload']); + + /** + * Test Account Session Create + */ + $response = $this->client->call(Client::METHOD_POST, '/account/sessions', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + ]), [ + 'email' => 'torsten@appwrite.io', + 'password' => 'new-password', + ]); + + $sessionNew = $this->client->parseCookie((string)$response['headers']['set-cookie'])['a_session_'.$projectId]; + $sessionNewId = $response['body']['$id']; + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.sessions.create', $response['event']); + $this->assertNotEmpty($response['payload']); + + /** + * Test Account Session Delete + */ + $this->client->call(Client::METHOD_DELETE, '/account/sessions/'.$sessionNewId, array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + 'cookie' => 'a_session_'.$projectId.'=' . $sessionNew, + ])); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.sessions.delete', $response['event']); + $this->assertNotEmpty($response['payload']); + + /** + * Test Account Create Recovery + */ + $this->client->call(Client::METHOD_POST, '/account/recovery', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + ]), [ + 'email' => 'torsten@appwrite.io', + 'url' => 'http://localhost/recovery', + ]); + + $response = json_decode($client->receive(), true); + + $lastEmail = $this->getLastEmail(); + $recovery = substr($lastEmail['text'], strpos($lastEmail['text'], '&secret=', 0) + 8, 256); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.recovery.create', $response['event']); + $this->assertNotEmpty($response['payload']); + + $response = $this->client->call(Client::METHOD_PUT, '/account/recovery', array_merge([ + 'origin' => 'http://localhost', + 'content-type' => 'application/json', + 'x-appwrite-project' => $projectId, + ]), [ + 'userId' => $userId, + 'secret' => $recovery, + 'password' => 'test-recovery', + 'passwordAgain' => 'test-recovery', + ]); + + $response = json_decode($client->receive(), true); + + $this->assertCount(1, $response['channels']); + $this->assertArrayHasKey('timestamp', $response); + $this->assertEquals('account.' . $userId, $response['channels'][0]); + $this->assertEquals('account.recovery.update', $response['event']); + $this->assertNotEmpty($response['payload']); + + $client->close(); + } } diff --git a/tests/e2e/Services/Realtime/RealtimeCustomClientTest.php b/tests/e2e/Services/Realtime/RealtimeCustomClientTest.php index e45c0b64b..381f68969 100644 --- a/tests/e2e/Services/Realtime/RealtimeCustomClientTest.php +++ b/tests/e2e/Services/Realtime/RealtimeCustomClientTest.php @@ -15,49 +15,4 @@ class RealtimeCustomClientTest extends Scope use RealtimeBase; use ProjectCustom; use SideClient; - - private function getWebsocket($channels = [], $headers = []) - { - $headers = array_merge( - ['Origin' => 'http://appwrite.test'], - $headers - ); - $query = [ - 'project' => $this->getProject()['$id'], - 'channels' => $channels - ]; - return new WebSocketClient('ws://appwrite-traefik/v1/realtime?' . http_build_query($query), [ - 'headers' => $headers, - 'timeout' => 5, - ]); - } - - public function testConnection() - { - /** - * Test for SUCCESS - */ - $client = $this->getWebsocket(['documents']); - $this->assertEquals('{"documents":0}', $client->receive()); - $client->close(); - - $client = $this->getWebsocket(['documents'], ['Origin' => 'http://appwrite.unknown']); - $this->assertEquals('Invalid Origin. Register your new client (appwrite.unknown) as a new Web platform on your project console dashboard', $client->receive()); - $this->expectException(ConnectionException::class); // Check if server disconnnected client - $client->close(); - - $client = $this->getWebsocket(); - $this->assertEquals('Missing channels', $client->receive()); - $this->expectException(ConnectionException::class); // Check if server disconnnected client - $client->close(); - - $client = new WebSocketClient('ws://appwrite-traefik/v1/realtime', [ - 'headers' => [ - 'Origin' => 'appwrite.test' - ] - ]); - $this->assertEquals('Missing or unknown project ID', $client->receive()); - $this->expectException(ConnectionException::class); // Check if server disconnnected client - $client->close(); - } } \ No newline at end of file