Merge branch 'feat-sites' into feat-add-detection-logic

src/Appwrite/Platform/Modules/Compute/Base.php

@@ -19,7 +19,7 @@ use Utopia\VCS\Exception\RepositoryNotFound;
 
 class Base extends Action
 {
-    public function redeployVcsFunction(Request $request, Document $function, Document $project, Document $installation, Database $dbForProject, Build $queueForBuilds, Document $template, GitHub $github): Document
+    public function redeployVcsFunction(Request $request, Document $function, Document $project, Document $installation, Database $dbForProject, Build $queueForBuilds, Document $template, GitHub $github, string $referenceType = 'branch', string $reference = ''): Document
     {
         $deploymentId = ID::unique();
         $entrypoint = $function->getAttribute('entrypoint', '');
@@ -37,7 +37,12 @@ class Base extends Action
         } catch (RepositoryNotFound $e) {
             throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND);
         }
-        $providerBranch = $function->getAttribute('providerBranch', 'main');
+
+        // TODO: Support tag and commit in future
+        if ($referenceType === 'branch') {
+            $providerBranch = empty($reference) ? $function->getAttribute('providerBranch', 'main') : $reference;
+        }
+
         $authorUrl = "https://github.com/$owner";
         $repositoryUrl = "https://github.com/$owner/$repositoryName";
         $branchUrl = "https://github.com/$owner/$repositoryName/tree/$providerBranch";
@@ -95,7 +100,7 @@ class Base extends Action
         return $deployment;
     }
 
-    public function redeployVcsSite(Request $request, Document $site, Document $project, Document $installation, Database $dbForProject, Database $dbForPlatform, Build $queueForBuilds, Document $template, GitHub $github): Document
+    public function redeployVcsSite(Request $request, Document $site, Document $project, Document $installation, Database $dbForProject, Database $dbForPlatform, Build $queueForBuilds, Document $template, GitHub $github, string $referenceType = 'branch', string $reference = ''): Document
     {
         $deploymentId = ID::unique();
         $providerInstallationId = $installation->getAttribute('providerInstallationId', '');
@@ -113,7 +118,11 @@ class Base extends Action
             throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND);
         }
 
-        $providerBranch = $site->getAttribute('providerBranch', 'main');
+        // TODO: Support tag and commit in future
+        if ($referenceType === 'branch') {
+            $providerBranch = empty($reference) ? $site->getAttribute('providerBranch', 'main') : $reference;
+        }
+
         $authorUrl = "https://github.com/$owner";
         $repositoryUrl = "https://github.com/$owner/$repositoryName";
         $branchUrl = "https://github.com/$owner/$repositoryName/tree/$providerBranch";

