Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API key migration support and console project scopes

Browse Source
This commit is contained in:
Prem Palanisamy
2026-03-16 22:29:13 +00:00
parent 8f993428de
commit b0d51cd25f
4 changed files with 96 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/config/scopes/consoleProject.php
+2
View File
@@ -4,4 +4,6 @@
return [
'platforms' => 'platforms.read',
'keys' => 'keys.read',
'keysWrite' => 'keys.write',
];
src/Appwrite/Platform/Workers/Migrations.php
+1
View File
@@ -353,6 +353,7 @@ class Migrations extends Action
'messages.write',
'targets.read',
'targets.write',
'migrations.write',
]
]);
src/Appwrite/Utopia/Response/Model/MigrationReport.php
+6
View File
@@ -59,6 +59,12 @@ class MigrationReport extends Model
'default' => 0,
'example' => 5,
])
->addRule(Resource::TYPE_API_KEY, [
'type' => self::TYPE_INTEGER,
'description' => 'Number of API keys to be migrated.',
'default' => 0,
'example' => 5,
])
->addRule(Resource::TYPE_SITE, [
'type' => self::TYPE_INTEGER,
'description' => 'Number of sites to be migrated.',
tests/e2e/Services/Migrations/MigrationsBase.php
+87
View File
@@ -1297,6 +1297,93 @@ trait MigrationsBase
$this->client->call(Client::METHOD_DELETE, '/projects/' . $this->getProject()['$id'] . '/platforms/' . $platform['$id'], $consoleSessionHeaders);
}
public function testAppwriteMigrationApiKey(): void
{
$consoleSessionHeaders = [
'content-type' => 'application/json',
'x-appwrite-project' => 'console',
'origin' => 'http://localhost',
'cookie' => 'a_session_console=' . $this->getRoot()['session'],
];
// Create API key on source project
$response = $this->client->call(Client::METHOD_POST, '/projects/' . $this->getProject()['$id'] . '/keys', $consoleSessionHeaders, [
'name' => 'Test API Key',
'scopes' => ['databases.read', 'databases.write'],
'expire' => null,
]);
$this->assertEquals(201, $response['headers']['status-code']);
$this->assertNotEmpty($response['body']);
$this->assertNotEmpty($response['body']['$id']);
$apiKey = $response['body'];
$result = $this->performMigrationSync([
'resources' => [
Resource::TYPE_API_KEY,
],
'endpoint' => $this->webEndpoint,
'projectId' => $this->getProject()['$id'],
'apiKey' => $this->getProject()['apiKey'],
]);
$this->assertEquals('completed', $result['status']);
$this->assertEquals([Resource::TYPE_API_KEY], $result['resources']);
$this->assertArrayHasKey(Resource::TYPE_API_KEY, $result['statusCounters']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_API_KEY]['error']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_API_KEY]['pending']);
$this->assertGreaterThanOrEqual(1, $result['statusCounters'][Resource::TYPE_API_KEY]['success']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_API_KEY]['processing']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_API_KEY]['warning']);
// Get a console key for the destination project to access console-scoped endpoints
$consoleKeyResponse = $this->client->call(Client::METHOD_POST, '/migrations/appwrite/console-key', [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getDestinationProject()['$id'],
'x-appwrite-key' => $this->getDestinationProject()['apiKey'],
]);
$this->assertEquals(200, $consoleKeyResponse['headers']['status-code']);
$destConsoleKey = $consoleKeyResponse['body']['key'];
// Verify API key on destination project using console key
$response = $this->client->call(Client::METHOD_GET, '/projects/' . $this->getDestinationProject()['$id'] . '/keys', [
'content-type' => 'application/json',
'x-appwrite-project' => 'console',
'x-appwrite-key' => $destConsoleKey,
]);
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertNotEmpty($response['body']);
$this->assertGreaterThan(0, $response['body']['total']);
$foundKey = null;
foreach ($response['body']['keys'] as $k) {
if ($k['name'] === 'Test API Key') {
$foundKey = $k;
break;
}
}
$this->assertNotNull($foundKey);
$this->assertEquals('Test API Key', $foundKey['name']);
$this->assertContains('databases.read', $foundKey['scopes']);
$this->assertContains('databases.write', $foundKey['scopes']);
// Cleanup on destination using console key
$this->client->call(Client::METHOD_DELETE, '/projects/' . $this->getDestinationProject()['$id'] . '/keys/' . $foundKey['$id'], [
'content-type' => 'application/json',
'x-appwrite-project' => 'console',
'x-appwrite-key' => $destConsoleKey,
]);
// Cleanup on source using console project + session auth
$this->client->call(Client::METHOD_DELETE, '/projects/' . $this->getProject()['$id'] . '/keys/' . $apiKey['$id'], $consoleSessionHeaders);
}
/**
* Import documents from a CSV file.
*/