Add createVcsDeployment endpoints for sites and functions

2026-05-23 00:49:02 +00:00 · 2025-02-19 14:55:44 +05:30 · 2025-02-19 14:55:44 +05:30 · f7749bbbef
commit f7749bbbef
parent ae1eb53e31
5 changed files with 183 additions and 21 deletions
--- a/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Vcs/Create.php
+++ b/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Vcs/Create.php
@ -0,0 +1,89 @@
+<?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\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 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.
+                EOT,
+                auth: [AuthType::KEY],
+                responses: [
+                    new SDKResponse(
+                        code: Response::STATUS_CODE_ACCEPTED,
+                        model: Response::MODEL_DEPLOYMENT,
+                    )
+                ],
+            ))
+            ->param('functionId', '', new UID(), 'Function ID.')
+            ->inject('request')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('dbForPlatform')
+            ->inject('project')
+            ->inject('queueForEvents')
+            ->inject('queueForBuilds')
+            ->inject('gitHub')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $functionId, 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, $function, $project, $installation, $dbForProject, $queueForBuilds, $template, $github);
+
+        $queueForEvents
+            ->setParam('functionId', $function->getId())
+            ->setParam('deploymentId', $deployment->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_ACCEPTED)
+            ->dynamic($deployment, Response::MODEL_DEPLOYMENT);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Functions/Services/Http.php
+++ b/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());
    }
 }
--- a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Template/Create.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Template/Create.php
@ -19,11 +19,9 @@ use Utopia\Database\Validator\Authorization;
 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\Boolean;
 use Utopia\Validator\Text;
-use Utopia\VCS\Adapter\Git\GitHub;

 class Create extends Base
 {
@ -67,18 +65,16 @@ class Create extends Base
            ->param('rootDirectory', '', new Text(128, 0), 'Path to site code in the template repo.')
            ->param('version', '', new Text(128, 0), 'Version (tag) for the repo linked to the site template.')
            ->param('activate', false, new Boolean(), 'Automatically activate the deployment when it is finished building.', true)
-            ->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 $repository, string $owner, string $rootDirectory, string $version, bool $activate, Request $request, Response $response, Database $dbForProject, Database $dbForPlatform, Document $project, Event $queueForEvents, Build $queueForBuilds, GitHub $github)
+    public function action(string $siteId, string $repository, string $owner, string $rootDirectory, string $version, bool $activate, Response $response, Database $dbForProject, Database $dbForPlatform, Document $project, Event $queueForEvents, Build $queueForBuilds)
    {
        $site = $dbForProject->getDocument('sites', $siteId);

@ -93,22 +89,6 @@ class Create extends Base
            'version' => $version
        ]);

-        if (!empty($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());
-
-            $response
-                ->setStatusCode(Response::STATUS_CODE_ACCEPTED)
-                ->dynamic($deployment, Response::MODEL_DEPLOYMENT);
-
-            return;
-        }
-
        $deploymentId = ID::unique();
        $deployment = $dbForProject->createDocument('deployments', new Document([
            '$id' => $deploymentId,
--- a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Vcs/Create.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Vcs/Create.php
@ -0,0 +1,89 @@
+<?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\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 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.
+                EOT,
+                auth: [AuthType::KEY],
+                responses: [
+                    new SDKResponse(
+                        code: Response::STATUS_CODE_ACCEPTED,
+                        model: Response::MODEL_DEPLOYMENT,
+                    )
+                ],
+            ))
+            ->param('siteId', '', new UID(), 'Site ID.')
+            ->inject('request')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('dbForPlatform')
+            ->inject('project')
+            ->inject('queueForEvents')
+            ->inject('queueForBuilds')
+            ->inject('gitHub')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, 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, $site, $project, $installation, $dbForProject, $dbForPlatform, $queueForBuilds, $template, $github);
+
+        $queueForEvents
+            ->setParam('siteId', $site->getId())
+            ->setParam('deploymentId', $deployment->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_ACCEPTED)
+            ->dynamic($deployment, Response::MODEL_DEPLOYMENT);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Services/Http.php
+++ b/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());