RateLimitedCampaignMailerTest

Author: tatevikg1

src/Domain/Messaging/Service/RateLimitedCampaignMailer.php

@@ -22,8 +22,16 @@ public function __construct(MailerInterface $mailer, SendRateLimiter $limiter)
 
     public function composeEmail(Message $processed, Subscriber $subscriber): Email
     {
-        return (new Email())
-            ->from('[email protected]')
+        $email = new Email();
+        if ($processed->getOptions()->getFromField() !== '') {
+            $email->from($processed->getOptions()->getFromField());
+        }
+
+        if ($processed->getOptions()->getReplyTo() !== '') {
+            $email->replyTo($processed->getOptions()->getReplyTo());
+        }
+
+        return $email
             ->to($subscriber->getEmail())
             ->subject($processed->getContent()->getSubject())
             ->text($processed->getContent()->getTextMessage())

tests/Unit/Domain/Messaging/Service/RateLimitedCampaignMailerTest.php

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Tests\Unit\Domain\Messaging\Service;
+
+use PhpList\Core\Domain\Messaging\Model\Message;
+use PhpList\Core\Domain\Messaging\Model\Message\MessageContent;
+use PhpList\Core\Domain\Messaging\Model\Message\MessageFormat;
+use PhpList\Core\Domain\Messaging\Model\Message\MessageMetadata;
+use PhpList\Core\Domain\Messaging\Model\Message\MessageOptions;
+use PhpList\Core\Domain\Messaging\Model\Message\MessageSchedule;
+use PhpList\Core\Domain\Messaging\Service\RateLimitedCampaignMailer;
+use PhpList\Core\Domain\Messaging\Service\SendRateLimiter;
+use PhpList\Core\Domain\Subscription\Model\Subscriber;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use ReflectionProperty;
+use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Mime\Email;
+
+class RateLimitedCampaignMailerTest extends TestCase
+{
+    private MailerInterface|MockObject $mailer;
+    private SendRateLimiter|MockObject $limiter;
+
+    private RateLimitedCampaignMailer $sut;
+
+    protected function setUp(): void
+    {
+        $this->mailer = $this->createMock(MailerInterface::class);
+        $this->limiter = $this->createMock(SendRateLimiter::class);
+        $this->sut = new RateLimitedCampaignMailer($this->mailer, $this->limiter);
+    }
+
+    public function testComposeEmailSetsHeadersAndBody(): void
+    {
+        $message = $this->buildMessage(
+            subject: 'Subject',
+            textBody: 'Plain text',
+            htmlBody: '<p>HTML</p>',
+            from: '[email protected]',
+            replyTo: '[email protected]'
+        );
+
+        $subscriber = new Subscriber();
+        $this->setSubscriberEmail($subscriber, '[email protected]');
+
+        $email = $this->sut->composeEmail($message, $subscriber);
+
+        $this->assertInstanceOf(Email::class, $email);
+        $this->assertSame('[email protected]', $email->getTo()[0]->getAddress());
+        $this->assertSame('Subject', $email->getSubject());
+        $this->assertSame('[email protected]', $email->getFrom()[0]->getAddress());
+        $this->assertSame('[email protected]', $email->getReplyTo()[0]->getAddress());
+        $this->assertSame('Plain text', $email->getTextBody());
+        $this->assertSame('<p>HTML</p>', $email->getHtmlBody());
+    }
+
+    public function testComposeEmailWithoutOptionalHeaders(): void
+    {
+        $message = $this->buildMessage(
+            subject: 'No headers',
+            textBody: 'text',
+            htmlBody: '<b>h</b>',
+            from: '',
+            replyTo: ''
+        );
+
+        $subscriber = new Subscriber();
+        $this->setSubscriberEmail($subscriber, '[email protected]');
+
+        $email = $this->sut->composeEmail($message, $subscriber);
+
+        $this->assertSame('[email protected]', $email->getTo()[0]->getAddress());
+        $this->assertSame('No headers', $email->getSubject());
+        $this->assertSame([], $email->getFrom());
+        $this->assertSame([], $email->getReplyTo());
+    }
+
+    public function testSendUsesLimiterAroundMailer(): void
+    {
+        $email = (new Email())->to('[email protected]');
+
+        $this->limiter->expects($this->once())->method('awaitTurn');
+        $this->mailer
+            ->expects($this->once())
+            ->method('send')
+            ->with($this->isInstanceOf(Email::class));
+        $this->limiter->expects($this->once())->method('afterSend');
+
+        $this->sut->send($email);
+    }
+
+    private function buildMessage(
+        string $subject,
+        string $textBody,
+        string $htmlBody,
+        string $from,
+        string $replyTo
+    ): Message {
+        $content = new MessageContent(
+            subject: $subject,
+            text: $htmlBody,
+            textMessage: $textBody,
+            footer: null,
+        );
+        $format = new MessageFormat(
+            htmlFormatted: true,
+            sendFormat: MessageFormat::FORMAT_HTML,
+            formatOptions: [MessageFormat::FORMAT_HTML]
+        );
+        $schedule = new MessageSchedule(
+            repeatInterval: 0,
+            repeatUntil: null,
+            requeueInterval: 0,
+            requeueUntil: null,
+            embargo: null
+        );
+        $metadata = new MessageMetadata();
+        $options = new MessageOptions(fromField: $from, toField: '', replyTo: $replyTo);
+
+        return new Message($format, $schedule, $metadata, $content, $options, null, null);
+    }
+
+    /**
+     * Subscriber has no public setter for email, so we use reflection.
+     */
+    private function setSubscriberEmail(Subscriber $subscriber, string $email): void
+    {
+        $ref = new ReflectionProperty($subscriber, 'email');
+        $ref->setValue($subscriber, $email);
+    }
+}