Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Move SendingQueueEntity::toArray() to SendingQueuesResponseBuilder::build()

Browse Source 
Based on a suggestion during the review of the PR, it was decided that
it makes more sense for the code that was created as
SendingQueueEntity::toArray() tp be moved to
SendingQueuesResponseBuilder::build(). It is used only to build the
format that is send in the API response.

[MAILPOET-4368]
This commit is contained in:
Rodrigo Primo
2023-10-25 10:50:51 -03:00
committed by Aschepikov
parent 69736c5e83
commit d4a80c7230
5 changed files with 59 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
mailpoet/lib/API/JSON/ResponseBuilders/SendingQueuesResponseBuilder.php Normal file
View File

@@ -0,0 +1,41 @@
<?php declare(strict_types = 1);
namespace MailPoet\API\JSON\ResponseBuilders;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\ScheduledTaskEntity;
use MailPoet\Entities\SendingQueueEntity;
class SendingQueuesResponseBuilder {
public function build(SendingQueueEntity $sendingQueue): array {
if (!$sendingQueue->getTask() instanceof ScheduledTaskEntity) {
throw new \RuntimeException('Invalid state. SendingQueue has no ScheduledTask associated.');
}
return [
'id' => $sendingQueue->getId(),
'type' => $sendingQueue->getTask()->getType(),
'status' => $sendingQueue->getTask()->getStatus(),
'priority' => $sendingQueue->getTask()->getPriority(),
'scheduled_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getScheduledAt()),
'processed_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getProcessedAt()),
'created_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getCreatedAt()),
'updated_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getUpdatedAt()),
'deleted_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getDeletedAt()),
'in_progress' => $sendingQueue->getTask()->getInProgress(),
'reschedule_count' => $sendingQueue->getTask()->getRescheduleCount(),
'meta' => $sendingQueue->getMeta(),
'task_id' => $sendingQueue->getTask()->getId(),
'newsletter_id' => ($sendingQueue->getNewsletter() instanceof NewsletterEntity) ? $sendingQueue->getNewsletter()->getId() : null,
'newsletter_rendered_body' => $sendingQueue->getNewsletterRenderedBody(),
'newsletter_rendered_subject' => $sendingQueue->getNewsletterRenderedSubject(),
'count_total' => $sendingQueue->getCountTotal(),
'count_processed' => $sendingQueue->getCountProcessed(),
'count_to_process' => $sendingQueue->getCountToProcess(),
];
}
private function getFormattedDateOrNull(?\DateTimeInterface $date): ?string {
return $date ? $date->format('Y-m-d H:i:s') : null;
}
}

10
mailpoet/lib/API/JSON/v1/SendingQueue.php
View File

@@ -5,6 +5,7 @@ namespace MailPoet\API\JSON\v1;
use MailPoet\API\JSON\Endpoint as APIEndpoint;
use MailPoet\API\JSON\Error as APIError;
use MailPoet\API\JSON\Response;
use MailPoet\API\JSON\ResponseBuilders\SendingQueuesResponseBuilder;
use MailPoet\Config\AccessControl;
use MailPoet\Cron\ActionScheduler\Actions\DaemonTrigger;
use MailPoet\Cron\CronTrigger;
@@ -60,6 +61,9 @@ class SendingQueue extends APIEndpoint {
/** @var DaemonTrigger */
private $actionSchedulerDaemonTriggerAction;
/** @var SendingQueuesResponseBuilder */
private $sendingQueuesResponseBuilder;
public function __construct(
SubscribersFeature $subscribersFeature,
NewslettersRepository $newsletterRepository,
@@ -70,7 +74,8 @@ class SendingQueue extends APIEndpoint {
Scheduler $scheduler,
SettingsController $settings,
DaemonTrigger $actionSchedulerDaemonTriggerAction,
NewsletterValidator $newsletterValidator
NewsletterValidator $newsletterValidator,
SendingQueuesResponseBuilder $sendingQueuesResponseBuilder
) {
$this->subscribersFeature = $subscribersFeature;
$this->subscribersFinder = $subscribersFinder;
@@ -82,6 +87,7 @@ class SendingQueue extends APIEndpoint {
$this->settings = $settings;
$this->actionSchedulerDaemonTriggerAction = $actionSchedulerDaemonTriggerAction;
$this->newsletterValidator = $newsletterValidator;
$this->sendingQueuesResponseBuilder = $sendingQueuesResponseBuilder;
}
public function add($data = []) {
@@ -202,7 +208,7 @@ class SendingQueue extends APIEndpoint {
} else {
$this->triggerSending($newsletter);
return $this->successResponse(
($newsletter->getLatestQueue() instanceof SendingQueueEntity) ? $newsletter->getLatestQueue()->toArray() : null
($newsletter->getLatestQueue() instanceof SendingQueueEntity) ? $this->sendingQueuesResponseBuilder->build($newsletter->getLatestQueue()) : null
);
}
}