Skip to content

feat(migration): add project-level resource migrations #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
premtsd-code wants to merge 15 commits into
base: add-webhook-migration
Choose a base branch
from
Open

feat(migration): add project-level resource migrations #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0c70a49
Add AuthMethods migration
premtsd-code May 18, 2026
5224e3c
Register TYPE_AUTH_METHODS in source/destination getSupportedResources
premtsd-code May 18, 2026
d74e8cb
Add Protocols migration
premtsd-code May 18, 2026
b7b64ac
Add Labels migration
premtsd-code May 18, 2026
2f72707
Add Services migration
premtsd-code May 18, 2026
eab858e
Add Policies migration
premtsd-code May 18, 2026
ddb4a6d
Fix doubled /v1 prefix in source-side project calls
premtsd-code May 18, 2026
0a9e5bf
Coerce 0 to null for nullable-int policy fields
premtsd-code May 19, 2026
e998c64
Write policies via dbForPlatform on destination
premtsd-code May 19, 2026
8334156
Skip auth on platform-DB project update for policies write
premtsd-code May 19, 2026
a18e76b
chore: bump appwrite/appwrite to 24.* and rename Project* enums
premtsd-code May 20, 2026
bac84c4
refactor(policies): export via per-policy SDK methods
premtsd-code May 20, 2026
de887c1
refactor(source): use Project::get() SDK for AuthMethods/Protocols/Se…
premtsd-code May 20, 2026
fb634d6
refactor(destination): direct dbForPlatform writes for all 5 settings
premtsd-code May 20, 2026
16ff6ce
chore: trim verbose comments to match existing style
premtsd-code May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"ext-curl": "*",
"ext-openssl": "*",

"appwrite/appwrite": "23.*",
"appwrite/appwrite": "24.*",
"utopia-php/database": "5.*",
"utopia-php/storage": "2.*",
"utopia-php/dsn": "0.2.*",
Expand Down
14 changes: 7 additions & 7 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

187 changes: 178 additions & 9 deletions src/Migration/Destinations/Appwrite.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@
use Appwrite\Enums\Compression;
use Appwrite\Enums\Framework;
use Appwrite\Enums\PasswordHash;
use Appwrite\Enums\ProjectProtocolId;
use Appwrite\Enums\Runtime;
use Appwrite\Enums\ProjectServiceId;
use Appwrite\Enums\SmtpEncryption;
use Appwrite\InputFile;
use Appwrite\Services\Functions;
use Appwrite\Services\Messaging;
use Appwrite\Services\Project;
use Appwrite\Services\Sites;
use Appwrite\Services\Storage;
use Appwrite\Services\Teams;
Expand All @@ -37,8 +40,10 @@
use Utopia\Migration\Destination;
use Utopia\Migration\Exception;
use Utopia\Migration\Resource;
use Utopia\Migration\Resources\Auth\AuthMethods;
use Utopia\Migration\Resources\Auth\Hash;
use Utopia\Migration\Resources\Auth\Membership;
use Utopia\Migration\Resources\Auth\Policies;
use Utopia\Migration\Resources\Auth\Team;
use Utopia\Migration\Resources\Auth\User;
use Utopia\Migration\Resources\Database\Attribute;
Expand All @@ -56,7 +61,10 @@
use Utopia\Migration\Resources\Messaging\Provider;
use Utopia\Migration\Resources\Messaging\Subscriber;
use Utopia\Migration\Resources\Messaging\Topic;
use Utopia\Migration\Resources\Settings\Labels;
use Utopia\Migration\Resources\Settings\ProjectVariable;
use Utopia\Migration\Resources\Settings\Protocols;
use Utopia\Migration\Resources\Settings\Services as ServicesResource;
use Utopia\Migration\Resources\Settings\Webhook;
use Utopia\Migration\Resources\Sites\Deployment as SiteDeployment;
use Utopia\Migration\Resources\Sites\EnvVar as SiteEnvVar;
Expand Down Expand Up @@ -91,12 +99,13 @@ class Appwrite extends Destination
];

protected Client $client;
protected string $project;
protected string $projectId;

protected string $key;

