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.

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

Feat 5376 improve the select query #287

Closed
Closed
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
],
"test": [
"Composer\\Config::disableProcessTimeout",
"docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml"
"docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml --stop-on-failure"
],
"lint": "./vendor/bin/pint --test",
"format": "./vendor/bin/pint",
Expand Down
64 changes: 50 additions & 14 deletions src/Database/Adapter/MariaDB.php
Original file line number Diff line number Diff line change
Expand Up @@ -1046,17 +1046,31 @@ public function find(string $collection, array $queries = [], ?int $limit = 25,
$results = $stmt->fetchAll();

foreach ($results as $key => $value) {
$results[$key]['$id'] = $value['_uid'];
$results[$key]['$internalId'] = $value['_id'];
$results[$key]['$createdAt'] = $value['_createdAt'];
$results[$key]['$updatedAt'] = $value['_updatedAt'];
$results[$key]['$permissions'] = json_decode($value['_permissions'] ?? '[]', true);

unset($results[$key]['_uid']);
unset($results[$key]['_id']);
unset($results[$key]['_createdAt']);
unset($results[$key]['_updatedAt']);
unset($results[$key]['_permissions']);

if (isset($value['_uid'])) {
$results[$key]['$id'] = $value['_uid'];
unset($results[$key]['_uid']);
}

if (isset($value['_id'])) {
$results[$key]['$internalId'] = $value['_id'];
unset($results[$key]['_id']);
}

if (isset($value['_createdAt'])) {
$results[$key]['$createdAt'] = $value['_createdAt'];
unset($results[$key]['_createdAt']);
}

if (isset($value['_updatedAt'])) {
$results[$key]['$updatedAt'] = $value['_updatedAt'];
unset($results[$key]['_updatedAt']);
}

if (isset($value['_permissions'])) {
$results[$key]['$permissions'] = json_decode($value['_permissions'] ?? '[]', true);
unset($results[$key]['_permissions']);
}

$results[$key] = new Document($results[$key]);
}
Expand Down Expand Up @@ -1189,10 +1203,32 @@ protected function getAttributeProjection(array $selections, string $prefix = ''
return '*';
}

if (in_array('$id', $selections)) {
$index = array_search('$id', $selections);
$selections[$index] = '_uid';
faisalill marked this conversation as resolved.
Show resolved Hide resolved
}

if (in_array('$internalId', $selections)) {
$index = array_search('$internalId', $selections);
$selections[$index] = '_id';
}

if (in_array('$createdAt', $selections)) {
$index = array_search('$createdAt', $selections);
$selections[$index] = '_createdAt';
}

if (in_array('$updatedAt', $selections)) {
$index = array_search('$updatedAt', $selections);
$selections[$index] = '_updatedAt';
}

if (in_array('$permissions', $selections)) {
faisalill marked this conversation as resolved.
Show resolved Hide resolved
$index = array_search('$permissions', $selections);
$selections[$index] = '_permissions';
}

$selections[] = '_uid';
$selections[] = '_id';
$selections[] = '_createdAt';
$selections[] = '_updatedAt';
$selections[] = '_permissions';

if (!empty($prefix)) {
Expand Down
31 changes: 20 additions & 11 deletions src/Database/Adapter/Postgres.php
Original file line number Diff line number Diff line change
Expand Up @@ -1056,17 +1056,26 @@ public function find(string $collection, array $queries = [], ?int $limit = 25,
$results = $stmt->fetchAll();

foreach ($results as $key => $value) {
$results[$key]['$id'] = $value['_uid'];
$results[$key]['$internalId'] = $value['_id'];
$results[$key]['$createdAt'] = $value['_createdAt'];
$results[$key]['$updatedAt'] = $value['_updatedAt'];
$results[$key]['$permissions'] = json_decode($value['_permissions'] ?? '[]', true);

unset($results[$key]['_uid']);
unset($results[$key]['_id']);
unset($results[$key]['_createdAt']);
unset($results[$key]['_updatedAt']);
unset($results[$key]['_permissions']);
if(isset($value['_uid'])){
$results[$key]['$id'] = $value['_uid'];
unset($results[$key]['_uid']);
}
if(isset($value['_id'])){
$results[$key]['$internalId'] = $value['_id'];
unset($results[$key]['_id']);
}
if(isset($value['_createdAt'])){
$results[$key]['$createdAt'] = $value['_createdAt'];
unset($results[$key]['_createdAt']);
}
if(isset($value['_updatedAt'])){
$results[$key]['$updatedAt'] = $value['_updatedAt'];
unset($results[$key]['_updatedAt']);
}
if(isset($value['_permissions'])){
$results[$key]['$permissions'] = json_decode($value['_permissions'] ?? '[]', true);
unset($results[$key]['_permissions']);
}

$results[$key] = new Document($results[$key]);
}
Expand Down
35 changes: 24 additions & 11 deletions src/Database/Adapter/SQL.php
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,30 @@ public function getDocument(string $collection, string $id, array $queries = [])
return new Document([]);
}

$document['$id'] = $document['_uid'];
$document['$internalId'] = $document['_id'];
$document['$createdAt'] = $document['_createdAt'];
$document['$updatedAt'] = $document['_updatedAt'];
$document['$permissions'] = json_decode($document['_permissions'] ?? '[]', true);

unset($document['_id']);
unset($document['_uid']);
unset($document['_createdAt']);
unset($document['_updatedAt']);
unset($document['_permissions']);
if(isset($document['_uid'])){
$document['$id'] = $document['_uid'];
unset($document['_uid']);
}

if(isset($document['_id'])){
$document['$internalId'] = $document['_id'];
unset($document['_id']);
}

if(isset($document['_createdAt'])){
$document['$createdAt'] = $document['_createdAt'];
unset($document['_createdAt']);
}

if(isset($document['_updatedAt'])){
$document['$updatedAt'] = $document['_updatedAt'];
unset($document['_updatedAt']);
}

if(isset($document['_permissions'])){
$document['$permissions'] = json_decode($document['_permissions'] ?? '[]', true);
unset($document['_permissions']);
}

return new Document($document);
}
Expand Down
51 changes: 50 additions & 1 deletion src/Database/Database.php
Original file line number Diff line number Diff line change
Expand Up @@ -2263,6 +2263,26 @@ public function getDocument(string $collection, string $id, array $queries = [])

$this->trigger(self::EVENT_DOCUMENT_READ, $document);

foreach ($queries as $query){
if($query->getMethod() == Query::TYPE_SELECT){
$queriedValues = $query->getValues();
$defaultKeys = ['$id', '$internalId', '$permissions', '$createdAt', '$updatedAt', '$collection'];
faisalill marked this conversation as resolved.
Show resolved Hide resolved

foreach($queriedValues as $queriedValue){
if(in_array($queriedValue, $defaultKeys)){
$index = array_search($queriedValue, $defaultKeys);
unset($defaultKeys[$index]);
}
}

foreach($defaultKeys as $defaultKey){
if($document->isSet($defaultKey)){
$document->removeAttribute($defaultKey);
}
}
}
}

return $document;
}

