From d84c9033878e93084db3d0a709c573c9121604ee Mon Sep 17 00:00:00 2001 From: Hemachandar Date: Wed, 25 Feb 2026 18:23:40 +0530 Subject: [PATCH] Move VCS events APIs to Modules --- app/config/services.php | 2 +- app/controllers/api/vcs.php | 705 ------------------ .../Modules/VCS/Http/GitHub/Action.php | 522 +++++++++++++ .../Http/GitHub/Authorize/External/Update.php | 140 ++++ .../Modules/VCS/Http/GitHub/Events/Create.php | 241 ++++++ .../Platform/Modules/VCS/Services/Http.php | 6 + 6 files changed, 910 insertions(+), 706 deletions(-) delete mode 100644 app/controllers/api/vcs.php create mode 100644 src/Appwrite/Platform/Modules/VCS/Http/GitHub/Action.php create mode 100644 src/Appwrite/Platform/Modules/VCS/Http/GitHub/Authorize/External/Update.php create mode 100644 src/Appwrite/Platform/Modules/VCS/Http/GitHub/Events/Create.php diff --git a/app/config/services.php b/app/config/services.php index 5d503b0099..c55050c0b9 100644 --- a/app/config/services.php +++ b/app/config/services.php @@ -188,7 +188,7 @@ return [ 'name' => 'VCS', 'subtitle' => 'The VCS service allows you to interact with providers like GitHub, GitLab etc.', 'description' => '', - 'controller' => 'api/vcs.php', + 'controller' => '', // Uses modules 'sdk' => false, 'docs' => false, 'docsUrl' => '', diff --git a/app/controllers/api/vcs.php b/app/controllers/api/vcs.php deleted file mode 100644 index 6dd18ed0f3..0000000000 --- a/app/controllers/api/vcs.php +++ /dev/null @@ -1,705 +0,0 @@ -getAttribute('resourceType'); - - if ($resourceType !== "function" && $resourceType !== "site") { - continue; - } - - $projectId = $repository->getAttribute('projectId'); - $project = $authorization->skip(fn () => $dbForPlatform->getDocument('projects', $projectId)); - if ($project->isEmpty()) { - throw new Exception(Exception::PROJECT_NOT_FOUND, 'Repository references non-existent project'); - } - $dbForProject = $getProjectDB($project); - - $resourceCollection = $resourceType === "function" ? 'functions' : 'sites'; - $resourceId = $repository->getAttribute('resourceId'); - $resource = $authorization->skip(fn () => $dbForProject->getDocument($resourceCollection, $resourceId)); - $resourceInternalId = $resource->getSequence(); - - $deploymentId = ID::unique(); - $repositoryId = $repository->getId(); - $repositoryInternalId = $repository->getSequence(); - $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); - $installationId = $repository->getAttribute('installationId'); - $installationInternalId = $repository->getAttribute('installationInternalId'); - $productionBranch = $resource->getAttribute('providerBranch'); - $activate = false; - - if ($providerBranch == $productionBranch && $external === false) { - $activate = true; - } - - $owner = $github->getOwnerName($providerInstallationId) ?? ''; - try { - $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; - if (empty($repositoryName)) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - } catch (RepositoryNotFound $e) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - - if (empty($repositoryName)) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - - $isAuthorized = !$external; - - if (!$isAuthorized && !empty($providerPullRequestId)) { - if (\in_array($providerPullRequestId, $repository->getAttribute('providerPullRequestIds', []))) { - $isAuthorized = true; - } - } - - $commentStatus = $isAuthorized ? 'waiting' : 'failed'; - $protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https'; - $hostname = $platform['consoleHostname'] ?? ''; - - $authorizeUrl = $protocol . '://' . $hostname . "/console/git/authorize-contributor?projectId={$projectId}&installationId={$installationId}&repositoryId={$repositoryId}&providerPullRequestId={$providerPullRequestId}"; - - $action = $isAuthorized ? ['type' => 'logs'] : ['type' => 'authorize', 'url' => $authorizeUrl]; - - $latestCommentId = ''; - - if (!empty($providerPullRequestId) && $resource->getAttribute('providerSilentMode', false) === false) { - $latestComment = $authorization->skip(fn () => $dbForPlatform->findOne('vcsComments', [ - Query::equal('providerRepositoryId', [$providerRepositoryId]), - Query::equal('providerPullRequestId', [$providerPullRequestId]), - Query::orderDesc('$createdAt'), - ])); - - if (!$latestComment->isEmpty()) { - $latestCommentId = $latestComment->getAttribute('providerCommentId', ''); - - $retries = 0; - $lockAcquired = false; - - while ($retries < 9) { - $retries++; - - try { - $dbForPlatform->createDocument('vcsCommentLocks', new Document([ - '$id' => $latestCommentId - ])); - $lockAcquired = true; - break; - } catch (\Throwable $err) { - if ($retries >= 9) { - Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); - } - - \sleep(1); - } - } - - if ($lockAcquired) { - // Wrap in try/finally to ensure lock file gets deleted - try { - $comment = new Comment($platform); - $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); - $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); - - $latestCommentId = \strval($github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment())); - } finally { - $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); - } - } - } else { - $comment = new Comment($platform); - $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); - $latestCommentId = \strval($github->createComment($owner, $repositoryName, $providerPullRequestId, $comment->generateComment())); - - if (!empty($latestCommentId)) { - $teamId = $project->getAttribute('teamId', ''); - - $latestComment = $authorization->skip(fn () => $dbForPlatform->createDocument('vcsComments', new Document([ - '$id' => ID::unique(), - '$permissions' => [ - Permission::read(Role::team(ID::custom($teamId))), - Permission::update(Role::team(ID::custom($teamId), 'owner')), - Permission::update(Role::team(ID::custom($teamId), 'developer')), - Permission::delete(Role::team(ID::custom($teamId), 'owner')), - Permission::delete(Role::team(ID::custom($teamId), 'developer')), - ], - 'installationInternalId' => $installationInternalId, - 'installationId' => $installationId, - 'projectInternalId' => $project->getSequence(), - 'projectId' => $project->getId(), - 'providerRepositoryId' => $providerRepositoryId, - 'providerBranch' => $providerBranch, - 'providerPullRequestId' => $providerPullRequestId, - 'providerCommentId' => $latestCommentId - ]))); - } - } - } elseif (!empty($providerBranch)) { - $latestComments = $authorization->skip(fn () => $dbForPlatform->find('vcsComments', [ - Query::equal('providerRepositoryId', [$providerRepositoryId]), - Query::equal('providerBranch', [$providerBranch]), - Query::orderDesc('$createdAt'), - ])); - - foreach ($latestComments as $comment) { - $latestCommentId = $comment->getAttribute('providerCommentId', ''); - - $retries = 0; - $lockAcquired = false; - - while ($retries < 9) { - $retries++; - - try { - $dbForPlatform->createDocument('vcsCommentLocks', new Document([ - '$id' => $latestCommentId - ])); - $lockAcquired = true; - break; - } catch (\Throwable $err) { - if ($retries >= 9) { - Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); - } - - \sleep(1); - } - } - - if ($lockAcquired) { - // Wrap in try/finally to ensure lock file gets deleted - try { - $comment = new Comment($platform); - $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); - $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); - - $latestCommentId = \strval($github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment())); - } finally { - $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); - } - } - } - } - - if (!$isAuthorized) { - $resourceName = $resource->getAttribute('name'); - $projectName = $project->getAttribute('name'); - $name = "{$resourceName} ({$projectName})"; - $message = 'Authorization required for external contributor.'; - - $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); - try { - $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; - if (empty($repositoryName)) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - } catch (RepositoryNotFound $e) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - $owner = $github->getOwnerName($providerInstallationId); - $github->updateCommitStatus($repositoryName, $providerCommitHash, $owner, 'failure', $message, $authorizeUrl, $name); - continue; - } - - if ($external) { - $pullRequestResponse = $github->getPullRequest($owner, $repositoryName, $providerPullRequestId); - $providerRepositoryName = $pullRequestResponse['head']['repo']['owner']['login']; - $providerRepositoryOwner = $pullRequestResponse['head']['repo']['name']; - } - - $commands = []; - if (!empty($resource->getAttribute('installCommand', ''))) { - $commands[] = $resource->getAttribute('installCommand', ''); - } - if (!empty($resource->getAttribute('buildCommand', ''))) { - $commands[] = $resource->getAttribute('buildCommand', ''); - } - if (!empty($resource->getAttribute('commands', ''))) { - $commands[] = $resource->getAttribute('commands', ''); - } - - $deployment = $authorization->skip(fn () => $dbForProject->createDocument('deployments', new Document([ - '$id' => $deploymentId, - '$permissions' => [ - Permission::read(Role::any()), - Permission::update(Role::any()), - Permission::delete(Role::any()), - ], - 'resourceId' => $resourceId, - 'resourceInternalId' => $resourceInternalId, - 'resourceType' => $resourceCollection, - 'entrypoint' => $resource->getAttribute('entrypoint', ''), - 'buildCommands' => \implode(' && ', $commands), - 'startCommand' => $resource->getAttribute('startCommand', ''), - 'buildOutput' => $resource->getAttribute('outputDirectory', ''), - 'adapter' => $resource->getAttribute('adapter', ''), - 'fallbackFile' => $resource->getAttribute('fallbackFile', ''), - 'type' => 'vcs', - 'installationId' => $installationId, - 'installationInternalId' => $installationInternalId, - 'providerRepositoryId' => $providerRepositoryId, - 'repositoryId' => $repositoryId, - 'repositoryInternalId' => $repositoryInternalId, - 'providerBranchUrl' => $providerBranchUrl, - 'providerRepositoryName' => $providerRepositoryName, - 'providerRepositoryOwner' => $providerRepositoryOwner, - 'providerRepositoryUrl' => $providerRepositoryUrl, - 'providerCommitHash' => $providerCommitHash, - 'providerCommitAuthorUrl' => $providerCommitAuthorUrl, - 'providerCommitAuthor' => $providerCommitAuthor, - 'providerCommitMessage' => mb_strimwidth($providerCommitMessage, 0, 255, '...'), - 'providerCommitUrl' => $providerCommitUrl, - 'providerCommentId' => \strval($latestCommentId), - 'providerBranch' => $providerBranch, - 'activate' => $activate, - ]))); - - $resource = $resource - ->setAttribute('latestDeploymentId', $deployment->getId()) - ->setAttribute('latestDeploymentInternalId', $deployment->getSequence()) - ->setAttribute('latestDeploymentCreatedAt', $deployment->getCreatedAt()) - ->setAttribute('latestDeploymentStatus', $deployment->getAttribute('status', '')); - $authorization->skip(fn () => $dbForProject->updateDocument($resource->getCollection(), $resource->getId(), $resource)); - - if ($resource->getCollection() === 'sites') { - $projectId = $project->getId(); - - // Deployment preview - $sitesDomain = $platform['sitesDomain']; - $domain = ID::unique() . "." . $sitesDomain; - $ruleId = md5($domain); - $previewRuleId = $ruleId; - $authorization->skip( - fn () => $dbForPlatform->createDocument('rules', new Document([ - '$id' => $ruleId, - 'projectId' => $project->getId(), - 'projectInternalId' => $project->getSequence(), - 'domain' => $domain, - 'type' => 'deployment', - 'trigger' => 'deployment', - 'deploymentId' => $deployment->getId(), - 'deploymentInternalId' => $deployment->getSequence(), - 'deploymentResourceType' => 'site', - 'deploymentResourceId' => $resourceId, - 'deploymentResourceInternalId' => $resourceInternalId, - 'deploymentVcsProviderBranch' => $providerBranch, - 'status' => 'verified', - 'certificateId' => '', - 'search' => implode(' ', [$ruleId, $domain]), - 'owner' => 'Appwrite', - 'region' => $project->getAttribute('region') - ])) - ); - - // VCS branch preview - if (!empty($providerBranch)) { - $domain = (new BranchDomainFilter())->apply([ - 'branch' => $providerBranch, - 'resourceId' => $resource->getId(), - 'projectId' => $project->getId(), - 'sitesDomain' => $sitesDomain, - ]); - $ruleId = md5($domain); - try { - $authorization->skip( - fn () => $dbForPlatform->createDocument('rules', new Document([ - '$id' => $ruleId, - 'projectId' => $project->getId(), - 'projectInternalId' => $project->getSequence(), - 'domain' => $domain, - 'type' => 'deployment', - 'trigger' => 'deployment', - 'deploymentId' => $deployment->getId(), - 'deploymentInternalId' => $deployment->getSequence(), - 'deploymentResourceType' => 'site', - 'deploymentResourceId' => $resourceId, - 'deploymentResourceInternalId' => $resourceInternalId, - 'deploymentVcsProviderBranch' => $providerBranch, - 'status' => 'verified', - 'certificateId' => '', - 'search' => implode(' ', [$ruleId, $domain]), - 'owner' => 'Appwrite', - 'region' => $project->getAttribute('region') - ])) - ); - } catch (Duplicate $err) { - // Ignore, rule already exists; will be updated by builds worker - } - } - - // VCS commit preview - if (!empty($providerCommitHash)) { - $domain = "commit-" . substr($providerCommitHash, 0, 16) . ".{$sitesDomain}"; - $ruleId = md5($domain); - try { - $authorization->skip( - fn () => $dbForPlatform->createDocument('rules', new Document([ - '$id' => $ruleId, - 'projectId' => $project->getId(), - 'projectInternalId' => $project->getSequence(), - 'domain' => $domain, - 'type' => 'deployment', - 'trigger' => 'deployment', - 'deploymentId' => $deployment->getId(), - 'deploymentInternalId' => $deployment->getSequence(), - 'deploymentResourceType' => 'site', - 'deploymentResourceId' => $resourceId, - 'deploymentResourceInternalId' => $resourceInternalId, - 'deploymentVcsProviderBranch' => $providerBranch, - 'status' => 'verified', - 'certificateId' => '', - 'search' => implode(' ', [$ruleId, $domain]), - 'owner' => 'Appwrite', - 'region' => $project->getAttribute('region') - ])) - ); - } catch (Duplicate $err) { - // Ignore, rule already exists; will be updated by builds worker - } - } - } - - if ($resource->getCollection() === 'sites' && !empty($latestCommentId) && !empty($previewRuleId)) { - $retries = 0; - $lockAcquired = false; - - while ($retries < 9) { - $retries++; - - try { - $dbForPlatform->createDocument('vcsCommentLocks', new Document([ - '$id' => $latestCommentId - ])); - $lockAcquired = true; - break; - } catch (\Throwable $err) { - if ($retries >= 9) { - Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); - } - - \sleep(1); - } - } - - if ($lockAcquired) { - // Wrap in try/finally to ensure lock file gets deleted - try { - $rule = $authorization->skip(fn () => $dbForPlatform->getDocument('rules', $previewRuleId)); - - $protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https'; - $previewUrl = !empty($rule) ? ("{$protocol}://" . $rule->getAttribute('domain', '')) : ''; - - if (!empty($previewUrl)) { - $comment = new Comment($platform); - $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); - $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, $previewUrl); - $github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment()); - } - } finally { - $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); - } - } - } - - if (!empty($providerCommitHash) && $resource->getAttribute('providerSilentMode', false) === false) { - $resourceName = $resource->getAttribute('name'); - $projectName = $project->getAttribute('name'); - $region = $project->getAttribute('region', 'default'); - $name = "{$resourceName} ({$projectName})"; - $message = 'Starting...'; - - $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); - try { - $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; - if (empty($repositoryName)) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - } catch (RepositoryNotFound $e) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - $owner = $github->getOwnerName($providerInstallationId); - - $providerTargetUrl = $protocol . '://' . $hostname . "/console/project-$region-$projectId/$resourceCollection/$resourceType-$resourceId"; - $github->updateCommitStatus($repositoryName, $providerCommitHash, $owner, 'pending', $message, $providerTargetUrl, $name); - } - - $queueForBuilds - ->setType(BUILD_TYPE_DEPLOYMENT) - ->setResource($resource) - ->setDeployment($deployment) - ->setProject($project); // set the project because it won't be set for git deployments - - $queueForBuilds->trigger(); // must trigger here so that we create a build for each function/site - - //TODO: Add event? - } catch (Throwable $e) { - $errors[] = $e->getMessage(); - } - } - - $queueForBuilds->reset(); // prevent shutdown hook from triggering again - - if (!empty($errors)) { - throw new Exception(Exception::GENERAL_UNKNOWN, \implode("\n", $errors)); - } -}; - -Http::post('/v1/vcs/github/events') - ->desc('Create event') - ->groups(['api', 'vcs']) - ->label('scope', 'public') - ->inject('gitHub') - ->inject('request') - ->inject('response') - ->inject('dbForPlatform') - ->inject('authorization') - ->inject('getProjectDB') - ->inject('queueForBuilds') - ->inject('platform') - ->action( - function (GitHub $github, Request $request, Response $response, Database $dbForPlatform, Authorization $authorization, callable $getProjectDB, Build $queueForBuilds, array $platform) use ($createGitDeployments) { - $payload = $request->getRawPayload(); - $signatureRemote = $request->getHeader('x-hub-signature-256', ''); - $signatureLocal = System::getEnv('_APP_VCS_GITHUB_WEBHOOK_SECRET', ''); - - $valid = empty($signatureRemote) ? true : $github->validateWebhookEvent($payload, $signatureRemote, $signatureLocal); - - if (!$valid) { - throw new Exception(Exception::GENERAL_ACCESS_FORBIDDEN, "Invalid webhook payload signature. Please make sure the webhook secret has same value in your GitHub app and in the _APP_VCS_GITHUB_WEBHOOK_SECRET environment variable"); - } - - $event = $request->getHeader('x-github-event', ''); - $privateKey = System::getEnv('_APP_VCS_GITHUB_PRIVATE_KEY'); - $githubAppId = System::getEnv('_APP_VCS_GITHUB_APP_ID'); - $parsedPayload = $github->getEvent($event, $payload); - - if ($event == $github::EVENT_PUSH) { - $providerBranchCreated = $parsedPayload["branchCreated"] ?? false; - $providerBranchDeleted = $parsedPayload["branchDeleted"] ?? false; - $providerBranch = $parsedPayload["branch"] ?? ''; - $providerBranchUrl = $parsedPayload["branchUrl"] ?? ''; - $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; - $providerRepositoryName = $parsedPayload["repositoryName"] ?? ''; - $providerInstallationId = $parsedPayload["installationId"] ?? ''; - $providerRepositoryUrl = $parsedPayload["repositoryUrl"] ?? ''; - $providerCommitHash = $parsedPayload["commitHash"] ?? ''; - $providerRepositoryOwner = $parsedPayload["owner"] ?? ''; - $providerCommitAuthorName = $parsedPayload["headCommitAuthorName"] ?? ''; - $providerCommitAuthorEmail = $parsedPayload["headCommitAuthorEmail"] ?? ''; - $providerCommitAuthorUrl = $parsedPayload["authorUrl"] ?? ''; - $providerCommitMessage = $parsedPayload["headCommitMessage"] ?? ''; - $providerCommitUrl = $parsedPayload["headCommitUrl"] ?? ''; - - $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); - - //find resourceId from relevant resources table - $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ - Query::equal('providerRepositoryId', [$providerRepositoryId]), - Query::limit(100), - ])); - - // create new deployment only on push (not committed by us) and not when branch is created or deleted - if ($providerCommitAuthorEmail !== APP_VCS_GITHUB_EMAIL && !$providerBranchCreated && !$providerBranchDeleted) { - $createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, $providerBranchUrl, $providerRepositoryName, $providerRepositoryUrl, $providerRepositoryOwner, $providerCommitHash, $providerCommitAuthorName, $providerCommitAuthorUrl, $providerCommitMessage, $providerCommitUrl, '', false, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $request, $platform); - } - } elseif ($event == $github::EVENT_INSTALLATION) { - if ($parsedPayload["action"] == "deleted") { - // TODO: Use worker for this job instead (update function/site as well) - $providerInstallationId = $parsedPayload["installationId"]; - - $installations = $dbForPlatform->find('installations', [ - Query::equal('providerInstallationId', [$providerInstallationId]), - Query::limit(1000) - ]); - - foreach ($installations as $installation) { - $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ - Query::equal('installationInternalId', [$installation->getSequence()]), - Query::limit(1000) - ])); - - foreach ($repositories as $repository) { - $authorization->skip(fn () => $dbForPlatform->deleteDocument('repositories', $repository->getId())); - } - - $authorization->skip(fn () => $dbForPlatform->deleteDocument('installations', $installation->getId())); - } - } - } elseif ($event == $github::EVENT_PULL_REQUEST) { - if ($parsedPayload["action"] == "opened" || $parsedPayload["action"] == "reopened" || $parsedPayload["action"] == "synchronize") { - $providerBranch = $parsedPayload["branch"] ?? ''; - $providerBranchUrl = $parsedPayload["branchUrl"] ?? ''; - $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; - $providerRepositoryName = $parsedPayload["repositoryName"] ?? ''; - $providerInstallationId = $parsedPayload["installationId"] ?? ''; - $providerRepositoryUrl = $parsedPayload["repositoryUrl"] ?? ''; - $providerPullRequestId = $parsedPayload["pullRequestNumber"] ?? ''; - $providerCommitHash = $parsedPayload["commitHash"] ?? ''; - $providerRepositoryOwner = $parsedPayload["owner"] ?? ''; - $external = $parsedPayload["external"] ?? true; - $providerCommitUrl = $parsedPayload["headCommitUrl"] ?? ''; - $providerCommitAuthorUrl = $parsedPayload["authorUrl"] ?? ''; - - // Ignore sync for non-external. We handle it in push webhook - if (!$external && $parsedPayload["action"] == "synchronize") { - return $response->json($parsedPayload); - } - - $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); - - $commitDetails = $github->getCommit($providerRepositoryOwner, $providerRepositoryName, $providerCommitHash); - $providerCommitAuthor = $commitDetails["commitAuthor"] ?? ''; - $providerCommitMessage = $commitDetails["commitMessage"] ?? ''; - - $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ - Query::equal('providerRepositoryId', [$providerRepositoryId]), - Query::orderDesc('$createdAt') - ])); - - $createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, $providerBranchUrl, $providerRepositoryName, $providerRepositoryUrl, $providerRepositoryOwner, $providerCommitHash, $providerCommitAuthor, $providerCommitAuthorUrl, $providerCommitMessage, $providerCommitUrl, $providerPullRequestId, $external, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $request, $platform); - } elseif ($parsedPayload["action"] == "closed") { - // Allowed external contributions cleanup - - $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; - $providerPullRequestId = $parsedPayload["pullRequestNumber"] ?? ''; - $external = $parsedPayload["external"] ?? true; - - if ($external) { - $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ - Query::equal('providerRepositoryId', [$providerRepositoryId]), - Query::orderDesc('$createdAt') - ])); - - foreach ($repositories as $repository) { - $providerPullRequestIds = $repository->getAttribute('providerPullRequestIds', []); - - if (\in_array($providerPullRequestId, $providerPullRequestIds)) { - $providerPullRequestIds = \array_diff($providerPullRequestIds, [$providerPullRequestId]); - $repository = $repository->setAttribute('providerPullRequestIds', $providerPullRequestIds); - $repository = $authorization->skip(fn () => $dbForPlatform->updateDocument('repositories', $repository->getId(), $repository)); - } - } - } - } - } - - $response->json($parsedPayload); - } - ); - -Http::patch('/v1/vcs/github/installations/:installationId/repositories/:repositoryId') - ->desc('Update external deployment (authorize)') - ->groups(['api', 'vcs']) - ->label('scope', 'vcs.write') - ->label('sdk', new Method( - namespace: 'vcs', - group: 'repositories', - name: 'updateExternalDeployments', - description: '/docs/references/vcs/update-external-deployments.md', - auth: [AuthType::ADMIN], - responses: [ - new SDKResponse( - code: Response::STATUS_CODE_NOCONTENT, - model: Response::MODEL_NONE, - ) - ] - )) - ->param('installationId', '', new Text(256), 'Installation Id') - ->param('repositoryId', '', new Text(256), 'VCS Repository Id') - ->param('providerPullRequestId', '', new Text(256), 'GitHub Pull Request Id') - ->inject('gitHub') - ->inject('response') - ->inject('project') - ->inject('dbForPlatform') - ->inject('authorization') - ->inject('getProjectDB') - ->inject('queueForBuilds') - ->inject('platform') - ->action(function (string $installationId, string $repositoryId, string $providerPullRequestId, GitHub $github, Request $request, Response $response, Document $project, Database $dbForPlatform, Authorization $authorization, callable $getProjectDB, Build $queueForBuilds, array $platform) use ($createGitDeployments) { - $installation = $dbForPlatform->getDocument('installations', $installationId); - - if ($installation->isEmpty()) { - throw new Exception(Exception::INSTALLATION_NOT_FOUND); - } - - $repository = $authorization->skip(fn () => $dbForPlatform->findOne('repositories', [ - Query::equal('$id', [$repositoryId]), - Query::equal('projectInternalId', [$project->getSequence()]) - ])); - - if ($repository->isEmpty()) { - throw new Exception(Exception::REPOSITORY_NOT_FOUND); - } - - if (\in_array($providerPullRequestId, $repository->getAttribute('providerPullRequestIds', []))) { - throw new Exception(Exception::PROVIDER_CONTRIBUTION_CONFLICT); - } - - $providerPullRequestIds = \array_unique(\array_merge($repository->getAttribute('providerPullRequestIds', []), [$providerPullRequestId])); - $repository = $repository->setAttribute('providerPullRequestIds', $providerPullRequestIds); - - // TODO: Delete from array when PR is closed - - $repository = $authorization->skip(fn () => $dbForPlatform->updateDocument('repositories', $repository->getId(), $repository)); - - $privateKey = System::getEnv('_APP_VCS_GITHUB_PRIVATE_KEY'); - $githubAppId = System::getEnv('_APP_VCS_GITHUB_APP_ID'); - $providerInstallationId = $installation->getAttribute('providerInstallationId'); - $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); - - $repositories = [$repository]; - $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); - - $owner = $github->getOwnerName($providerInstallationId); - try { - $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; - if (empty($repositoryName)) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - } catch (RepositoryNotFound $e) { - throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); - } - $pullRequestResponse = $github->getPullRequest($owner, $repositoryName, $providerPullRequestId); - - $providerBranch = \explode(':', $pullRequestResponse['head']['label'])[1] ?? ''; - $providerCommitHash = $pullRequestResponse['head']['sha'] ?? ''; - $providerBranchUrl = $pullRequestResponse['head']['repo']['html_url'] ?? ''; - $providerRepositoryName = $pullRequestResponse['head']['repo']['name'] ?? ''; - $providerRepositoryUrl = $pullRequestResponse['head']['repo']['html_url'] ?? ''; - $providerRepositoryOwner = $pullRequestResponse['head']['repo']['owner']['login'] ?? ''; - $providerCommitAuthor = $pullRequestResponse['head']['user']['login'] ?? ''; - $providerCommitAuthorUrl = $pullRequestResponse['head']['user']['html_url'] ?? ''; - $providerCommitMessage = $pullRequestResponse['title'] ?? ''; - $providerCommitUrl = $pullRequestResponse['html_url'] ?? ''; - - $createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, '', '', '', '', $providerCommitHash, '', '', '', '', $providerPullRequestId, true, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $request, $platform); - - $response->noContent(); - }); diff --git a/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Action.php b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Action.php new file mode 100644 index 0000000000..0a8ac2a026 --- /dev/null +++ b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Action.php @@ -0,0 +1,522 @@ +getId(); + $resourceType = $repository->getAttribute('resourceType'); + + $logBase = "vcs.github.event.{$repositoryId}"; + Span::add("{$logBase}.resourceType", $resourceType); + Span::add("{$logBase}.projectId", $projectId); + + if ($resourceType !== "function" && $resourceType !== "site") { + continue; + } + + $projectId = $repository->getAttribute('projectId'); + $project = $authorization->skip(fn () => $dbForPlatform->getDocument('projects', $projectId)); + + if ($project->isEmpty()) { + throw new Exception(Exception::PROJECT_NOT_FOUND, 'Repository references non-existent project'); + } + + if (!$this->validateDB($project)) { + continue; + } + + $dbForProject = $getProjectDB($project); + $resourceCollection = $resourceType === "function" ? 'functions' : 'sites'; + $resourceId = $repository->getAttribute('resourceId'); + $resource = $authorization->skip(fn () => $dbForProject->getDocument($resourceCollection, $resourceId)); + $resourceInternalId = $resource->getSequence(); + + $deploymentId = ID::unique(); + $repositoryId = $repository->getId(); + $repositoryInternalId = $repository->getSequence(); + $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); + $installationId = $repository->getAttribute('installationId'); + $installationInternalId = $repository->getAttribute('installationInternalId'); + $productionBranch = $resource->getAttribute('providerBranch'); + $activate = false; + + if ($providerBranch == $productionBranch && $external === false) { + $activate = true; + } + + $owner = $github->getOwnerName($providerInstallationId) ?? ''; + try { + $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; + if (empty($repositoryName)) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + } catch (RepositoryNotFound $e) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + + if (empty($repositoryName)) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + + $isAuthorized = !$external; + + if (!$isAuthorized && !empty($providerPullRequestId)) { + if (\in_array($providerPullRequestId, $repository->getAttribute('providerPullRequestIds', []))) { + $isAuthorized = true; + } + } + + Span::add("{$logBase}.authorized", $isAuthorized); + + $commentStatus = $isAuthorized ? 'waiting' : 'failed'; + $protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https'; + $hostname = $platform['consoleHostname'] ?? ''; + + $authorizeUrl = $protocol . '://' . $hostname . "/console/git/authorize-contributor?projectId={$projectId}&installationId={$installationId}&repositoryId={$repositoryId}&providerPullRequestId={$providerPullRequestId}"; + + $action = $isAuthorized ? ['type' => 'logs'] : ['type' => 'authorize', 'url' => $authorizeUrl]; + + $latestCommentId = ''; + + if (!empty($providerPullRequestId) && $resource->getAttribute('providerSilentMode', false) === false) { + $latestComment = $authorization->skip(fn () => $dbForPlatform->findOne('vcsComments', [ + Query::equal('providerRepositoryId', [$providerRepositoryId]), + Query::equal('providerPullRequestId', [$providerPullRequestId]), + Query::orderDesc('$createdAt'), + ])); + + if (!$latestComment->isEmpty()) { + $latestCommentId = $latestComment->getAttribute('providerCommentId', ''); + + $retries = 0; + $lockAcquired = false; + + while ($retries < 9) { + $retries++; + + try { + $dbForPlatform->createDocument('vcsCommentLocks', new Document([ + '$id' => $latestCommentId + ])); + $lockAcquired = true; + break; + } catch (\Throwable $err) { + if ($retries >= 9) { + Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); + } + + \sleep(1); + } + } + + if ($lockAcquired) { + // Wrap in try/finally to ensure lock file gets deleted + try { + $comment = new Comment($platform); + $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); + $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); + + $latestCommentId = \strval($github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment())); + } finally { + $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); + } + } + } else { + $comment = new Comment($platform); + $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); + $latestCommentId = \strval($github->createComment($owner, $repositoryName, $providerPullRequestId, $comment->generateComment())); + + if (!empty($latestCommentId)) { + $teamId = $project->getAttribute('teamId', ''); + + $latestComment = $authorization->skip(fn () => $dbForPlatform->createDocument('vcsComments', new Document([ + '$id' => ID::unique(), + '$permissions' => [ + Permission::read(Role::team(ID::custom($teamId))), + Permission::update(Role::team(ID::custom($teamId), 'owner')), + Permission::update(Role::team(ID::custom($teamId), 'developer')), + Permission::delete(Role::team(ID::custom($teamId), 'owner')), + Permission::delete(Role::team(ID::custom($teamId), 'developer')), + ], + 'installationInternalId' => $installationInternalId, + 'installationId' => $installationId, + 'projectInternalId' => $project->getSequence(), + 'projectId' => $project->getId(), + 'providerRepositoryId' => $providerRepositoryId, + 'providerBranch' => $providerBranch, + 'providerPullRequestId' => $providerPullRequestId, + 'providerCommentId' => $latestCommentId + ]))); + } + } + } elseif (!empty($providerBranch)) { + $latestComments = $authorization->skip(fn () => $dbForPlatform->find('vcsComments', [ + Query::equal('providerRepositoryId', [$providerRepositoryId]), + Query::equal('providerBranch', [$providerBranch]), + Query::orderDesc('$createdAt'), + ])); + + foreach ($latestComments as $comment) { + $latestCommentId = $comment->getAttribute('providerCommentId', ''); + + $retries = 0; + $lockAcquired = false; + + while ($retries < 9) { + $retries++; + + try { + $dbForPlatform->createDocument('vcsCommentLocks', new Document([ + '$id' => $latestCommentId + ])); + $lockAcquired = true; + break; + } catch (\Throwable $err) { + if ($retries >= 9) { + Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); + } + + \sleep(1); + } + } + + if ($lockAcquired) { + // Wrap in try/finally to ensure lock file gets deleted + try { + $comment = new Comment($platform); + $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); + $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, ''); + + $latestCommentId = \strval($github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment())); + } finally { + $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); + } + } + } + } + + if (!$isAuthorized) { + $resourceName = $resource->getAttribute('name'); + $projectName = $project->getAttribute('name'); + $name = "{$resourceName} ({$projectName})"; + $message = 'Authorization required for external contributor.'; + + $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); + try { + $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; + if (empty($repositoryName)) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + } catch (RepositoryNotFound $e) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + $owner = $github->getOwnerName($providerInstallationId); + $github->updateCommitStatus($repositoryName, $providerCommitHash, $owner, 'failure', $message, $authorizeUrl, $name); + continue; + } + + if ($external) { + $pullRequestResponse = $github->getPullRequest($owner, $repositoryName, $providerPullRequestId); + $providerRepositoryName = $pullRequestResponse['head']['repo']['owner']['login']; + $providerRepositoryOwner = $pullRequestResponse['head']['repo']['name']; + } + + $commands = []; + if (!empty($resource->getAttribute('installCommand', ''))) { + $commands[] = $resource->getAttribute('installCommand', ''); + } + if (!empty($resource->getAttribute('buildCommand', ''))) { + $commands[] = $resource->getAttribute('buildCommand', ''); + } + if (!empty($resource->getAttribute('commands', ''))) { + $commands[] = $resource->getAttribute('commands', ''); + } + + $deployment = $authorization->skip(fn () => $dbForProject->createDocument('deployments', new Document([ + '$id' => $deploymentId, + '$permissions' => [ + Permission::read(Role::any()), + Permission::update(Role::any()), + Permission::delete(Role::any()), + ], + 'resourceId' => $resourceId, + 'resourceInternalId' => $resourceInternalId, + 'resourceType' => $resourceCollection, + 'entrypoint' => $resource->getAttribute('entrypoint', ''), + 'buildCommands' => \implode(' && ', $commands), + 'startCommand' => $resource->getAttribute('startCommand', ''), + 'buildOutput' => $resource->getAttribute('outputDirectory', ''), + 'adapter' => $resource->getAttribute('adapter', ''), + 'fallbackFile' => $resource->getAttribute('fallbackFile', ''), + 'type' => 'vcs', + 'installationId' => $installationId, + 'installationInternalId' => $installationInternalId, + 'providerRepositoryId' => $providerRepositoryId, + 'repositoryId' => $repositoryId, + 'repositoryInternalId' => $repositoryInternalId, + 'providerBranchUrl' => $providerBranchUrl, + 'providerRepositoryName' => $providerRepositoryName, + 'providerRepositoryOwner' => $providerRepositoryOwner, + 'providerRepositoryUrl' => $providerRepositoryUrl, + 'providerCommitHash' => $providerCommitHash, + 'providerCommitAuthorUrl' => $providerCommitAuthorUrl, + 'providerCommitAuthor' => $providerCommitAuthor, + 'providerCommitMessage' => mb_strimwidth($providerCommitMessage, 0, 255, '...'), + 'providerCommitUrl' => $providerCommitUrl, + 'providerCommentId' => \strval($latestCommentId), + 'providerBranch' => $providerBranch, + 'activate' => $activate, + ]))); + + $resource = $resource + ->setAttribute('latestDeploymentId', $deployment->getId()) + ->setAttribute('latestDeploymentInternalId', $deployment->getSequence()) + ->setAttribute('latestDeploymentCreatedAt', $deployment->getCreatedAt()) + ->setAttribute('latestDeploymentStatus', $deployment->getAttribute('status', '')); + $authorization->skip(fn () => $dbForProject->updateDocument($resource->getCollection(), $resource->getId(), $resource)); + + if ($resource->getCollection() === 'sites') { + $projectId = $project->getId(); + + // Deployment preview + $sitesDomain = $platform['sitesDomain']; + $domain = ID::unique() . "." . $sitesDomain; + $ruleId = md5($domain); + $previewRuleId = $ruleId; + $authorization->skip( + fn () => $dbForPlatform->createDocument('rules', new Document([ + '$id' => $ruleId, + 'projectId' => $project->getId(), + 'projectInternalId' => $project->getSequence(), + 'domain' => $domain, + 'type' => 'deployment', + 'trigger' => 'deployment', + 'deploymentId' => $deployment->getId(), + 'deploymentInternalId' => $deployment->getSequence(), + 'deploymentResourceType' => 'site', + 'deploymentResourceId' => $resourceId, + 'deploymentResourceInternalId' => $resourceInternalId, + 'deploymentVcsProviderBranch' => $providerBranch, + 'status' => 'verified', + 'certificateId' => '', + 'search' => implode(' ', [$ruleId, $domain]), + 'owner' => 'Appwrite', + 'region' => $project->getAttribute('region') + ])) + ); + + // VCS branch preview + if (!empty($providerBranch)) { + $domain = (new BranchDomainFilter())->apply([ + 'branch' => $providerBranch, + 'resourceId' => $resource->getId(), + 'projectId' => $project->getId(), + 'sitesDomain' => $sitesDomain, + ]); + $ruleId = md5($domain); + try { + $authorization->skip( + fn () => $dbForPlatform->createDocument('rules', new Document([ + '$id' => $ruleId, + 'projectId' => $project->getId(), + 'projectInternalId' => $project->getSequence(), + 'domain' => $domain, + 'type' => 'deployment', + 'trigger' => 'deployment', + 'deploymentId' => $deployment->getId(), + 'deploymentInternalId' => $deployment->getSequence(), + 'deploymentResourceType' => 'site', + 'deploymentResourceId' => $resourceId, + 'deploymentResourceInternalId' => $resourceInternalId, + 'deploymentVcsProviderBranch' => $providerBranch, + 'status' => 'verified', + 'certificateId' => '', + 'search' => implode(' ', [$ruleId, $domain]), + 'owner' => 'Appwrite', + 'region' => $project->getAttribute('region') + ])) + ); + } catch (Duplicate $err) { + // Ignore, rule already exists; will be updated by builds worker + } + } + + // VCS commit preview + if (!empty($providerCommitHash)) { + $domain = "commit-" . substr($providerCommitHash, 0, 16) . ".{$sitesDomain}"; + $ruleId = md5($domain); + try { + $authorization->skip( + fn () => $dbForPlatform->createDocument('rules', new Document([ + '$id' => $ruleId, + 'projectId' => $project->getId(), + 'projectInternalId' => $project->getSequence(), + 'domain' => $domain, + 'type' => 'deployment', + 'trigger' => 'deployment', + 'deploymentId' => $deployment->getId(), + 'deploymentInternalId' => $deployment->getSequence(), + 'deploymentResourceType' => 'site', + 'deploymentResourceId' => $resourceId, + 'deploymentResourceInternalId' => $resourceInternalId, + 'deploymentVcsProviderBranch' => $providerBranch, + 'status' => 'verified', + 'certificateId' => '', + 'search' => implode(' ', [$ruleId, $domain]), + 'owner' => 'Appwrite', + 'region' => $project->getAttribute('region') + ])) + ); + } catch (Duplicate $err) { + // Ignore, rule already exists; will be updated by builds worker + } + } + } + + if ($resource->getCollection() === 'sites' && !empty($latestCommentId) && !empty($previewRuleId)) { + $retries = 0; + $lockAcquired = false; + + while ($retries < 9) { + $retries++; + + try { + $dbForPlatform->createDocument('vcsCommentLocks', new Document([ + '$id' => $latestCommentId + ])); + $lockAcquired = true; + break; + } catch (\Throwable $err) { + if ($retries >= 9) { + Console::warning("Error creating vcs comment lock for " . $latestCommentId . ": " . $err->getMessage()); + } + + \sleep(1); + } + } + + if ($lockAcquired) { + // Wrap in try/finally to ensure lock file gets deleted + try { + $rule = $authorization->skip(fn () => $dbForPlatform->getDocument('rules', $previewRuleId)); + + $protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https'; + $previewUrl = !empty($rule) ? ("{$protocol}://" . $rule->getAttribute('domain', '')) : ''; + + if (!empty($previewUrl)) { + $comment = new Comment($platform); + $comment->parseComment($github->getComment($owner, $repositoryName, $latestCommentId)); + $comment->addBuild($project, $resource, $resourceType, $commentStatus, $deploymentId, $action, $previewUrl); + $github->updateComment($owner, $repositoryName, $latestCommentId, $comment->generateComment()); + } + } finally { + $authorization->skip(fn () => $dbForPlatform->deleteDocument('vcsCommentLocks', $latestCommentId)); + } + } + } + + if (!empty($providerCommitHash) && $resource->getAttribute('providerSilentMode', false) === false) { + $resourceName = $resource->getAttribute('name'); + $projectName = $project->getAttribute('name'); + $region = $project->getAttribute('region', 'default'); + $name = "{$resourceName} ({$projectName})"; + $message = 'Starting...'; + + $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); + try { + $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; + if (empty($repositoryName)) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + } catch (RepositoryNotFound $e) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + $owner = $github->getOwnerName($providerInstallationId); + + $providerTargetUrl = $protocol . '://' . $hostname . "/console/project-$region-$projectId/$resourceCollection/$resourceType-$resourceId"; + $github->updateCommitStatus($repositoryName, $providerCommitHash, $owner, 'pending', $message, $providerTargetUrl, $name); + } + + $queueName = $this->getBuildQueueName( $project, $dbForPlatform, $authorization); + + $queueForBuilds + ->setQueue($queueName) + ->setType(BUILD_TYPE_DEPLOYMENT) + ->setResource($resource) + ->setDeployment($deployment) + ->setProject($project); // set the project because it won't be set for git deployments + + $queueForBuilds->trigger(); // must trigger here so that we create a build for each function/site + + Span::add("{$logBase}.build.triggered", 'true'); + //TODO: Add event? + } catch (\Throwable $e) { + Span::add("{$logBase}.error", $e->getMessage()); + $errors[] = $e->getMessage(); + } + } + + $queueForBuilds->reset(); // prevent shutdown hook from triggering again + + if (!empty($errors)) { + throw new Exception(Exception::GENERAL_UNKNOWN, \implode("\n", $errors)); + } + } + + protected function validateDB(Document $project): bool + { + return true; + } + + protected function getBuildQueueName(Document $project, Database $dbForPlatform, Authorization $authorization): string + { + return System::getEnv('_APP_BUILDS_QUEUE_NAME', Event::BUILDS_QUEUE_NAME); + } +} \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Authorize/External/Update.php b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Authorize/External/Update.php new file mode 100644 index 0000000000..55529cfdb4 --- /dev/null +++ b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Authorize/External/Update.php @@ -0,0 +1,140 @@ +setHttpMethod(Action::HTTP_REQUEST_METHOD_PATCH) + ->setHttpPath('/v1/vcs/github/installations/:installationId/repositories/:repositoryId') + ->desc('Update external deployment (authorize)') + ->groups(['api', 'vcs']) + ->label('scope', 'vcs.write') + ->label('sdk', new Method( + namespace: 'vcs', + group: 'repositories', + name: 'updateExternalDeployments', + description: '/docs/references/vcs/update-external-deployments.md', + auth: [AuthType::ADMIN], + responses: [ + new SDKResponse( + code: Response::STATUS_CODE_NOCONTENT, + model: Response::MODEL_NONE, + ) + ] + )) + ->param('installationId', '', new Text(256), 'Installation Id') + ->param('repositoryId', '', new Text(256), 'VCS Repository Id') + ->param('providerPullRequestId', '', new Text(256), 'GitHub Pull Request Id') + ->inject('gitHub') + ->inject('response') + ->inject('project') + ->inject('dbForPlatform') + ->inject('authorization') + ->inject('getProjectDB') + ->inject('queueForBuilds') + ->inject('platform') + ->callback($this->action(...)); + } + + public function action( + string $installationId, + string $repositoryId, + string $providerPullRequestId, + GitHub $github, + Response $response, + Document $project, + Database $dbForPlatform, + Authorization $authorization, + callable $getProjectDB, + Build $queueForBuilds, + array $platform + ) + { + $installation = $dbForPlatform->getDocument('installations', $installationId); + + if ($installation->isEmpty()) { + throw new Exception(Exception::INSTALLATION_NOT_FOUND); + } + + $repository = $authorization->skip(fn () => $dbForPlatform->findOne('repositories', [ + Query::equal('$id', [$repositoryId]), + Query::equal('projectInternalId', [$project->getSequence()]) + ])); + + if ($repository->isEmpty()) { + throw new Exception(Exception::REPOSITORY_NOT_FOUND); + } + + if (\in_array($providerPullRequestId, $repository->getAttribute('providerPullRequestIds', []))) { + throw new Exception(Exception::PROVIDER_CONTRIBUTION_CONFLICT); + } + + $providerPullRequestIds = \array_unique(\array_merge($repository->getAttribute('providerPullRequestIds', []), [$providerPullRequestId])); + $repository = $repository->setAttribute('providerPullRequestIds', $providerPullRequestIds); + + // TODO: Delete from array when PR is closed + + $repository = $authorization->skip(fn () => $dbForPlatform->updateDocument('repositories', $repository->getId(), $repository)); + + $privateKey = System::getEnv('_APP_VCS_GITHUB_PRIVATE_KEY'); + $githubAppId = System::getEnv('_APP_VCS_GITHUB_APP_ID'); + $providerInstallationId = $installation->getAttribute('providerInstallationId'); + $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); + + $repositories = [$repository]; + $providerRepositoryId = $repository->getAttribute('providerRepositoryId'); + + $owner = $github->getOwnerName($providerInstallationId); + try { + $repositoryName = $github->getRepositoryName($providerRepositoryId) ?? ''; + if (empty($repositoryName)) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + } catch (RepositoryNotFound $e) { + throw new Exception(Exception::PROVIDER_REPOSITORY_NOT_FOUND); + } + $pullRequestResponse = $github->getPullRequest($owner, $repositoryName, $providerPullRequestId); + + $providerBranch = \explode(':', $pullRequestResponse['head']['label'])[1] ?? ''; + $providerCommitHash = $pullRequestResponse['head']['sha'] ?? ''; + $providerBranchUrl = $pullRequestResponse['head']['repo']['html_url'] ?? ''; + $providerRepositoryName = $pullRequestResponse['head']['repo']['name'] ?? ''; + $providerRepositoryUrl = $pullRequestResponse['head']['repo']['html_url'] ?? ''; + $providerRepositoryOwner = $pullRequestResponse['head']['repo']['owner']['login'] ?? ''; + $providerCommitAuthor = $pullRequestResponse['head']['user']['login'] ?? ''; + $providerCommitAuthorUrl = $pullRequestResponse['head']['user']['html_url'] ?? ''; + $providerCommitMessage = $pullRequestResponse['title'] ?? ''; + $providerCommitUrl = $pullRequestResponse['html_url'] ?? ''; + + $this->createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, '', '', '', '', $providerCommitHash, '', '', '', '', $providerPullRequestId, true, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $platform); + + $response->noContent(); + } +} \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Events/Create.php b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Events/Create.php new file mode 100644 index 0000000000..f21c8bd109 --- /dev/null +++ b/src/Appwrite/Platform/Modules/VCS/Http/GitHub/Events/Create.php @@ -0,0 +1,241 @@ +setHttpMethod(Action::HTTP_REQUEST_METHOD_POST) + ->setHttpPath('/v1/vcs/github/events') + ->desc('Create event') + ->groups(['api', 'vcs']) + ->label('scope', 'public') + ->inject('gitHub') + ->inject('request') + ->inject('response') + ->inject('dbForPlatform') + ->inject('authorization') + ->inject('getProjectDB') + ->inject('queueForBuilds') + ->inject('platform') + ->callback($this->action(...)); + } + + public function action( + GitHub $github, + Request $request, + Response $response, + Database $dbForPlatform, + Authorization $authorization, + callable $getProjectDB, + Build $queueForBuilds, + array $platform + ) { + $event = $request->getHeader('x-github-event', ''); + Span::add('vcs.github.event.name', $event); + + $payload = $request->getRawPayload(); + $signature = $request->getHeader('x-hub-signature-256', ''); + $secretKey = System::getEnv('_APP_VCS_GITHUB_WEBHOOK_SECRET', ''); + + $valid = empty($signature) ? true : $github->validateWebhookEvent($payload, $signature, $secretKey); + Span::add('vcs.github.event.signature.valid', $valid); + + if (!$valid) { + throw new Exception(Exception::GENERAL_ACCESS_FORBIDDEN, "Invalid webhook payload signature. Please make sure the webhook secret has same value in your GitHub app and in the _APP_VCS_GITHUB_WEBHOOK_SECRET environment variable"); + } + + // TODO(hmacr): Forward event to other regions + + $githubAppId = System::getEnv('_APP_VCS_GITHUB_APP_ID'); + $privateKey = System::getEnv('_APP_VCS_GITHUB_PRIVATE_KEY'); + $parsedPayload = $github->getEvent($event, $payload); + + match ($event) { + $github::EVENT_INSTALLATION => $this->handleInstallationEvent($parsedPayload, $dbForPlatform, $authorization), + $github::EVENT_PUSH => $this->handlePushEvent($parsedPayload, $githubAppId, $privateKey, $github, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $platform), + $github::EVENT_PULL_REQUEST => $this->handlePullRequestEvent($parsedPayload, $privateKey, $githubAppId, $github, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $platform), + default => null, + }; + + return $response->json($parsedPayload); + } + + private function handleInstallationEvent( + array $parsedPayload, + Database $dbForPlatform, + Authorization $authorization, + ) + { + if ($parsedPayload["action"] !== "deleted") { + return; + } + + // TODO: Use worker for this job instead (update function/site as well) + $providerInstallationId = $parsedPayload["installationId"]; + + $installations = $dbForPlatform->find('installations', [ + Query::equal('providerInstallationId', [$providerInstallationId]), + Query::limit(1000) + ]); + + foreach ($installations as $installation) { + $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ + Query::equal('installationInternalId', [$installation->getSequence()]), + Query::limit(1000) + ])); + + foreach ($repositories as $repository) { + $authorization->skip(fn () => $dbForPlatform->deleteDocument('repositories', $repository->getId())); + } + + $authorization->skip(fn () => $dbForPlatform->deleteDocument('installations', $installation->getId())); + } + } + + private function handlePushEvent( + array $parsedPayload, + string $githubAppId, + string $privateKey, + GitHub $github, + Database $dbForPlatform, + Authorization $authorization, + Build $queueForBuilds, + callable $getProjectDB, + array $platform, + ) + { + $providerBranchCreated = $parsedPayload["branchCreated"] ?? false; + $providerBranchDeleted = $parsedPayload["branchDeleted"] ?? false; + $providerBranch = $parsedPayload["branch"] ?? ''; + $providerBranchUrl = $parsedPayload["branchUrl"] ?? ''; + $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; + $providerRepositoryName = $parsedPayload["repositoryName"] ?? ''; + $providerInstallationId = $parsedPayload["installationId"] ?? ''; + $providerRepositoryUrl = $parsedPayload["repositoryUrl"] ?? ''; + $providerCommitHash = $parsedPayload["commitHash"] ?? ''; + $providerRepositoryOwner = $parsedPayload["owner"] ?? ''; + $providerCommitAuthorName = $parsedPayload["headCommitAuthorName"] ?? ''; + $providerCommitAuthorEmail = $parsedPayload["headCommitAuthorEmail"] ?? ''; + $providerCommitAuthorUrl = $parsedPayload["authorUrl"] ?? ''; + $providerCommitMessage = $parsedPayload["headCommitMessage"] ?? ''; + $providerCommitUrl = $parsedPayload["headCommitUrl"] ?? ''; + + Span::add('vcs.github.event.repo.id', $providerRepositoryId); + Span::add('vcs.github.event.repo.name', $providerRepositoryName); + Span::add('vcs.github.event.branch', $providerBranch); + Span::add('vcs.github.event.installation.id', $providerInstallationId); + + $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); + + // Find associated repositories + $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ + Query::equal('providerRepositoryId', [$providerRepositoryId]), + Query::limit(100), + ])); + + // Create new deployment only on push (not committed by us) and not when branch is created or deleted + if ($providerCommitAuthorEmail !== APP_VCS_GITHUB_EMAIL && !$providerBranchCreated && !$providerBranchDeleted) { + $this->createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, $providerBranchUrl, $providerRepositoryName, $providerRepositoryUrl, $providerRepositoryOwner, $providerCommitHash, $providerCommitAuthorName, $providerCommitAuthorUrl, $providerCommitMessage, $providerCommitUrl, '', false, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $platform); + } + } + + private function handlePullRequestEvent( + array $parsedPayload, + string $privateKey, + string $githubAppId, + GitHub $github, + Database $dbForPlatform, + Authorization $authorization, + Build $queueForBuilds, + callable $getProjectDB, + array $platform, + ) + { + $action = $parsedPayload["action"] ?? ''; + + if ($action == "opened" || $action == "reopened" || $action == "synchronize") { + $providerBranch = $parsedPayload["branch"] ?? ''; + $providerBranchUrl = $parsedPayload["branchUrl"] ?? ''; + $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; + $providerRepositoryName = $parsedPayload["repositoryName"] ?? ''; + $providerInstallationId = $parsedPayload["installationId"] ?? ''; + $providerRepositoryUrl = $parsedPayload["repositoryUrl"] ?? ''; + $providerPullRequestId = $parsedPayload["pullRequestNumber"] ?? ''; + $providerCommitHash = $parsedPayload["commitHash"] ?? ''; + $providerRepositoryOwner = $parsedPayload["owner"] ?? ''; + $external = $parsedPayload["external"] ?? true; + $providerCommitUrl = $parsedPayload["headCommitUrl"] ?? ''; + $providerCommitAuthorUrl = $parsedPayload["authorUrl"] ?? ''; + + Span::add('vcs.github.event.repo.id', $providerRepositoryId); + Span::add('vcs.github.event.repo.name', $providerRepositoryName); + Span::add('vcs.github.event.branch', $providerBranch); + Span::add('vcs.github.event.installation.id', $providerInstallationId); + + // Ignore sync for non-external. We handle it in push webhook + if (!$external && $parsedPayload["action"] == "synchronize") { + return; + } + + $github->initializeVariables($providerInstallationId, $privateKey, $githubAppId); + + $commitDetails = $github->getCommit($providerRepositoryOwner, $providerRepositoryName, $providerCommitHash); + $providerCommitAuthor = $commitDetails["commitAuthor"] ?? ''; + $providerCommitMessage = $commitDetails["commitMessage"] ?? ''; + + $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ + Query::equal('providerRepositoryId', [$providerRepositoryId]), + Query::orderDesc('$createdAt') + ])); + + $this->createGitDeployments($github, $providerInstallationId, $repositories, $providerBranch, $providerBranchUrl, $providerRepositoryName, $providerRepositoryUrl, $providerRepositoryOwner, $providerCommitHash, $providerCommitAuthor, $providerCommitAuthorUrl, $providerCommitMessage, $providerCommitUrl, $providerPullRequestId, $external, $dbForPlatform, $authorization, $queueForBuilds, $getProjectDB, $platform); + } elseif ($action == "closed") { + // Allowed external contributions cleanup + + $providerRepositoryId = $parsedPayload["repositoryId"] ?? ''; + $providerPullRequestId = $parsedPayload["pullRequestNumber"] ?? ''; + $external = $parsedPayload["external"] ?? true; + + if ($external) { + $repositories = $authorization->skip(fn () => $dbForPlatform->find('repositories', [ + Query::equal('providerRepositoryId', [$providerRepositoryId]), + Query::orderDesc('$createdAt') + ])); + + foreach ($repositories as $repository) { + $providerPullRequestIds = $repository->getAttribute('providerPullRequestIds', []); + + if (\in_array($providerPullRequestId, $providerPullRequestIds)) { + $providerPullRequestIds = \array_diff($providerPullRequestIds, [$providerPullRequestId]); + $repository = $repository->setAttribute('providerPullRequestIds', $providerPullRequestIds); + $repository = $authorization->skip(fn () => $dbForPlatform->updateDocument('repositories', $repository->getId(), $repository)); + } + } + } + } + } +} \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/VCS/Services/Http.php b/src/Appwrite/Platform/Modules/VCS/Services/Http.php index 8bd2314f9e..ae766ad00e 100644 --- a/src/Appwrite/Platform/Modules/VCS/Services/Http.php +++ b/src/Appwrite/Platform/Modules/VCS/Services/Http.php @@ -2,8 +2,10 @@ namespace Appwrite\Platform\Modules\VCS\Services; +use Appwrite\Platform\Modules\VCS\Http\GitHub\Authorize\External\Update as UpdateExternalDeployment; use Appwrite\Platform\Modules\VCS\Http\GitHub\Authorize\Get as GetGitHubAuthorize; use Appwrite\Platform\Modules\VCS\Http\GitHub\Callback\Get as GetGitHubCallback; +use Appwrite\Platform\Modules\VCS\Http\GitHub\Events\Create as CreateGitHubEvent; use Appwrite\Platform\Modules\VCS\Http\Installations\Delete as DeleteInstallation; use Appwrite\Platform\Modules\VCS\Http\Installations\Get as GetInstallation; use Appwrite\Platform\Modules\VCS\Http\Installations\Repositories\Branches\XList as ListRepositoryBranches; @@ -24,6 +26,7 @@ class Http extends Service // GitHub Authorization & Callback $this->addAction(GetGitHubAuthorize::getName(), new GetGitHubAuthorize()); $this->addAction(GetGitHubCallback::getName(), new GetGitHubCallback()); + $this->addAction(UpdateExternalDeployment::getName(), new UpdateExternalDeployment()); // Installations $this->addAction(GetInstallation::getName(), new GetInstallation()); @@ -37,5 +40,8 @@ class Http extends Service $this->addAction(ListRepositoryBranches::getName(), new ListRepositoryBranches()); $this->addAction(GetRepositoryContents::getName(), new GetRepositoryContents()); $this->addAction(CreateRepositoryDetections::getName(), new CreateRepositoryDetections()); + + // Events + $this->addAction(CreateGitHubEvent::getName(), new CreateGitHubEvent()); } }