Refactor index validation and enhance support checks in Database and Validator classes

Author: ArnabChatterjee20k

src/Database/Database.php

@@ -87,18 +87,6 @@ class Database
     public const INDEX_HNSW_DOT = 'hnsw_dot';
     public const INDEX_TRIGRAM = 'trigram';
 
-    public const VALID_INDEX_TYPES = [
-        self::INDEX_KEY,
-        self::INDEX_UNIQUE,
-        self::INDEX_FULLTEXT,
-        self::INDEX_SPATIAL,
-        self::INDEX_OBJECT,
-        self::INDEX_HNSW_EUCLIDEAN,
-        self::INDEX_HNSW_COSINE,
-        self::INDEX_HNSW_DOT,
-        self::INDEX_TRIGRAM,
-    ];
-
     // Max limits
     public const MAX_INT = 2147483647;
     public const MAX_BIG_INT = PHP_INT_MAX;
@@ -3646,13 +3634,6 @@ public function createIndex(string $collection, string $id, string $type, array
             throw new LimitException('Index limit reached. Cannot create new index.');
         }
 
-        if (!\in_array($type, self::VALID_INDEX_TYPES, true)) {
-            throw new DatabaseException(
-                'Unknown index type: ' . $type . '. Must be one of ' .
-                \implode(', ', \array_map(fn ($t) => $t, self::VALID_INDEX_TYPES))
-            );
-        }
-
         /** @var array<Document> $collectionAttributes */
         $collectionAttributes = $collection->getAttribute('attributes', []);
         $indexAttributesWithTypes = [];

src/Database/Validator/Index.php

@@ -108,6 +108,9 @@ public function isArray(): bool
      */
     public function isValid($value): bool
     {
+        if (!$this->checkValidIndex($value)) {
+            return false;
+        }
         if (!$this->checkValidAttributes($value)) {
             return false;
         }
@@ -156,6 +159,76 @@ public function isValid($value): bool
         return true;
     }
 
+    /**
+     * @param Document $index
+     * @return bool
+    */
+    public function checkValidIndex(Document $index): bool
+    {
+        $type = $index->getAttribute('type');
+        switch ($type) {
+            case Database::INDEX_KEY:
+                if (!$this->supportForKeyIndexes) {
+                    $this->message = 'Key index is not supported';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_UNIQUE:
+                if (!$this->supportForUniqueIndexes) {
+                    $this->message = 'Unique index is not supported';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_FULLTEXT:
+                if (!$this->supportForFulltextIndexes) {
+                    $this->message = 'Fulltext index is not supported';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_SPATIAL:
+                if (!$this->supportForSpatialIndexes) {
+                    $this->message = 'Spatial indexes are not supported';
+                    return false;
+                }
+                if (!empty($index->getAttribute('orders')) && !$this->supportForSpatialIndexOrder) {
+                    $this->message = 'Spatial indexes with explicit orders are not supported. Remove the orders to create this index.';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_HNSW_EUCLIDEAN:
+            case Database::INDEX_HNSW_COSINE:
+            case Database::INDEX_HNSW_DOT:
+                if (!$this->supportForVectorIndexes) {
+                    $this->message = 'Vector indexes are not supported';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_OBJECT:
+                if (!$this->supportForObjectIndexes) {
+                    $this->message = 'Object indexes are not supported';
+                    return false;
+                }
+                break;
+
+            case Database::INDEX_TRIGRAM:
+                if (!$this->supportForTrigramIndexes) {
+                    $this->message = 'Trigram indexes are not supported';
+                    return false;
+                }
+                break;
+
+            default:
+                $this->message = 'Unknown index type: ' . $type . '. Must be one of ' . Database::INDEX_KEY . ', ' . Database::INDEX_UNIQUE . ', ' . Database::INDEX_FULLTEXT . ', ' . Database::INDEX_SPATIAL . ', ' . Database::INDEX_OBJECT . ', ' . Database::INDEX_HNSW_EUCLIDEAN . ', ' . Database::INDEX_HNSW_COSINE . ', ' . Database::INDEX_HNSW_DOT . ', '.Database::INDEX_TRIGRAM;
+                return false;
+        }
+        return true;
+    }
+
     /**
      * @param Document $index
      * @return bool
@@ -539,11 +612,6 @@ public function checkKeyUniqueFulltextSupport(Document $index): bool
             return false;
         }
 
-        if ($type === Database::INDEX_FULLTEXT && $this->supportForFulltextIndexes === false) {
-            $this->message = 'Fulltext index is not supported';
-            return false;
-        }
-
         return true;
     }
 

tests/e2e/Adapter/Scopes/AttributeTests.php

@@ -1531,7 +1531,7 @@ public function testArrayAttribute(): void
         if ($database->getAdapter()->getSupportForIndexArray()) {
             if ($database->getAdapter()->getSupportForAttributes() && $database->getAdapter()->getMaxIndexLength() > 0) {
                 // If getMaxIndexLength() > 0 We clear length for array attributes
-                $database->createIndex($collection, 'indx1', Database::INDEX_KEY, ['long_size'], [], []);
+                $database->createIndex($collection, 'indx1', Database::INDEX_KEY, ['long_size'], [100], []);
                 $database->deleteIndex($collection, 'indx1');
                 $database->createIndex($collection, 'indx2', Database::INDEX_KEY, ['long_size'], [1000], []);
 

tests/e2e/Adapter/Scopes/IndexTests.php

@@ -267,7 +267,7 @@ public function testIndexValidation(): void
             $database->getAdapter()->getSupportForAttributes(),
             $database->getAdapter()->getSupportForMultipleFulltextIndexes(),
             $database->getAdapter()->getSupportForIdenticalIndexes(),
-            false,
+            $database->getAdapter()->getSupportForObject(),
             $database->getAdapter()->getSupportForTrigramIndex()
         );
 
@@ -285,7 +285,7 @@ public function testIndexValidation(): void
                 $this->fail('Failed to throw exception');
             }
         } catch (Exception $e) {
-            $this->assertEquals('Attribute "integer" cannot be part of a fulltext index, must be of type string', $e->getMessage());
+            $this->assertEquals('Fulltext index is not supported', $e->getMessage());
         }