mirror of
https://github.com/appwrite/appwrite.git
synced 2026-11-18 20:36:03 +00:00
Merge pull request #12868 from appwrite/fix/mail-worker-delivery-outcome
Handle mail adapter delivery failures
This commit is contained in:
2 files changed
+92
-4
No files matched your search
@@ -216,7 +216,12 @@ class Mails extends Action
|
||||
$emailMessage->setOrigin(MESSAGE_SEND_TYPE_INTERNAL);
|
||||
|
||||
try {
|
||||
$adapter->send($emailMessage);
|
||||
$result = $adapter->send($emailMessage);
|
||||
|
||||
if (($result['deliveredTo'] ?? 0) === 0) {
|
||||
$error = $result['results'][0]['error'] ?? ($result['error'] ?? 'Unknown error');
|
||||
throw new Exception($error);
|
||||
}
|
||||
} catch (\Throwable $error) {
|
||||
Span::add('mail.status', 'failure');
|
||||
|
||||
|
||||
@@ -17,6 +17,9 @@ use Utopia\Telemetry\Adapter\None;
|
||||
final class SpyMailAdapter extends EmailAdapter
|
||||
{
|
||||
public ?EmailMessage $captured = null;
|
||||
public int $deliveredTo = 1;
|
||||
public ?string $error = null;
|
||||
public bool $emptyResults = false;
|
||||
public int $sendCount = 0;
|
||||
|
||||
public function getName(): string
|
||||
@@ -34,11 +37,32 @@ final class SpyMailAdapter extends EmailAdapter
|
||||
$this->sendCount++;
|
||||
$this->captured = $message;
|
||||
|
||||
return [
|
||||
'deliveredTo' => 1,
|
||||
$response = [
|
||||
'deliveredTo' => $this->deliveredTo,
|
||||
'type' => $this->getType(),
|
||||
'results' => [['recipient' => $message->getTo()[0]['email'] ?? '', 'status' => 'sent']],
|
||||
'results' => [],
|
||||
];
|
||||
|
||||
if ($this->emptyResults) {
|
||||
if ($this->error !== null) {
|
||||
$response['error'] = $this->error;
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
$result = [
|
||||
'recipient' => $message->getTo()[0]['email'] ?? '',
|
||||
'status' => $this->deliveredTo === 0 ? 'failure' : 'success',
|
||||
];
|
||||
|
||||
if ($this->error !== null) {
|
||||
$result['error'] = $this->error;
|
||||
}
|
||||
|
||||
$response['results'] = [$result];
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -61,10 +85,12 @@ final class MailsTest extends TestCase
|
||||
'queue' => 'v1-mails',
|
||||
'timestamp' => \time(),
|
||||
'payload' => [
|
||||
'smtp' => [],
|
||||
'recipient' => 'legacy@example.test',
|
||||
'name' => 'Legacy User',
|
||||
'subject' => 'Hello {{name}}',
|
||||
'body' => 'Body {{name}}',
|
||||
'bodyTemplate' => '',
|
||||
'variables' => ['name' => 'Legacy'],
|
||||
'customMailOptions' => [
|
||||
'senderEmail' => 'sender@example.test',
|
||||
@@ -95,4 +121,61 @@ final class MailsTest extends TestCase
|
||||
$this->assertSame('reply@example.test', $message->getReplyToEmail());
|
||||
$this->assertSame('Custom Reply', $message->getReplyToName());
|
||||
}
|
||||
|
||||
public function testMailDeliveryFailureIsThrownByMailsWorker(): void
|
||||
{
|
||||
$adapter = new SpyMailAdapter();
|
||||
$adapter->deliveredTo = 0;
|
||||
$adapter->error = 'Domain not verified';
|
||||
|
||||
$this->assertMailWorkerThrows($adapter, 'Error sending mail: Domain not verified');
|
||||
}
|
||||
|
||||
public function testMailDeliveryFailureUsesTopLevelErrorWhenResultsEmpty(): void
|
||||
{
|
||||
$adapter = new SpyMailAdapter();
|
||||
$adapter->deliveredTo = 0;
|
||||
$adapter->emptyResults = true;
|
||||
$adapter->error = 'Provider rejected request';
|
||||
|
||||
$this->assertMailWorkerThrows($adapter, 'Error sending mail: Provider rejected request');
|
||||
}
|
||||
|
||||
private function assertMailWorkerThrows(SpyMailAdapter $adapter, string $expectedMessage): void
|
||||
{
|
||||
$registry = new Registry();
|
||||
$registry->set('smtp', static fn () => $adapter);
|
||||
|
||||
$previousSmtpHost = \getenv('_APP_SMTP_HOST');
|
||||
\putenv('_APP_SMTP_HOST=spy.smtp.test');
|
||||
|
||||
try {
|
||||
$this->expectException(\Exception::class);
|
||||
$this->expectExceptionMessage($expectedMessage);
|
||||
|
||||
$worker = new Mails();
|
||||
$worker->action(
|
||||
new Message([
|
||||
'pid' => 'pid',
|
||||
'queue' => 'v1-mails',
|
||||
'timestamp' => \time(),
|
||||
'payload' => [
|
||||
'smtp' => [],
|
||||
'recipient' => 'legacy@example.test',
|
||||
'name' => 'Legacy User',
|
||||
'subject' => 'Hello',
|
||||
'body' => 'Body',
|
||||
'bodyTemplate' => '',
|
||||
'variables' => [],
|
||||
],
|
||||
]),
|
||||
new Document(['$id' => 'project-x']),
|
||||
$registry,
|
||||
new Log(),
|
||||
new None(),
|
||||
);
|
||||
} finally {
|
||||
\putenv($previousSmtpHost === false ? '_APP_SMTP_HOST' : '_APP_SMTP_HOST=' . $previousSmtpHost);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user