Campaign processor

Author: tatevikg1

config/services/services.yml

@@ -29,3 +29,8 @@ services:
         autowire: true
         autoconfigure: true
         public: true
+
+    PhpList\Core\Domain\Messaging\Service\CampaignProcessor:
+        autowire: true
+        autoconfigure: true
+        public: true

src/Domain/Messaging/Command/ProcessQueueCommand.php

@@ -4,45 +4,38 @@
 
 namespace PhpList\Core\Domain\Messaging\Command;
 
+use PhpList\Core\Domain\Messaging\Service\CampaignProcessor;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Doctrine\ORM\EntityManagerInterface;
-use PhpList\Core\Domain\Messaging\Model\Message;
 use PhpList\Core\Domain\Messaging\Repository\MessageRepository;
 use PhpList\Core\Domain\Messaging\Service\MessageProcessingPreparator;
-use PhpList\Core\Domain\Subscription\Service\Provider\SubscriberProvider;
 use Symfony\Component\Lock\LockFactory;
-use Symfony\Component\Mailer\MailerInterface;
-use Symfony\Component\Mime\Email;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Throwable;
 
+#[AsCommand(
+    name: 'phplist:process-queue',
+    description: 'Processes the email campaign queue.'
+)]
 class ProcessQueueCommand extends Command
 {
-    protected static $defaultName = 'phplist:process-queue';
-
     private MessageRepository $messageRepository;
-    private MailerInterface $mailer;
     private LockFactory $lockFactory;
-    private EntityManagerInterface $entityManager;
-    private SubscriberProvider $subscriberProvider;
     private MessageProcessingPreparator $messagePreparator;
+    private CampaignProcessor $campaignProcessor;
 
     public function __construct(
         MessageRepository $messageRepository,
-        MailerInterface $mailer,
         LockFactory $lockFactory,
-        EntityManagerInterface $entityManager,
-        SubscriberProvider $subscriberProvider,
-        MessageProcessingPreparator $messagePreparator
+        MessageProcessingPreparator $messagePreparator,
+        CampaignProcessor $campaignProcessor,
     ) {
         parent::__construct();
         $this->messageRepository = $messageRepository;
-        $this->mailer = $mailer;
         $this->lockFactory = $lockFactory;
-        $this->entityManager = $entityManager;
-        $this->subscriberProvider = $subscriberProvider;
         $this->messagePreparator = $messagePreparator;
+        $this->campaignProcessor = $campaignProcessor;
     }
 
     /**
@@ -64,45 +57,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $campaigns = $this->messageRepository->findBy(['status' => 'submitted']);
 
             foreach ($campaigns as $campaign) {
-                $this->processCampaign($campaign, $output);
+                $this->campaignProcessor->process($campaign, $output);
             }
+        } catch (Throwable $throwable) {
+            $output->writeln($throwable->getMessage());
+
+            return Command::FAILURE;
         } finally {
             $lock->release();
         }
 
         return Command::SUCCESS;
     }
-
-    private function processCampaign(Message $campaign, OutputInterface $output): void
-    {
-        $subscribers = $this->subscriberProvider->getSubscribersForMessage($campaign);
-        // phpcs:ignore Generic.Commenting.Todo
-        // @todo check $ISPrestrictions logic
-        foreach ($subscribers as $subscriber) {
-            if (!filter_var($subscriber->getEmail(), FILTER_VALIDATE_EMAIL)) {
-                continue;
-            }
-            $this->messagePreparator->processMessageLinks($campaign, $subscriber->getId());
-            $email = (new Email())
-                ->from('[email protected]')
-                ->to($subscriber->getEmail())
-                ->subject($campaign->getContent()->getSubject())
-                ->text($campaign->getContent()->getTextMessage())
-                ->html($campaign->getContent()->getText());
-
-            try {
-                $this->mailer->send($email);
-
-                // phpcs:ignore Generic.Commenting.Todo
-                // @todo log somewhere that this subscriber got email
-            } catch (Throwable $e) {
-                $output->writeln('Failed to send to: ' . $subscriber->getEmail());
-            }
-
-            usleep(100000);
-        }
-
-        $campaign->getMetadata()->setStatus('sent');
-        $this->entityManager->flush();
-    }
 }

src/Domain/Messaging/Service/CampaignProcessor.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Messaging\Service;
+
+use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Messaging\Model\Message;
+use PhpList\Core\Domain\Subscription\Service\Provider\SubscriberProvider;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Mime\Email;
+use Throwable;
+
+class CampaignProcessor
+{
+    private MailerInterface $mailer;
+    private EntityManagerInterface $entityManager;
+    private SubscriberProvider $subscriberProvider;
+    private MessageProcessingPreparator $messagePreparator;
+    private LoggerInterface $logger;
+
+    public function __construct(
+        MailerInterface $mailer,
+        EntityManagerInterface $entityManager,
+        SubscriberProvider $subscriberProvider,
+        MessageProcessingPreparator $messagePreparator,
+        LoggerInterface $logger,
+    ) {
+        $this->mailer = $mailer;
+        $this->entityManager = $entityManager;
+        $this->subscriberProvider = $subscriberProvider;
+        $this->messagePreparator = $messagePreparator;
+        $this->logger = $logger;
+    }
+
+    public function process(Message $campaign, ?OutputInterface $output = null): void
+    {
+        $subscribers = $this->subscriberProvider->getSubscribersForMessage($campaign);
+        // phpcs:ignore Generic.Commenting.Todo
+        // @todo check $ISPrestrictions logic
+        foreach ($subscribers as $subscriber) {
+            if (!filter_var($subscriber->getEmail(), FILTER_VALIDATE_EMAIL)) {
+                continue;
+            }
+            $this->messagePreparator->processMessageLinks($campaign, $subscriber->getId());
+            $email = (new Email())
+                ->from('[email protected]')
+                ->to($subscriber->getEmail())
+                ->subject($campaign->getContent()->getSubject())
+                ->text($campaign->getContent()->getTextMessage())
+                ->html($campaign->getContent()->getText());
+
+            try {
+                $this->mailer->send($email);
+
+                // phpcs:ignore Generic.Commenting.Todo
+                // @todo log somewhere that this subscriber got email
+            } catch (Throwable $e) {
+                $this->logger->error($e->getMessage(), [
+                    'subscriber_id' => $subscriber->getId(),
+                    'campaign_id' => $campaign->getId(),
+                ]);
+                $output?->writeln('Failed to send to: ' . $subscriber->getEmail());
+            }
+
+            usleep(100000);
+        }
+
+        $campaign->getMetadata()->setStatus('sent');
+        $this->entityManager->flush();
+    }
+}

src/Domain/Subscription/Service/SubscriberCsvExporter.php

@@ -29,7 +29,7 @@ public function __construct(
         SubscriberAttributeManager $attributeManager,
         SubscriberRepository $subscriberRepository,
         SubscriberAttributeDefinitionRepository $definitionRepository,
-        LoggerInterface $logger
+        LoggerInterface $logger,
     ) {
         $this->attributeManager = $attributeManager;
         $this->subscriberRepository = $subscriberRepository;