feat: add event support

Author: innocenzi

packages/mailer/composer.json

@@ -14,7 +14,8 @@
         "symfony/amazon-mailer": "^7.2.0"
     },
     "suggest": {
-        "tempest/storage": "For storage attachment support"
+        "tempest/storage": "For storage attachment support",
+        "tempest/event-bus": "For event support"
     },
     "autoload": {
         "psr-4": {

packages/mailer/src/EmailSent.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Tempest\Mail;
+
+/**
+ * An email has been sent.
+ */
+final readonly class EmailSent
+{
+    public function __construct(
+        public Email $email,
+    ) {}
+}

packages/mailer/src/GenericMailer.php

@@ -3,6 +3,7 @@
 namespace Tempest\Mail;
 
 use Symfony\Component\Mailer\Transport\TransportInterface;
+use Tempest\EventBus\EventBus;
 use Tempest\Mail\Exceptions\MailerTransportWasMissing;
 use Tempest\Mail\MailerConfig;
 use Tempest\View\ViewRenderer;
@@ -17,6 +18,7 @@ final class GenericMailer implements Mailer
     public function __construct(
         private MailerConfig $mailerConfig,
         private ViewRenderer $viewRenderer,
+        private ?EventBus $eventBus = null,
         private ?TransportInterface $transport = null,
     ) {
         $this->transport ??= $this->createTransport();
@@ -28,6 +30,8 @@ public function send(Email $email): SentEmail
             ->with(fn (Email $from) => new EmailToSymfonyEmailMapper($this->mailerConfig, $this->viewRenderer)->map($from, null))
             ->do();
 
+        $this->eventBus?->dispatch(new EmailSent($email));
+
         return new SentGenericEmail(
             original: $email,
             symfonyEmail: $symfonyEmail,

packages/mailer/src/MailerInitializer.php

@@ -5,6 +5,7 @@
 use Tempest\Container\Container;
 use Tempest\Container\Initializer;
 use Tempest\Container\Singleton;
+use Tempest\EventBus\EventBus;
 use Tempest\Mail\MailerConfig;
 use Tempest\View\ViewRenderer;
 
@@ -16,6 +17,7 @@ public function initialize(Container $container): Mailer
         return new GenericMailer(
             mailerConfig: $container->get(MailerConfig::class),
             viewRenderer: $container->get(ViewRenderer::class),
+            eventBus: $container->get(EventBus::class),
         );
     }
 }

packages/mailer/src/Testing/MailerTester.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\ExpectationFailedException;
 use Tempest\Container\Container;
+use Tempest\EventBus\EventBus;
 use Tempest\Mail\Email;
 use Tempest\Mail\Mailer;
 use Tempest\Mail\MailerConfig;
@@ -29,6 +30,7 @@ public function preventSendingEmails(): void
         $this->mailer ??= new TestingMailer(
             mailerConfig: $this->container->get(MailerConfig::class),
             viewRenderer: $this->container->get(ViewRenderer::class),
+            eventBus: $this->container->get(EventBus::class),
         );
 
         $this->container->singleton(Mailer::class, $this->mailer);

packages/mailer/src/Testing/TestingMailer.php

@@ -2,7 +2,9 @@
 
 namespace Tempest\Mail\Testing;
 
+use Tempest\EventBus\EventBus;
 use Tempest\Mail\Email;
+use Tempest\Mail\EmailSent;
 use Tempest\Mail\EmailToSymfonyEmailMapper;
 use Tempest\Mail\Mailer;
 use Tempest\Mail\MailerConfig;
@@ -15,6 +17,7 @@ final class TestingMailer implements Mailer
     public function __construct(
         private readonly MailerConfig $mailerConfig,
         private readonly ViewRenderer $viewRenderer,
+        private readonly ?EventBus $eventBus = null,
     ) {}
 
     /**
@@ -32,6 +35,8 @@ public function send(Email $email): SentTestingEmail
             ->with(fn (Email $from) => new EmailToSymfonyEmailMapper($this->mailerConfig, $this->viewRenderer)->map($from, null))
             ->do();
 
+        $this->eventBus?->dispatch(new EmailSent($email));
+
         return new SentTestingEmail(
             original: $email,
             symfonyEmail: $symfonyEmail,

tests/Integration/Mailer/MailerTest.php

@@ -2,7 +2,9 @@
 
 namespace Tests\Tempest\Integration\Mailer;
 
+use Tempest\EventBus\EventBus;
 use Tempest\Mail\Attachment;
+use Tempest\Mail\EmailSent;
 use Tempest\Mail\Exceptions\RecipientWasMissing;
 use Tempest\Mail\Exceptions\SenderWasMissing;
 use Tempest\Mail\GenericEmail;
@@ -16,6 +18,26 @@ final class MailerTest extends FrameworkIntegrationTestCase
         get => $this->container->get(Mailer::class);
     }
 
+    public function test_event(): void
+    {
+        $sent = false;
+
+        $this->container
+            ->get(EventBus::class)
+            ->listen(function (EmailSent $event) use (&$sent): void {
+                $sent = $event;
+            });
+
+        $this->mailer->send(new GenericEmail(
+            subject: 'Hello',
+            to: '[email protected]',
+            from: '[email protected]',
+            text: 'Hello Jon',
+        ));
+
+        $this->assertInstanceOf(EmailSent::class, $sent);
+    }
+
     public function test_default_sender(): void
     {
         $this->mail->allowSendingEmails();

tests/Integration/Mailer/MailerTesterTest.php

@@ -59,13 +59,13 @@ public function test_assert_sent_with_class_string_and_callback(): void
         $this->expectExceptionMessage("Email `Tests\Tempest\Integration\Mailer\Fixtures\TextOnlyEmail` was sent but failed the assertion.");
 
         $this->mailer->send(new TextOnlyEmail());
-        $this->mail->assertSent(TextOnlyEmail::class, fn (Email $email) => false);
+        $this->mail->assertSent(TextOnlyEmail::class, fn (Email $_email) => false);
     }
 
     public function test_assert_sent_with_class_string_and_truthy_callback(): void
     {
         $this->mailer->send(new TextOnlyEmail());
-        $this->mail->assertSent(TextOnlyEmail::class, fn (Email $email) => true);
+        $this->mail->assertSent(TextOnlyEmail::class, fn (Email $_email) => true);
     }
 
     public function test_assert_not_sent_with_class_string(): void
@@ -96,7 +96,7 @@ public function test_assertions(): void
             ],
         ));
 
-        $this->mail->assertSent(GenericEmail::class, function (Email $email) {
+        $this->mail->assertSent(GenericEmail::class, function (Email $email): void {
             $this->assertCount(1, $email->content->attachments);
             $this->assertSame('hello!', ($email->content->attachments[0]->resolve)());
         });