Primary attributes

phpunit.xml

@@ -7,7 +7,7 @@
     convertNoticesToExceptions="true"
     convertWarningsToExceptions="true"
     processIsolation="false"
-    stopOnFailure="false"
+    stopOnFailure="true"
 >
     <testsuites>
         <testsuite name="unit">

src/Database/Adapter.php

@@ -854,6 +854,13 @@ abstract public function getMaxIndexLength(): int;
      */
     abstract public function getMinDateTime(): \DateTime;
 
+    /**
+     * Get Id's attribute primitive type int or string
+     *
+     * @return string
+     */
+    abstract public function getIdAttributeType(): string;
+
     /**
      * Get the maximum supported DateTime value
      *

src/Database/Adapter/MariaDB.php

@@ -1904,6 +1904,9 @@ protected function getSQLType(string $type, int $size, bool $signed = true, bool
         }
 
         switch ($type) {
+            case Database::VAR_ID:
+                return 'bigint UNSIGNED';
+
             case Database::VAR_STRING:
                 // $size = $size * 4; // Convert utf8mb4 size to bytes
                 if ($size > 16777215) {

src/Database/Adapter/Pool.php

@@ -489,4 +489,9 @@ protected function execute(mixed $stmt): bool
     {
         return $this->delegate(__FUNCTION__, \func_get_args());
     }
+
+    public function getIdAttributeType(): string
+    {
+        return $this->delegate(__FUNCTION__, \func_get_args());
+    }
 }

src/Database/Adapter/Postgres.php

@@ -1817,6 +1817,9 @@ protected function getSQLType(string $type, int $size, bool $signed = true, bool
         }
 
         switch ($type) {
+            case Database::VAR_ID:
+                return 'bigint';
+
             case Database::VAR_STRING:
                 // $size = $size * 4; // Convert utf8mb4 size to bytes
                 if ($size > $this->getMaxVarcharLength()) {

src/Database/Adapter/SQL.php

@@ -1003,6 +1003,11 @@ public function getAttributeWidth(Document $collection): int
             }
 
             switch ($attribute['type']) {
+                case Database::VAR_SEQUENCE:
+                case Database::VAR_ID:
+                    $total += 8; //  BIGINT 8 bytes
+                    break;
+
                 case Database::VAR_STRING:
                     /**
                      * Text / Mediumtext / Longtext
@@ -1577,6 +1582,14 @@ public function getMaxVarcharLength(): int
         return 16381; // Floor value for Postgres:16383 | MySQL:16381 | MariaDB:16382
     }
 
+    /**
+     * @return string
+     */
+    public function getIdAttributeType(): string
+    {
+        return Database::VAR_ID_INT;
+    }
+
     /**
      * @return int
      */

src/Database/Database.php

@@ -40,6 +40,12 @@ class Database
     public const VAR_FLOAT = 'double';
     public const VAR_BOOLEAN = 'boolean';
     public const VAR_DATETIME = 'datetime';
+    public const VAR_ID = 'id';
+    public const VAR_SEQUENCE = 'sequence';
+
+    // VAR_ID types
+    public const VAR_ID_INT = 'integer_';
+    public const VAR_ID_MONGO = 'mongo_';
 
     public const INT_MAX = 2147483647;
     public const BIG_INT_MAX = PHP_INT_MAX;
