Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add timeout and add sites scopes

Browse Source
This commit is contained in:
Khushboo Verma
2024-10-26 11:01:14 +02:00
parent 826a1a02a2
commit 08630cd686
29 changed files with 61 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env
+1
View File
@@ -70,6 +70,7 @@ _APP_STORAGE_PREVIEW_LIMIT=20000000
_APP_SITES_SIZE_LIMIT=30000000
_APP_FUNCTIONS_SIZE_LIMIT=30000000
_APP_FUNCTIONS_TIMEOUT=900
_APP_SITES_TIMEOUT=900
_APP_FUNCTIONS_BUILD_TIMEOUT=900
_APP_FUNCTIONS_CPUS=8
_APP_FUNCTIONS_MEMORY=8192
app/config/collections.php
+11
View File
@@ -3380,6 +3380,17 @@ $projectCollections = array_merge([
'array' => false,
'filters' => ['subQueryProjectVariables'],
],
[
'$id' => ID::custom('timeout'),
'type' => Database::VAR_INTEGER,
'format' => '',
'size' => 0,
'signed' => true,
'required' => false,
'default' => null,
'array' => false,
'filters' => [],
],
[
'$id' => ID::custom('search'),
'type' => Database::VAR_STRING,
app/config/roles.php
+2
View File
@@ -58,6 +58,8 @@ $admins = [
'health.read',
'functions.read',
'functions.write',
'sites.read',
'sites.write',
'execution.read',
'execution.write',
'rules.read',
app/config/scopes.php
+6
View File
@@ -64,6 +64,12 @@ return [ // List of publicly visible scopes
'functions.write' => [
'description' => 'Access to create, update, and delete your project\'s functions and code deployments',
],
'sites.read' => [
'description' => 'Access to read your project\'s sites and deployments',
],
'sites.write' => [
'description' => 'Access to create, update, and delete your project\'s sites and deployments',
],
'execution.read' => [
'description' => 'Access to read your project\'s execution logs',
],
app/controllers/general.php
+2 -2
View File
@@ -155,8 +155,8 @@ function router(App $utopia, Database $dbForConsole, callable $getProjectDB, Swo
'logo' => 'node.png',
'startCommand' => null,
'version' => 'v1',
'base' => 'static:1.0',
'image' => 'static:1.0',
'base' => 'openruntimes/static:v4-:1.0',
'image' => 'openruntimes/static:v4-:1.0',
'supports' => [System::X86, System::ARM64, System::ARMV7, System::ARMV8]
],
default => null
docker-compose.yml
+1
View File
@@ -166,6 +166,7 @@ services:
- _APP_SITES_CPUS
- _APP_SITES_MEMORY
- _APP_SITES_SIZE_LIMIT
- _APP_SITES_TIMEOUT
- _APP_DOMAIN_SITES
- _APP_EXECUTOR_SECRET
- _APP_EXECUTOR_HOST
src/Appwrite/Platform/Modules/Sites/Http/Deployments/CancelDeployment.php
+1 -1
View File
@@ -32,7 +32,7 @@ class CancelDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId/build')
->desc('Cancel deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.write') //TODO: Update the scope to sites later
->label('scope', 'sites.write')
->label('audits.event', 'deployment.update')
->label('audits.resource', 'site/{request.siteId}')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
src/Appwrite/Platform/Modules/Sites/Http/Deployments/CreateDeployment.php
+1 -1
View File
@@ -41,7 +41,7 @@ class CreateDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments')
->desc('Create deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.write') //TODO: Update the scope to sites later
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].deployments.[deploymentId].create')
->label('audits.event', 'deployment.create')
->label('audits.resource', 'site/{request.siteId}')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/DeleteDeployment.php
+1 -1
View File
@@ -29,7 +29,7 @@ class DeleteDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId')
->desc('Delete deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.write') //TODO: Update the scope to sites later
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].deployments.[deploymentId].delete')
->label('audits.event', 'deployment.delete')
->label('audits.resource', 'site/{request.siteId}')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/DownloadBuild.php
+1 -1
View File
@@ -27,7 +27,7 @@ class DownloadBuild extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId/build/download')
->desc('Download build')
->groups(['api', 'sites'])
->label('scope', 'functions.read') //TODO: Update the scope to sites later
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getBuildDownload')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/DownloadDeployment.php
+1 -1
View File
@@ -27,7 +27,7 @@ class DownloadDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId/download')
->desc('Download deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.read') //TODO: Update the scope to sites later
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getDeploymentDownload')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/GetDeployment.php
+1 -1
View File
@@ -25,7 +25,7 @@ class GetDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId')
->desc('Get deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.read') //TODO: Update the scope to sites later
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getDeployment')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/ListDeployments.php
+1 -1
View File
@@ -31,7 +31,7 @@ class ListDeployments extends Action
->setHttpPath('/v1/sites/:siteId/deployments')
->desc('List deployments')
->groups(['api', 'sites'])
->label('scope', 'functions.read') //TODO: Update the scope to sites later
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'listDeployments')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/RebuildDeployment.php
+1 -1
View File
@@ -29,7 +29,7 @@ class RebuildDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId/build')
->desc('Rebuild deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.write') //TODO: Update the scope to sites later
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].deployments.[deploymentId].update')
->label('audits.event', 'deployment.update')
->label('audits.resource', 'site/{request.siteId}')
src/Appwrite/Platform/Modules/Sites/Http/Deployments/UpdateDeployment.php
+1 -1
View File
@@ -27,7 +27,7 @@ class UpdateDeployment extends Action
->setHttpPath('/v1/sites/:siteId/deployments/:deploymentId')
->desc('Update deployment')
->groups(['api', 'sites'])
->label('scope', 'functions.write') //TODO: Update the scope to sites later
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].deployments.[deploymentId].update')
->label('audits.event', 'deployment.update')
->label('audits.resource', 'site/{request.siteId}')
src/Appwrite/Platform/Modules/Sites/Http/Sites/CreateSite.php
+5 -2
View File
@@ -25,6 +25,7 @@ use Utopia\Swoole\Request;
use Utopia\System\System;
use Utopia\Validator\ArrayList;
use Utopia\Validator\Boolean;
use Utopia\Validator\Range;
use Utopia\Validator\Text;
use Utopia\Validator\WhiteList;
use Utopia\VCS\Adapter\Git\GitHub;
@@ -45,7 +46,7 @@ class CreateSite extends Base
->setHttpPath('/v1/sites')
->desc('Create site')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites.write
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].create')
->label('audits.event', 'site.create')
->label('audits.resource', 'site/{response.$id}')
@@ -60,6 +61,7 @@ class CreateSite extends Base
->param('name', '', new Text(128), 'Site name. Max length: 128 chars.')
->param('framework', '', new WhiteList(array_keys(Config::getParam('frameworks')), true), 'Sites framework.')
->param('enabled', true, new Boolean(), 'Is site enabled? When set to \'disabled\', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.', true) // TODO: Add logging param later
->param('timeout', 15, new Range(1, (int) System::getEnv('_APP_SITES_TIMEOUT', 900)), 'Maximum request time in seconds.', true)
->param('installCommand', '', new Text(8192, 0), 'Install Command.', true)
->param('buildCommand', '', new Text(8192, 0), 'Build Command.', true)
->param('outputDirectory', '', new Text(8192, 0), 'Output Directory for site.', true)
@@ -92,7 +94,7 @@ class CreateSite extends Base
->callback([$this, 'action']);
}
public function action(string $siteId, string $name, string $framework, bool $enabled, string $installCommand, string $buildCommand, string $outputDirectory, string $fallbackRedirect, array $scopes, string $installationId, string $providerRepositoryId, string $providerBranch, bool $providerSilentMode, string $providerRootDirectory, string $templateRepository, string $templateOwner, string $templateRootDirectory, string $templateVersion, string $specification, Request $request, Response $response, Database $dbForProject, Document $project, Document $user, Event $queueForEvents, Build $queueForBuilds, Database $dbForConsole, GitHub $github)
public function action(string $siteId, string $name, string $framework, bool $enabled, int $timeout, string $installCommand, string $buildCommand, string $outputDirectory, string $fallbackRedirect, array $scopes, string $installationId, string $providerRepositoryId, string $providerBranch, bool $providerSilentMode, string $providerRootDirectory, string $templateRepository, string $templateOwner, string $templateRootDirectory, string $templateVersion, string $specification, Request $request, Response $response, Database $dbForProject, Document $project, Document $user, Event $queueForEvents, Build $queueForBuilds, Database $dbForConsole, GitHub $github)
{
$siteId = ($siteId == 'unique()') ? ID::unique() : $siteId;
@@ -134,6 +136,7 @@ class CreateSite extends Base
'framework' => $framework,
'deploymentInternalId' => '',
'deploymentId' => '',
'timeout' => $timeout,
'installCommand' => $installCommand,
'buildCommand' => $buildCommand,
'outputDirectory' => $outputDirectory,
src/Appwrite/Platform/Modules/Sites/Http/Sites/DeleteSite.php
+1 -1
View File
@@ -28,7 +28,7 @@ class DeleteSite extends Base
->setHttpPath('/v1/sites/:siteId')
->desc('Delete site')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites.write
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].delete')
->label('audits.event', 'site.delete')
->label('audits.resource', 'site/{request.siteId}')
src/Appwrite/Platform/Modules/Sites/Http/Sites/GetSite.php
+1 -1
View File
@@ -26,7 +26,7 @@ class GetSite extends Base
->setHttpPath('/v1/sites/:siteId')
->desc('Get site')
->groups(['api', 'sites'])
->label('scope', 'functions.read') // TODO: Update scope to sites.read
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'get')
src/Appwrite/Platform/Modules/Sites/Http/Sites/GetSiteUsage.php
+1 -1
View File
@@ -31,7 +31,7 @@ class GetSiteUsage extends Base
->setHttpPath('/v1/sites/:siteId/usage')
->desc('Get site usage')
->groups(['api', 'sites', 'usage'])
->label('scope', 'functions.read') // TODO: Update scope to sites.read
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getSiteUsage')
src/Appwrite/Platform/Modules/Sites/Http/Sites/GetSitesUsage.php
+1 -1
View File
@@ -29,7 +29,7 @@ class GetSitesUsage extends Base
->setHttpPath('/v1/sites/usage')
->desc('Get sites usage')
->groups(['api', 'sites', 'usage'])
->label('scope', 'functions.read') // TODO: Update scope to sites.read
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getUsage')
src/Appwrite/Platform/Modules/Sites/Http/Sites/ListFrameworks.php
+1 -1
View File
@@ -26,7 +26,7 @@ class ListFrameworks extends Base
->setHttpPath('/v1/sites/frameworks')
->desc('List frameworks')
->groups(['api', 'sites'])
->label('scope', 'functions.read') // TODO: Update scope to sites.read
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'listFrameworks')
src/Appwrite/Platform/Modules/Sites/Http/Sites/ListSites.php
+1 -1
View File
@@ -31,7 +31,7 @@ class ListSites extends Base
->setHttpPath('/v1/sites')
->desc('List sites')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites.write
->label('scope', 'sites.write')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'list')
src/Appwrite/Platform/Modules/Sites/Http/Sites/UpdateSite.php
+7 -3
View File
@@ -21,8 +21,10 @@ use Utopia\Database\Validator\UID;
use Utopia\Platform\Action;
use Utopia\Platform\Scope\HTTP;
use Utopia\Swoole\Request;
use Utopia\System\System;
use Utopia\Validator\ArrayList;
use Utopia\Validator\Boolean;
use Utopia\Validator\Range;
use Utopia\Validator\Text;
use Utopia\Validator\WhiteList;
use Utopia\VCS\Adapter\Git\GitHub;
@@ -42,7 +44,7 @@ class UpdateSite extends Base
->setHttpPath('/v1/sites/:siteId')
->desc('Update site')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: update it to sites.write later
->label('scope', 'sites.write')
->label('event', 'sites.[siteId].update')
->label('audits.event', 'sites.update')
->label('audits.resource', 'site/{response.$id}')
@@ -57,6 +59,7 @@ class UpdateSite extends Base
->param('name', '', new Text(128), 'Site name. Max length: 128 chars.')
->param('framework', '', new WhiteList(array_keys(Config::getParam('frameworks')), true), 'Sites framework.')
->param('enabled', true, new Boolean(), 'Is site enabled? When set to \'disabled\', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.', true) // TODO: Add logging param later
->param('timeout', 15, new Range(1, (int) System::getEnv('_APP_SITES_TIMEOUT', 900)), 'Maximum request time in seconds.', true)
->param('installCommand', '', new Text(8192, 0), 'Install Command.', true)
->param('buildCommand', '', new Text(8192, 0), 'Build Command.', true)
->param('outputDirectory', '', new Text(8192, 0), 'Output Directory for site.', true)
@@ -84,7 +87,7 @@ class UpdateSite extends Base
->callback([$this, 'action']);
}
public function action(string $siteId, string $name, string $framework, bool $enabled, string $installCommand, string $buildCommand, string $outputDirectory, string $fallbackRedirect, array $scopes, string $installationId, ?string $providerRepositoryId, string $providerBranch, bool $providerSilentMode, string $providerRootDirectory, string $specification, Request $request, Response $response, Database $dbForProject, Document $project, Event $queueForEvents, Build $queueForBuilds, Database $dbForConsole, GitHub $github)
public function action(string $siteId, string $name, string $framework, bool $enabled, int $timeout, string $installCommand, string $buildCommand, string $outputDirectory, string $fallbackRedirect, array $scopes, string $installationId, ?string $providerRepositoryId, string $providerBranch, bool $providerSilentMode, string $providerRootDirectory, string $specification, Request $request, Response $response, Database $dbForProject, Document $project, Event $queueForEvents, Build $queueForBuilds, Database $dbForConsole, GitHub $github)
{
// TODO: If only branch changes, re-deploy
$site = $dbForProject->getDocument('sites', $siteId);
@@ -202,8 +205,9 @@ class UpdateSite extends Base
'framework' => $framework,
'enabled' => $enabled,
'live' => $live,
'buildCommand' => $buildCommand,
'timeout' => $timeout,
'installCommand' => $installCommand,
'buildCommand' => $buildCommand,
'outputDirectory' => $outputDirectory,
'fallbackRedirect' => $fallbackRedirect,
'scopes' => $scopes,
src/Appwrite/Platform/Modules/Sites/Http/Variables/CreateVariable.php
+1 -1
View File
@@ -33,7 +33,7 @@ class CreateVariable extends Base
->setHttpPath('/v1/sites/:siteId/variables')
->desc('Create variable')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites.write
->label('scope', 'sites.write')
->label('audits.event', 'variable.create')
->label('audits.resource', 'site/{request.siteId}')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
src/Appwrite/Platform/Modules/Sites/Http/Variables/DeleteVariable.php
+1 -1
View File
@@ -26,7 +26,7 @@ class DeleteVariable extends Base
->setHttpPath('/v1/sites/:siteId/variables/:variableId')
->desc('Delete variable')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites
->label('scope', 'sites.write')
->label('audits.event', 'variable.delete')
->label('audits.resource', 'site/{request.siteId}')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
src/Appwrite/Platform/Modules/Sites/Http/Variables/GetVariable.php
+1 -1
View File
@@ -26,7 +26,7 @@ class GetVariable extends Base
->setHttpPath('/v1/sites/:siteId/variables/:variableId')
->desc('Get variable')
->groups(['api', 'sites'])
->label('scope', 'functions.read') // TODO: Update scope to sites
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'getVariable')
src/Appwrite/Platform/Modules/Sites/Http/Variables/ListVariables.php
+1 -1
View File
@@ -27,7 +27,7 @@ class ListVariables extends Base
->setHttpPath('/v1/sites/:siteId/variables')
->desc('List variables')
->groups(['api', 'sites'])
->label('scope', 'functions.read') // TODO: Update scope to sites
->label('scope', 'sites.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'sites')
->label('sdk.method', 'listVariables')
src/Appwrite/Platform/Modules/Sites/Http/Variables/UpdateVariable.php
+1 -1
View File
@@ -28,7 +28,7 @@ class UpdateVariable extends Base
->setHttpPath('/v1/sites/:siteId/variables/:variableId')
->desc('Update variable')
->groups(['api', 'sites'])
->label('scope', 'functions.write') // TODO: Update scope to sites
->label('scope', 'sites.write')
->label('audits.event', 'variable.update')
->label('audits.resource', 'site/{request.siteId}')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
src/Appwrite/Utopia/Response/Model/Site.php
+6
View File
@@ -72,6 +72,12 @@ class Site extends Model
'example' => [],
'array' => true
])
->addRule('timeout', [
'type' => self::TYPE_INTEGER,
'description' => 'Site request timeout in seconds.',
'default' => 15,
'example' => 300,
])
->addRule('installCommand', [
'type' => self::TYPE_STRING,
'description' => 'The install command used to install the site dependencies.',