Add Email Templates migration

This commit is contained in:
Prem Palanisamy committed 2026-05-21 16:55:26 +01:00
1 parent cc7d68aaad
commit 9813afb2d7
11 files changed
+324

No files matched your search

+57
View File
@@ -76,6 +76,7 @@ use Utopia\Migration\Resources\Sites\EnvVar as SiteEnvVar;
use Utopia\Migration\Resources\Sites\Site;
use Utopia\Migration\Resources\Storage\Bucket;
use Utopia\Migration\Resources\Storage\File;
use Utopia\Migration\Resources\Templates\EmailTemplate;
use Utopia\Migration\Transfer;
class Appwrite extends Destination
@@ -312,6 +313,9 @@ class Appwrite extends Destination
// Domains
Resource::TYPE_RULE,
// Templates
Resource::TYPE_EMAIL_TEMPLATE,
];
}
@@ -472,6 +476,7 @@ class Appwrite extends Destination
Transfer::GROUP_BACKUPS => $this->importBackupResource($resource),
Transfer::GROUP_SETTINGS => $this->importSettingsResource($resource),
Transfer::GROUP_DOMAINS => $this->importDomainsResource($resource),
Transfer::GROUP_TEMPLATES => $this->importTemplatesResource($resource),
default => throw new \Exception('Invalid resource group', Exception::CODE_VALIDATION),
};
} catch (\Throwable $e) {
@@ -3186,6 +3191,22 @@ class Appwrite extends Destination
return $resource;
}
public function importTemplatesResource(Resource $resource): Resource
{
switch ($resource->getName()) {
case Resource::TYPE_EMAIL_TEMPLATE:
/** @var EmailTemplate $resource */
$this->createEmailTemplate($resource);
break;
}
if ($resource->getStatus() !== Resource::STATUS_SKIPPED) {
$resource->setStatus(Resource::STATUS_SUCCESS);
}
return $resource;
}
protected function createProjectVariable(ProjectVariable $resource): bool
{
$existing = $this->dbForProject->findOne('variables', [
@@ -3324,6 +3345,42 @@ class Appwrite extends Destination
return true;
}
/**
* Direct DB write rather than the SDK's updateEmailTemplate — the SDK path
* rejects the call unless custom SMTP is enabled on the project. Templates
* may legitimately migrate before SMTP (different groups, different runs),
* so bypass that check by writing the project.templates map directly.
* Read-then-merge preserves any templates already configured on the
* destination (other locales, untouched template types).
*/
protected function createEmailTemplate(EmailTemplate $resource): bool
{
$project = $this->dbForPlatform->getDocument('projects', $this->projectId);
$templates = $project->getAttribute('templates', []);
$key = 'email.' . $resource->getTemplateId() . '-' . $resource->getLocale();
$existing = $templates[$key] ?? [];
$existing['subject'] = $resource->getSubject();
$existing['message'] = $resource->getMessage();
$existing['senderName'] = $resource->getSenderName();
$existing['senderEmail'] = $resource->getSenderEmail();
$existing['replyToEmail'] = $resource->getReplyToEmail();
$existing['replyToName'] = $resource->getReplyToName();
$templates[$key] = $existing;
$this->dbForPlatform->getAuthorization()->skip(fn () => $this->dbForPlatform->updateDocument(
'projects',
$this->projectId,
new UtopiaDocument(['templates' => $templates]),
));
$this->dbForPlatform->purgeCachedDocument('projects', $this->projectId);
return true;
}
/**
* Auto-generated rules (default `.appwrite.network` domains for functions/sites)
* are recreated automatically on the destination when the parent Function/Site
+4
View File
@@ -87,6 +87,9 @@ abstract class Resource implements \JsonSerializable
public const TYPE_SERVICES = 'services';
public const TYPE_SMTP = 'smtp';
// Templates
public const TYPE_EMAIL_TEMPLATE = 'email-template';
// Domains
public const TYPE_RULE = 'rule';
@@ -139,6 +142,7 @@ abstract class Resource implements \JsonSerializable
self::TYPE_SERVICES,
self::TYPE_SMTP,
self::TYPE_RULE,
self::TYPE_EMAIL_TEMPLATE,
self::TYPE_PROVIDER,
self::TYPE_TOPIC,
self::TYPE_SUBSCRIBER,
@@ -0,0 +1,122 @@
<?php
namespace Utopia\Migration\Resources\Templates;
use Utopia\Migration\Resource;
use Utopia\Migration\Transfer;
/**
* Custom email template — one row per (templateId, locale) pair. The resource
* `id` follows the storage key format `email.{templateId}-{locale}` so
* destination read-then-merge can address the slot directly.
*/
class EmailTemplate extends Resource
{
public function __construct(
string $id,
private readonly string $templateId,
private readonly string $locale,
private readonly string $subject,
private readonly string $message,
private readonly string $senderName = '',
private readonly string $senderEmail = '',
private readonly string $replyToEmail = '',
private readonly string $replyToName = '',
string $createdAt = '',
string $updatedAt = '',
) {
$this->id = $id;
$this->createdAt = $createdAt;
$this->updatedAt = $updatedAt;
}
/**
* @param array<string, mixed> $array
*/
public static function fromArray(array $array): self
{
return new self(
$array['id'],
(string) $array['templateId'],
(string) $array['locale'],
(string) ($array['subject'] ?? ''),
(string) ($array['message'] ?? ''),
(string) ($array['senderName'] ?? ''),
(string) ($array['senderEmail'] ?? ''),
(string) ($array['replyToEmail'] ?? ''),
(string) ($array['replyToName'] ?? ''),
createdAt: $array['createdAt'] ?? '',
updatedAt: $array['updatedAt'] ?? '',
);
}
/**
* @return array<string, mixed>
*/
public function jsonSerialize(): array
{
return [
'id' => $this->id,
'templateId' => $this->templateId,
'locale' => $this->locale,
'subject' => $this->subject,
'message' => $this->message,
'senderName' => $this->senderName,
'senderEmail' => $this->senderEmail,
'replyToEmail' => $this->replyToEmail,
'replyToName' => $this->replyToName,
'createdAt' => $this->createdAt,
'updatedAt' => $this->updatedAt,
];
}
public static function getName(): string
{
return Resource::TYPE_EMAIL_TEMPLATE;
}
public function getGroup(): string
{
return Transfer::GROUP_TEMPLATES;
}
public function getTemplateId(): string
{
return $this->templateId;
}
public function getLocale(): string
{
return $this->locale;
}
public function getSubject(): string
{
return $this->subject;
}
public function getMessage(): string
{
return $this->message;
}
public function getSenderName(): string
{
return $this->senderName;
}
public function getSenderEmail(): string
{
return $this->senderEmail;
}
public function getReplyToEmail(): string
{
return $this->replyToEmail;
}
public function getReplyToName(): string
{
return $this->replyToName;
}
}
+17
View File
@@ -66,6 +66,11 @@ abstract class Source extends Target
return static::$defaultBatchSize;
}
public function getTemplatesBatchSize(): int
{
return static::$defaultBatchSize;
}
/**
* @param array<Resource> $resources
* @return void
@@ -133,6 +138,7 @@ abstract class Source extends Target
Transfer::GROUP_BACKUPS => Transfer::GROUP_BACKUPS_RESOURCES,
Transfer::GROUP_SETTINGS => Transfer::GROUP_SETTINGS_RESOURCES,
Transfer::GROUP_DOMAINS => Transfer::GROUP_DOMAINS_RESOURCES,
Transfer::GROUP_TEMPLATES => Transfer::GROUP_TEMPLATES_RESOURCES,
];
foreach ($mapping as $group => $resources) {
@@ -179,6 +185,9 @@ abstract class Source extends Target
case Transfer::GROUP_DOMAINS:
$this->exportGroupDomains($this->getDomainsBatchSize(), $resources);
break;
case Transfer::GROUP_TEMPLATES:
$this->exportGroupTemplates($this->getTemplatesBatchSize(), $resources);
break;
}
}
}
@@ -262,4 +271,12 @@ abstract class Source extends Target
* @param array<string> $resources Resources to export
*/
abstract protected function exportGroupDomains(int $batchSize, array $resources): void;
/**
* Export Templates Group
*
* @param int $batchSize
* @param array<string> $resources Resources to export
*/
abstract protected function exportGroupTemplates(int $batchSize, array $resources): void;
}
+83
View File
@@ -79,6 +79,7 @@ use Utopia\Migration\Resources\Settings\Webhook;
use Utopia\Migration\Resources\Sites\Deployment as SiteDeployment;
use Utopia\Migration\Resources\Sites\EnvVar as SiteEnvVar;
use Utopia\Migration\Resources\Sites\Site;
use Utopia\Migration\Resources\Templates\EmailTemplate;
use Utopia\Migration\Resources\Storage\Bucket;
use Utopia\Migration\Resources\Storage\File;
use Utopia\Migration\Source;
@@ -246,6 +247,9 @@ class Appwrite extends Source
// Domains
Resource::TYPE_RULE,
// Templates
Resource::TYPE_EMAIL_TEMPLATE,
];
}
@@ -288,6 +292,7 @@ class Appwrite extends Source
$this->reportBackups($resources, $report, $resourceIds);
$this->reportSettings($resources, $report, $resourceIds);
$this->reportDomains($resources, $report, $resourceIds);
$this->reportTemplates($resources, $report, $resourceIds);
$report['version'] = $this->call(
'GET',
@@ -1589,6 +1594,19 @@ class Appwrite extends Source
}
}
private function reportTemplates(array $resources, array &$report, array $resourceIds = []): void
{
if (\in_array(Resource::TYPE_EMAIL_TEMPLATE, $resources)) {
try {
// listEmailTemplates is paginated by limit/offset (not cursor); pass total: true
// so the report count is accurate even if the page is empty.
$report[Resource::TYPE_EMAIL_TEMPLATE] = $this->project->listEmailTemplates([Query::limit(1)], total: true)->total;
} catch (\Throwable) {
$report[Resource::TYPE_EMAIL_TEMPLATE] = 0;
}
}
}
private function reportSettings(array $resources, array &$report, array $resourceIds = []): void
{
if (\in_array(Resource::TYPE_PROJECT_VARIABLE, $resources)) {
@@ -1885,6 +1903,71 @@ class Appwrite extends Source
}
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
if (\in_array(Resource::TYPE_EMAIL_TEMPLATE, $resources)) {
try {
$this->exportEmailTemplates($batchSize);
} catch (\Throwable $e) {
$this->addError(new Exception(
Resource::TYPE_EMAIL_TEMPLATE,
Transfer::GROUP_TEMPLATES,
message: $e->getMessage(),
code: (int) $e->getCode() ?: Exception::CODE_INTERNAL,
previous: $e
));
}
}
}
/**
* @throws AppwriteException
*/
private function exportEmailTemplates(int $batchSize): void
{
// listEmailTemplates is offset-paginated (cursor not supported — the list is
// assembled from a project attribute map, not a collection). Walk the offset
// until a page comes back smaller than the requested limit.
$offset = 0;
while (true) {
$response = $this->project->listEmailTemplates([
Query::limit($batchSize),
Query::offset($offset),
]);
if (\count($response->templates) === 0) {
break;
}
$templates = [];
foreach ($response->templates as $template) {
$id = 'email.' . $template->templateId . '-' . $template->locale;
$templates[] = new EmailTemplate(
$id,
$template->templateId,
$template->locale,
$template->subject,
$template->message,
$template->senderName,
$template->senderEmail,
$template->replyToEmail,
$template->replyToName,
);
}
$this->callback($templates);
if (\count($response->templates) < $batchSize) {
break;
}
$offset += $batchSize;
}
}
/**
* @throws AppwriteException
*/
+5
View File
@@ -450,6 +450,11 @@ class CSV extends Source
throw new \Exception('Not Implemented');
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
throw new \Exception('Not Implemented');
}
/**
* @param callable(resource $stream, string $delimiter): void $callback
* @return void
+5
View File
@@ -837,4 +837,9 @@ class Firebase extends Source
{
throw new \Exception('Not implemented');
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
throw new \Exception('Not implemented');
}
}
+5
View File
@@ -224,6 +224,11 @@ class JSON extends Source
throw new \Exception('Not Implemented');
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
throw new \Exception('Not Implemented');
}
/**
* @throws \Exception
*/
+5
View File
@@ -972,4 +972,9 @@ class NHost extends Source
{
throw new \Exception('Not Implemented');
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
throw new \Exception('Not Implemented');
}
}
+10
View File
@@ -32,6 +32,8 @@ class Transfer
public const GROUP_DOMAINS = 'domains';
public const GROUP_TEMPLATES = 'templates';
public const GROUP_AUTH_RESOURCES = [
Resource::TYPE_USER,
Resource::TYPE_TEAM,
@@ -107,6 +109,10 @@ class Transfer
Resource::TYPE_SMTP,
];
public const GROUP_TEMPLATES_RESOURCES = [
Resource::TYPE_EMAIL_TEMPLATE,
];
public const GROUP_BACKUPS_RESOURCES = [
Resource::TYPE_BACKUP_POLICY,
];
@@ -162,6 +168,9 @@ class Transfer
// Domains
Resource::TYPE_RULE,
// Templates
Resource::TYPE_EMAIL_TEMPLATE,
// legacy
Resource::TYPE_DOCUMENT,
Resource::TYPE_ATTRIBUTE,
@@ -448,6 +457,7 @@ class Transfer
self::GROUP_MESSAGING => array_merge($resources, self::GROUP_MESSAGING_RESOURCES),
self::GROUP_BACKUPS => array_merge($resources, self::GROUP_BACKUPS_RESOURCES),
self::GROUP_DOMAINS => array_merge($resources, self::GROUP_DOMAINS_RESOURCES),
self::GROUP_TEMPLATES => array_merge($resources, self::GROUP_TEMPLATES_RESOURCES),
default => throw new \Exception('No service group found'),
};
}
@@ -251,4 +251,15 @@ class MockSource extends Source
$this->handleResourceTransfer(Transfer::GROUP_DOMAINS, $resource);
}
}
protected function exportGroupTemplates(int $batchSize, array $resources): void
{
foreach (Transfer::GROUP_TEMPLATES_RESOURCES as $resource) {
if (!\in_array($resource, $resources)) {
continue;
}
$this->handleResourceTransfer(Transfer::GROUP_TEMPLATES, $resource);
}
}
}