private Functions $functions;
private Messaging $messaging;
private Project $project;
private Sites $sites;
private Storage $storage;
private Teams $teams;
Expand Down Expand Up @@ -170,7 +179,7 @@ public function __construct(
protected OnDuplicate $onDuplicate = OnDuplicate::Fail,
?callable $getDatabaseDSN = null,
) {
$this->project = $project;
$this->projectId = $project;
$this->endpoint = $endpoint;
$this->key = $key;

Expand All @@ -181,6 +190,7 @@ public function __construct(

$this->functions = new Functions($this->client);
$this->messaging = new Messaging($this->client);
$this->project = new Project($this->client);
$this->sites = new Sites($this->client);
$this->storage = new Storage($this->client);
$this->teams = new Teams($this->client);
Expand Down Expand Up @@ -241,6 +251,8 @@ public static function getSupportedResources(): array
Resource::TYPE_USER,
Resource::TYPE_TEAM,
Resource::TYPE_MEMBERSHIP,
Resource::TYPE_AUTH_METHODS,
Resource::TYPE_POLICIES,

// Database
Resource::TYPE_DATABASE,
Expand Down Expand Up @@ -283,6 +295,9 @@ public static function getSupportedResources(): array
// Settings
Resource::TYPE_PROJECT_VARIABLE,
Resource::TYPE_WEBHOOK,
Resource::TYPE_PROTOCOLS,
Resource::TYPE_LABELS,
Resource::TYPE_SERVICES,

// Backups
Resource::TYPE_BACKUP_POLICY,
Expand Down Expand Up @@ -2160,6 +2175,14 @@ public function importAuthResource(Resource $resource): Resource
userId: $user->getId(),
);
break;
case Resource::TYPE_AUTH_METHODS:
/** @var AuthMethods $resource */
$this->createAuthMethods($resource);
break;
case Resource::TYPE_POLICIES:
/** @var Policies $resource */
$this->createPolicies($resource);
break;
}

$resource->setStatus(Resource::STATUS_SUCCESS);
Expand Down Expand Up @@ -3107,6 +3130,18 @@ public function importSettingsResource(Resource $resource): Resource
/** @var Webhook $resource */
$this->createWebhook($resource);
break;
case Resource::TYPE_PROTOCOLS:
/** @var Protocols $resource */
$this->createProtocols($resource);
break;
case Resource::TYPE_LABELS:
/** @var Labels $resource */
$this->createLabels($resource);
break;
case Resource::TYPE_SERVICES:
/** @var ServicesResource $resource */
$this->createServices($resource);
break;
}

if ($resource->getStatus() !== Resource::STATUS_SKIPPED) {
Expand Down Expand Up @@ -3155,6 +3190,75 @@ protected function createProjectVariable(ProjectVariable $resource): bool
return true;
}

protected function createProtocols(Protocols $resource): bool
{
$project = $this->dbForPlatform->getDocument('projects', $this->projectId);
$apis = $project->getAttribute('apis', []);

$apis[(string) ProjectProtocolId::REST()] = $resource->getRest();
$apis[(string) ProjectProtocolId::GRAPHQL()] = $resource->getGraphql();
$apis[(string) ProjectProtocolId::WEBSOCKET()] = $resource->getWebsocket();

$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['apis' => $apis]),
));

$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}

protected function createLabels(Labels $resource): bool
{
$labels = \array_values(\array_unique($resource->getLabels()));

$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['labels' => $labels]),
));

$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}

protected function createServices(ServicesResource $resource): bool
{
$project = $this->dbForPlatform->getDocument('projects', $this->projectId);
$services = $project->getAttribute('services', []);

$services[(string) ProjectServiceId::ACCOUNT()] = $resource->getAccount();
$services[(string) ProjectServiceId::AVATARS()] = $resource->getAvatars();
$services[(string) ProjectServiceId::DATABASES()] = $resource->getDatabases();
$services[(string) ProjectServiceId::TABLESDB()] = $resource->getTablesdb();
$services[(string) ProjectServiceId::LOCALE()] = $resource->getLocale();
$services[(string) ProjectServiceId::HEALTH()] = $resource->getHealth();
$services[(string) ProjectServiceId::PROJECT()] = $resource->getProject();
$services[(string) ProjectServiceId::STORAGE()] = $resource->getStorage();
$services[(string) ProjectServiceId::TEAMS()] = $resource->getTeams();
$services[(string) ProjectServiceId::USERS()] = $resource->getUsers();
$services[(string) ProjectServiceId::VCS()] = $resource->getVcs();
$services[(string) ProjectServiceId::SITES()] = $resource->getSites();
$services[(string) ProjectServiceId::FUNCTIONS()] = $resource->getFunctions();
$services[(string) ProjectServiceId::PROXY()] = $resource->getProxy();
$services[(string) ProjectServiceId::GRAPHQL()] = $resource->getGraphql();
$services[(string) ProjectServiceId::MIGRATIONS()] = $resource->getMigrations();
$services[(string) ProjectServiceId::MESSAGING()] = $resource->getMessaging();

$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['services' => $services]),
));

$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}