src/Appwrite/Platform/Modules/Functions/Http/Deployments/Vcs/Create.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Functions\Http\Deployments\Vcs;
+
+use Appwrite\Event\Build;
+use Appwrite\Event\Event;
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\SDK\AuthType;
+use Appwrite\SDK\Method;
+use Appwrite\SDK\Response as SDKResponse;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Swoole\Request;
+use Utopia\Validator\Text;
+use Utopia\Validator\WhiteList;
+use Utopia\VCS\Adapter\Git\GitHub;
+
+class Create extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'createVcsDeployment';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_POST)
+            ->setHttpPath('/v1/functions/:functionId/deployments/vcs')
+            ->desc('Create VCS deployment')
+            ->groups(['api', 'functions'])
+            ->label('scope', 'functions.write')
+            ->label('event', 'functions.[functionId].deployments.[deploymentId].create')
+            ->label('audits.event', 'deployment.create')
+            ->label('audits.resource', 'function/{request.functionId}')
+            ->label('sdk', new Method(
+                namespace: 'functions',
+                name: 'createVcsDeployment',
+                description: <<<EOT
+                Create a deployment when a function is connected to VCS.
+
+                This endpoint lets you create deployment from a branch, commit, or a tag.
+                EOT,
+                auth: [AuthType::KEY],
+                responses: [
+                    new SDKResponse(
+                        code: Response::STATUS_CODE_ACCEPTED,
+                        model: Response::MODEL_DEPLOYMENT,
+                    )
+                ],
+            ))
+            ->param('functionId', '', new UID(), 'Function ID.')
+            // TODO: Support tag and commit in future
+            ->param('type', '', new WhiteList(['branch']), 'Type of reference passed. Allowed values are: branch')
+            ->param('reference', '', new Text(255), 'VCS reference to create deployment from. Depending on type this can be: branch name')
+            ->inject('request')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('dbForPlatform')
+            ->inject('project')
+            ->inject('queueForEvents')
+            ->inject('queueForBuilds')
+            ->inject('gitHub')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $functionId, string $type, string $reference, Request $request, Response $response, Database $dbForProject, Database $dbForPlatform, Document $project, Event $queueForEvents, Build $queueForBuilds, GitHub $github)
+    {
+        $function = $dbForProject->getDocument('functions', $functionId);
+
+        if ($function->isEmpty()) {
+            throw new Exception(Exception::FUNCTION_NOT_FOUND);
+        }
+
+        $template = new Document();
+
+        $installation = $dbForPlatform->getDocument('installations', $function->getAttribute('installationId'));
+
+        $deployment = $this->redeployVcsFunction(
+            request: $request,
+            function: $function,
+            project: $project,
+            installation: $installation,
+            dbForProject: $dbForProject,
+            queueForBuilds: $queueForBuilds,
+            template: $template,
+            github: $github,
+            reference: $reference,
+            referenceType: $type
+        );
+
+        $queueForEvents
+            ->setParam('functionId', $function->getId())
+            ->setParam('deploymentId', $deployment->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_ACCEPTED)
+            ->dynamic($deployment, Response::MODEL_DEPLOYMENT);
+    }
+}

src/Appwrite/Platform/Modules/Functions/Services/Http.php

@@ -4,6 +4,7 @@ namespace Appwrite\Platform\Modules\Functions\Services;
 
 use Appwrite\Platform\Modules\Functions\Http\Deployments\Create as CreateDeployment;
 use Appwrite\Platform\Modules\Functions\Http\Deployments\Template\Create as CreateTemplateDeployment;
+use Appwrite\Platform\Modules\Functions\Http\Deployments\Vcs\Create as CreateVcsDeployment;
 use Appwrite\Platform\Modules\Functions\Http\Functions\Create as CreateFunction;
 use Appwrite\Platform\Modules\Functions\Http\Functions\Update as UpdateFunction;
 use Appwrite\Platform\Modules\Functions\Http\Functions\XList as ListFunctions;
@@ -21,5 +22,6 @@ class Http extends Service
         $this->addAction(ListRuntimes::getName(), new ListRuntimes());
         $this->addAction(CreateDeployment::getName(), new CreateDeployment());
         $this->addAction(CreateTemplateDeployment::getName(), new CreateTemplateDeployment());
+        $this->addAction(CreateVcsDeployment::getName(), new CreateVcsDeployment());
     }
 }

src/Appwrite/Platform/Modules/Sites/Http/Deployments/Template/Create.php

@@ -93,14 +93,14 @@ class Create extends Base
             'version' => $version
         ]);
 
