Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allows to update permissions without payload #3346

Merged
merged 21 commits into from
Jun 24, 2022
Merged

Allows to update permissions without payload #3346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8f831b2
Allows to update permissions without payload
gepd Jun 6, 2022
a107f59
Merge branch 'master' into feat-empty-payload
gepd Jun 6, 2022
3cf26d1
make data optional
gepd Jun 8, 2022
2e05afe
Make param optional from utopia
gepd Jun 9, 2022
be53bae
Merge branch 'appwrite:master' into feat-empty-payload
gepd Jun 9, 2022
d96b077
remove null as param is already nullable
gepd Jun 9, 2022
d150591
committed suggested changes
gepd Jun 20, 2022
7b60a36
added test to update permissions with empty payload
gepd Jun 20, 2022
ca455b3
Fixed linting errors
gepd Jun 20, 2022
7cb19a7
fixed minor typo
gepd Jun 20, 2022
0bade37
updated test
gepd Jun 20, 2022
52757ef
updated test
gepd Jun 20, 2022
43ed259
added empty array as default
gepd Jun 20, 2022
dab6f97
remove dependency
gepd Jun 20, 2022
bfe3cde
create collection and attribute
gepd Jun 20, 2022
5067a46
Remove $data argument
gepd Jun 20, 2022
9dab76f
get $id from response
gepd Jun 20, 2022
c2ce37e
added read and write permissions
gepd Jun 21, 2022
6cc6928
simplified test
gepd Jun 21, 2022
addfae2
fix tests
gepd Jun 22, 2022
020e081
fix linter
gepd Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions app/controllers/api/database.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1859,7 +1859,7 @@ function createAttribute(string $collectionId, Document $attribute, Response $re
->label('sdk.response.model', Response::MODEL_DOCUMENT)
->param('collectionId', null, new UID(), 'Collection ID.')
->param('documentId', null, new UID(), 'Document ID.')
->param('data', [], new JSON(), 'Document data as JSON object. Include only attribute and value pairs to be updated.')
->param('data', [], new JSON(), 'Document data as JSON object. Include only attribute and value pairs to be updated.', true)
gepd marked this conversation as resolved.
Show resolved Hide resolved
->param('read', null, new Permissions(), 'An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.', true)
->param('write', null, new Permissions(), 'An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.', true)
->inject('response')
Expand Down Expand Up @@ -1900,8 +1900,8 @@ function createAttribute(string $collectionId, Document $attribute, Response $re

$data = (\is_string($data)) ? \json_decode($data, true) : $data; // Cast to JSON array

if (empty($data)) {
throw new Exception('Missing payload', 400, Exception::DOCUMENT_MISSING_PAYLOAD);
if (empty($data) && empty($read) && empty($write)) {
gepd marked this conversation as resolved.
Show resolved Hide resolved
throw new Exception('Missing payload or read/write permissions', 400, Exception::DOCUMENT_MISSING_PAYLOAD);
}

if (!\is_array($data)) {
Expand Down
102 changes: 102 additions & 0 deletions tests/e2e/Services/Database/DatabaseBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2162,4 +2162,106 @@ public function testUniqueIndexDuplicate(array $data): array

return $data;
}

public function testUpdatePermissionsWithEmptyPayload(): array
{
// Create collection
$movies = $this->client->call(Client::METHOD_POST, '/database/collections', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'collectionId' => 'unique()',
'name' => 'Movies',
'read' => [],
'write' => [],
'permission' => 'document',
]);

$this->assertEquals($movies['headers']['status-code'], 201);
$this->assertEquals($movies['body']['name'], 'Movies');

$moviesId = $movies['body']['$id'];

// create attribute
$title = $this->client->call(Client::METHOD_POST, '/database/collections/' . $moviesId . '/attributes/string', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey']
]), [
'key' => 'title',
'size' => 256,
'required' => true,
]);

$this->assertEquals($title['headers']['status-code'], 201);

// wait for database worker to create attributes
sleep(2);

// add document
$document = $this->client->call(Client::METHOD_POST, '/database/collections/' . $moviesId . '/documents', array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'documentId' => 'unique()',
'data' => [
'title' => 'Captain America',
],
'read' => ['role:all'],
'write' => ['role:all'],
]);

$id = $document['body']['$id'];

$this->assertEquals($document['headers']['status-code'], 201);
$this->assertCount(1, $document['body']['$read']);
$this->assertCount(1, $document['body']['$write']);
$this->assertEquals(['role:all'], $document['body']['$read']);
$this->assertEquals(['role:all'], $document['body']['$write']);

// Send only read permission
$document = $this->client->call(Client::METHOD_PATCH, '/database/collections/' . $moviesId . '/documents/' . $id, array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'read' => ['user:' . $this->getUser()['$id']],
]);

if ($this->getSide() == 'client') {
$this->assertEquals($document['headers']['status-code'], 200);
}

if ($this->getSide() == 'server') {
$this->assertEquals($document['headers']['status-code'], 200);
$this->assertCount(1, $document['body']['$read']);
$this->assertCount(1, $document['body']['$write']);
$this->assertEquals(['user:' . $this->getUser()['$id']], $document['body']['$read']);
$this->assertEquals(['role:all'], $document['body']['$write']);
}

// send only write permission
$document = $this->client->call(Client::METHOD_PATCH, '/database/collections/' . $moviesId . '/documents/' . $id, array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'write' => ['user:' . $this->getUser()['$id']],
]);

if ($this->getSide() == 'server') {
$this->assertEquals($document['headers']['status-code'], 200);
$this->assertCount(1, $document['body']['$read']);
$this->assertCount(1, $document['body']['$write']);
$this->assertEquals(['user:' . $this->getUser()['$id']], $document['body']['$read']);
$this->assertEquals(['user:' . $this->getUser()['$id']], $document['body']['$write']);
}

// remove collection
$this->client->call(Client::METHOD_DELETE, '/database/collections/' . $moviesId, array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()));

return [];
}
}