appwrite/tests/e2e/Services/GraphQL/FunctionsServerTest.php
2026-03-31 22:04:37 +05:30

534 lines
17 KiB
PHP

<?php
namespace Tests\E2E\Services\GraphQL;
use Appwrite\Tests\Async;
use Appwrite\Tests\Async\Exceptions\Critical;
use Tests\E2E\Client;
use Tests\E2E\Scopes\ProjectCustom;
use Tests\E2E\Scopes\Scope;
use Tests\E2E\Scopes\SideServer;
use Utopia\Database\Helpers\ID;
use Utopia\Database\Helpers\Role;
class FunctionsServerTest extends Scope
{
use ProjectCustom;
use SideServer;
use Base;
use Async;
private static array $cachedFunction = [];
private static array $cachedDeployment = [];
private static array $cachedExecution = [];
protected function setupFunction(): array
{
$key = $this->getProject()['$id'];
if (!empty(self::$cachedFunction[$key])) {
return self::$cachedFunction[$key];
}
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::CREATE_FUNCTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => ID::unique(),
'name' => 'Test Function',
'entrypoint' => 'index.js',
'runtime' => 'node-22',
'execute' => [Role::any()->toString()],
]
];
$function = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($function['body']['data']);
$this->assertArrayNotHasKey('errors', $function['body']);
$function = $function['body']['data']['functionsCreate'];
$functionId = $function['_id'];
$query = '
mutation createVariables($functionId: String!) {
var1: functionsCreateVariable(functionId: $functionId, key: "name", value: "John Doe") {
_id
}
var2: functionsCreateVariable(functionId: $functionId, key: "age", value: "42") {
_id
}
}
';
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $functionId,
]
];
$variables = $this->client->call(Client::METHOD_POST, '/graphql', [
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
'x-appwrite-key' => $this->getProject()['apiKey'],
], $gqlPayload);
$this->assertIsArray($variables['body']['data']);
$this->assertArrayNotHasKey('errors', $variables['body']);
self::$cachedFunction[$key] = $function;
return $function;
}
protected function setupDeployment(): array
{
$key = $this->getProject()['$id'];
if (!empty(self::$cachedDeployment[$key])) {
return self::$cachedDeployment[$key];
}
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::CREATE_DEPLOYMENT);
$gqlPayload = [
'operations' => \json_encode([
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
'activate' => true,
'code' => null,
]
]),
'map' => \json_encode([
'code' => ["variables.code"]
]),
'code' => $this->packageFunction('basic'),
];
$deployment = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'multipart/form-data',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($deployment['body']['data']);
$this->assertArrayNotHasKey('errors', $deployment['body']);
// Poll get deployment until an error, or status is either 'ready' or 'failed'
$deployment = $deployment['body']['data']['functionsCreateDeployment'];
$deploymentId = $deployment['_id'];
$query = $this->getQuery(self::GET_DEPLOYMENT);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
'deploymentId' => $deploymentId,
]
];
$this->assertEventually(function () use ($projectId, $gqlPayload, &$deployment) {
$deployment = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($deployment['body']['data']);
$this->assertArrayNotHasKey('errors', $deployment['body']);
$deployment = $deployment['body']['data']['functionsGetDeployment'];
if ($deployment['status'] === 'failed') {
throw new Critical('Deployment build failed: ' . ($deployment['buildLogs'] ?? 'no logs'));
}
$this->assertEquals('ready', $deployment['status']);
}, 120000);
self::$cachedDeployment[$key] = $deployment;
return $deployment;
}
protected function setupExecution(): array
{
$key = $this->getProject()['$id'];
if (!empty(self::$cachedExecution[$key])) {
return self::$cachedExecution[$key];
}
$deployment = $this->setupDeployment();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::CREATE_EXECUTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $deployment['resourceId'],
]
];
$execution = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($execution['body']['data']);
$this->assertArrayNotHasKey('errors', $execution['body']);
self::$cachedExecution[$key] = $execution['body']['data']['functionsCreateExecution'];
return self::$cachedExecution[$key];
}
public function testCreateFunction(): void
{
$function = $this->setupFunction();
$this->assertIsArray($function);
}
/**
* @return void
* @throws \Exception
*/
public function testCreateDeployment(): void
{
$deployment = $this->setupDeployment();
$this->assertIsArray($deployment);
}
/**
* @return void
* @throws \Exception
*/
public function testCreateExecution(): void
{
$execution = $this->setupExecution();
$this->assertIsArray($execution);
}
/**
* @return void
* @throws \Exception
*/
public function testCreateRetryBuild(): void
{
$deployment = $this->setupDeployment();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::RETRY_BUILD);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $deployment['resourceId'],
'deploymentId' => $deployment['_id'],
'buildId' => $deployment['buildId'],
]
];
$response = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($response['body']['data']);
$this->assertEquals(200, $response['headers']['status-code']);
}
public function testGetFunctions(): array
{
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_FUNCTIONS);
$gqlPayload = [
'query' => $query,
];
$functions = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($functions['body']['data']);
$this->assertArrayNotHasKey('errors', $functions['body']);
$functions = $functions['body']['data']['functionsList'];
$this->assertIsArray($functions);
return $functions;
}
/**
* @return array
* @throws \Exception
*/
public function testGetFunction(): array
{
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_FUNCTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
]
];
$function = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($function['body']['data']);
$this->assertArrayNotHasKey('errors', $function['body']);
$function = $function['body']['data']['functionsGet'];
$this->assertIsArray($function);
return $function;
}
public function testGetRuntimes(): array
{
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_RUNTIMES);
$gqlPayload = [
'query' => $query,
];
$runtimes = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
]), $gqlPayload);
$this->assertIsArray($runtimes['body']['data']);
$this->assertArrayNotHasKey('errors', $runtimes['body']);
$runtimes = $runtimes['body']['data']['functionsListRuntimes'];
$this->assertIsArray($runtimes);
return $runtimes;
}
/**
* @return array
* @throws \Exception
*/
public function testGetDeployments()
{
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_DEPLOYMENTS);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
]
];
$deployments = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($deployments['body']['data']);
$this->assertArrayNotHasKey('errors', $deployments['body']);
$deployments = $deployments['body']['data']['functionsListDeployments'];
$this->assertIsArray($deployments);
return $deployments;
}
/**
* @return array
* @throws \Exception
*/
public function testGetDeployment()
{
$deployment = $this->setupDeployment();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_DEPLOYMENT);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $deployment['resourceId'],
'deploymentId' => $deployment['_id'],
]
];
$deployment = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($deployment['body']['data']);
$this->assertArrayNotHasKey('errors', $deployment['body']);
$deployment = $deployment['body']['data']['functionsGetDeployment'];
$this->assertIsArray($deployment);
return $deployment;
}
/**
* @return array
* @throws \Exception
*/
public function testGetExecutions(): array
{
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_EXECUTIONS);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
]
];
$executions = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($executions['body']['data']);
$this->assertArrayNotHasKey('errors', $executions['body']);
$executions = $executions['body']['data']['functionsListExecutions'];
$this->assertIsArray($executions);
return $executions;
}
/**
* @return array
* @throws \Exception
*/
public function testGetExecution(): array
{
$execution = $this->setupExecution();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::GET_EXECUTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $execution['functionId'],
'executionId' => $execution['_id'],
]
];
$execution = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($execution['body']['data']);
$this->assertArrayNotHasKey('errors', $execution['body']);
$execution = $execution['body']['data']['functionsGetExecution'];
$this->assertIsArray($execution);
return $execution;
}
/**
* @return array
* @throws \Exception
*/
public function testUpdateFunction(): array
{
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::UPDATE_FUNCTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
'name' => 'Test Function Updated',
'execute' => [Role::any()->toString()],
'entrypoint' => 'index.php',
'runtime' => 'php-8.0',
'vars' => [
'name' => 'John Doe',
'age' => 42,
],
]
];
$function = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsArray($function['body']['data']);
$this->assertArrayNotHasKey('errors', $function['body']);
$function = $function['body']['data']['functionsUpdate'];
$this->assertIsArray($function);
return $function;
}
/**
* @throws \Exception
*/
public function testDeleteDeployment(): void
{
$deployment = $this->setupDeployment();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::DELETE_DEPLOYMENT);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $deployment['resourceId'],
'deploymentId' => $deployment['_id'],
]
];
$response = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsNotArray($response['body']);
$this->assertEquals(204, $response['headers']['status-code']);
// Clear cache after deletion
$key = $this->getProject()['$id'];
self::$cachedDeployment[$key] = [];
self::$cachedExecution[$key] = [];
}
/**
* @throws \Exception
*/
public function testDeleteFunction(): void
{
// Ensure deployment is deleted first
$this->testDeleteDeployment();
$function = $this->setupFunction();
$projectId = $this->getProject()['$id'];
$query = $this->getQuery(self::DELETE_FUNCTION);
$gqlPayload = [
'query' => $query,
'variables' => [
'functionId' => $function['_id'],
]
];
$response = $this->client->call(Client::METHOD_POST, '/graphql', \array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $projectId,
], $this->getHeaders()), $gqlPayload);
$this->assertIsNotArray($response['body']);
$this->assertEquals(204, $response['headers']['status-code']);
// Clear cache after deletion
$key = $this->getProject()['$id'];
self::$cachedFunction[$key] = [];
}
}