2025-05-09 11:55:36 +00:00
< ? php
2025-07-27 08:20:34 +00:00
namespace Tests\E2E\Services\Databases\Grids ;
2025-05-09 11:55:36 +00:00
use Tests\E2E\Client ;
use Tests\E2E\Scopes\ProjectCustom ;
use Tests\E2E\Scopes\Scope ;
use Tests\E2E\Scopes\SideClient ;
use Utopia\Database\Database ;
use Utopia\Database\Helpers\ID ;
use Utopia\Database\Helpers\Permission ;
use Utopia\Database\Helpers\Role ;
class DatabasesCustomClientTest extends Scope
{
use DatabasesBase ;
use ProjectCustom ;
use SideClient ;
public function testAllowedPermissions () : void
{
/**
* Test for SUCCESS
*/
$database = $this -> client -> call ( Client :: METHOD_POST , '/databases' , [
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
], [
'databaseId' => ID :: unique (),
'name' => 'Test Database'
]);
$databaseId = $database [ 'body' ][ '$id' ];
// Collection aliases write to create, update, delete
2025-07-27 08:20:34 +00:00
$movies = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: unique (),
'name' => 'Movies' ,
2025-05-09 14:34:02 +00:00
'rowSecurity' => true ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: write ( Role :: user ( $this -> getUser ()[ '$id' ])),
],
]);
$moviesId = $movies [ 'body' ][ '$id' ];
$this -> assertContains ( Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])), $movies [ 'body' ][ '$permissions' ]);
$this -> assertContains ( Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])), $movies [ 'body' ][ '$permissions' ]);
$this -> assertContains ( Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])), $movies [ 'body' ][ '$permissions' ]);
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $moviesId . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => 'title' ,
'size' => 256 ,
'required' => true ,
]);
sleep ( 1 );
$this -> assertEquals ( 202 , $response [ 'headers' ][ 'status-code' ]);
// Document aliases write to update, delete
2025-07-27 08:20:34 +00:00
$row1 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $moviesId . '/rows' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'rowId' => ID :: unique (),
'data' => [
'title' => 'Captain America' ,
],
'permissions' => [
Permission :: write ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
$this -> assertNotContains ( Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])), $row1 [ 'body' ][ '$permissions' ]);
$this -> assertContains ( Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])), $row1 [ 'body' ][ '$permissions' ]);
$this -> assertContains ( Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])), $row1 [ 'body' ][ '$permissions' ]);
/**
* Test for FAILURE
*/
// Document does not allow create permission
2025-07-27 08:20:34 +00:00
$row2 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $moviesId . '/rows' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'rowId' => ID :: unique (),
'data' => [
'title' => 'Captain America' ,
],
'permissions' => [
Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
$this -> assertEquals ( 400 , $row2 [ 'headers' ][ 'status-code' ]);
}
public function testUpdateWithoutPermission () : array
{
// If document has been created by server and client tried to update it without adjusting permissions, permission validation should be skipped
// As a part of preparation, we get ID of currently logged-in user
$response = $this -> client -> call ( Client :: METHOD_GET , '/account' , array_merge ([
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()));
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
$userId = $response [ 'body' ][ '$id' ];
$database = $this -> client -> call ( Client :: METHOD_POST , '/databases' , array_merge ([
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'databaseId' => ID :: custom ( 'permissionCheckDatabase' ),
'name' => 'Test Database' ,
]);
$this -> assertEquals ( 201 , $database [ 'headers' ][ 'status-code' ]);
$this -> assertEquals ( 'Test Database' , $database [ 'body' ][ 'name' ]);
$databaseId = $database [ 'body' ][ '$id' ];
// Create collection
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'permissionCheck' ),
'name' => 'permissionCheck' ,
'permissions' => [],
2025-05-09 14:34:02 +00:00
'rowSecurity' => true ,
2025-05-09 11:55:36 +00:00
]);
$this -> assertEquals ( 201 , $response [ 'headers' ][ 'status-code' ]);
// Add attribute to collection
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/permissionCheck/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => 'name' ,
'size' => 255 ,
'required' => true ,
]);
$this -> assertEquals ( 202 , $response [ 'headers' ][ 'status-code' ]);
// Wait for database worker to finish creating attributes
sleep ( 2 );
// Creating document by server, give read permission to our user + some other user
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/permissionCheck/rows' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'rowId' => ID :: custom ( 'permissionCheckDocument' ),
'data' => [
'name' => 'AppwriteBeginner' ,
],
'permissions' => [
Permission :: read ( Role :: user ( ID :: custom ( 'user2' ))),
Permission :: read ( Role :: user ( $userId )),
Permission :: update ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
],
]);
$this -> assertEquals ( 201 , $response [ 'headers' ][ 'status-code' ]);
// Update document
// This is the point of this test. We should be allowed to do this action, and it should not fail on permission check
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/permissionCheck/rows/permissionCheckDocument' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'name' => 'AppwriteExpert' ,
]
]);
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
// Get name of the document, should be the new one
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_GET , '/databases/' . $databaseId . '/grids/tables/permissionCheck/rows/permissionCheckDocument' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()));
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
$this -> assertEquals ( " AppwriteExpert " , $response [ 'body' ][ 'name' ]);
// Cleanup to prevent collision with other tests
// Delete collection
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_DELETE , '/databases/' . $databaseId . '/grids/tables/permissionCheck' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]));
$this -> assertEquals ( 204 , $response [ 'headers' ][ 'status-code' ]);
// Wait for database worker to finish deleting collection
sleep ( 2 );
// Make sure collection has been deleted
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_GET , '/databases/' . $databaseId . '/grids/tables/permissionCheck' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]));
$this -> assertEquals ( 404 , $response [ 'headers' ][ 'status-code' ]);
return [];
}
public function testUpdateTwoWayRelationship () : void
{
$database = $this -> client -> call ( Client :: METHOD_POST , '/databases' , [
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
], [
'databaseId' => ID :: unique (),
'name' => 'Test Database'
]);
$databaseId = $database [ 'body' ][ '$id' ];
// Creating collection 1
2025-07-27 08:20:34 +00:00
$table1 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: unique (),
'name' => 'level1' ,
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: read ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
// Creating collection 2
2025-07-27 08:20:34 +00:00
$table2 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: unique (),
'name' => 'level2' ,
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: read ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
\sleep ( 2 );
// Creating two way relationship between collection 1 and collection 2 from collection 1
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => 'oneToMany' ,
'twoWay' => true ,
'onDelete' => 'cascade' ,
'key' => $table2 [ 'body' ][ '$id' ],
'twoWayKey' => $table1 [ 'body' ][ '$id' ]
]);
\sleep ( 3 );
// Update relation from collection 2 to on delete restrict
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table2 [ 'body' ][ '$id' ] . '/columns/' . $table1 [ 'body' ][ '$id' ] . '/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'onDelete' => 'restrict' ,
]);
// Fetching attributes after updating relation to compare
2025-07-27 08:20:34 +00:00
$table1Attributes = $this -> client -> call ( Client :: METHOD_GET , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ], [
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]);
$table1RelationAttribute = $table1Attributes [ 'body' ][ 'columns' ][ 0 ];
$this -> assertEquals ( $relation [ 'body' ][ 'side' ], $table1RelationAttribute [ 'side' ]);
$this -> assertEquals ( $relation [ 'body' ][ 'twoWayKey' ], $table1RelationAttribute [ 'twoWayKey' ]);
$this -> assertEquals ( $relation [ 'body' ][ 'relatedTable' ], $table1RelationAttribute [ 'relatedTable' ]);
$this -> assertEquals ( 'restrict' , $table1RelationAttribute [ 'onDelete' ]);
}
public function testRelationshipSameTwoWayKey () : void
{
$database = $this -> client -> call ( Client :: METHOD_POST , '/databases' , [
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
], [
'databaseId' => ID :: unique (),
'name' => 'Same two way key'
]);
$databaseId = $database [ 'body' ][ '$id' ];
2025-07-27 08:20:34 +00:00
$table1 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: unique (),
'name' => 'c1' ,
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: read ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
2025-07-27 08:20:34 +00:00
$table2 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: unique (),
'name' => 'c2' ,
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: read ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: update ( Role :: user ( $this -> getUser ()[ '$id' ])),
Permission :: delete ( Role :: user ( $this -> getUser ()[ '$id' ])),
]
]);
\sleep ( 2 );
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_ONE_TO_ONE ,
'twoWay' => false ,
'onDelete' => 'cascade' ,
'key' => 'attr1' ,
'twoWayKey' => 'same_key'
]);
\sleep ( 2 );
$this -> assertEquals ( 202 , $relation [ 'headers' ][ 'status-code' ]);
$this -> assertEquals ( 'same_key' , $relation [ 'body' ][ 'twoWayKey' ]);
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_ONE_TO_MANY ,
'twoWay' => false ,
'onDelete' => 'cascade' ,
'key' => 'attr2' ,
'twoWayKey' => 'same_key'
]);
\sleep ( 2 );
$this -> assertEquals ( 409 , $relation [ 'body' ][ 'code' ]);
$this -> assertEquals ( 'Attribute with the requested key already exists. Attribute keys must be unique, try again with a different key.' , $relation [ 'body' ][ 'message' ]);
// twoWayKey is null TwoWayKey is default
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_ONE_TO_MANY ,
'twoWay' => false ,
'onDelete' => 'cascade' ,
'key' => 'attr3' ,
]);
\sleep ( 2 );
$this -> assertEquals ( 202 , $relation [ 'headers' ][ 'status-code' ]);
$this -> assertArrayHasKey ( 'twoWayKey' , $relation [ 'body' ]);
// twoWayKey is null, TwoWayKey is default, second POST
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_ONE_TO_MANY ,
'twoWay' => false ,
'onDelete' => 'cascade' ,
'key' => 'attr4' ,
]);
\sleep ( 2 );
$this -> assertEquals ( 'Attribute with the requested key already exists. Attribute keys must be unique, try again with a different key.' , $relation [ 'body' ][ 'message' ]);
$this -> assertEquals ( 409 , $relation [ 'body' ][ 'code' ]);
// RelationshipManyToMany
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_MANY_TO_MANY ,
'twoWay' => true ,
'onDelete' => 'setNull' ,
'key' => 'songs' ,
'twoWayKey' => 'playlist' ,
]);
\sleep ( 2 );
$this -> assertEquals ( 202 , $relation [ 'headers' ][ 'status-code' ]);
$this -> assertArrayHasKey ( 'twoWayKey' , $relation [ 'body' ]);
// Second RelationshipManyToMany on Same collections
2025-07-27 08:20:34 +00:00
$relation = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => Database :: RELATION_MANY_TO_MANY ,
'twoWay' => true ,
'onDelete' => 'setNull' ,
'key' => 'songs2' ,
'twoWayKey' => 'playlist2' ,
]);
\sleep ( 2 );
$this -> assertEquals ( 409 , $relation [ 'body' ][ 'code' ]);
$this -> assertEquals ( 'Creating more than one "manyToMany" relationship on the same table is currently not permitted.' , $relation [ 'body' ][ 'message' ]);
}
public function testUpdateWithoutRelationPermission () : void
{
$userId = $this -> getUser ()[ '$id' ];
$database = $this -> client -> call ( Client :: METHOD_POST , '/databases' , [
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
], [
'databaseId' => ID :: unique (),
'name' => ID :: unique (),
]);
$databaseId = $database [ 'body' ][ '$id' ];
// Creating collection 1
2025-07-27 08:20:34 +00:00
$table1 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection1' ),
'name' => ID :: custom ( 'collection1' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
// Creating collection 2
2025-07-27 08:20:34 +00:00
$table2 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection2' ),
'name' => ID :: custom ( 'collection2' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: read ( Role :: user ( $userId )),
]
]);
2025-07-27 08:20:34 +00:00
$table3 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection3' ),
'name' => ID :: custom ( 'collection3' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
2025-07-27 08:20:34 +00:00
$table4 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection4' ),
'name' => ID :: custom ( 'collection4' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: read ( Role :: user ( $userId )),
]
]);
2025-07-27 08:20:34 +00:00
$table5 = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection5' ),
'name' => ID :: custom ( 'collection5' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
// Creating one to one relationship from collection 1 to colletion 2
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table2 [ 'body' ][ '$id' ],
'type' => 'oneToOne' ,
'twoWay' => false ,
'onDelete' => 'setNull' ,
'key' => $table2 [ 'body' ][ '$id' ]
]);
// Creating one to one relationship from collection 2 to colletion 3
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table2 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table3 [ 'body' ][ '$id' ],
'type' => 'oneToOne' ,
'twoWay' => false ,
'onDelete' => 'setNull' ,
'key' => $table3 [ 'body' ][ '$id' ]
]);
// Creating one to one relationship from collection 3 to colletion 4
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table3 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table4 [ 'body' ][ '$id' ],
'type' => 'oneToOne' ,
'twoWay' => false ,
'onDelete' => 'setNull' ,
'key' => $table4 [ 'body' ][ '$id' ]
]);
// Creating one to one relationship from collection 4 to colletion 5
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table4 [ 'body' ][ '$id' ] . '/columns/relationship' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'relatedTableId' => $table5 [ 'body' ][ '$id' ],
'type' => 'oneToOne' ,
'twoWay' => false ,
'onDelete' => 'setNull' ,
'key' => $table5 [ 'body' ][ '$id' ]
]);
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => " Title " ,
'size' => 100 ,
'required' => false ,
'array' => false ,
'default' => null ,
]);
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table2 [ 'body' ][ '$id' ] . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => " Rating " ,
'size' => 100 ,
'required' => false ,
'array' => false ,
'default' => null ,
]);
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table3 [ 'body' ][ '$id' ] . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => " Rating " ,
'size' => 100 ,
'required' => false ,
'array' => false ,
'default' => null ,
]);
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table4 [ 'body' ][ '$id' ] . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => " Rating " ,
'size' => 100 ,
'required' => false ,
'array' => false ,
'default' => null ,
]);
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table5 [ 'body' ][ '$id' ] . '/columns/string' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'key' => " Rating " ,
'size' => 100 ,
'required' => false ,
'array' => false ,
'default' => null ,
]);
\sleep ( 2 );
// Creating parent document with a child reference to test the permissions
2025-07-27 08:20:34 +00:00
$parentDocument = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'rowId' => ID :: custom ( $table1 [ 'body' ][ '$id' ]),
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table2 [ 'body' ][ '$id' ]),
'Rating' => '10' ,
$table3 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table3 [ 'body' ][ '$id' ]),
'Rating' => '10' ,
$table4 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table4 [ 'body' ][ '$id' ]),
'Rating' => '10' ,
$table5 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table5 [ 'body' ][ '$id' ]),
'Rating' => '10'
]
]
]
]
]
]);
$this -> assertEquals ( 201 , $parentDocument [ 'headers' ][ 'status-code' ]);
// This is the point of the test. We should not need any authorization permission to update the document with same data.
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows/' . $table1 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'rowId' => ID :: custom ( $table1 [ 'body' ][ '$id' ]),
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => $table2 [ 'body' ][ '$id' ],
'Rating' => '10' ,
$table3 [ 'body' ][ '$id' ] => [
'$id' => $table3 [ 'body' ][ '$id' ],
'Rating' => '10' ,
$table4 [ 'body' ][ '$id' ] => [
'$id' => $table4 [ 'body' ][ '$id' ],
'Rating' => '10' ,
$table5 [ 'body' ][ '$id' ] => [
'$id' => $table5 [ 'body' ][ '$id' ],
'Rating' => '10'
]
]
]
]
]
]);
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
$this -> assertEquals ( $parentDocument [ 'body' ], $response [ 'body' ]);
// Giving update permission of collection 3 to user.
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_PUT , '/databases/' . $databaseId . '/grids/tables/collection3' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection3' ),
'name' => ID :: custom ( 'collection3' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: update ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
// This is the point of this test. We should be allowed to do this action, and it should not fail on permission check
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows/' . $table1 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table2 [ 'body' ][ '$id' ]),
'Rating' => '10' ,
$table3 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table3 [ 'body' ][ '$id' ]),
'Rating' => '11' ,
$table4 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table4 [ 'body' ][ '$id' ]),
'Rating' => '10' ,
$table5 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table5 [ 'body' ][ '$id' ]),
'Rating' => '11'
]
]
]
]
]
]);
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
$this -> assertEquals ( 11 , $response [ 'body' ][ $table2 [ 'body' ][ '$id' ]][ 'collection3' ][ 'Rating' ]);
// We should not be allowed to update the document as we do not have permission for collection 2.
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows/' . $table1 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table2 [ 'body' ][ '$id' ]),
'Rating' => '11' ,
$table3 [ 'body' ][ '$id' ] => null ,
]
]
]);
$this -> assertEquals ( 401 , $response [ 'headers' ][ 'status-code' ]);
// We should not be allowed to update the document as we do not have permission for collection 2.
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table2 [ 'body' ][ '$id' ] . '/rows/' . $table2 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'Rating' => '11' ,
]
]);
$this -> assertEquals ( 401 , $response [ 'headers' ][ 'status-code' ]);
// Removing update permission from collection 3.
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_PUT , '/databases/' . $databaseId . '/grids/tables/collection3' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection3' ),
'name' => ID :: custom ( 'collection3' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
// Giving update permission to collection 2.
2025-07-27 08:20:34 +00:00
$this -> client -> call ( Client :: METHOD_PUT , '/databases/' . $databaseId . '/grids/tables/collection2' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'tableId' => ID :: custom ( 'collection2' ),
'name' => ID :: custom ( 'collection2' ),
2025-05-09 14:34:02 +00:00
'rowSecurity' => false ,
2025-05-09 11:55:36 +00:00
'permissions' => [
Permission :: create ( Role :: user ( $userId )),
Permission :: update ( Role :: user ( $userId )),
Permission :: read ( Role :: user ( $userId )),
Permission :: delete ( Role :: user ( $userId )),
]
]);
// Creating collection 3 new document
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_POST , '/databases/' . $databaseId . '/grids/tables/' . $table3 [ 'body' ][ '$id' ] . '/rows' , array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
'x-appwrite-key' => $this -> getProject ()[ 'apiKey' ]
]), [
'rowId' => ID :: custom ( 'collection3Doc1' ),
'data' => [
'Rating' => '20'
]
]);
$this -> assertEquals ( 201 , $response [ 'headers' ][ 'status-code' ]);
// We should be allowed to link a new document from collection 3 to collection 2.
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows/' . $table1 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table2 [ 'body' ][ '$id' ]),
$table3 [ 'body' ][ '$id' ] => 'collection3Doc1' ,
]
]
]);
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
// We should be allowed to link and create a new document from collection 3 to collection 2.
2025-07-27 08:20:34 +00:00
$response = $this -> client -> call ( Client :: METHOD_PATCH , '/databases/' . $databaseId . '/grids/tables/' . $table1 [ 'body' ][ '$id' ] . '/rows/' . $table1 [ 'body' ][ '$id' ], array_merge ([
2025-05-09 11:55:36 +00:00
'content-type' => 'application/json' ,
'x-appwrite-project' => $this -> getProject ()[ '$id' ],
], $this -> getHeaders ()), [
'data' => [
'Title' => 'Captain America' ,
$table2 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( $table2 [ 'body' ][ '$id' ]),
$table3 [ 'body' ][ '$id' ] => [
'$id' => ID :: custom ( 'collection3Doc2' )
],
]
]
]);
$this -> assertEquals ( 200 , $response [ 'headers' ][ 'status-code' ]);
}
}