Merge pull request #99 from utopia-php/fix-query-on-

Fix: query on $id

Author: TorstenDittmann

src/Database/Adapter/MariaDB.php

@@ -580,6 +580,9 @@ public function find(string $collection, array $queries = [], int $limit = 25, i
         $permissions = (Authorization::$status) ? $this->getSQLPermissions($roles) : '1=1'; // Disable join when no authorization required
 
         foreach($queries as $i => $query) {
+            if($query->getAttribute() === '$id') {
+                $query->setAttribute('_uid');
+            }
             $conditions = [];
             foreach ($query->getValues() as $key => $value) {
                 $conditions[] = $this->getSQLCondition('table_main.'.$query->getAttribute(), $query->getOperator(), ':attribute_'.$i.'_'.$key.'_'.$query->getAttribute(), $value);
@@ -658,6 +661,9 @@ public function count(string $collection, array $queries = [], int $max = 0): in
         $permissions = (Authorization::$status) ? $this->getSQLPermissions($roles) : '1=1'; // Disable join when no authorization required
 
         foreach($queries as $i => $query) {
+            if($query->getAttribute() === '$id') {
+                $query->setAttribute('_uid');
+            }
             $conditions = [];
             foreach ($query->getValues() as $key => $value) {
                 $conditions[] = $this->getSQLCondition('table_main.'.$query->getAttribute(), $query->getOperator(), ':attribute_'.$i.'_'.$key.'_'.$query->getAttribute(), $value);
@@ -713,6 +719,9 @@ public function sum(string $collection, string $attribute, array $queries = [],
         $permissions = (Authorization::$status) ? $this->getSQLPermissions($roles) : '1=1'; // Disable join when no authorization required
 
         foreach($queries as $i => $query) {
+            if($query->getAttribute() === '$id') {
+                $query->setAttribute('_uid');
+            }
             $conditions = [];
             foreach ($query->getValues() as $key => $value) {
                 $conditions[] = $this->getSQLCondition('table_main.'.$query->getAttribute(), $query->getOperator(), ':attribute_'.$i.'_'.$key.'_'.$query->getAttribute(), $value);

src/Database/Adapter/MongoDB.php

@@ -695,6 +695,9 @@ protected function buildFilters($queries): array
         $filters = [];
 
         foreach($queries as $i => $query) {
+            if($query->getAttribute() === '$id') {
+                $query->setAttribute('_uid');
+            }
             $attribute = $query->getAttribute();
             $operator = $this->getQueryOperator($query->getOperator()); 
             $value = (count($query->getValues()) > 1) ? $query->getValues() : $query->getValues()[0]; 

src/Database/Query.php

@@ -16,17 +16,17 @@ class Query
     /**
      * @var string
      */
-    protected $attribute = '';
+    protected string $attribute = '';
 
     /**
      * @var string
      */
-    protected $operator = '';
+    protected string $operator = '';
 
     /**
      * @var (mixed)[]
      */
-    protected $values;
+    protected array $values;
 
     /**
      * Construct.
@@ -67,9 +67,9 @@ public function getOperator(): string
     /**
      * Get operand
      *
-     * @return mixed
+     * @return array
      */
-    public function getValues()
+    public function getValues(): array
     {
         return $this->values;
     }
@@ -88,6 +88,42 @@ public function getQuery(): array
         ];
     }
 
+    /**
+     * Set attribute
+     *
+     * @return self
+     */
+    public function setAttribute(string $attribute): self
+    {
+        $this->attribute = $attribute;
+
+        return $this;
+    }
+
+    /**
+     * Set operator
+     *
+     * @return self
+     */
+    public function setOperator(string $operator): self
+    {
+        $this->operator = $operator;
+
+        return $this;
+    }
+
+    /**
+     * Set operand
+     *
+     * @return self
+     */
+    public function setValues(array $values): self
+    {
+        $this->values = $values;
+
+        return $this;
+    }
+
     /**
      * Check if operator is supported
      *

src/Database/Validator/Queries.php

@@ -41,6 +41,11 @@ public function __construct($validator, $indexes, $strict = true)
     {
         $this->validator = $validator;
 
+        $this->indexes[] = [
+            'type' => Database::INDEX_UNIQUE,
+            'attributes' => ['$id']
+        ];
+
         foreach ($indexes as $index) {
             $this->indexes[] = $index->getArrayCopy(['attributes', 'type']);
         }

src/Database/Validator/QueryValidator.php

@@ -2,6 +2,7 @@
 
 namespace Utopia\Database\Validator;
 
+use Utopia\Database\Database;
 use Utopia\Validator;
 use Utopia\Database\Document;
 use Utopia\Database\Query;
@@ -39,6 +40,13 @@ class QueryValidator extends Validator
      */
     public function __construct(array $attributes)
     {
+        $this->schema[] = [
+            'key' => '$id',
+            'array' => false,
+            'type' => Database::VAR_STRING,
+            'size' => 512
+        ];
+
         foreach ($attributes as $attribute) {
             $this->schema[] = $attribute->getArrayCopy();
         }

tests/Database/Base.php

@@ -609,6 +609,7 @@ public function testFind(Document $document)
         $this->assertEquals(true, static::getDatabase()->createAttribute('movies', 'generes', Database::VAR_STRING, 32, true, null, true, true));
 
         static::getDatabase()->createDocument('movies', new Document([
+            '$id' => 'frozen',
             '$read' => ['role:all', 'user1', 'user2'],
             '$write' => ['role:all', 'user1x', 'user2x'],
             'name' => 'Frozen',
@@ -798,6 +799,16 @@ public function testFind(Document $document)
         $this->assertEquals('Frozen II', $documents[0]['name']);
         $this->assertEquals('Captain Marvel', $documents[1]['name']);
 
+        /**
+         * $id condition
+         */
+        $documents = static::getDatabase()->find('movies', [
+            new Query('$id', Query::TYPE_EQUAL, ['frozen']),
+        ]);
+
+        $this->assertEquals(1, count($documents));
+        $this->assertEquals('Frozen', $documents[0]['name']);
+
         /**
          * ORDER BY
          */

tests/Database/Validator/QueryValidatorTest.php

@@ -97,6 +97,7 @@ public function testQuery()
     {
         $validator = new QueryValidator($this->schema);
 
+        $this->assertEquals(true, $validator->isValid(Query::parse('$id.equal("Iron Man", "Ant Man")')));
         $this->assertEquals(true, $validator->isValid(Query::parse('title.notEqual("Iron Man", "Ant Man")')));
         $this->assertEquals(true, $validator->isValid(Query::parse('description.equal("Best movie ever")')));
         $this->assertEquals(true, $validator->isValid(Query::parse('rating.greater(4)')));