Merge branch 'main' of github.com:utopia-php/database into index-sequence-attribute

Author: fogelito

composer.json

@@ -40,7 +40,7 @@
         "ext-redis": "*",
         "utopia-php/validators": "^0.5",
         "utopia-php/console": "0.1.*",
-        "utopia-php/cache": "^4.0.0",
+        "utopia-php/cache": "^4.0 || ^5.0",
         "utopia-php/pools": "2.*",
         "utopia-php/mongo": "1.*"
     },

composer.lock

@@ -9347,6 +9347,14 @@ public function decode(Document $collection, Document $document, array $selectio
             $attributes[] = $attribute;
         }
 
+        $hasRelationshipSelections = false;
+        foreach ($selections as $selection) {
+            if (\str_contains($selection, '.')) {
+                $hasRelationshipSelections = true;
+                break;
+            }
+        }
+
         foreach ($attributes as $attribute) {
             $key = $attribute['$id'] ?? '';
             $type = $attribute['type'] ?? '';
@@ -9379,34 +9387,26 @@ public function decode(Document $collection, Document $document, array $selectio
             $value = ($array) ? $value : [$value];
             $value = (is_null($value)) ? [] : $value;
 
-            foreach ($value as $index => $node) {
-                foreach (\array_reverse($filters) as $filter) {
-                    $node = $this->decodeAttribute($filter, $node, $document, $key);
+            $selected = empty($selections)
+                || \in_array($key, $selections)
+                || \in_array('*', $selections);
+
+            if ($selected || $hasRelationshipSelections) {
+                foreach ($value as $index => $node) {
+                    foreach (\array_reverse($filters) as $filter) {
+                        $node = $this->decodeAttribute($filter, $node, $document, $key);
+                    }
+                    $value[$index] = $node;
                 }
-                $value[$index] = $node;
             }
 
             $filteredValue[$key] = ($array) ? $value : $value[0];
 
-            if (
-                empty($selections)
-                || \in_array($key, $selections)
-                || \in_array('*', $selections)
-            ) {
+            if ($selected) {
                 $document->setAttribute($key, ($array) ? $value : $value[0]);
             }
         }
 
-        $hasRelationshipSelections = false;
-        if (!empty($selections)) {
-            foreach ($selections as $selection) {
-                if (\str_contains($selection, '.')) {
-                    $hasRelationshipSelections = true;
-                    break;
-                }
-            }
-        }
-
         if ($hasRelationshipSelections && !empty($selections) && !\in_array('*', $selections)) {
             foreach ($collection->getAttribute('attributes', []) as $attribute) {
                 $key = $attribute['$id'] ?? '';

src/Database/Database.php

@@ -1260,6 +1260,78 @@ function (mixed $value) {
         }
     }
 
+    /**
+     * A filter can build its value by querying rather than transforming the stored one — that is
+     * what the subQuery filters in Appwrite do, listing a child collection per document. Reading a
+     * document without selecting such an attribute must not run it: the value is dropped anyway,
+     * and it is the filter, not the value, that costs the query.
+     */
+    public function testFilterNotAppliedWhenAttributeNotSelected(): void
+    {
+        /** @var Database $database */
+        $database = $this->getDatabase();
+
+        $calls = 0;
+
+        $database->addFilter(
+            'subQueryProbe',
+            fn (mixed $value) => null, // stores nothing, like a subQuery filter
+            function (mixed $value) use (&$calls) {
+                $calls++;
+                return ['fanned', 'out'];
+            }
+        );
+
+        $database->createCollection('filterSelect');
+        $database->createAttribute('filterSelect', 'plain', Database::VAR_STRING, 128, false);
+        $database->createAttribute('filterSelect', 'kids', Database::VAR_STRING, 128, false, filters: ['subQueryProbe']);
+
+        $database->createDocument('filterSelect', new Document([
+            '$id' => 'doc1',
+            '$permissions' => [
+                Permission::read(Role::any()),
+                Permission::update(Role::any()),
+                Permission::delete(Role::any()),
+            ],
+            'plain' => 'x',
+        ]));
+
+        $calls = 0;
+        $document = $database->getDocument('filterSelect', 'doc1');
+        $this->assertEquals(1, $calls);
+        $this->assertEquals(['fanned', 'out'], $document->getAttribute('kids'));
+
+        $calls = 0;
+        $document = $database->getDocument('filterSelect', 'doc1', [Query::select(['$id', 'plain'])]);
+        $this->assertEquals(0, $calls);
+        $this->assertNull($document->getAttribute('kids'));
+        $this->assertEquals('x', $document->getAttribute('plain'));
+
+        // Selecting it explicitly, and selecting everything, both still decode it.
+        $calls = 0;
+        $document = $database->getDocument('filterSelect', 'doc1', [Query::select(['$id', 'kids'])]);
+        $this->assertEquals(1, $calls);
+        $this->assertEquals(['fanned', 'out'], $document->getAttribute('kids'));
+
+        $calls = 0;
+        $document = $database->getDocument('filterSelect', 'doc1', [Query::select(['*'])]);
+        $this->assertEquals(1, $calls);
+        $this->assertEquals(['fanned', 'out'], $document->getAttribute('kids'));
+
+        // find() decodes through the same path, once per document returned.
+        $calls = 0;
+        $documents = $database->find('filterSelect', [Query::select(['$id', 'plain'])]);
+        $this->assertCount(1, $documents);
+        $this->assertEquals(0, $calls);
+        $this->assertNull($documents[0]->getAttribute('kids'));
+
+        $calls = 0;
+        $documents = $database->find('filterSelect');
+        $this->assertCount(1, $documents);
+        $this->assertEquals(1, $calls);
+        $this->assertEquals(['fanned', 'out'], $documents[0]->getAttribute('kids'));
+    }
+
     public function updateStringAttributeSize(int $size, Document $document): Document
     {
         /** @var Database $database */