MessageStatusEnum

Author: tatevikg1

src/Domain/Messaging/Model/Dto/Message/MessageMetadataDto.php

@@ -4,10 +4,12 @@
 
 namespace PhpList\Core\Domain\Messaging\Model\Dto\Message;
 
+use PhpList\Core\Domain\Messaging\Model\Message\MessageStatus;
+
 class MessageMetadataDto
 {
     public function __construct(
-        public readonly string $status,
+        public readonly MessageStatus $status,
     ) {
     }
 }

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

@@ -33,13 +33,13 @@ class MessageMetadata implements EmbeddableInterface
     private ?DateTime $sendStart;
 
     public function __construct(
-        ?string $status = null,
+        ?MessageStatus $status = null,
         int $bounceCount = 0,
         ?DateTime $entered = null,
         ?DateTime $sent = null,
         ?DateTime $sendStart = null,
     ) {
-        $this->status = $status;
+        $this->status = $status->value ?? null;
         $this->processed = false;
         $this->viewed = 0;
         $this->bounceCount = $bounceCount;
@@ -48,14 +48,17 @@ public function __construct(
         $this->sendStart = $sendStart;
     }
 
-    public function getStatus(): ?string
+    /**
+     * @SuppressWarnings("PHPMD.StaticAccess")
+     */
+    public function getStatus(): ?MessageStatus
     {
-        return $this->status;
+        return MessageStatus::from($this->status);
     }
 
-    public function setStatus(string $status): self
+    public function setStatus(MessageStatus $status): self
     {
-        $this->status = $status;
+        $this->status = $status->value;
         return $this;
     }
 

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

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Messaging\Model\Message;
+
+enum MessageStatus: string
+{
+    case Draft = 'draft';
+    case Prepared = 'prepared';
+    case Submitted = 'submitted';
+    case InProcess = 'inprocess';
+    case Sent = 'sent';
+    case Suspended = 'suspended';
+    case Requeued = 'requeued';
+
+    public function isFinal(): bool
+    {
+        return match ($this) {
+            self::Sent, self::Suspended => true,
+            default => false,
+        };
+    }
+}

src/Domain/Messaging/Service/Builder/MessageBuilder.php

@@ -45,7 +45,7 @@ public function build(MessageDtoInterface $createMessageDto, object $context = n
             return $context->getExisting();
         }
 
-        $metadata = new Message\MessageMetadata($createMessageDto->getMetadata()->status);
+        $metadata = new Message\MessageMetadata(Message\MessageStatus::Draft);
 
         return new Message($format, $schedule, $metadata, $content, $options, $context->getOwner(), $template);
     }

src/Domain/Messaging/Service/Manager/MessageManager.php

@@ -43,6 +43,14 @@ public function updateMessage(
         return $message;
     }
 
+    public function updateStatus(Message $message, Message\MessageStatus $status): Message
+    {
+        $message->getMetadata()->setStatus($status);
+        $this->messageRepository->save($message);
+
+        return $message;
+    }
+
     public function delete(Message $message): void
     {
         $this->messageRepository->remove($message);

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

@@ -69,7 +69,7 @@ public function process(Message $campaign, ?OutputInterface $output = null): voi
             usleep(100000);
         }
 
-        $campaign->getMetadata()->setStatus('sent');
+        $campaign->getMetadata()->setStatus(Message\MessageStatus::Sent);
         $this->entityManager->flush();
     }
 }

tests/Integration/Domain/Messaging/Repository/MessageRepositoryTest.php

@@ -48,7 +48,7 @@ public function testMessageIsPersistedAndFetchedCorrectly(): void
         $message = new Message(
             new MessageFormat(true, 'text'),
             new MessageSchedule(1, null, 3, null, null),
-            new MessageMetadata('done'),
+            new MessageMetadata(Message\MessageStatus::Sent),
             new MessageContent('Hello world!'),
             new MessageOptions(),
             $admin
@@ -62,7 +62,7 @@ public function testMessageIsPersistedAndFetchedCorrectly(): void
 
         self::assertCount(1, $foundMessages);
         self::assertInstanceOf(Message::class, $foundMessages[0]);
-        self::assertSame('done', $foundMessages[0]->getMetadata()->getStatus());
+        self::assertSame(Message\MessageStatus::Sent, $foundMessages[0]->getMetadata()->getStatus());
         self::assertSame('Hello world!', $foundMessages[0]->getContent()->getSubject());
     }
 
@@ -77,7 +77,7 @@ public function testGetByOwnerIdReturnsOnlyOwnedMessages(): void
         $msg1 = new Message(
             new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             new MessageSchedule(1, null, 3, null, null),
-            new MessageMetadata('done'),
+            new MessageMetadata(Message\MessageStatus::Sent),
             new MessageContent('Owned by Admin 1!'),
             new MessageOptions(),
             $admin1

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

@@ -58,7 +58,7 @@ public function testDeleteSubscriberWithRelatedDataDoesNotThrowDoctrineError():
         $msg = new Message(
             format: new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             schedule: new MessageSchedule(1, null, 3, null, null),
-            metadata: new MessageMetadata('done'),
+            metadata: new MessageMetadata(Message\MessageStatus::Sent),
             content: new MessageContent('Owned by Admin 1!'),
             options: new MessageOptions(),
             owner: $admin

tests/Unit/Domain/Messaging/Service/Builder/MessageBuilderTest.php

@@ -2,9 +2,8 @@
 
 declare(strict_types=1);
 
-namespace PhpList\Core\Tests\Unit\Domain\Service\Builder;
+namespace PhpList\Core\Tests\Unit\Domain\Messaging\Service\Builder;
 
-use Error;
 use InvalidArgumentException;
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Messaging\Model\Dto\CreateMessageDto;
@@ -64,7 +63,7 @@ private function createRequest(): CreateMessageDto
                 formatOptions: []
             ),
             metadata: new MessageMetadataDto(
-                status: 'draft'
+                status: Message\MessageStatus::Draft
             ),
             options: new MessageOptionsDto(
                 fromField: '',
@@ -117,16 +116,6 @@ public function testBuildsNewMessage(): void
         $this->builder->build($request, $context);
     }
 
-    public function testThrowsExceptionOnInvalidRequest(): void
-    {
-        $this->expectException(Error::class);
-
-        $this->builder->build(
-            $this->createMock(CreateMessageDto::class),
-            new MessageContext($this->createMock(Administrator::class))
-        );
-    }
-
     public function testThrowsExceptionOnInvalidContext(): void
     {
         $this->expectException(InvalidArgumentException::class);

tests/Unit/Domain/Messaging/Service/Builder/MessageContentBuilderTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpList\Core\Tests\Unit\Domain\Service\Builder;
+namespace PhpList\Core\Tests\Unit\Domain\Messaging\Service\Builder;
 
 use InvalidArgumentException;
 use PhpList\Core\Domain\Messaging\Model\Dto\Message\MessageContentDto;