UserMessageStatus

Author: tatevikg1

src/Domain/Messaging/Model/Message/UserMessageStatus.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Messaging\Model\Message;
+
+enum UserMessageStatus: string
+{
+    case Todo = 'todo';
+    case Active = 'active';
+    case Sent = 'sent';
+    case NotSent = 'not sent';
+    case InvalidEmailAddress = 'invalid email address';
+    case UnconfirmedUser = 'unconfirmed user';
+    case Excluded = 'excluded';
+}

src/Domain/Messaging/Model/UserMessage.php

@@ -7,6 +7,7 @@
 use DateTime;
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Common\Model\Interfaces\DomainModel;
+use PhpList\Core\Domain\Messaging\Model\Message\UserMessageStatus;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
 
@@ -65,9 +66,12 @@ public function getViewed(): ?DateTime
         return $this->viewed;
     }
 
-    public function getStatus(): ?string
+    /**
+     * @SuppressWarnings("PHPMD.StaticAccess")
+     */
+    public function getStatus(): ?UserMessageStatus
     {
-        return $this->status;
+        return UserMessageStatus::from($this->status);
     }
 
     public function setViewed(?DateTime $viewed): self
@@ -76,9 +80,9 @@ public function setViewed(?DateTime $viewed): self
         return $this;
     }
 
-    public function setStatus(?string $status): self
+    public function setStatus(?UserMessageStatus $status): self
     {
-        $this->status = $status;
+        $this->status = $status->value;
         return $this;
     }
 }

src/Domain/Messaging/Repository/UserMessageRepository.php

@@ -5,7 +5,14 @@
 namespace PhpList\Core\Domain\Messaging\Repository;
 
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
+use PhpList\Core\Domain\Messaging\Model\Message;
+use PhpList\Core\Domain\Messaging\Model\UserMessage;
+use PhpList\Core\Domain\Subscription\Model\Subscriber;
 
 class UserMessageRepository extends AbstractRepository
 {
+    public function findOneByUserAndMessage(Subscriber $subscriber, Message $campaign): ?UserMessage
+    {
+        return $this->findOneBy(['user' => $subscriber, 'message' => $campaign]);
+    }
 }

src/Domain/Messaging/Service/Processor/CampaignProcessor.php

@@ -6,6 +6,9 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use PhpList\Core\Domain\Messaging\Model\Message;
+use PhpList\Core\Domain\Messaging\Model\UserMessage;
+use PhpList\Core\Domain\Messaging\Model\Message\UserMessageStatus;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
 use PhpList\Core\Domain\Messaging\Service\MessageProcessingPreparator;
 use PhpList\Core\Domain\Messaging\Service\SendRateLimiter;
 use PhpList\Core\Domain\Subscription\Service\Provider\SubscriberProvider;
@@ -23,6 +26,7 @@ class CampaignProcessor
     private MessageProcessingPreparator $messagePreparator;
     private LoggerInterface $logger;
     private SendRateLimiter $rateLimiter;
