Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dic(conf): triggers started #205

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"SchedulerBundle\\Test\\Constraint\\Scheduler\\": "src/Test/Constraint/Scheduler/",
"SchedulerBundle\\Transport\\": "src/Transport/",
"SchedulerBundle\\Transport\\Configuration\\": "src/Transport/Configuration/",
"SchedulerBundle\\Trigger\\": "src/Trigger/",
"SchedulerBundle\\Worker\\": "src/Worker/"
}
},
Expand Down Expand Up @@ -88,6 +89,7 @@
"Tests\\SchedulerBundle\\Transport\\": "tests/Transport/",
"Tests\\SchedulerBundle\\Transport\\Assets\\": "tests/Transport/Assets/",
"Tests\\SchedulerBundle\\Transport\\Configuration\\": "tests/Transport/Configuration/",
"Tests\\SchedulerBundle\\Trigger\\": "tests/Trigger/",
"Tests\\SchedulerBundle\\Worker\\": "tests/Worker/",
"Tests\\SchedulerBundle\\Worker\\Assets\\": "tests/Worker/Assets/"
}
Expand Down Expand Up @@ -142,11 +144,14 @@
"symfony/framework-bundle": "^5.2",
"symfony/http-client": "^5.2",
"symfony/http-kernel": "^5.2",
"symfony/mailer": "^5.2",
"symfony/mercure": "^0.5.3",
"symfony/messenger": "^5.2",
"symfony/notifier": "^5.2",
"symfony/phpunit-bridge": "^5.2",
"symfony/rate-limiter": "^5.2",
"symfony/translation": "^5.2",
"symfony/twig-bundle": "^5.3",
"thecodingmachine/safe": "^1.3.3"
},
"suggest": {
Expand Down
58 changes: 58 additions & 0 deletions src/DependencyInjection/SchedulerBundleConfiguration.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,64 @@ public function getConfigTreeBuilder(): TreeBuilder
->end()
->end()
->end()
->arrayNode('triggers')
->addDefaultsIfNotSet()
->children()
->scalarNode('enabled')
->info('Enable the triggers support')
->defaultValue(false)
->end()
->arrayNode('email')
->addDefaultsIfNotSet()
->children()
->scalarNode('enabled')
->info('Enable the email triggers')
->defaultValue(false)
->end()
->arrayNode('on_failure')
->children()
->scalarNode('triggered_at')
->info('The amount of task that need to fail before the email is sent')
->defaultValue(1)
->end()
->scalarNode('to')
->info('The receiver email')
->defaultValue(null)
->end()
->scalarNode('from')
->info('The sender email')
->defaultValue(null)
->end()
->scalarNode('subject')
->info('The subject of the email')
->defaultValue('An task failed during its execution')
->end()
->end()
->end()
->arrayNode('on_success')
->children()
->scalarNode('triggered_at')
->info('The amount of task that need to succeed before the email is sent')
->defaultValue(1)
->end()
->scalarNode('to')
->info('The receiver email')
->defaultValue(null)
->end()
->scalarNode('from')
->info('The sender email')
->defaultValue(null)
->end()
->scalarNode('subject')
->info('The subject of the email')
->defaultValue('An task succeed during its execution')
->end()
->end()
->end()
->end()
->end()
->end()
->end()
->arrayNode('probe')
->children()
->scalarNode('enabled')
Expand Down
66 changes: 66 additions & 0 deletions src/DependencyInjection/SchedulerBundleExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
use SchedulerBundle\Middleware\TaskExecutionMiddleware;
use SchedulerBundle\Middleware\TaskLockBagMiddleware;
use SchedulerBundle\Middleware\TaskUpdateMiddleware;
use SchedulerBundle\Middleware\TriggerMiddleware;
use SchedulerBundle\Middleware\WorkerMiddlewareStack;
use SchedulerBundle\Middleware\PostExecutionMiddlewareInterface;
use SchedulerBundle\Middleware\PreExecutionMiddlewareInterface;
Expand Down Expand Up @@ -115,6 +116,10 @@
use SchedulerBundle\Transport\TransportFactory;
use SchedulerBundle\Transport\TransportFactoryInterface;
use SchedulerBundle\Transport\TransportInterface;
use SchedulerBundle\Trigger\EmailTriggerConfiguration;
use SchedulerBundle\Trigger\TriggerConfigurationInterface;
use SchedulerBundle\Trigger\TriggerConfigurationRegistry;
use SchedulerBundle\Trigger\TriggerConfigurationRegistryInterface;
use SchedulerBundle\Worker\Worker;
use SchedulerBundle\Worker\WorkerInterface;
use Symfony\Bundle\FrameworkBundle\Console\Application;
Expand All @@ -126,6 +131,7 @@
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mercure\Hub;
use Symfony\Component\Mercure\Jwt\StaticTokenProvider;
use Symfony\Component\Lock\LockFactory;
Expand Down Expand Up @@ -158,6 +164,7 @@ final class SchedulerBundleExtension extends Extension
private const SCHEDULER_SCHEDULE_POLICY = 'scheduler.schedule_policy';
private const TRANSPORT_CONFIGURATION_TAG = 'scheduler.configuration';
private const TRANSPORT_CONFIGURATION_FACTORY_TAG = 'scheduler.configuration_factory';
private const SCHEDULER_TRIGGER_CONFIGURATION_TAG = 'scheduler.trigger_configuration';

public function load(array $configs, ContainerBuilder $container): void
{
Expand Down Expand Up @@ -192,6 +199,7 @@ public function load(array $configs, ContainerBuilder $container): void
$this->registerMiddlewareStacks($container, $config);
$this->registerProbeContext($container, $config);
$this->registerMercureSupport($container, $config);
$this->registerTriggers($container, $config);
$this->registerDataCollector($container);
}

Expand All @@ -206,6 +214,8 @@ private function registerParameters(ContainerBuilder $container, array $configur
$container->setParameter('scheduler.probe_enabled', $configuration['probe']['enabled'] ?? false);
$container->setParameter('scheduler.mercure_support', $configuration['mercure']['enabled']);
$container->setParameter('scheduler.pool_support', $configuration['pool']['enabled']);
$container->setParameter('scheduler.trigger_support', $configuration['triggers']['enabled']);
$container->setParameter('scheduler.trigger_support.emails_enabled', $configuration['triggers']['email']['enabled']);
}

private function registerAutoConfigure(ContainerBuilder $container): void
Expand All @@ -226,6 +236,7 @@ private function registerAutoConfigure(ContainerBuilder $container): void
$container->registerForAutoconfiguration(BuilderInterface::class)->addTag(self::SCHEDULER_TASK_BUILDER_TAG);
$container->registerForAutoconfiguration(ProbeInterface::class)->addTag(self::SCHEDULER_PROBE_TAG);
$container->registerForAutoconfiguration(TaskBagInterface::class)->addTag('scheduler.task_bag');
$container->registerForAutoconfiguration(TriggerConfigurationInterface::class)->addTag(self::SCHEDULER_TRIGGER_CONFIGURATION_TAG);
}

