Add migrations and filters for 1.6.x

app/controllers/general.php

@@ -11,9 +11,10 @@ use Appwrite\Network\Validator\Origin;
 use Appwrite\Utopia\Request;
 use Appwrite\Utopia\Request\Filters\V16 as RequestV16;
 use Appwrite\Utopia\Request\Filters\V17 as RequestV17;
+use Appwrite\Utopia\Request\Filters\V18 as RequestV18;
 use Appwrite\Utopia\Response;
 use Appwrite\Utopia\Response\Filters\V16 as ResponseV16;
-use Appwrite\Utopia\Response\Filters\V17 as ResponseV17;
+use Appwrite\Utopia\Response\Filters\V18 as ResponseV18;
 use Appwrite\Utopia\View;
 use Executor\Executor;
 use MaxMind\Db\Reader;
@@ -434,6 +435,9 @@ App::init()
             if (version_compare($requestFormat, '1.5.0', '<')) {
                 $request->addFilter(new RequestV17());
             }
+            if (version_compare($requestFormat, '1.6.0', '<')) {
+                $request->addFilter(new RequestV18());
+            }
         }
 
         $domain = $request->getHostname();
@@ -550,6 +554,9 @@ App::init()
             if (version_compare($responseFormat, '1.5.0', '<')) {
                 $response->addFilter(new ResponseV17());
             }
+            if (version_compare($responseFormat, '1.6.0', '<')) {
+                $response->addFilter(new ResponseV18());
+            }
             if (version_compare($responseFormat, APP_VERSION_STABLE, '>')) {
                 $response->addHeader('X-Appwrite-Warning', "The current SDK is built for Appwrite " . $responseFormat . ". However, the current Appwrite server version is ". APP_VERSION_STABLE . ". Please downgrade your SDK to match the Appwrite version: https://appwrite.io/docs/sdks");
             }

src/Appwrite/Migration/Migration.php

@@ -86,6 +86,7 @@ abstract class Migration
         '1.5.5'  => 'V20',
         '1.5.6'  => 'V20',
         '1.5.7'  => 'V20',
+        '1.6.0' => 'V12'
     ];
 
     /**

src/Appwrite/Migration/Version/V21.php

@@ -0,0 +1,143 @@
+<?php
+
+namespace Appwrite\Migration\Version;
+
+use Appwrite\Migration\Migration;
+use Exception;
+use Throwable;
+use Utopia\CLI\Console;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+
+class V20 extends Migration
+{
+    /**
+     * @throws Throwable
+     */
+    public function execute(): void
+    {
+        /**
+         * Disable SubQueries for Performance.
+         */
+        foreach (['subQueryIndexes', 'subQueryPlatforms', 'subQueryDomains', 'subQueryKeys', 'subQueryWebhooks', 'subQuerySessions', 'subQueryTokens', 'subQueryMemberships', 'subQueryVariables', 'subQueryChallenges', 'subQueryProjectVariables', 'subQueryTargets', 'subQueryTopicTargets'] as $name) {
+            Database::addFilter(
+                $name,
+                fn () => null,
+                fn () => []
+            );
+        }
+
+        Console::log('Migrating Project: ' . $this->project->getAttribute('name') . ' (' . $this->project->getId() . ')');
+        $this->projectDB->setNamespace("_{$this->project->getInternalId()}");
+
+        Console::info('Migrating Collections');
+        $this->migrateCollections();
+
+        Console::info('Migrating Documents');
+        $this->forEachDocument([$this, 'fixDocument']);
+    }
+
+    /**
+     * Migrate Collections.
+     *
+     * @return void
+     * @throws Exception|Throwable
+     */
+    private function migrateCollections(): void
+    {
+        $internalProjectId = $this->project->getInternalId();
+        $collectionType = match ($internalProjectId) {
+            'console' => 'console',
+            default => 'projects',
+        };
+
+        $collections = $this->collections[$collectionType];
+        foreach ($collections as $collection) {
+            $id = $collection['$id'];
+
+            Console::log("Migrating Collection \"{$id}\"");
+
+            $this->projectDB->setNamespace("_$internalProjectId");
+
+            switch ($id) {
+                case 'projects':
+                    // Create accessedAt attribute
+                    try {
+                        $this->createAttributeFromCollection($this->projectDB, $id, 'accessedAt');
+                    } catch (Throwable $th) {
+                        Console::warning("'accessedAt' from {$id}: {$th->getMessage()}");
+                    }
+                    break;
+                case 'schedules':
+                    // Create data attribute
+                    try {
+                        $this->createAttributeFromCollection($this->projectDB, $id, 'data');
+                    } catch (Throwable $th) {
+                        Console::warning("'data' from {$id}: {$th->getMessage()}");
+                    }
+
+                    break;
+
+                case 'functions':
+                    // Create scopes attribute
+                    try {
+                        $this->createAttributeFromCollection($this->projectDB, $id, 'scopes');
+                    } catch (Throwable $th) {
+                        Console::warning("'scopes' from {$id}: {$th->getMessage()}");
+                    }
+
+                    break;
+                case 'executions':
+                    // Create requestMethod index
+                    try {
+                        $this->createIndexFromCollection($this->projectDB, $id, '_key_requestMethod');
+                    } catch (\Throwable $th) {
+                        Console::warning("'_key_requestMethod' from {$id}: {$th->getMessage()}");
+                    }
+
+                    // Create requestPath index
+                    try {
+                        $this->createIndexFromCollection($this->projectDB, $id, '_key_requestPath');
+                    } catch (\Throwable $th) {
+                        Console::warning("'_key_requestPath' from {$id}: {$th->getMessage()}");
+                    }
+
+                    // Create deployment index
+                    try {
+                        $this->createIndexFromCollection($this->projectDB, $id, '_key_deployment');
+                    } catch (\Throwable $th) {
+                        Console::warning("'_key_deployment' from {$id}: {$th->getMessage()}");
+                    }
+            }
+
+            usleep(50000);
+        }
+    }
+
+    /**
+     * Fix run on each document
+     *
+     * @param Document $document
+     * @return Document
+     */
+    protected function fixDocument(Document $document): Document
+    {
+        switch ($document->getCollection()) {
+            case 'projects':
+                /**
+                 * Bump version number.
+                 */
+                $document->setAttribute('version', '1.6.0');
+                break;
+            case 'functions':
+                /**
+                 * Add scopes attribute.
+                 */
+                if (!$document->getAttribute('scopes', false)) {
+                    $document->setAttribute('scopes', []);
+                }
+                break;
+        }
+        return $document;
+    }
+}

