CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-06-03 03:14:50 +12:00
Code Issues Projects Releases Wiki Activity

Merge branch 'feat-database-indexing' of https://github.com/appwrite/appwrite into feat-database-indexing

Browse source
This commit is contained in:
Torsten Dittmann 2021-12-14 09:36:04 +01:00
parent 8179bc1a8f a10eccbdc7
commit 3f0d4a64c0
27 changed files with 1506 additions and 1161 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
app/controllers/shared/api.php
View file

@ -167,7 +167,7 @@ App::init(function ($utopia, $request, $project) {
throw new Exception('JWT authentication is disabled for this project', 501);
}
break;
default:
throw new Exception('Unsupported authentication route');
break;
@ -188,7 +188,7 @@ App::shutdown(function ($utopia, $request, $response, $project, $events, $audits
/** @var bool $mode */
if (!empty($events->getParam('event'))) {
if(empty($events->getParam('eventData'))) {
if (empty($events->getParam('eventData'))) {
$events->setParam('eventData', $response->getPayload());
}
@ -207,10 +207,10 @@ App::shutdown(function ($utopia, $request, $response, $project, $events, $audits
if ($project->getId() !== 'console') {
$payload = new Document($response->getPayload());
$target = Realtime::fromPayload($events->getParam('event'), $payload);
$target = Realtime::fromPayload($events->getParam('event'), $payload, $project);
Realtime::send(
$project->getId(),
$target['projectId'] ?? $project->getId(),
$response->getPayload(),
$events->getParam('event'),
$target['channels'],

40
app/init.php
View file

@ -21,9 +21,6 @@ use Appwrite\Extend\PDO;
use Ahc\Jwt\JWT;
use Ahc\Jwt\JWTException;
use Appwrite\Auth\Auth;
use Appwrite\Database\Database as DatabaseOld;
use Appwrite\Database\Adapter\MySQL as MySQLAdapter;
use Appwrite\Database\Adapter\Redis as RedisAdapter;
use Appwrite\Event\Event;
use Appwrite\Network\Validator\Email;
use Appwrite\Network\Validator\IP;
@ -156,43 +153,6 @@ if(!empty($user) || !empty($pass)) {
Resque::setBackend(App::getEnv('_APP_REDIS_HOST', '').':'.App::getEnv('_APP_REDIS_PORT', ''));
}
/**
* Old DB Filters
*/
DatabaseOld::addFilter('json',
function($value) {
if(!is_array($value)) {
return $value;
}
return json_encode($value);
},
function($value) {
return json_decode($value, true);
}
);
DatabaseOld::addFilter('encrypt',
function($value) {
$key = App::getEnv('_APP_OPENSSL_KEY_V1');
$iv = OpenSSL::randomPseudoBytes(OpenSSL::cipherIVLength(OpenSSL::CIPHER_AES_128_GCM));
$tag = null;
return json_encode([
'data' => OpenSSL::encrypt($value, OpenSSL::CIPHER_AES_128_GCM, $key, 0, $iv, $tag),
'method' => OpenSSL::CIPHER_AES_128_GCM,
'iv' => bin2hex($iv),
'tag' => bin2hex($tag),
'version' => '1',
]);
},
function($value) {
$value = json_decode($value, true);
$key = App::getEnv('_APP_OPENSSL_KEY_V'.$value['version']);
return OpenSSL::decrypt($value['data'], $value['method'], $key, 0, hex2bin($value['iv']), hex2bin($value['tag']));
}
);
/**
* New DB Filters
*/

72
app/workers/database.php
View file

@ -1,5 +1,6 @@
<?php
use Appwrite\Messaging\Adapter\Realtime;
use Appwrite\Resque\Worker;
use Utopia\CLI\Console;
use Utopia\Database\Document;
@ -33,7 +34,7 @@ class DatabaseV1 extends Worker
if($document->isEmpty()) {
throw new Exception('Missing document');
}
switch (strval($type)) {
case DATABASE_TYPE_CREATE_ATTRIBUTE:
$this->createAttribute($collection, $document, $projectId);
@ -67,9 +68,11 @@ class DatabaseV1 extends Worker
*/
protected function createAttribute(Document $collection, Document $attribute, string $projectId): void
{
$dbForConsole = $this->getConsoleDB();
$dbForInternal = $this->getInternalDB($projectId);
$dbForExternal = $this->getExternalDB($projectId);
$event = 'database.attributes.update';
$collectionId = $collection->getId();
$key = $attribute->getAttribute('key', '');
$type = $attribute->getAttribute('type', '');
@ -81,6 +84,7 @@ class DatabaseV1 extends Worker
$format = $attribute->getAttribute('format', '');
$formatOptions = $attribute->getAttribute('formatOptions', []);
$filters = $attribute->getAttribute('filters', []);
$project = $dbForConsole->getDocument('projects', $projectId);
try {
if(!$dbForExternal->createAttribute($collectionId, $key, $type, $size, $required, $default, $signed, $array, $format, $formatOptions, $filters)) {
@ -90,6 +94,20 @@ class DatabaseV1 extends Worker
} catch (\Throwable $th) {
Console::error($th->getMessage());
$dbForInternal->updateDocument('attributes', $attribute->getId(), $attribute->setAttribute('status', 'failed'));
} finally {
$target = Realtime::fromPayload($event, $attribute, $project);
Realtime::send(
projectId: 'console',
payload: $attribute->getArrayCopy(),
event: $event,
channels: $target['channels'],
roles: $target['roles'],
options: [
'projectId' => $projectId,
'collectionId' => $collection->getId()
]
);
}
$dbForInternal->deleteCachedDocument('collections', $collectionId);
@ -102,11 +120,15 @@ class DatabaseV1 extends Worker
*/
protected function deleteAttribute(Document $collection, Document $attribute, string $projectId): void
{
$dbForConsole = $this->getConsoleDB();
$dbForInternal = $this->getInternalDB($projectId);
$dbForExternal = $this->getExternalDB($projectId);
$event = 'database.attributes.delete';
$collectionId = $collection->getId();
$key = $attribute->getAttribute('key', '');
$status = $attribute->getAttribute('status', '');
$project = $dbForConsole->getDocument('projects', $projectId);
// possible states at this point:
// - available: should not land in queue; controller flips these to 'deleting'
@ -122,6 +144,20 @@ class DatabaseV1 extends Worker
} catch (\Throwable $th) {
Console::error($th->getMessage());
$dbForInternal->updateDocument('attributes', $attribute->getId(), $attribute->setAttribute('status', 'stuck'));
} finally {
$target = Realtime::fromPayload($event, $attribute, $project);
Realtime::send(
projectId: 'console',
payload: $attribute->getArrayCopy(),
event: $event,
channels: $target['channels'],
roles: $target['roles'],
options: [
'projectId' => $projectId,
'collectionId' => $collection->getId()
]
);
}
// The underlying database removes/rebuilds indexes when attribute is removed
@ -185,15 +221,18 @@ class DatabaseV1 extends Worker
*/
protected function createIndex(Document $collection, Document $index, string $projectId): void
{
$dbForConsole = $this->getConsoleDB();
$dbForInternal = $this->getInternalDB($projectId);
$dbForExternal = $this->getExternalDB($projectId);
$event = 'database.indexes.update';
$collectionId = $collection->getId();
$key = $index->getAttribute('key', '');
$type = $index->getAttribute('type', '');
$attributes = $index->getAttribute('attributes', []);
$lengths = $index->getAttribute('lengths', []);
$orders = $index->getAttribute('orders', []);
$project = $dbForConsole->getDocument('projects', $projectId);
try {
if(!$dbForExternal->createIndex($collectionId, $key, $type, $attributes, $lengths, $orders)) {
@ -203,6 +242,20 @@ class DatabaseV1 extends Worker
} catch (\Throwable $th) {
Console::error($th->getMessage());
$dbForInternal->updateDocument('indexes', $index->getId(), $index->setAttribute('status', 'failed'));
} finally {
$target = Realtime::fromPayload($event, $index, $project);
Realtime::send(
projectId: 'console',
payload: $index->getArrayCopy(),
event: $event,
channels: $target['channels'],
roles: $target['roles'],
options: [
'projectId' => $projectId,
'collectionId' => $collection->getId()
]
);
}
$dbForInternal->deleteCachedDocument('collections', $collectionId);
@ -215,12 +268,15 @@ class DatabaseV1 extends Worker
*/
protected function deleteIndex(Document $collection, Document $index, string $projectId): void
{
$dbForConsole = $this->getConsoleDB();
$dbForInternal = $this->getInternalDB($projectId);
$dbForExternal = $this->getExternalDB($projectId);
$collectionId = $collection->getId();
$key = $index->getAttribute('key');
$status = $index->getAttribute('status', '');
$event = 'database.indexes.delete';
$project = $dbForConsole->getDocument('projects', $projectId);
try {
if($status !== 'failed' && !$dbForExternal->deleteIndex($collectionId, $key)) {
@ -230,6 +286,20 @@ class DatabaseV1 extends Worker
} catch (\Throwable $th) {
Console::error($th->getMessage());
$dbForInternal->updateDocument('indexes', $index->getId(), $index->setAttribute('status', 'stuck'));
} finally {
$target = Realtime::fromPayload($event, $index, $project);
Realtime::send(
projectId: 'console',
payload: $index->getArrayCopy(),
event: $event,
channels: $target['channels'],
roles: $target['roles'],
options: [
'projectId' => $projectId,
'collectionId' => $collection->getId()
]
);
}
$dbForInternal->deleteCachedDocument('collections', $collectionId);

2
composer.json
View file

@ -51,7 +51,7 @@
"utopia-php/registry": "0.5.*",
"utopia-php/preloader": "0.2.*",
"utopia-php/domains": "1.1.*",
"utopia-php/swoole": "0.2.*",
"utopia-php/swoole": "0.3.*",
"utopia-php/storage": "0.5.*",
"utopia-php/websocket": "0.0.*",
"utopia-php/image": "0.5.*",

90
composer.lock generated
View file

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "7e24a95bc534ed39b042f19b27268de9",
"content-hash": "9dcf48d4173daea87c60b464b104cd22",
"packages": [
{
"name": "adhocore/jwt",
@ -2138,16 +2138,16 @@
},
{
"name": "utopia-php/database",
"version": "0.12.0",
"version": "0.12.1",
"source": {
"type": "git",
"url": "https://github.com/utopia-php/database.git",
"reference": "102ee1d21fd55fc92dc7a07b60672a98ae49be26"
"reference": "af512b7a00cc7c6e30fa03efbc5fd7e77a93e2df"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/utopia-php/database/zipball/102ee1d21fd55fc92dc7a07b60672a98ae49be26",
"reference": "102ee1d21fd55fc92dc7a07b60672a98ae49be26",
"url": "https://api.github.com/repos/utopia-php/database/zipball/af512b7a00cc7c6e30fa03efbc5fd7e77a93e2df",
"reference": "af512b7a00cc7c6e30fa03efbc5fd7e77a93e2df",
"shasum": ""
},
"require": {
@ -2155,7 +2155,7 @@
"ext-pdo": "*",
"ext-redis": "*",
"mongodb/mongodb": "1.8.0",
"php": ">=7.1",
"php": ">=8.0",
"utopia-php/cache": "0.4.*",
"utopia-php/framework": "0.*.*"
},
@ -2195,9 +2195,9 @@
],
"support": {
"issues": "https://github.com/utopia-php/database/issues",
"source": "https://github.com/utopia-php/database/tree/0.12.0"
"source": "https://github.com/utopia-php/database/tree/0.12.1"
},
"time": "2021-11-24T14:53:22+00:00"
"time": "2021-12-13T14:57:32+00:00"
},
{
"name": "utopia-php/domains",
@ -2255,24 +2255,24 @@
},
{
"name": "utopia-php/framework",
"version": "0.19.1",
"version": "0.19.2",
"source": {
"type": "git",
"url": "https://github.com/utopia-php/framework.git",
"reference": "cc7629b5f7a8f45912ec2e069b7f14e361e41c34"
"reference": "49e4374b97c0f4d14bc84b424bdc9c3b7747e15f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/utopia-php/framework/zipball/cc7629b5f7a8f45912ec2e069b7f14e361e41c34",
"reference": "cc7629b5f7a8f45912ec2e069b7f14e361e41c34",
"url": "https://api.github.com/repos/utopia-php/framework/zipball/49e4374b97c0f4d14bc84b424bdc9c3b7747e15f",
"reference": "49e4374b97c0f4d14bc84b424bdc9c3b7747e15f",
"shasum": ""
},
"require": {
"php": ">=7.3.0"
"php": ">=8.0.0"
},
"require-dev": {
"phpunit/phpunit": "^9.4",
"vimeo/psalm": "4.0.1"
"phpunit/phpunit": "^9.5.10",
"vimeo/psalm": "4.13.1"
},
"type": "library",
"autoload": {
@ -2298,9 +2298,9 @@
],
"support": {
"issues": "https://github.com/utopia-php/framework/issues",
"source": "https://github.com/utopia-php/framework/tree/0.19.1"
"source": "https://github.com/utopia-php/framework/tree/0.19.2"
},
"time": "2021-11-25T16:11:40+00:00"
"time": "2021-12-07T09:29:35+00:00"
},
{
"name": "utopia-php/image",
@ -2567,16 +2567,16 @@
},
{
"name": "utopia-php/storage",
"version": "0.5.0",
"version": "0.5.1",
"source": {
"type": "git",
"url": "https://github.com/utopia-php/storage.git",
"reference": "92ae20c7a2ac329f573a58a82dc245134cc63408"
"reference": "e672aa3fc2a8ba689aff65f68ff29f1d608223b8"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/utopia-php/storage/zipball/92ae20c7a2ac329f573a58a82dc245134cc63408",
"reference": "92ae20c7a2ac329f573a58a82dc245134cc63408",
"url": "https://api.github.com/repos/utopia-php/storage/zipball/e672aa3fc2a8ba689aff65f68ff29f1d608223b8",
"reference": "e672aa3fc2a8ba689aff65f68ff29f1d608223b8",
"shasum": ""
},
"require": {
@ -2613,33 +2613,33 @@
],
"support": {
"issues": "https://github.com/utopia-php/storage/issues",
"source": "https://github.com/utopia-php/storage/tree/0.5.0"
"source": "https://github.com/utopia-php/storage/tree/0.5.1"
},
"time": "2021-04-15T16:43:12+00:00"
"time": "2021-12-13T15:17:14+00:00"
},
{
"name": "utopia-php/swoole",
"version": "0.2.4",
"version": "0.3.2",
"source": {
"type": "git",
"url": "https://github.com/utopia-php/swoole.git",
"reference": "37d8c64b536d6bc7da4f0f5a934a0ec44885abf4"
"reference": "2b714eddf77cd5eda1889219c9656d7c0a63ce73"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/utopia-php/swoole/zipball/37d8c64b536d6bc7da4f0f5a934a0ec44885abf4",
"reference": "37d8c64b536d6bc7da4f0f5a934a0ec44885abf4",
"url": "https://api.github.com/repos/utopia-php/swoole/zipball/2b714eddf77cd5eda1889219c9656d7c0a63ce73",
"reference": "2b714eddf77cd5eda1889219c9656d7c0a63ce73",
"shasum": ""
},
"require": {
"ext-swoole": "*",
"php": ">=7.4",
"php": ">=8.0",
"utopia-php/framework": "0.*.*"
},
"require-dev": {
"phpunit/phpunit": "^9.3",
"swoole/ide-helper": "4.5.5",
"vimeo/psalm": "4.0.1"
"swoole/ide-helper": "4.8.3",
"vimeo/psalm": "4.15.0"
},
"type": "library",
"autoload": {
@ -2669,9 +2669,9 @@
],
"support": {
"issues": "https://github.com/utopia-php/swoole/issues",
"source": "https://github.com/utopia-php/swoole/tree/0.2.4"
"source": "https://github.com/utopia-php/swoole/tree/0.3.2"
},
"time": "2021-06-22T10:49:24+00:00"
"time": "2021-12-13T15:37:41+00:00"
},
{
"name": "utopia-php/system",
@ -5665,23 +5665,23 @@
},
{
"name": "symfony/console",
"version": "v5.4.0",
"version": "v5.4.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/console.git",
"reference": "ec3661faca1d110d6c307e124b44f99ac54179e3"
"reference": "9130e1a0fc93cb0faadca4ee917171bd2ca9e5f4"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/console/zipball/ec3661faca1d110d6c307e124b44f99ac54179e3",
"reference": "ec3661faca1d110d6c307e124b44f99ac54179e3",
"url": "https://api.github.com/repos/symfony/console/zipball/9130e1a0fc93cb0faadca4ee917171bd2ca9e5f4",
"reference": "9130e1a0fc93cb0faadca4ee917171bd2ca9e5f4",
"shasum": ""
},
"require": {
"php": ">=7.2.5",
"symfony/deprecation-contracts": "^2.1|^3",
"symfony/polyfill-mbstring": "~1.0",
"symfony/polyfill-php73": "^1.8",
"symfony/polyfill-php73": "^1.9",
"symfony/polyfill-php80": "^1.16",
"symfony/service-contracts": "^1.1|^2|^3",
"symfony/string": "^5.1|^6.0"
@ -5744,7 +5744,7 @@
"terminal"
],
"support": {
"source": "https://github.com/symfony/console/tree/v5.4.0"
"source": "https://github.com/symfony/console/tree/v5.4.1"
},
"funding": [
{
@ -5760,7 +5760,7 @@
"type": "tidelift"
}
],
"time": "2021-11-29T15:30:56+00:00"
"time": "2021-12-09T11:22:43+00:00"
},
{
"name": "symfony/polyfill-intl-grapheme",
@ -6170,16 +6170,16 @@
},
{
"name": "symfony/string",
"version": "v6.0.0",
"version": "v6.0.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/string.git",
"reference": "ba727797426af0f587f4800566300bdc0cda0777"
"reference": "0cfed595758ec6e0a25591bdc8ca733c1896af32"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/string/zipball/ba727797426af0f587f4800566300bdc0cda0777",
"reference": "ba727797426af0f587f4800566300bdc0cda0777",
"url": "https://api.github.com/repos/symfony/string/zipball/0cfed595758ec6e0a25591bdc8ca733c1896af32",
"reference": "0cfed595758ec6e0a25591bdc8ca733c1896af32",
"shasum": ""
},
"require": {
@ -6235,7 +6235,7 @@
"utf8"
],
"support": {
"source": "https://github.com/symfony/string/tree/v6.0.0"
"source": "https://github.com/symfony/string/tree/v6.0.1"
},
"funding": [
{
@ -6251,7 +6251,7 @@
"type": "tidelift"
}
],
"time": "2021-10-29T07:35:21+00:00"
"time": "2021-12-08T15:13:44+00:00"
},
{
"name": "textalk/websocket",

23
public/scripts/init.js
View file

@ -57,10 +57,27 @@ window.addEventListener("load", async () => {
const realtime = window.ls.container.get('realtime');
const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));
let current = {};
window.ls.container.get('console').subscribe('project', event => {
for (let project in event.payload) {
current[project] = event.payload[project] ?? 0;
window.ls.container.get('console').subscribe(['project', 'console'], response => {
switch (response.event) {
case 'stats.connections':
for (let project in response.payload) {
current[project] = response.payload[project] ?? 0;
}
break;
case 'database.attributes.create':
case 'database.attributes.update':
case 'database.attributes.delete':
document.dispatchEvent(new CustomEvent('database.createAttribute'));
break;
case 'database.indexes.create':
case 'database.indexes.update':
case 'database.indexes.delete':
document.dispatchEvent(new CustomEvent('database.createIndex'));
break;
}
});
while (true) {

4
src/Appwrite/Auth/Validator/Password.php
View file

@ -18,7 +18,7 @@ class Password extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Password must be at least 8 characters';
}
@ -30,7 +30,7 @@ class Password extends Validator
*
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (!\is_string($value)) {
return false;

4
src/Appwrite/Database/Validator/Authorization.php
View file

@ -46,7 +46,7 @@ class Authorization extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return $this->message;
}
@ -60,7 +60,7 @@ class Authorization extends Validator
*
* @return bool
*/
public function isValid($permissions)
public function isValid($permissions): bool
{
if (!self::$status) {
return true;

2
src/Appwrite/Database/Validator/Collection.php
View file

@ -39,7 +39,7 @@ class Collection extends Structure
*
* @return bool
*/
public function isValid($document)
public function isValid($document): bool
{
$document = new Document(
\array_merge($this->merge, ($document instanceof Document) ? $document->getArrayCopy() : $document)

2
src/Appwrite/Database/Validator/CustomId.php
View file

@ -13,7 +13,7 @@ class CustomId extends Key {
*
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
return $value == 'unique()' || parent::isValid($value);

4
src/Appwrite/Database/Validator/DocumentId.php
View file

@ -42,7 +42,7 @@ class DocumentId extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return $this->message;
}
@ -56,7 +56,7 @@ class DocumentId extends Validator
*
* @return bool
*/
public function isValid($id)
public function isValid($id): bool
{
$document = $this->database->getDocument($id);

4
src/Appwrite/Database/Validator/Key.php
View file

@ -18,7 +18,7 @@ class Key extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return $this->message;
}
@ -32,7 +32,7 @@ class Key extends Validator
*
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (!\is_string($value)) {
return false;

4
src/Appwrite/Database/Validator/Permissions.php
View file

@ -34,7 +34,7 @@ class Permissions extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return $this->message;
}
@ -48,7 +48,7 @@ class Permissions extends Validator
*
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (!\is_array($value) && !empty($value)) {
$this->message = 'Invalid permissions data structure';

4
src/Appwrite/Database/Validator/Structure.php
View file

@ -109,7 +109,7 @@ class Structure extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Invalid document structure: '.$this->message;
}
@ -123,7 +123,7 @@ class Structure extends Validator
*
* @return bool
*/
public function isValid($document)
public function isValid($document): bool
{
$document = (\is_array($document)) ? new Document($document) : $document;

4
src/Appwrite/Database/Validator/UID.php
View file

@ -13,7 +13,7 @@ class UID extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Invalid UID format';
}
@ -27,7 +27,7 @@ class UID extends Validator
*
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if ($value === 0) { // TODO Deprecate confition when we get the chance.
return true;

16
src/Appwrite/Messaging/Adapter/Realtime.php
View file

@ -234,16 +234,18 @@ class Realtime extends Adapter
/**
* Create channels array based on the event name and payload.
*
*
* @param string $event
* @param Document $payload
* @param Document|null $project
* @return array
*/
public static function fromPayload(string $event, Document $payload): array
public static function fromPayload(string $event, Document $payload, Document $project = null): array
{
$channels = [];
$roles = [];
$permissionsChanged = false;
$projectId = null;
switch (true) {
case strpos($event, 'account.recovery.') === 0:
@ -279,6 +281,13 @@ class Realtime extends Adapter
$channels[] = 'collections.' . $payload->getId();
$roles = $payload->getRead();
break;
case strpos($event, 'database.attributes.') === 0:
case strpos($event, 'database.indexes.') === 0:
$channels[] = 'console';
$projectId = 'console';
$roles = ['team:' . $project->getAttribute('teamId')];
break;
case strpos($event, 'database.documents.') === 0:
$channels[] = 'documents';
@ -306,7 +315,8 @@ class Realtime extends Adapter
return [
'channels' => $channels,
'roles' => $roles,
'permissionsChanged' => $permissionsChanged
'permissionsChanged' => $permissionsChanged,
'projectId' => $projectId
];
}
}

4
src/Appwrite/Network/Validator/CNAME.php
View file

@ -22,7 +22,7 @@ class CNAME extends Validator
/**
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Invalid CNAME record';
}
@ -34,7 +34,7 @@ class CNAME extends Validator
*
* @return bool
*/
public function isValid($domain)
public function isValid($domain): bool
{
if (!is_string($domain)) {
return false;

4
src/Appwrite/Network/Validator/Domain.php
View file

@ -20,7 +20,7 @@ class Domain extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Value must be a valid domain';
}
@ -35,7 +35,7 @@ class Domain extends Validator
* @param mixed $value
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (empty($value)) {
return false;

4
src/Appwrite/Network/Validator/Email.php
View file

@ -20,7 +20,7 @@ class Email extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Value must be a valid email address';
}
@ -33,7 +33,7 @@ class Email extends Validator
* @param mixed $value
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (!\filter_var($value, FILTER_VALIDATE_EMAIL)) {
return false;

4
src/Appwrite/Network/Validator/Host.php
View file

@ -30,7 +30,7 @@ class Host extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'URL host must be one of: ' . \implode(', ', $this->whitelist);
}
@ -43,7 +43,7 @@ class Host extends Validator
* @param mixed $value
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
$urlValidator = new URL();

4
src/Appwrite/Network/Validator/IP.php
View file

@ -46,7 +46,7 @@ class IP extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Value must be a valid IP address';
}
@ -59,7 +59,7 @@ class IP extends Validator
* @param mixed $value
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
switch ($this->type) {
case self::ALL:

4
src/Appwrite/Network/Validator/Origin.php
View file

@ -84,7 +84,7 @@ class Origin extends Validator
}
}
public function getDescription()
public function getDescription(): string
{
if (!\array_key_exists($this->client, $this->platforms)) {
return 'Unsupported platform';
@ -102,7 +102,7 @@ class Origin extends Validator
*
* @return bool
*/
public function isValid($origin)
public function isValid($origin): bool
{
if (!is_string($origin)) {
return false;

4
src/Appwrite/Network/Validator/URL.php
View file

@ -20,7 +20,7 @@ class URL extends Validator
*
* @return string
*/
public function getDescription()
public function getDescription(): string
{
return 'Value must be a valid URL';
}
@ -33,7 +33,7 @@ class URL extends Validator
* @param mixed $value
* @return bool
*/
public function isValid($value)
public function isValid($value): bool
{
if (\filter_var($value, FILTER_VALIDATE_URL) === false) {
return false;

2
src/Appwrite/Template/Template.php
View file

@ -63,7 +63,7 @@ class Template extends View
*
* @throws Exception
*/
public function render($minify = true)
public function render($minify = true): string
{
if ($this->rendered) { // Don't render any template
return '';

1041
tests/e2e/Services/Realtime/RealtimeBase.php
View file

File diff suppressed because it is too large Load diff

276
tests/e2e/Services/Realtime/RealtimeConsoleClientTest.php Normal file
View file

@ -0,0 +1,276 @@
<?php
namespace Tests\E2E\Services\Realtime;
use Exception;
use SebastianBergmann\RecursionContext\InvalidArgumentException;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\Exception as FrameworkException;
use Tests\E2E\Client;
use Tests\E2E\Scopes\Scope;
use Tests\E2E\Scopes\ProjectCustom;
use Tests\E2E\Scopes\SideConsole;
use WebSocket\BadOpcodeException;
use WebSocket\ConnectionException;
use WebSocket\TimeoutException;
class RealtimeConsoleClientTest extends Scope
{
use RealtimeBase;
use ProjectCustom;
use SideConsole;
public function testAttributes()
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = 'console';
$client = $this->getWebsocket(['console'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_console='. $this->getRoot()['session'],
], $projectId);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertNotEmpty($response['data']['user']);
/**
* Test Attributes
*/
$actors = $this->client->call(Client::METHOD_POST, '/database/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'collectionId' => 'unique()',
'name' => 'Actors',
'read' => ['role:all'],
'write' => ['role:all'],
'permission' => 'collection'
]);
$data = ['actorsId' => $actors['body']['$id']];
$name = $this->client->call(Client::METHOD_POST, '/database/collections/' . $data['actorsId'] . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'attributeId' => 'name',
'size' => 256,
'required' => true,
]);
$this->assertEquals($name['headers']['status-code'], 201);
$this->assertEquals($name['body']['key'], 'name');
$this->assertEquals($name['body']['type'], 'string');
$this->assertEquals($name['body']['size'], 256);
$this->assertEquals($name['body']['required'], true);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.attributes.create', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$this->assertEquals('processing', $response['data']['payload']['status']);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.attributes.update', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$this->assertEquals('available', $response['data']['payload']['status']);
$client->close();
return $data;
}
/**
* @depends testAttributes
*/
public function testIndexes(array $data)
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = 'console';
$client = $this->getWebsocket(['console'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_console='. $this->getRoot()['session'],
], $projectId);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertNotEmpty($response['data']['user']);
/**
* Test Indexes
*/
$index = $this->client->call(Client::METHOD_POST, '/database/collections/' . $data['actorsId'] . '/indexes', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'indexId' => 'key_name',
'type' => 'key',
'attributes' => [
'name',
],
]);
$this->assertEquals($index['headers']['status-code'], 201);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.indexes.create', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$this->assertEquals('processing', $response['data']['payload']['status']);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.indexes.update', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$this->assertEquals('available', $response['data']['payload']['status']);
$client->close();
return $data;
}
/**
* @depends testIndexes
*/
public function testDeleteIndex(array $data)
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = 'console';
$client = $this->getWebsocket(['console'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_console='. $this->getRoot()['session'],
], $projectId);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertNotEmpty($response['data']['user']);
/**
* Test Delete Index
*/
$attribute = $this->client->call(Client::METHOD_DELETE, '/database/collections/' . $data['actorsId'] . '/indexes/key_name', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()));
$this->assertEquals($attribute['headers']['status-code'], 204);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.indexes.delete', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$client->close();
return $data;
}
/**
* @depends testDeleteIndex
*/
public function testDeleteAttribute(array $data)
{
$user = $this->getUser();
$session = $user['session'] ?? '';
$projectId = 'console';
$client = $this->getWebsocket(['console'], [
'origin' => 'http://localhost',
'cookie' => 'a_session_console='. $this->getRoot()['session'],
], $projectId);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('connected', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertNotEmpty($response['data']['user']);
/**
* Test Delete Attribute
*/
$attribute = $this->client->call(Client::METHOD_DELETE, '/database/collections/' . $data['actorsId'] . '/attributes/name', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()));
$this->assertEquals($attribute['headers']['status-code'], 204);
$response = json_decode($client->receive(), true);
$this->assertArrayHasKey('type', $response);
$this->assertArrayHasKey('data', $response);
$this->assertEquals('event', $response['type']);
$this->assertNotEmpty($response['data']);
$this->assertArrayHasKey('timestamp', $response['data']);
$this->assertCount(1, $response['data']['channels']);
$this->assertContains('console', $response['data']['channels']);
$this->assertEquals('database.attributes.delete', $response['data']['event']);
$this->assertNotEmpty($response['data']['payload']);
$client->close();
}
}

1037
tests/e2e/Services/Realtime/RealtimeCustomClientTest.php
View file

File diff suppressed because it is too large Load diff