Expand Down Expand Up @@ -3978,6 +3998,21 @@ public function find(string $collection, array $queries = [], ?int $timeout = nu

$this->trigger(self::EVENT_DOCUMENT_FIND, $results);

// remove default keys $id and $permissions from the results

foreach ($queries as $query) {
if($query->getMethod() === Query::TYPE_SELECT){
foreach ($results as $result) {
faisalill marked this conversation as resolved.
Show resolved Hide resolved
$result->removeAttribute('$id');
$result->removeAttribute('$permissions');
$result->removeAttribute('$collection');
$result->removeAttribute('$createdAt');
$result->removeAttribute('$updatedAt');
$result->removeAttribute('$internalId');
}
}
}

return $results;
}

Expand Down Expand Up @@ -4313,7 +4348,15 @@ public function decode(Document $collection, Document $document, array $selectio
}

if (empty($selections) || \in_array($key, $selections) || \in_array('*', $selections)) {
$document->setAttribute($key, ($array) ? $value : $value[0]);
if($key === '$createdAt' && $value[0] === NULL){
continue;
}
else if($key === '$updatedAt' && $value[0] === NULL){
continue;
}
else{
TorstenDittmann marked this conversation as resolved.
Show resolved Hide resolved
$document->setAttribute($key, ($array) ? $value : $value[0]);
}
}
}