src/Appwrite/Utopia/Request/Filters/V18.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Appwrite\Utopia\Request\Filters;
+
+use Appwrite\Utopia\Request\Filter;
+
+class V18 extends Filter
+{
+    // Convert 1.5 params to 1.6
+    public function parse(array $content, string $model): array
+    {
+        switch ($model) {
+            case 'account.deleteMfaAuthenticator':
+                unset($content['otp']);
+                break;
+
+        }
+
+        return $content;
+    }
+}

src/Appwrite/Utopia/Response/Filters/V18.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Filters;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Filter;
+
+class V18 extends Filter
+{
+    // Convert 1.6 Data format to 1.5 format
+    public function parse(array $content, string $model): array
+    {
+        $parsedResponse = $content;
+
+        $parsedResponse = match($model) {
+            Response::MODEL_FUNCTION => $this->parseFunction($content),
+            Response::MODEL_PROJECT => $this->parseProject($content),
+            default => $parsedResponse,
+        };
+
+        return $parsedResponse;
+    }
+
+    protected function parseFunction(array $content)
+    {
+        unset($content['scopes']);
+        return $content;
+    }
+
+    protected function parseProject(array $content)
+    {
+        unset($content['authMockNumbers']);
+        unset($content['authSessionAlerts']);
+        return $content;
+    }
+}

tests/unit/Utopia/Request/Filters/V18Test.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Tests\Unit\Utopia\Request\Filters;
+
+use Appwrite\Utopia\Request\Filter;
+use Appwrite\Utopia\Request\Filters\V18;
+use PHPUnit\Framework\TestCase;
+
+class V18Test extends TestCase
+{
+    /**
+     * @var Filter
+     */
+    protected $filter;
+
+    public function setUp(): void
+    {
+        $this->filter = new V18();
+    }
+
+    public function tearDown(): void
+    {
+    }
+
+    public function deleteMfaAuthenticatorProvider()
+    {
+        return [
+            'remove otp' => [
+                [
+                    'type' => 'totp',
+                    'otp' => 1230
+                ],
+                [
+                    'type' => 'totp'
+                ]
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider deleteMfaAuthenticatorProvider
+     */
+    public function testdeleteMfaAuthenticator(array $content, array $expected): void
+    {
+        $model = 'account.deleteMfaAuthenticator';
+
+        $result = $this->filter->parse($content, $model);
+
+        $this->assertEquals($expected, $result);
+    }
+}

tests/unit/Utopia/Response/Filters/V18Test.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Tests\Unit\Utopia\Response\Filters;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Filters\V18;
+use PHPUnit\Framework\TestCase;
+
+class V18Test extends TestCase
+{
+    /**
+     * @var Filter
+     */
+    protected $filter = null;
+
+    public function setUp(): void
+    {
+        $this->filter = new V18();
+    }
+
+    public function tearDown(): void
+    {
+    }
+
+    public function functionProvider(): array
+    {
+        return [
+            'remove scopes' => [
+                [
+                    'scopes' => [
+                        'example_scope',
+                        'example_scope2',
+                    ],
+                ],
+                [
+                ]
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider functionProvider
+     */
+    public function testFunction(array $content, array $expected): void
+    {
+        $model = Response::MODEL_FUNCTION;
+
+        $result = $this->filter->parse($content, $model);
+
+        $this->assertEquals($expected, $result);
+    }
+
+    public function projectProvider(): array
+    {
+        return [
+            'remove authMockNumbers and authSessionAlerts' => [
+                [
+                    'authMockNumbers' => [
+                        'example_mock_number',
+                        'example_mock_number2',
+                    ],
+                    'authSessionAlerts' => [
+                        'example_alert',
+                        'example_alert2',
+                    ],
+                ],
+                [
+                ]
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider projectProvider
+     */
+    public function testProject(array $content, array $expected): void
+    {
+        $model = Response::MODEL_PROJECT;
+
+        $result = $this->filter->parse($content, $model);
+
+        $this->assertEquals($expected, $result);
+    }
+}