private function registerConfigurationFactories(ContainerBuilder $container): void
Expand Down Expand Up @@ -1328,6 +1339,61 @@ private function registerMercureSupport(ContainerBuilder $container, array $conf
;
}

private function registerTriggers(ContainerBuilder $container, array $config): void
{
if (!$container->getParameter('scheduler.trigger_support')) {
return;
}

$container->register(TriggerConfigurationRegistry::class, TriggerConfigurationRegistry::class)
->setArguments([
new TaggedIteratorArgument(self::SCHEDULER_TRIGGER_CONFIGURATION_TAG),
])
->setPublic(false)
->addTag('container.preload', [
'class' => TriggerConfigurationRegistry::class,
])
;
$container->setAlias(TriggerConfigurationRegistryInterface::class, TriggerConfigurationRegistry::class);

$container->register(TriggerMiddleware::class, TriggerMiddleware::class)
->setArguments([
new Reference(EventDispatcherInterface::class, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE),
new Reference(TriggerConfigurationRegistryInterface::class, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE),
new Reference(LoggerInterface::class, ContainerInterface::NULL_ON_INVALID_REFERENCE),
new Reference(MailerInterface::class, ContainerInterface::NULL_ON_INVALID_REFERENCE),
])
->setPublic(false)
->addTag(self::SCHEDULER_WORKER_MIDDLEWARE_TAG)
->addTag('container.preload', [
'class' => TriggerMiddleware::class,
])
;

if (!$container->getParameter('scheduler.trigger_support.emails_enabled')) {
return;
}

$container->register(EmailTriggerConfiguration::class, EmailTriggerConfiguration::class)
->setArguments([
$container->getParameter('scheduler.trigger_support'),
$config['triggers']['email']['on_failure']['triggered_at'],
$config['triggers']['email']['on_success']['triggered_at'],
$config['triggers']['email']['on_failure']['subject'],
$config['triggers']['email']['on_success']['subject'],
$config['triggers']['email']['on_failure']['from'],
$config['triggers']['email']['on_success']['from'],
$config['triggers']['email']['on_failure']['to'],
$config['triggers']['email']['on_success']['to'],
])
->addTag(self::SCHEDULER_TRIGGER_CONFIGURATION_TAG)
->setPublic(false)
->addTag('container.preload', [
'class' => EmailTriggerConfiguration::class,
])
;
}