@@ -166,8 +172,8 @@ class Database
         ],
         [
             '$id' => '$sequence',
-            'type' => self::VAR_STRING,
-            'size' => Database::LENGTH_KEY,
+            'type' => self::VAR_SEQUENCE,
+            'size' => 0,
             'required' => true,
             'signed' => true,
             'array' => false,
@@ -1787,6 +1793,9 @@ private function validateAttribute(
         $this->checkAttribute($collection, $attribute);
 
         switch ($type) {
+            case self::VAR_ID:
+
+                break;
             case self::VAR_STRING:
                 if ($size > $this->adapter->getLimitForString()) {
                     throw new DatabaseException('Max size allowed for string is: ' . number_format($this->adapter->getLimitForString()));
@@ -3646,6 +3655,7 @@ public function createDocument(string $collection, Document $document): Document
 
         $structure = new Structure(
             $collection,
+            $this->adapter->getIdAttributeType(),
             $this->adapter->getMinDateTime(),
             $this->adapter->getMaxDateTime(),
         );
@@ -3734,6 +3744,7 @@ public function createDocuments(
 
             $validator = new Structure(
                 $collection,
+                $this->adapter->getIdAttributeType(),
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
             );
@@ -4264,6 +4275,7 @@ public function updateDocument(string $collection, string $id, Document $documen
 
             $structureValidator = new Structure(
                 $collection,
+                $this->adapter->getIdAttributeType(),
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
             );
@@ -4346,6 +4358,7 @@ public function updateDocuments(
             $validator = new DocumentsValidator(
                 $attributes,
                 $indexes,
+                $this->adapter->getIdAttributeType(),
                 $this->maxQueryValues,
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
@@ -4381,6 +4394,7 @@ public function updateDocuments(
         // Check new document structure
         $validator = new PartialStructure(
             $collection,
+            $this->adapter->getIdAttributeType(),
             $this->adapter->getMinDateTime(),
             $this->adapter->getMaxDateTime(),
         );
@@ -5018,6 +5032,7 @@ public function createOrUpdateDocumentsWithIncrease(
 
             $validator = new Structure(
                 $collection,
+                $this->adapter->getIdAttributeType(),
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
             );
@@ -5794,6 +5809,7 @@ public function deleteDocuments(
             $validator = new DocumentsValidator(
                 $attributes,
                 $indexes,
+                $this->adapter->getIdAttributeType(),
                 $this->maxQueryValues,
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime()
@@ -5985,6 +6001,7 @@ public function find(string $collection, array $queries = [], string $forPermiss
             $validator = new DocumentsValidator(
                 $attributes,
                 $indexes,
+                $this->adapter->getIdAttributeType(),
                 $this->maxQueryValues,
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
@@ -6238,6 +6255,7 @@ public function count(string $collection, array $queries = [], ?int $max = null)
             $validator = new DocumentsValidator(
                 $attributes,
                 $indexes,
+                $this->adapter->getIdAttributeType(),
                 $this->maxQueryValues,
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),
@@ -6288,6 +6306,7 @@ public function sum(string $collection, string $attribute, array $queries = [],
             $validator = new DocumentsValidator(
                 $attributes,
                 $indexes,
+                $this->adapter->getIdAttributeType(),
                 $this->maxQueryValues,
                 $this->adapter->getMinDateTime(),
                 $this->adapter->getMaxDateTime(),

src/Database/Validator/Queries/Documents.php

@@ -20,11 +20,13 @@ class Documents extends IndexedQueries
      *
      * @param array<mixed> $attributes
      * @param array<mixed> $indexes
+     * @param string $idAttributeType
      * @throws Exception
      */
     public function __construct(
         array $attributes,
         array $indexes,
+        string $idAttributeType,
         int $maxValuesCount = 100,
         \DateTime $minAllowedDate = new \DateTime('0000-01-01'),
         \DateTime $maxAllowedDate = new \DateTime('9999-12-31'),
@@ -38,7 +40,7 @@ public function __construct(
         $attributes[] = new Document([
             '$id' => '$sequence',
             'key' => '$sequence',
-            'type' => Database::VAR_STRING,
+            'type' => Database::VAR_SEQUENCE,
             'array' => false,
         ]);
         $attributes[] = new Document([
@@ -60,6 +62,7 @@ public function __construct(
             new Cursor(),
             new Filter(
                 $attributes,
+                $idAttributeType,
                 $maxValuesCount,
                 $minAllowedDate,
                 $maxAllowedDate,

src/Database/Validator/Query/Filter.php

@@ -6,6 +6,7 @@
 use Utopia\Database\Document;
 use Utopia\Database\Query;
 use Utopia\Database\Validator\Datetime as DatetimeValidator;
+use Utopia\Database\Validator\Sequence;
 use Utopia\Validator\Boolean;
 use Utopia\Validator\FloatValidator;
 use Utopia\Validator\Integer;
@@ -25,7 +26,8 @@ class Filter extends Base
      * @param \DateTime $maxAllowedDate
      */
     public function __construct(
-        array $attributes = [],
+        array $attributes,
+        private readonly string $idAttributeType,
         private readonly int $maxValuesCount = 100,
         private readonly \DateTime $minAllowedDate = new \DateTime('0000-01-01'),
         private readonly \DateTime $maxAllowedDate = new \DateTime('9999-12-31'),
@@ -106,6 +108,14 @@ protected function isValidAttributeAndValues(string $attribute, array $values, s
             $validator = null;
 
             switch ($attributeType) {
+                case Database::VAR_SEQUENCE:
+                    $validator = new Sequence($this->idAttributeType, true);
+                    break;
+
+                case Database::VAR_ID:
+                    $validator = new Sequence($this->idAttributeType, false);
+                    break;
+
                 case Database::VAR_STRING:
                     $validator = new Text(0, 0);
                     break;

src/Database/Validator/Sequence.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Utopia\Database\Validator;
+
+use Utopia\Database\Database;
+use Utopia\Validator;
+use Utopia\Validator\Integer;
+use Utopia\Validator\Range;
+
+class Sequence extends Validator
+{
+    private string $idAttributeType;
+    private bool $primary;
+
+    public function getDescription(): string
+    {
+        return 'Invalid sequence value';
+    }
+
+    /**
+     * Expression constructor
+     */
+    public function __construct(string $idAttributeType, bool $primary)
+    {
+        $this->primary = $primary;
+        $this->idAttributeType = $idAttributeType;
+    }
+
+    public function isArray(): bool
+    {
+        return false;
+    }
+
+    public function getType(): string
+    {
+        return self::TYPE_STRING;
+    }
+
+    public function isValid($value): bool
+    {
+        if ($this->primary && empty($value)) {
+            return false;
+        }
+
+        if (gettype($value) !== 'string') {
+            return false;
+        }
+
+        if ($this->idAttributeType === Database::VAR_ID_MONGO) {
+            return preg_match('/^[a-f0-9]{24}$/i', $value) === 1;
+        } elseif ($this->idAttributeType === Database::VAR_ID_INT) {
+            $validator = new Integer(loose: true);
+            if (!$validator->isValid($value)) {
+                return false;
+            }
+
+            $start = ($this->primary) ? 1 : 0;
+
+            $validator = new Range($start, Database::BIG_INT_MAX, Database::VAR_INTEGER);
+            if (!$validator->isValid($value)) {
+                return false;
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+}

src/Database/Validator/Structure.php

@@ -32,8 +32,8 @@ class Structure extends Validator
         ],
         [
             '$id' => '$sequence',
-            'type' => Database::VAR_STRING,
-            'size' => 255,
+            'type' => Database::VAR_SEQUENCE,
+            'size' => 0,
             'required' => false,
             'signed' => true,
             'array' => false,
@@ -50,7 +50,7 @@ class Structure extends Validator
         ],
         [
             '$id' => '$tenant',
-            'type' => Database::VAR_INTEGER,
+            'type' => Database::VAR_INTEGER, // ?????
             'size' => 8,
             'required' => false,
             'default' => null,
@@ -103,6 +103,7 @@ class Structure extends Validator
      */
     public function __construct(
         protected readonly Document $collection,
+        private readonly string $idAttributeType,
         private readonly \DateTime $minAllowedDate = new \DateTime('0000-01-01'),
         private readonly \DateTime $maxAllowedDate = new \DateTime('9999-12-31'),
     ) {
@@ -315,6 +316,14 @@ protected function checkForInvalidAttributeValues(array $structure, array $keys)
             $validators = [];
 
             switch ($type) {
+                case Database::VAR_SEQUENCE:
+                    $validators[] = new Sequence($this->idAttributeType, true);
+                    break;
+
+                case Database::VAR_ID:
+                    $validators[] = new Sequence($this->idAttributeType, false);
+                    break;
+
                 case Database::VAR_STRING:
                     $validators[] = new Text($size, min: 0);
                     break;