Add change class for upsert diffs

Author: abnegate

src/Database/Adapter.php

@@ -693,7 +693,7 @@ abstract public function updateDocuments(string $collection, Document $updates,
      *
      * @param string $collection
      * @param string $attribute
-     * @param array<string|int, array{old: Document, new: Document}> $documents
+     * @param array<Change> $documents
      * @return array<Document>
      */
     abstract public function createOrUpdateDocuments(

src/Database/Adapter/MariaDB.php

@@ -5,6 +5,7 @@
 use Exception;
 use PDO;
 use PDOException;
+use Utopia\Database\Change;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
 use Utopia\Database\Exception as DatabaseException;
@@ -1333,7 +1334,7 @@ public function updateDocument(string $collection, string $id, Document $documen
     /**
      * @param string $collection
      * @param string $attribute
-     * @param array<string|int, array{old: Document, new: Document}> $documents
+     * @param array<Change> $documents
      * @return array<Document>
      * @throws DatabaseException
      */
@@ -1357,8 +1358,8 @@ public function createOrUpdateDocuments(
             $documentIds = [];
             $documentTenants = [];
 
-            foreach ($documents as $document) {
-                $document = $document['new'];
+            foreach ($documents as $change) {
+                $document = $change->getNew();
                 $attributes = $document->getAttributes();
                 $attributes['_uid'] = $document->getId();
                 $attributes['_createdAt'] = $document->getCreatedAt();
@@ -1455,9 +1456,9 @@ public function createOrUpdateDocuments(
             $addQueries = [];
             $addBindValues = [];
 
-            foreach ($documents as $index => $document) {
-                $old = $document['old'];
-                $document = $document['new'];
+            foreach ($documents as $index => $change) {
+                $old = $change->getOld();
+                $document = $change->getNew();
 
                 $current = [];
                 foreach (Database::PERMISSIONS as $type) {
@@ -1530,16 +1531,17 @@ public function createOrUpdateDocuments(
             }
 
             $internalIds = $this->getInternalIds($collection, $documentIds, $documentTenants);
+
             foreach ($documents as $document) {
-                if (isset($internalIds[$document['new']->getId()])) {
-                    $document['new']['$internalId'] = $internalIds[$document['new']->getId()];
+                if (isset($internalIds[$document->getNew()->getId()])) {
+                    $document->getNew()->setAttribute('$internalId', $internalIds[$document->getNew()->getId()]);
                 }
             }
         } catch (PDOException $e) {
             throw $this->processException($e);
         }
 
-        return \array_map(fn ($document) => $document['new'], $documents);
+        return \array_map(fn ($change) => $change->getNew(), $documents);
     }
 
     /**

src/Database/Adapter/Postgres.php

@@ -5,6 +5,7 @@
 use Exception;
 use PDO;
 use PDOException;
+use Utopia\Database\Change;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
 use Utopia\Database\Exception as DatabaseException;
@@ -1381,12 +1382,12 @@ public function updateDocument(string $collection, string $id, Document $documen
     /**
      * @param string $collection
      * @param string $attribute
-     * @param array<array{old: Document, new: Document}> $documents
+     * @param array<Change> $documents
      * @return array<Document>
      */
     public function createOrUpdateDocuments(string $collection, string $attribute, array $documents): array
     {
-        return $documents;
+        return \array_map(fn ($change) => $change->getNew(), $documents);
     }
 
     /**

src/Database/Change.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Utopia\Database;
+
+class Change
+{
+    public function __construct(
+        protected Document $old,
+        protected Document $new,
+    ) {
+    }
+
+    public function getOld(): Document
+    {
+        return $this->old;
+    }
+
+    public function setOld(Document $old): void
+    {
+        $this->old = $old;
+    }
+
+    public function getNew(): Document
+    {
+        return $this->new;
+    }
+
+    public function setNew(Document $new): void
+    {
+        $this->new = $new;
+    }
+}

src/Database/Database.php

@@ -4742,21 +4742,21 @@ public function createOrUpdateDocumentsWithIncrease(
                 $document = $this->silent(fn () => $this->createDocumentRelationships($collection, $document));
             }
 
-            $documents[$key] = [
-                'old' => $old,
-                'new' => $document
-            ];
+            $documents[$key] = new Change(
+                old: $old,
+                new: $document
+            );
         }
 
         /**
-         * @var array<int|string, array{old: Document, new: Document}> $documents
+         * @var array<Change> $documents
          */
         $documents = $this->withTransaction(function () use ($collection, $attribute, $documents, $batchSize) {
             $stack = [];
 
             foreach (\array_chunk($documents, $batchSize) as $chunk) {
                 /**
-                 * @var array<int|string, array{old: Document, new: Document}> $chunk
+                 * @var array<Change> $chunk
                  */
                 \array_push(
                     $stack,
@@ -4771,7 +4771,13 @@ public function createOrUpdateDocumentsWithIncrease(
             return $stack;
         });
 
+        /**
+         * @var array<Document> $documents
+         */
         foreach ($documents as $key => $document) {
+            /**
+             * @var Document $document
+             */
             if ($this->resolveRelationships) {
                 $document = $this->silent(fn () => $this->populateDocumentRelationships($collection, $document));
             }