Merge pull request #639 from utopia-php/null-permissions

Fix encoding decoding

Author: abnegate

src/Database/Database.php

@@ -6313,12 +6313,9 @@ public function encode(Document $collection, Document $document): Document
     {
         $attributes = $collection->getAttribute('attributes', []);
 
-        $internalAttributes = \array_filter(Database::INTERNAL_ATTRIBUTES, function ($attribute) {
-            // We don't want to encode permissions into a JSON string
-            return $attribute['$id'] !== '$permissions';
-        });
-
-        $attributes = \array_merge($attributes, $internalAttributes);
+        foreach ($this->getInternalAttributes() as $attribute) {
+            $attributes[] = $attribute;
+        }
 
         foreach ($attributes as $attribute) {
             $key = $attribute['$id'] ?? '';
@@ -6327,6 +6324,13 @@ public function encode(Document $collection, Document $document): Document
             $filters = $attribute['filters'] ?? [];
             $value = $document->getAttribute($key);
 
+            if ($key === '$permissions') {
+                if (empty($value)) {
+                    $document->setAttribute('$permissions', []); // set default value
+                }
+                continue;
+            }
+
             // Continue on optional param with no default
             if (is_null($value) && is_null($default)) {
                 continue;
@@ -6394,7 +6398,9 @@ public function decode(Document $collection, Document $document, array $selectio
             }
         }
 
-        $attributes = \array_merge($attributes, $this->getInternalAttributes());
+        foreach ($this->getInternalAttributes() as $attribute) {
+            $attributes[] = $attribute;
+        }
 
         foreach ($attributes as $attribute) {
             $key = $attribute['$id'] ?? '';
@@ -6413,10 +6419,11 @@ public function decode(Document $collection, Document $document, array $selectio
             $value = ($array) ? $value : [$value];
             $value = (is_null($value)) ? [] : $value;
 
-            foreach ($value as &$node) {
-                foreach (\array_reverse($filters) as $filter) {
+            foreach ($value as $index => $node) {
+                foreach (array_reverse($filters) as $filter) {
                     $node = $this->decodeAttribute($filter, $node, $document, $key);
                 }
+                $value[$index] = $node;
             }
 
             if (
@@ -6447,7 +6454,9 @@ public function casting(Document $collection, Document $document): Document
 
         $attributes = $collection->getAttribute('attributes', []);
 
-        $attributes = \array_merge($attributes, $this->getInternalAttributes());
+        foreach ($this->getInternalAttributes() as $attribute) {
+            $attributes[] = $attribute;
+        }
 
         foreach ($attributes as $attribute) {
             $key = $attribute['$id'] ?? '';
@@ -6466,7 +6475,7 @@ public function casting(Document $collection, Document $document): Document
                 $value = [$value];
             }
 
-            foreach ($value as &$node) {
+            foreach ($value as $index => $node) {
                 switch ($type) {
                     case self::VAR_BOOLEAN:
                         $node = (bool)$node;
@@ -6480,6 +6489,8 @@ public function casting(Document $collection, Document $document): Document
                     default:
                         break;
                 }
+
+                $value[$index] = $node;
             }
 
             $document->setAttribute($key, ($array) ? $value : $value[0]);

src/Database/Document.php

@@ -27,11 +27,11 @@ class Document extends ArrayObject
      */
     public function __construct(array $input = [])
     {
-        if (isset($input['$id']) && !\is_string($input['$id'])) {
+        if (array_key_exists('$id', $input) && !\is_string($input['$id'])) {
             throw new StructureException('$id must be of type string');
         }
 
-        if (isset($input['$permissions']) && !is_array($input['$permissions'])) {
+        if (array_key_exists('$permissions', $input) && !is_array($input['$permissions'])) {
             throw new StructureException('$permissions must be of type array');
         }
 

tests/e2e/Adapter/Scopes/PermissionTests.php

@@ -14,6 +14,40 @@
 
 trait PermissionTests
 {
+    public function testCreateDocumentsEmptyPermission(): void
+    {
+        /** @var Database $database */
+        $database = static::getDatabase();
+
+        $database->createCollection(__FUNCTION__);
+
+        /**
+         * Validate the decode function does not add $permissions null entry when no permissions are provided
+         */
+
+        $document = $database->createDocument(__FUNCTION__, new Document());
+
+        $this->assertArrayHasKey('$permissions', $document);
+        $this->assertEquals([], $document->getAttribute('$permissions'));
+
+        $documents = [];
+
+        for ($i = 0; $i < 2; $i++) {
+            $documents[] = new Document();
+        }
+
+        $results = [];
+        $count = $database->createDocuments(__FUNCTION__, $documents, onNext: function ($doc) use (&$results) {
+            $results[] = $doc;
+        });
+
+        $this->assertEquals(2, $count);
+        foreach ($results as $result) {
+            $this->assertArrayHasKey('$permissions', $result);
+            $this->assertEquals([], $result->getAttribute('$permissions'));
+        }
+    }
+
     public function testReadPermissionsFailure(): Document
     {
         Authorization::cleanRoles();