Merge branch '1.5.x' into refactor-disallow-new-session-with-existing

app/controllers/api/account.php

@@ -333,7 +333,7 @@ App::get('/v1/account/sessions/oauth2/:provider')
     ->label('error', __DIR__ . '/../../views/general/error.phtml')
     ->label('scope', 'sessions.write')
     ->label('sdk.auth', [])
-    ->label('sdk.hideServer', true)
+    ->label('sdk.hide', [APP_PLATFORM_SERVER])
     ->label('sdk.namespace', 'account')
     ->label('sdk.method', 'createOAuth2Session')
     ->label('sdk.description', '/docs/references/account/create-session-oauth2.md')
@@ -403,7 +403,6 @@ App::get('/v1/account/tokens/oauth2/:provider')
     ->label('error', __DIR__ . '/../../views/general/error.phtml')
     ->label('scope', 'sessions.write')
     ->label('sdk.auth', [])
-    ->label('sdk.hideServer', true)
     ->label('sdk.namespace', 'account')
     ->label('sdk.method', 'createOAuth2Token')
     ->label('sdk.description', '/docs/references/account/create-token-oauth2.md')
@@ -1657,8 +1656,7 @@ $createSession = function (string $userId, string $secret, Request $request, Res
 };
 
 App::put('/v1/account/sessions/magic-url')
-    ->alias('/v1/account/sessions/phone')
-    ->desc('Create session (deprecated)')
+    ->desc('Update magic URL session')
     ->label('event', 'users.[userId].sessions.[sessionId].create')
     ->groups(['api', 'account'])
     ->label('scope', 'sessions.write')
@@ -1666,8 +1664,39 @@ App::put('/v1/account/sessions/magic-url')
     ->label('audits.resource', 'user/{response.userId}')
     ->label('audits.userId', '{response.userId}')
     ->label('sdk.auth', [])
+    ->label('sdk.deprecated', true)
     ->label('sdk.namespace', 'account')
-    ->label('sdk.method', ['updateMagicURLSession', 'updatePhoneSession'])
+    ->label('sdk.method', 'updateMagicURLSession')
+    ->label('sdk.description', '/docs/references/account/create-session.md')
+    ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_SESSION)
+    ->label('abuse-limit', 10)
+    ->label('abuse-key', 'ip:{ip},userId:{param-userId}')
+    ->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
+    ->param('secret', '', new Text(256), 'Valid verification token.')
+    ->inject('request')
+    ->inject('response')
+    ->inject('user')
+    ->inject('dbForProject')
+    ->inject('project')
+    ->inject('locale')
+    ->inject('geodb')
+    ->inject('queueForEvents')
+    ->action($createSession);
+
+App::put('/v1/account/sessions/phone')
+    ->desc('Update phone session')
+    ->label('event', 'users.[userId].sessions.[sessionId].create')
+    ->groups(['api', 'account'])
+    ->label('scope', 'sessions.write')
+    ->label('audits.event', 'session.create')
+    ->label('audits.resource', 'user/{response.userId}')
+    ->label('audits.userId', '{response.userId}')
+    ->label('sdk.auth', [])
+    ->label('sdk.deprecated', true)
+    ->label('sdk.namespace', 'account')
+    ->label('sdk.method', 'updatePhoneSession')
     ->label('sdk.description', '/docs/references/account/create-session.md')
     ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
@@ -3939,11 +3968,11 @@ App::put('/v1/account/mfa/challenge')
         };
 
     if (!$success && $provider === 'totp') {
-        $backups = $user->getAttribute('mfaBackups', []);
+        $backups = $user->getAttribute('totpBackup', []);
         if (in_array($otp, $backups)) {
             $success = true;
             $backups = array_diff($backups, [$otp]);
-            $user->setAttribute('mfaBackups', $backups);
+            $user->setAttribute('totpBackup', $backups);
             $dbForProject->updateDocument('users', $user->getId(), $user);
         }
     }

src/Appwrite/GraphQL/Schema.php

@@ -99,33 +99,26 @@ class Schema
                 /** @var Route $route */
 
                 $namespace = $route->getLabel('sdk.namespace', '');
-                $methods = $route->getLabel('sdk.method', '');
+                $method = $route->getLabel('sdk.method', '');
+                $name = $namespace . \ucfirst($method);
 