Expand Down Expand Up @@ -4471,6 +4514,12 @@ private function validateSelections(Document $collection, array $queries): array
}
}

$keys[] = '$id';
$keys[] = '$internalId';
$keys[] = '$createdAt';
$keys[] = '$updatedAt';
$keys[] = '$permissions';
faisalill marked this conversation as resolved.
Show resolved Hide resolved

$invalid = \array_diff($selections, $keys);
if (!empty($invalid) && !\in_array('*', $invalid)) {
throw new DatabaseException('Cannot select attributes: ' . \implode(', ', $invalid));
Expand Down
37 changes: 28 additions & 9 deletions tests/Database/Base.php
Original file line number Diff line number Diff line change
Expand Up @@ -1016,7 +1016,9 @@ public function testGetDocument(Document $document): Document
*/
public function testGetDocumentSelect(Document $document): Document
{
$document = static::getDatabase()->getDocument('documents', $document->getId(), [
$documentId = $document->getId();

$document = static::getDatabase()->getDocument('documents', $documentId, [
Query::select(['string', 'integer']),
]);

Expand All @@ -1029,6 +1031,22 @@ public function testGetDocumentSelect(Document $document): Document
$this->assertArrayNotHasKey('boolean', $document->getAttributes());
$this->assertArrayNotHasKey('colors', $document->getAttributes());
$this->assertArrayNotHasKey('with-dash', $document->getAttributes());
$this->assertArrayNotHasKey('$id', $document);
$this->assertArrayNotHasKey('$internalId', $document);
$this->assertArrayNotHasKey('$collection', $document);
$this->assertArrayNotHasKey('$permissions', $document);
$this->assertArrayNotHasKey('$createdAt', $document);
$this->assertArrayNotHasKey('$updatedAt', $document);

$document = static::getDatabase()->getDocument('documents', $documentId, [
Query::select(['string', 'integer', '$id', '$internalId', '$permissions', '$createdAt', '$updatedAt']),
]);

$this->assertArrayHasKey('$id', $document);
$this->assertArrayHasKey('$internalId', $document);
$this->assertArrayHasKey('$permissions', $document);
$this->assertArrayHasKey('$createdAt', $document);
$this->assertArrayHasKey('$updatedAt', $document);

return $document;
}
Expand Down Expand Up @@ -2539,18 +2557,19 @@ public function testFindSelect(): void
$documents = static::getDatabase()->find('movies', [
Query::select(['name', 'year'])
]);

foreach ($documents as $document) {
$this->assertArrayHasKey('$id', $document);
$this->assertArrayHasKey('$internalId', $document);
$this->assertArrayHasKey('$collection', $document);
$this->assertArrayHasKey('$createdAt', $document);
$this->assertArrayHasKey('$updatedAt', $document);
$this->assertArrayHasKey('$permissions', $document);
$this->assertArrayHasKey('name', $document);
$this->assertArrayHasKey('year', $document);
$this->assertArrayNotHasKey('director', $document);
$this->assertArrayNotHasKey('price', $document);
$this->assertArrayNotHasKey('active', $document);
$this->assertArrayNotHasKey('director', $document);
$this->assertArrayNotHasKey('$id', $document);
$this->assertArrayNotHasKey('$internalId', $document);
$this->assertArrayNotHasKey('$collection', $document);
$this->assertArrayNotHasKey('$createdAt', $document);
$this->assertArrayNotHasKey('$updatedAt', $document);
$this->assertArrayNotHasKey('$permissions', $document);
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a test for the find method when selecting internal attributes


Expand Down Expand Up @@ -4156,7 +4175,7 @@ public function testOneToOneOneWayRelationship(): void
$this->assertArrayNotHasKey('area', $person->getAttribute('library'));

$person = static::getDatabase()->getDocument('person', 'person1', [
Query::select(['*', 'library.name'])
Query::select(['*', 'library.name', '$id'])
]);

$this->assertEquals('Library 1', $person->getAttribute('library')->getAttribute('name'));
faisalill marked this conversation as resolved.
Show resolved Hide resolved
Expand Down