protected function createWebhook(Webhook $resource): bool
{
$existing = $this->dbForPlatform->findOne('webhooks', [
Expand All @@ -3175,7 +3279,7 @@ protected function createWebhook(Webhook $resource): bool
'$id' => ID::unique(),
'$permissions' => $resource->getPermissions(),
'projectInternalId' => $this->projectInternalId,
'projectId' => $this->project,
'projectId' => $this->projectId,
'name' => $resource->getWebhookName(),
'events' => $resource->getEvents(),
'url' => $resource->getUrl(),
Expand All @@ -3194,7 +3298,7 @@ protected function createWebhook(Webhook $resource): bool
return false;
}

$this->dbForPlatform->purgeCachedDocument('projects', $this->project);
$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}
Expand All @@ -3205,7 +3309,7 @@ protected function createWebhook(Webhook $resource): bool
protected function createPlatform(Platform $resource): bool
{
$existing = $this->dbForPlatform->findOne('platforms', [
Query::equal('projectId', [$this->project]),
Query::equal('projectId', [$this->projectId]),
Query::equal('type', [$resource->getType()]),
Query::equal('name', [$resource->getPlatformName()]),
]);
Expand All @@ -3223,7 +3327,7 @@ protected function createPlatform(Platform $resource): bool
'$id' => ID::unique(),
'$permissions' => $resource->getPermissions(),
'projectInternalId' => $this->projectInternalId,
'projectId' => $this->project,
'projectId' => $this->projectId,
'type' => $resource->getType(),
'name' => $resource->getPlatformName(),
'key' => $resource->getKey(),
Expand All @@ -3237,7 +3341,72 @@ protected function createPlatform(Platform $resource): bool
return false;
}

$this->dbForPlatform->purgeCachedDocument('projects', $this->project);
$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}

/**
* Storage keys mirror app/config/auth.php, not the SDK enum values.
* Shares the `auths` map with createPolicies — read-then-merge.
*/
protected function createAuthMethods(AuthMethods $resource): bool
{
$project = $this->dbForPlatform->getDocument('projects', $this->projectId);
$auths = $project->getAttribute('auths', []);

$auths['emailPassword'] = $resource->getEmailPassword();
$auths['usersAuthMagicURL'] = $resource->getMagicURL();
$auths['emailOtp'] = $resource->getEmailOtp();
$auths['anonymous'] = $resource->getAnonymous();
$auths['invites'] = $resource->getInvites();
$auths['JWT'] = $resource->getJwt();
$auths['phone'] = $resource->getPhone();

$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['auths' => $auths]),
));

$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}

/**
* Direct DB write — SDK policy setters reject `total: 0` but `0` is the
* storage value for "disabled". Shares the `auths` map with
* createAuthMethods — read-then-merge.
*/
protected function createPolicies(Policies $resource): bool
{
$project = $this->dbForPlatform->getDocument('projects', $this->projectId);
$auths = $project->getAttribute('auths', []);

$auths['passwordHistory'] = $resource->getPasswordHistory();
$auths['duration'] = $resource->getSessionDuration();
$auths['maxSessions'] = $resource->getSessionsLimit();
$auths['limit'] = $resource->getUserLimit();

$auths['passwordDictionary'] = $resource->getPasswordDictionary();
$auths['personalDataCheck'] = $resource->getPersonalDataCheck();
$auths['sessionAlerts'] = $resource->getSessionAlerts();
$auths['invalidateSessions'] = $resource->getSessionInvalidation();

$auths['membershipsUserId'] = $resource->getMembershipsUserId();
$auths['membershipsUserEmail'] = $resource->getMembershipsUserEmail();
$auths['membershipsUserName'] = $resource->getMembershipsUserName();
$auths['membershipsMfa'] = $resource->getMembershipsUserMfa();
$auths['membershipsUserPhone'] = $resource->getMembershipsUserPhone();

$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['auths' => $auths]),
));

$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}
Expand All @@ -3264,7 +3433,7 @@ protected function createApiKey(ApiKey $resource): bool
'$id' => ID::unique(),
'$permissions' => $resource->getPermissions(),
'resourceInternalId' => $this->projectInternalId,
'resourceId' => $this->project,
'resourceId' => $this->projectId,
'resourceType' => 'projects',
'name' => $resource->getApiKeyName(),
'scopes' => $resource->getScopes(),
Expand All @@ -3280,7 +3449,7 @@ protected function createApiKey(ApiKey $resource): bool
return false;
}

$this->dbForPlatform->purgeCachedDocument('projects', $this->project);
$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);

return true;
}
Expand Down
Loading
Loading