Add: testSendMessage endpoint

Author: tatevikg1

config/services/messenger_handlers.yml

@@ -1,5 +1,10 @@
 services:
-    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessorMessageHandler:
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\CampaignProcessorMessageHandler:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\TestCampaignProcessorMessageHandler:
         autowire: true
         autoconfigure: true
         public: false

src/Messaging/Controller/CampaignActionController.php

@@ -6,7 +6,8 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
-use PhpList\Core\Domain\Messaging\Message\SyncCampaignProcessorMessage;
+use PhpList\Core\Domain\Messaging\Message\CampaignProcessor\SyncCampaignProcessorMessage;
+use PhpList\Core\Domain\Messaging\Message\CampaignProcessor\TestCampaignProcessorMessage;
 use PhpList\Core\Domain\Messaging\Model\Message;
 use PhpList\Core\Domain\Messaging\Model\Message\MessageStatus;
 use PhpList\Core\Domain\Messaging\Service\Manager\MessageManager;
@@ -15,6 +16,7 @@
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Messaging\Request\Message\MessageMetadataRequest;
 use PhpList\RestBundle\Messaging\Request\ResendMessageToListsRequest;
+use PhpList\RestBundle\Messaging\Request\TestSendMessageToSubscribersRequest;
 use PhpList\RestBundle\Messaging\Serializer\MessageNormalizer;
 use PhpList\RestBundle\Messaging\Service\CampaignService;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
@@ -28,6 +30,7 @@
  * This controller provides REST API to manage campaign actions.
  *
  * @author Tatevik Grigoryan <tatevik@phplist.com>
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 #[Route('/campaigns', name: 'campaign_')]
 class CampaignActionController extends BaseController
@@ -283,4 +286,75 @@ public function resendMessageToLists(
 
         return $this->json($this->campaignService->getMessage($message), Response::HTTP_OK);
     }
+
+    #[Route(
+        '/{messageId}/test-send',
+        name: 'test_send_campaign',
+        requirements: ['messageId' => '\d+'],
+        methods: ['POST']
+    )]
+    #[OA\Post(
+        path: '/api/v2/campaigns/{messageId}/test-send',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+        'Processes/sends campaign/message by id to specified subscribers.',
+        summary: 'Processes/sends campaign/message by id to specified subscribers.',
+        requestBody: new OA\RequestBody(
+            description: 'Subscribers email to send this campaign to.',
+            required: true,
+            content: new OA\JsonContent(ref: '#/components/schemas/ResendMessageToListsRequest')
+        ),
+        tags: ['campaigns'],
+        parameters: [
+            new OA\Parameter(
+                name: 'php-auth-pw',
+                description: 'Session key obtained from login',
+                in: 'header',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+            new OA\Parameter(
+                name: 'messageId',
+                description: 'message ID',
+                in: 'path',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            )
+        ],
+        responses: [
+            new OA\Response(
+                response: 200,
+                description: 'Success',
+                content: new OA\JsonContent(ref: '#/components/schemas/Message')
+            ),
+            new OA\Response(
+                response: 403,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/NotFoundErrorResponse')
+            ),
+        ]
+    )]
+    public function testSendMessage(
+        Request $request,
+        #[MapEntity(mapping: ['messageId' => 'id'])] ?Message $message = null
+    ): JsonResponse {
+        $this->requireAuthentication($request);
+        if ($message === null) {
+            throw $this->createNotFoundException('Campaign not found.');
+        }
+
+        /** @var TestSendMessageToSubscribersRequest $testSendRequest */
+        $testSendRequest = $this->validator->validate($request, TestSendMessageToSubscribersRequest::class);
+
+        $this->messageBus->dispatch(new TestCampaignProcessorMessage(
+            messageId: $message->getId(),
+            subscriberEmails: $testSendRequest->emails
+        ));
+
+        return $this->json($this->campaignService->getMessage($message), Response::HTTP_OK);
+    }
 }

src/Messaging/Request/Message/MessageScheduleRequest.php

@@ -34,12 +34,12 @@ class MessageScheduleRequest implements RequestDtoInterface
 {
     public ?int $repeatInterval = null;
 
-    #[Assert\DateTime(format: "Y-m-d\TH:i:s.uP")]
+    #[Assert\DateTime(format: 'Y-m-d\TH:i:s.uP')]
     public ?string $repeatUntil = null;
 
     public ?int $requeueInterval = null;
 
-    #[Assert\DateTime(format: "Y-m-d\TH:i:s.uP")]
+    #[Assert\DateTime(format: 'Y-m-d\TH:i:s.uP')]
     public ?string $requeueUntil = null;
 
     #[Assert\NotBlank]

src/Messaging/Request/TestSendMessageToSubscribersRequest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Messaging\Request;
+
+use OpenApi\Attributes as OA;
+use PhpList\RestBundle\Common\Request\RequestInterface;
+use PhpList\RestBundle\Subscription\Validator\Constraint\EmailExists;
+use Symfony\Component\Validator\Constraints as Assert;
+
+#[OA\Schema(
+    schema: 'TestSendMessageToSubscribersRequest',
+    required: ['emails'],
+    properties: [
+        new OA\Property(
+            property: 'emails',
+            description: 'Target subscribers emails.',
+            type: 'array',
+            items: new OA\Items(type: 'string', format: 'email'),
+            example: ['user1@example.com', 'user2@example.com']
+        ),
+    ],
+    type: 'object'
+)]
+class TestSendMessageToSubscribersRequest implements RequestInterface
+{
+    #[Assert\NotNull]
+    #[Assert\Type('array')]
+    #[Assert\Count(min: 1)]
+    #[Assert\All([
+        new Assert\Type('string'),
+        new Assert\Email(),
+        new EmailExists(),
+    ])]
+    public array $emails;
+
+    public function getDto(): array
+    {
+        return [
+            'emails' => $this->emails,
+        ];
+    }
+}