+    private UserMessageRepository $userMessageRepository;
 
     public function __construct(
         MailerInterface $mailer,
@@ -31,13 +35,15 @@ public function __construct(
         MessageProcessingPreparator $messagePreparator,
         LoggerInterface $logger,
         SendRateLimiter $rateLimiter,
+        UserMessageRepository $userMessageRepository
     ) {
         $this->mailer = $mailer;
         $this->entityManager = $entityManager;
         $this->subscriberProvider = $subscriberProvider;
         $this->messagePreparator = $messagePreparator;
         $this->logger = $logger;
         $this->rateLimiter = $rateLimiter;
+        $this->userMessageRepository = $userMessageRepository;
     }
 
     public function process(Message $campaign, ?OutputInterface $output = null): void
@@ -48,12 +54,25 @@ public function process(Message $campaign, ?OutputInterface $output = null): voi
         $this->updateMessageStatus($campaign, Message\MessageStatus::InProcess);
 
         foreach ($subscribers as $subscriber) {
+            $existing = $this->userMessageRepository->findOneByUserAndMessage($subscriber, $campaign);
+            if ($existing && $existing->getStatus() !== UserMessageStatus::Todo->value) {
+                continue;
+            }
+
+            $userMessage = $existing ?? new UserMessage($subscriber, $campaign);
+            $userMessage->setStatus(UserMessageStatus::Active);
+            $this->entityManager->persist($userMessage);
+            $this->entityManager->flush();
+
             $this->rateLimiter->awaitTurn($output);
 
             if (!filter_var($subscriber->getEmail(), FILTER_VALIDATE_EMAIL)) {
+                $this->updateUserMessageStatus($userMessage, UserMessageStatus::InvalidEmailAddress);
                 continue;
             }
+
             $this->messagePreparator->processMessageLinks($campaign, $subscriber->getId());
+
             $email = (new Email())
                 ->from('[email protected]')
                 ->to($subscriber->getEmail())
@@ -63,8 +82,10 @@ public function process(Message $campaign, ?OutputInterface $output = null): voi
 
             try {
                 $this->mailer->send($email);
+                $this->updateUserMessageStatus($userMessage, UserMessageStatus::Sent);
                 $this->rateLimiter->afterSend();
             } catch (Throwable $e) {
+                $this->updateUserMessageStatus($userMessage, UserMessageStatus::NotSent);
                 $this->logger->error($e->getMessage(), [
                     'subscriber_id' => $subscriber->getId(),
                     'campaign_id' => $campaign->getId(),
@@ -81,4 +102,9 @@ private function updateMessageStatus(Message $message, Message\MessageStatus $st
         $message->getMetadata()->setStatus($status);
         $this->entityManager->flush();
     }
-}
+
+    private function updateUserMessageStatus(UserMessage $userMessage, Message\UserMessageStatus $status): void
+    {
+        $userMessage->setStatus($status);
+        $this->entityManager->flush();
+    }}

tests/Integration/Domain/Subscription/Service/SubscriberDeletionServiceTest.php

@@ -92,7 +92,7 @@ public function testDeleteSubscriberWithRelatedDataDoesNotThrowDoctrineError():
         $this->entityManager->persist($linkTrackUmlClick);
 
         $userMessage = new UserMessage($subscriber, $msg);
-        $userMessage->setStatus('sent');
+        $userMessage->setStatus(Message\UserMessageStatus::Sent);
         $this->entityManager->persist($userMessage);
 
         $userMessageBounce = new UserMessageBounce(1, new DateTime());

tests/Unit/Domain/Messaging/Service/Processor/CampaignProcessorTest.php

@@ -9,6 +9,7 @@
 use PhpList\Core\Domain\Messaging\Model\Message;
 use PhpList\Core\Domain\Messaging\Model\Message\MessageContent;
 use PhpList\Core\Domain\Messaging\Model\Message\MessageMetadata;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
 use PhpList\Core\Domain\Messaging\Service\MessageProcessingPreparator;
 use PhpList\Core\Domain\Messaging\Service\Processor\CampaignProcessor;
 use PhpList\Core\Domain\Messaging\Service\SendRateLimiter;
@@ -31,6 +32,7 @@ class CampaignProcessorTest extends TestCase
     private OutputInterface&MockObject $output;
     private CampaignProcessor $campaignProcessor;
     private SendRateLimiter&MockObject $rateLimiter;
+    private UserMessageRepository&MockObject $userMessageRepository;
 
     protected function setUp(): void
     {
@@ -41,16 +43,18 @@ protected function setUp(): void
         $this->logger = $this->createMock(LoggerInterface::class);
         $this->output = $this->createMock(OutputInterface::class);
         $this->rateLimiter = $this->createMock(SendRateLimiter::class);
+        $this->userMessageRepository = $this->createMock(UserMessageRepository::class);
         $this->rateLimiter->method('awaitTurn');
         $this->rateLimiter->method('afterSend');
 
         $this->campaignProcessor = new CampaignProcessor(
-            $this->mailer,
-            $this->entityManager,
-            $this->subscriberProvider,
-            $this->messagePreparator,
-            $this->logger,
-            $this->rateLimiter
+            mailer: $this->mailer,
+            entityManager: $this->entityManager,
+            subscriberProvider: $this->subscriberProvider,
+            messagePreparator: $this->messagePreparator,
+            logger: $this->logger,
+            rateLimiter: $this->rateLimiter,
+            userMessageRepository: $this->userMessageRepository,
         );
     }