createFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'events' => [ 'users.*.create', 'users.*.delete', ], 'schedule' => '0 0 1 1 *', 'timeout' => 10, ]); $this->assertEquals(401, $function['headers']['status-code']); /** * Test for DUPLICATE functionId */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [Role::user($this->getUser()['$id'])->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'events' => [ 'users.*.create', 'users.*.delete', ], 'timeout' => 10, ]); $response = $this->client->call(Client::METHOD_POST, '/functions', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ]), [ 'functionId' => $functionId, 'name' => 'Test', 'execute' => [Role::user($this->getUser()['$id'])->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'events' => [ 'users.*.create', 'users.*.delete', ], 'timeout' => 10, ]); $this->assertEquals(409, $response['headers']['status-code']); } public function testCreateExecution() { /** * Test for SUCCESS */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [Role::user($this->getUser()['$id'])->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'events' => [ 'users.*.create', 'users.*.delete', ], 'timeout' => 10, ]); $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('basic'), 'activate' => true ]); // Deny create async execution as guest $execution = $this->client->call(Client::METHOD_POST, '/functions/' . $functionId . '/executions', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], [ 'async' => true, ]); $this->assertEquals(401, $execution['headers']['status-code']); // Allow create async execution as user $execution = $this->createExecution($functionId, [ 'async' => true, ]); $this->assertEquals(202, $execution['headers']['status-code']); $this->cleanupFunction($functionId); } public function testCreateHeadExecution() { /** * Test for SUCCESS */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [Role::user($this->getUser()['$id'])->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'events' => [ 'users.*.create', 'users.*.delete', ], 'timeout' => 10, ]); $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('basic'), 'activate' => true ]); // Deny create async execution as guest $execution = $this->client->call(Client::METHOD_POST, '/functions/' . $functionId . '/executions', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], [ 'async' => true, ]); $this->assertEquals(401, $execution['headers']['status-code']); // Allow create async execution as user $execution = $this->client->call(Client::METHOD_HEAD, '/functions/' . $functionId . '/executions', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'async' => true, ]); $this->assertEquals(200, $execution['headers']['status-code']); $this->assertEmpty($execution['body']); $this->cleanupFunction($functionId); } public function testCreateCustomExecution(): array { /** * Test for SUCCESS */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [Role::any()->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'timeout' => 10, ]); $deploymentId = $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('basic'), 'activate' => true ]); $execution = $this->createExecution($functionId, [ 'body' => 'foobar', 'async' => 'false' ]); $output = json_decode($execution['body']['responseBody'], true); $this->assertEquals(201, $execution['headers']['status-code']); $this->assertNotEmpty($execution['body']['responseHeaders']); $executionIdHeader = null; foreach ($execution['body']['responseHeaders'] as $header) { if ($header['name'] === 'x-appwrite-execution-id') { $executionIdHeader = $header['value']; break; } } $this->assertNotEmpty($executionIdHeader); $this->assertEquals($execution['body']['$id'], $executionIdHeader); $this->assertEquals(200, $execution['body']['responseStatusCode']); $this->assertGreaterThan(0, $execution['body']['duration']); $this->assertEquals('completed', $execution['body']['status']); $this->assertEquals($functionId, $output['APPWRITE_FUNCTION_ID']); $this->assertEquals('Test', $output['APPWRITE_FUNCTION_NAME']); $this->assertEquals($deploymentId, $output['APPWRITE_FUNCTION_DEPLOYMENT']); $this->assertEquals('http', $output['APPWRITE_FUNCTION_TRIGGER']); $this->assertEquals('Node.js', $output['APPWRITE_FUNCTION_RUNTIME_NAME']); $this->assertEquals('22', $output['APPWRITE_FUNCTION_RUNTIME_VERSION']); $this->assertEquals(APP_VERSION_STABLE, $output['APPWRITE_VERSION']); $this->assertEquals(System::getEnv('_APP_REGION', 'default'), $output['APPWRITE_REGION']); $this->assertEquals('', $output['APPWRITE_FUNCTION_EVENT']); $this->assertEquals('foobar', $output['APPWRITE_FUNCTION_DATA']); $this->assertEquals($this->getUser()['$id'], $output['APPWRITE_FUNCTION_USER_ID']); $this->assertNotEmpty($output['APPWRITE_FUNCTION_JWT']); $this->assertEquals($this->getProject()['$id'], $output['APPWRITE_FUNCTION_PROJECT_ID']); $executionId = $execution['body']['$id'] ?? ''; $this->assertNotEmpty($output['APPWRITE_FUNCTION_EXECUTION_ID']); $this->assertEquals($executionId, $output['APPWRITE_FUNCTION_EXECUTION_ID']); $this->assertNotEmpty($output['APPWRITE_FUNCTION_CLIENT_IP']); $execution = $this->createExecution($functionId, [ 'body' => 'foobar', 'async' => true ]); $executionId = $execution['body']['$id']; $this->assertEquals(202, $execution['headers']['status-code']); $this->assertEventually(function () use ($functionId, $executionId) { $execution = $this->getExecution($functionId, $executionId); $this->assertEquals('completed', $execution['body']['status']); $this->assertEquals(200, $execution['body']['responseStatusCode']); }, 10000, 500); return [ 'functionId' => $functionId ]; } public function testCreateCustomExecutionGuest() { /** * Test for SUCCESS */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test guest execution', 'execute' => [Role::any()->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'vars' => [ 'funcKey1' => 'funcValue1', 'funcKey2' => 'funcValue2', 'funcKey3' => 'funcValue3', ], 'timeout' => 10, ]); $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('basic'), 'activate' => true ]); $execution = $this->client->call(Client::METHOD_POST, '/functions/' . $functionId . '/executions', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], [ 'data' => 'foobar', 'async' => true, ]); $this->assertEquals(202, $execution['headers']['status-code']); } public function testCreateExecutionNoDeployment() { $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'timeout' => 10, ]); $execution = $this->createExecution($functionId, [ 'async' => true ]); $this->assertEquals(404, $execution['headers']['status-code']); } public function testSynchronousExecution() { /** * Test for SUCCESS */ $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test synchronous execution', 'execute' => [Role::any()->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'timeout' => 10, ]); $deploymentId = $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('basic'), 'activate' => true ]); $execution = $this->createExecution($functionId, [ 'body' => 'foobar', // Testing default value, should be 'async' => 'false' ]); $output = json_decode($execution['body']['responseBody'], true); $this->assertEquals(201, $execution['headers']['status-code']); $this->assertEquals('completed', $execution['body']['status']); $this->assertEquals(200, $execution['body']['responseStatusCode']); $this->assertEquals($functionId, $output['APPWRITE_FUNCTION_ID']); $this->assertEquals('Test synchronous execution', $output['APPWRITE_FUNCTION_NAME']); $this->assertEquals($deploymentId, $output['APPWRITE_FUNCTION_DEPLOYMENT']); $this->assertEquals('http', $output['APPWRITE_FUNCTION_TRIGGER']); $this->assertEquals('Node.js', $output['APPWRITE_FUNCTION_RUNTIME_NAME']); $this->assertEquals('22', $output['APPWRITE_FUNCTION_RUNTIME_VERSION']); $this->assertEquals(APP_VERSION_STABLE, $output['APPWRITE_VERSION']); $this->assertEquals(System::getEnv('_APP_REGION', 'default'), $output['APPWRITE_REGION']); $this->assertEquals('', $output['APPWRITE_FUNCTION_EVENT']); $this->assertEquals('foobar', $output['APPWRITE_FUNCTION_DATA']); $this->assertEquals($this->getUser()['$id'], $output['APPWRITE_FUNCTION_USER_ID']); $this->assertNotEmpty($output['APPWRITE_FUNCTION_JWT']); $this->assertEquals($this->getProject()['$id'], $output['APPWRITE_FUNCTION_PROJECT_ID']); // Client should never see logs and errors $this->assertEmpty($execution['body']['logs']); $this->assertEmpty($execution['body']['errors']); $this->cleanupFunction($functionId); } public function testNonOverrideOfHeaders() { $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test', 'execute' => [Role::any()->toString()], 'runtime' => 'node-22', 'entrypoint' => 'index.js' ]); $this->setupDeployment($functionId, [ 'entrypoint' => 'index.js', 'code' => $this->packageFunction('basic'), 'activate' => true ]); $execution = $this->client->call(Client::METHOD_POST, '/functions/' . $functionId . '/executions', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'x-appwrite-event' => "OVERRIDDEN", 'x-appwrite-trigger' => "OVERRIDDEN", 'x-appwrite-user-id' => "OVERRIDDEN", 'x-appwrite-user-jwt' => "OVERRIDDEN", ]); $output = json_decode($execution['body']['responseBody'], true); $this->assertNotEquals('OVERRIDDEN', $output['APPWRITE_FUNCTION_JWT']); $this->assertNotEquals('OVERRIDDEN', $output['APPWRITE_FUNCTION_EVENT']); $this->assertNotEquals('OVERRIDDEN', $output['APPWRITE_FUNCTION_TRIGGER']); $this->assertNotEquals('OVERRIDDEN', $output['APPWRITE_FUNCTION_USER_ID']); $this->cleanupFunction($functionId); } public function testListTemplates() { /** * Test for SUCCESS */ // List all templates $templates = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders())); $this->assertEquals(200, $templates['headers']['status-code']); $this->assertGreaterThan(0, $templates['body']['total']); $this->assertIsArray($templates['body']['templates']); /** * Test for SUCCESS with total=false */ $templatesWithIncludeTotalFalse = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'total' => false ]); $this->assertEquals(200, $templatesWithIncludeTotalFalse['headers']['status-code']); $this->assertIsArray($templatesWithIncludeTotalFalse['body']); $this->assertIsArray($templatesWithIncludeTotalFalse['body']['templates']); $this->assertIsInt($templatesWithIncludeTotalFalse['body']['total']); $this->assertEquals(0, $templatesWithIncludeTotalFalse['body']['total']); $this->assertGreaterThan(0, count($templatesWithIncludeTotalFalse['body']['templates'])); foreach ($templates['body']['templates'] as $template) { $this->assertArrayHasKey('name', $template); $this->assertArrayHasKey('id', $template); $this->assertArrayHasKey('icon', $template); $this->assertArrayHasKey('tagline', $template); $this->assertArrayHasKey('useCases', $template); $this->assertArrayHasKey('vcsProvider', $template); $this->assertArrayHasKey('runtimes', $template); $this->assertArrayHasKey('variables', $template); } // List templates with pagination $templatesOffset = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'limit' => 1, 'offset' => 2 ]); $this->assertEquals(200, $templatesOffset['headers']['status-code']); $this->addToAssertionCount(1, $templatesOffset['body']['templates']); $this->assertEquals($templates['body']['templates'][2]['id'], $templatesOffset['body']['templates'][0]['id']); // List templates with filters $templates = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'useCases' => ['starter', 'ai'], 'runtimes' => ['node-22'] ]); $this->assertEquals(200, $templates['headers']['status-code']); $this->assertGreaterThanOrEqual(3, $templates['body']['total']); $this->assertIsArray($templates['body']['templates']); foreach ($templates['body']['templates'] as $template) { $this->assertContains($template['useCases'][0], ['starter', 'ai']); } $this->assertArrayHasKey('runtimes', $templates['body']['templates'][0]); foreach ($templates['body']['templates'] as $template) { $this->assertThat( \array_column($template['runtimes'], 'name'), $this->logicalOr( $this->containsEqual('node-22'), ), ); } // List templates with pagination and filters $templates = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'limit' => 5, 'offset' => 2, 'useCases' => ['databases'], 'runtimes' => ['node-22'] ]); $this->assertEquals(200, $templates['headers']['status-code']); $this->assertCount(5, $templates['body']['templates']); $this->assertIsArray($templates['body']['templates']); $this->assertArrayHasKey('runtimes', $templates['body']['templates'][0]); foreach ($templates['body']['templates'] as $template) { $this->assertContains($template['useCases'][0], ['databases']); } $this->assertContains('node-22', array_column($templates['body']['templates'][0]['runtimes'], 'name')); /** * Test for FAILURE */ // List templates with invalid limit $templates = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'limit' => 5001, 'offset' => 10, ]); $this->assertEquals(400, $templates['headers']['status-code']); // List templates with invalid offset $templates = $this->client->call(Client::METHOD_GET, '/functions/templates', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'limit' => 5, 'offset' => 5001, ]); $this->assertEquals(400, $templates['headers']['status-code']); } public function testGetTemplate() { /** * Test for SUCCESS */ $template = $this->getTemplate('query-neo4j-auradb'); $this->assertEquals(200, $template['headers']['status-code']); $this->assertIsArray($template['body']); $this->assertEquals('query-neo4j-auradb', $template['body']['id']); $this->assertEquals('Query Neo4j AuraDB', $template['body']['name']); $this->assertEquals('icon-neo4j', $template['body']['icon']); $this->assertEquals('Graph database with focus on relations between data.', $template['body']['tagline']); $this->assertEquals(['databases'], $template['body']['useCases']); $this->assertEquals('github', $template['body']['vcsProvider']); $this->assertIsArray($template['body']['runtimes']); $this->assertIsArray($template['body']['scopes']); /** * Test for FAILURE */ $template = $this->getTemplate('invalid-template-id'); $this->assertEquals(404, $template['headers']['status-code']); } /** * Test that event-triggered functions work when the triggering request * comes from a client SDK (session auth) that doesn't have permission * to read the functions collection. */ public function testEventTriggerWithClientAuth() { $functionId = $this->setupFunction([ 'functionId' => ID::unique(), 'name' => 'Test Client Event Trigger', 'runtime' => 'node-22', 'entrypoint' => 'index.js', 'events' => [ 'databases.*.collections.*.documents.*.create', ], 'timeout' => 15, ]); $this->setupDeployment($functionId, [ 'code' => $this->packageFunction('event-handler'), 'activate' => true ]); $database = $this->client->call(Client::METHOD_POST, '/databases', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ], [ 'databaseId' => ID::unique(), 'name' => 'Test Database', ]); $this->assertEquals(201, $database['headers']['status-code']); $databaseId = $database['body']['$id']; $collection = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ], [ 'collectionId' => ID::unique(), 'name' => 'Test Collection', 'permissions' => [ Permission::create(Role::users()), ], 'documentSecurity' => false, ]); $this->assertEquals(201, $collection['headers']['status-code']); $collectionId = $collection['body']['$id']; $attribute = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/attributes/string', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ], [ 'key' => 'name', 'size' => 255, 'required' => false, ]); $this->assertEquals(202, $attribute['headers']['status-code']); sleep(2); $document = $this->client->call(Client::METHOD_POST, '/databases/' . $databaseId . '/collections/' . $collectionId . '/documents', array_merge([ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], ], $this->getHeaders()), [ 'documentId' => ID::unique(), 'data' => ['name' => 'Test Document'], ]); $this->assertEquals(201, $document['headers']['status-code']); $documentId = $document['body']['$id']; $this->assertEventually(function () use ($functionId, $documentId) { $executions = $this->client->call(Client::METHOD_GET, '/functions/' . $functionId . '/executions', [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ]); $this->assertEquals(200, $executions['headers']['status-code']); $this->assertGreaterThan(0, count($executions['body']['executions']), 'Function should have been triggered by document creation'); $lastExecution = $executions['body']['executions'][0]; $this->assertEquals('completed', $lastExecution['status']); $this->assertEquals(204, $lastExecution['responseStatusCode']); $this->assertStringContainsString($documentId, $lastExecution['logs']); }, 20000, 500); $this->client->call(Client::METHOD_DELETE, '/databases/' . $databaseId, [ 'content-type' => 'application/json', 'x-appwrite-project' => $this->getProject()['$id'], 'x-appwrite-key' => $this->getProject()['apiKey'], ]); $this->cleanupFunction($functionId); } }