-                if (!\is_array($methods)) {
-                    $methods = [$methods];
+                if (empty($name)) {
+                    continue;
                 }
 
-                foreach ($methods as $method) {
-                    $name = $namespace . \ucfirst($method);
-
-                    if (empty($name)) {
-                        continue;
-                    }
-
-                    foreach (Mapper::route($utopia, $route, $complexity) as $field) {
-                        switch ($route->getMethod()) {
-                            case 'GET':
-                                $queries[$name] = $field;
-                                break;
-                            case 'POST':
-                            case 'PUT':
-                            case 'PATCH':
-                            case 'DELETE':
-                                $mutations[$name] = $field;
-                                break;
-                            default:
-                                throw new \Exception("Unsupported method: {$route->getMethod()}");
-                        }
+                foreach (Mapper::route($utopia, $route, $complexity) as $field) {
+                    switch ($route->getMethod()) {
+                        case 'GET':
+                            $queries[$name] = $field;
+                            break;
+                        case 'POST':
+                        case 'PUT':
+                        case 'PATCH':
+                        case 'DELETE':
+                            $mutations[$name] = $field;
+                            break;
+                        default:
+                            throw new \Exception("Unsupported method: {$route->getMethod()}");
                     }
                 }
             }

src/Appwrite/Platform/Tasks/Specs.php

@@ -168,30 +168,35 @@ class Specs extends Action
 
             foreach ($appRoutes as $key => $method) {
                 foreach ($method as $route) {
+                    $hide = $route->getLabel('sdk.hide', false);
+                    if ($hide === true || (\is_array($hide) && \in_array($platform, $hide))) {
+                        continue;
+                    }
+
                     /** @var \Utopia\Route $route */
                     $routeSecurity = $route->getLabel('sdk.auth', []);
-                    $sdkPlaforms = [];
+                    $sdkPlatforms = [];
 
                     foreach ($routeSecurity as $value) {
                         switch ($value) {
                             case APP_AUTH_TYPE_SESSION:
-                                $sdkPlaforms[] = APP_PLATFORM_CLIENT;
+                                $sdkPlatforms[] = APP_PLATFORM_CLIENT;
                                 break;
                             case APP_AUTH_TYPE_KEY:
-                                $sdkPlaforms[] = APP_PLATFORM_SERVER;
+                                $sdkPlatforms[] = APP_PLATFORM_SERVER;
                                 break;
                             case APP_AUTH_TYPE_JWT:
-                                $sdkPlaforms[] = APP_PLATFORM_SERVER;
+                                $sdkPlatforms[] = APP_PLATFORM_SERVER;
                                 break;
                             case APP_AUTH_TYPE_ADMIN:
-                                $sdkPlaforms[] = APP_PLATFORM_CONSOLE;
+                                $sdkPlatforms[] = APP_PLATFORM_CONSOLE;
                                 break;
                         }
                     }
 
                     if (empty($routeSecurity)) {
-                        $sdkPlaforms[] = APP_PLATFORM_CLIENT;
-                        $sdkPlaforms[] = APP_PLATFORM_SERVER;
+                        $sdkPlatforms[] = APP_PLATFORM_SERVER;
+                        $sdkPlatforms[] = APP_PLATFORM_CLIENT;
                     }
 
                     if (!$route->getLabel('docs', true)) {
@@ -210,7 +215,7 @@ class Specs extends Action
                         continue;
                     }
 
-                    if ($platform !== APP_PLATFORM_CONSOLE && !\in_array($platforms[$platform], $sdkPlaforms)) {
+                    if ($platform !== APP_PLATFORM_CONSOLE && !\in_array($platforms[$platform], $sdkPlatforms)) {
                         continue;
                     }
 

src/Appwrite/Specification/Format/OpenAPI3.php

@@ -120,18 +120,10 @@ class OpenAPI3 extends Format
         foreach ($this->routes as $route) {
             $url = \str_replace('/v1', '', $route->getPath());
             $scope = $route->getLabel('scope', '');
-            $hide = $route->getLabel('sdk.hide', false);
             $consumes = [$route->getLabel('sdk.request.type', 'application/json')];
 
-            if ($hide) {
-                continue;
-            }
-
-            $method = $route->getLabel('sdk.method', [\uniqid()]);
-            if (\is_array($method)) {
-                $method = $method[0];
-            }
 
+            $method = $route->getLabel('sdk.method', \uniqid());
             $desc = (!empty($route->getLabel('sdk.description', ''))) ? \realpath(__DIR__ . '/../../../../' . $route->getLabel('sdk.description', '')) : null;
             $produces = $route->getLabel('sdk.response.type', null);
             $model = $route->getLabel('sdk.response.model', 'none');
@@ -156,12 +148,8 @@ class OpenAPI3 extends Format
             }
 
             if (empty($routeSecurity)) {
-                if (!$route->getLabel('sdk.hideServer', false)) {
-                    $sdkPlatforms[] = APP_PLATFORM_SERVER;
-                }
-                if (!$route->getLabel('sdk.hideClient', false)) {
-                    $sdkPlatforms[] = APP_PLATFORM_CLIENT;
-                }
+                $sdkPlatforms[] = APP_PLATFORM_SERVER;
+                $sdkPlatforms[] = APP_PLATFORM_CLIENT;
             }
 
             $temp = [
@@ -175,6 +163,7 @@ class OpenAPI3 extends Format
                     'weight' => $route->getOrder(),
                     'cookies' => $route->getLabel('sdk.cookies', false),
                     'type' => $route->getLabel('sdk.methodType', ''),
+                    'deprecated' => $route->getLabel('sdk.deprecated', false),
                     'demo' => Template::fromCamelCaseToDash($route->getLabel('sdk.namespace', 'default')) . '/' . Template::fromCamelCaseToDash($method) . '.md',
                     'edit' => 'https://github.com/appwrite/appwrite/edit/master' . $route->getLabel('sdk.description', ''),
                     'rate-limit' => $route->getLabel('abuse-limit', 0),

src/Appwrite/Specification/Format/Swagger2.php

@@ -118,18 +118,9 @@ class Swagger2 extends Format
             /** @var \Utopia\Route $route */
             $url = \str_replace('/v1', '', $route->getPath());
             $scope = $route->getLabel('scope', '');
-            $hide = $route->getLabel('sdk.hide', false);
             $consumes = [$route->getLabel('sdk.request.type', 'application/json')];
 
-            if ($hide) {
-                continue;
-            }
-
-            $method = $route->getLabel('sdk.method', [\uniqid()]);
-            if (\is_array($method)) {
-                $method = $method[0];
-            }
-
+            $method = $route->getLabel('sdk.method', \uniqid());
             $desc = (!empty($route->getLabel('sdk.description', ''))) ? \realpath(__DIR__ . '/../../../../' . $route->getLabel('sdk.description', '')) : null;
             $produces = $route->getLabel('sdk.response.type', null);
             $model = $route->getLabel('sdk.response.model', 'none');
@@ -154,8 +145,8 @@ class Swagger2 extends Format
             }
 
             if (empty($routeSecurity)) {
-                $sdkPlatforms[] = APP_PLATFORM_CLIENT;
                 $sdkPlatforms[] = APP_PLATFORM_SERVER;
+                $sdkPlatforms[] = APP_PLATFORM_CLIENT;
             }
 
             $temp = [
@@ -171,6 +162,7 @@ class Swagger2 extends Format
                     'weight' => $route->getOrder(),
                     'cookies' => $route->getLabel('sdk.cookies', false),
                     'type' => $route->getLabel('sdk.methodType', ''),
+                    'deprecated' => $route->getLabel('sdk.deprecated', false),
                     'demo' => Template::fromCamelCaseToDash($route->getLabel('sdk.namespace', 'default')) . '/' . Template::fromCamelCaseToDash($method) . '.md',
                     'edit' => 'https://github.com/appwrite/appwrite/edit/master' . $route->getLabel('sdk.description', ''),
                     'rate-limit' => $route->getLabel('abuse-limit', 0),

src/Appwrite/Utopia/Request.php

@@ -25,10 +25,7 @@ class Request extends UtopiaRequest
         $parameters = parent::getParams();
 
         if (self::hasFilter() && self::hasRoute()) {
-            $method = self::getRoute()->getLabel('sdk.method', ['unknown']);
-            if (\is_array($method)) {
-                $method = $method[0];
-            }
+            $method = self::getRoute()->getLabel('sdk.method', 'unknown');
             $endpointIdentifier = self::getRoute()->getLabel('sdk.namespace', 'unknown') . '.' . $method;
             $parameters = self::getFilter()->parse($parameters, $endpointIdentifier);
         }