private function registerDataCollector(ContainerBuilder $container): void
{
$container->register(SchedulerDataCollector::class, SchedulerDataCollector::class)
Expand Down
125 changes: 125 additions & 0 deletions src/EventListener/EmailTaskLifecycleSubscriber.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?php

declare(strict_types=1);

namespace SchedulerBundle\EventListener;

use SchedulerBundle\Event\TaskExecutedEvent;
use SchedulerBundle\Event\TaskFailedEvent;
use SchedulerBundle\Task\FailedTask;
use SchedulerBundle\Task\Output;
use SchedulerBundle\Task\TaskInterface;
use SchedulerBundle\Task\TaskList;
use SchedulerBundle\Task\TaskListInterface;
use SchedulerBundle\Trigger\EmailTriggerConfiguration;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;

/**
* @author Guillaume Loulier <contact@guillaumeloulier.fr>
*/
final class EmailTaskLifecycleSubscriber implements EventSubscriberInterface
{
private TaskListInterface $failedTasksList;
private TaskListInterface $succeedTasksList;
private ?MailerInterface $mailer;
private EmailTriggerConfiguration $emailTriggerConfiguration;

public function __construct(
EmailTriggerConfiguration $emailTriggerConfiguration,
?MailerInterface $mailer = null
) {
$this->emailTriggerConfiguration = $emailTriggerConfiguration;
$this->mailer = $mailer;

$this->failedTasksList = new TaskList();
$this->succeedTasksList = new TaskList();
}
Comment on lines +26 to +40
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
private TaskListInterface $failedTasksList;
private TaskListInterface $succeedTasksList;
private ?MailerInterface $mailer;
private EmailTriggerConfiguration $emailTriggerConfiguration;
public function __construct(
EmailTriggerConfiguration $emailTriggerConfiguration,
?MailerInterface $mailer = null
) {
$this->emailTriggerConfiguration = $emailTriggerConfiguration;
$this->mailer = $mailer;
$this->failedTasksList = new TaskList();
$this->succeedTasksList = new TaskList();
}
private TaskListInterface $failedTasksList;
private TaskListInterface $succeedTasksList;
public function __construct(
private EmailTriggerConfiguration $emailTriggerConfiguration,
private ?MailerInterface $mailer = null
) {
$this->failedTasksList = new TaskList();
$this->succeedTasksList = new TaskList();
}


/**
* {@inheritdoc}
*/
public static function getSubscribedEvents(): array
{
return [
TaskExecutedEvent::class => 'onTaskExecuted',
TaskFailedEvent::class => 'onTaskFailed',
];
}

public function onTaskFailed(FailedTask $failedTask): void
{
$this->failedTasksList->add($failedTask->getTask());
}

public function onTaskExecuted(TaskExecutedEvent $event): void
{
$task = $event->getTask();
$output = $event->getOutput();

$this->handleTaskFailure($task, $output);
$this->handleTaskSuccess($task, $output);
}

private function handleTaskFailure(TaskInterface $task, Output $output): void
{
if ($this->failedTasksList->count() !== $this->emailTriggerConfiguration->getFailureTriggeredAt()) {
return;
}

if (null === $this->emailTriggerConfiguration->getFailureTo()) {
return;
}

$this->send(
(new TemplatedEmail())
->from($this->emailTriggerConfiguration->getFailureFrom())
->to(new Address($this->emailTriggerConfiguration->getFailureTo()))
->subject($this->emailTriggerConfiguration->getFailureSubject())
->htmlTemplate('emails/task_failure.html.twig')
->context([
'tasks' => $this->failedTasksList->toArray(false),
])
);
}

private function handleTaskSuccess(TaskInterface $task, Output $output): void
{
if ($task->getExecutionState() !== TaskInterface::SUCCEED) {
return;
}

$this->succeedTasksList->add($task);

if ($this->succeedTasksList->count() !== $this->emailTriggerConfiguration->getSuccessTriggeredAt()) {
return;
}

if (null === $this->emailTriggerConfiguration->getSuccessTo()) {
return;
}

$this->send(
(new TemplatedEmail())
->from($this->emailTriggerConfiguration->getSuccessFrom())
->to(new Address($this->emailTriggerConfiguration->getSuccessTo()))
->subject($this->emailTriggerConfiguration->getFailureSubject())
->htmlTemplate('emails/task_success.html.twig')
->context([
'tasks' => $this->succeedTasksList->toArray(false),
])
);
}

private function send(Email $email): void
{
if (null === $this->mailer) {
return;
}

$this->mailer->send($email);
}
}
36 changes: 18 additions & 18 deletions src/EventListener/MercureEventSubscriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,24 @@ public function __construct(
$this->serializer = $serializer;
}

/**
* {@inheritdoc}
*/
public static function getSubscribedEvents(): array
{
return [
TaskScheduledEvent::class => ['onTaskScheduled', -255],
TaskUnscheduledEvent::class => ['onTaskUnscheduled', -255],
TaskExecutedEvent::class => ['onTaskExecuted', -255],
TaskFailedEvent::class => ['onTaskFailed', -255],
WorkerPausedEvent::class => ['onWorkerPaused', -255],
WorkerStartedEvent::class => ['onWorkerStarted', -255],
WorkerStoppedEvent::class => ['onWorkerStopped', -255],
WorkerForkedEvent::class => ['onWorkerForked', -255],
WorkerRestartedEvent::class => ['onWorkerRestarted', -255],
];
}

/**
* @throws JsonException {@see json_encode()}
*/
Expand Down Expand Up @@ -185,22 +203,4 @@ public function onWorkerRestarted(WorkerRestartedEvent $event): void
],
], JSON_THROW_ON_ERROR)));
}

/**
* {@inheritdoc}
*/
public static function getSubscribedEvents(): array
{
return [
TaskScheduledEvent::class => ['onTaskScheduled', -255],
TaskUnscheduledEvent::class => ['onTaskUnscheduled', -255],
TaskExecutedEvent::class => ['onTaskExecuted', -255],
TaskFailedEvent::class => ['onTaskFailed', -255],
WorkerPausedEvent::class => ['onWorkerPaused', -255],
WorkerStartedEvent::class => ['onWorkerStarted', -255],
WorkerStoppedEvent::class => ['onWorkerStopped', -255],
WorkerForkedEvent::class => ['onWorkerForked', -255],
WorkerRestartedEvent::class => ['onWorkerRestarted', -255],
];
}
}
Loading