-        if (!empty($providerRepositoryId)) {
+        if (!empty($site->getAttribute('providerRepositoryId'))) {
             $installation = $dbForPlatform->getDocument('installations', $site->getAttribute('installationId'));
 
             $deployment = $this->redeployVcsSite($request, $site, $project, $installation, $dbForProject, $dbForPlatform, $queueForBuilds, $template, $github);
 
             $queueForEvents
-                ->setParam('siteId', $site->getId())
-                ->setParam('deploymentId', $deployment->getId());
+            ->setParam('siteId', $site->getId())
+            ->setParam('deploymentId', $deployment->getId());
 
             $response
                 ->setStatusCode(Response::STATUS_CODE_ACCEPTED)

src/Appwrite/Platform/Modules/Sites/Http/Deployments/Vcs/Create.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Deployments\Vcs;
+
+use Appwrite\Event\Build;
+use Appwrite\Event\Event;
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\SDK\AuthType;
+use Appwrite\SDK\Method;
+use Appwrite\SDK\Response as SDKResponse;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Swoole\Request;
+use Utopia\Validator\Text;
+use Utopia\Validator\WhiteList;
+use Utopia\VCS\Adapter\Git\GitHub;
+
+class Create extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'createVcsDeployment';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_POST)
+            ->setHttpPath('/v1/sites/:siteId/deployments/vcs')
+            ->desc('Create VCS deployment')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'sites.write')
+            ->label('event', 'sites.[siteId].deployments.[deploymentId].create')
+            ->label('audits.event', 'deployment.create')
+            ->label('audits.resource', 'site/{request.siteId}')
+            ->label('sdk', new Method(
+                namespace: 'sites',
+                name: 'createVcsDeployment',
+                description: <<<EOT
+                Create a deployment when a site is connected to VCS.
+
+                This endpoint lets you create deployment from a branch, commit, or a tag.
+                EOT,
+                auth: [AuthType::KEY],
+                responses: [
+                    new SDKResponse(
+                        code: Response::STATUS_CODE_ACCEPTED,
+                        model: Response::MODEL_DEPLOYMENT,
+                    )
+                ],
+            ))
+            ->param('siteId', '', new UID(), 'Site ID.')
+            // TODO: Support tag and commit in future
+            ->param('type', '', new WhiteList(['branch']), 'Type of reference passed. Allowed values are: branch')
+            ->param('reference', '', new Text(255), 'VCS reference to create deployment from. Depending on type this can be: branch name')
+            ->inject('request')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('dbForPlatform')
+            ->inject('project')
+            ->inject('queueForEvents')
+            ->inject('queueForBuilds')
+            ->inject('gitHub')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $type, string $reference, Request $request, Response $response, Database $dbForProject, Database $dbForPlatform, Document $project, Event $queueForEvents, Build $queueForBuilds, GitHub $github)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $template = new Document();
+
+        $installation = $dbForPlatform->getDocument('installations', $site->getAttribute('installationId'));
+
+        $deployment = $this->redeployVcsSite(
+            request: $request,
+            site: $site,
+            project: $project,
+            installation: $installation,
+            dbForProject: $dbForProject,
+            dbForPlatform: $dbForPlatform,
+            queueForBuilds: $queueForBuilds,
+            template: $template,
+            github: $github,
+            reference: $reference,
+            referenceType: $type
+        );
+
+        $queueForEvents
+            ->setParam('siteId', $site->getId())
+            ->setParam('deploymentId', $deployment->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_ACCEPTED)
+            ->dynamic($deployment, Response::MODEL_DEPLOYMENT);
+    }
+}

src/Appwrite/Platform/Modules/Sites/Services/Http.php

@@ -11,6 +11,7 @@ use Appwrite\Platform\Modules\Sites\Http\Deployments\Download\Get as DownloadDep
 use Appwrite\Platform\Modules\Sites\Http\Deployments\Get as GetDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Deployments\Template\Create as CreateTemplateDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Deployments\Update as UpdateDeployment;
+use Appwrite\Platform\Modules\Sites\Http\Deployments\Vcs\Create as CreateVcsDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Deployments\XList as ListDeployments;
 use Appwrite\Platform\Modules\Sites\Http\Frameworks\XList as ListFrameworks;
 use Appwrite\Platform\Modules\Sites\Http\Logs\Delete as DeleteLog;
@@ -51,6 +52,7 @@ class Http extends Service
         // Deployments
         $this->addAction(CreateDeployment::getName(), new CreateDeployment());
         $this->addAction(CreateTemplateDeployment::getName(), new CreateTemplateDeployment());
+        $this->addAction(CreateVcsDeployment::getName(), new CreateVcsDeployment());
         $this->addAction(GetDeployment::getName(), new GetDeployment());
         $this->addAction(ListDeployments::getName(), new ListDeployments());
         $this->addAction(UpdateDeployment::getName(), new UpdateDeployment());