[Scheduler] add failure event

alli83 · alli83 · commit 56f2c939c31b · 2023-10-17T12:04:59.000+11:00
diff --git a/src/Symfony/Component/Scheduler/CHANGELOG.md b/src/Symfony/Component/Scheduler/CHANGELOG.md
@@ -15,6 +15,7 @@ CHANGELOG
  * Add `MessageProviderInterface` to trigger unique messages at runtime
  * Add `PreRunEvent` and `PostRunEvent` events
  * Add `DispatchSchedulerEventListener`
+ * Add `FailureEvent` event
 
 6.3
 ---
diff --git a/src/Symfony/Component/Scheduler/Event/FailureEvent.php b/src/Symfony/Component/Scheduler/Event/FailureEvent.php
@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Scheduler\Event;
+
+use Symfony\Component\Scheduler\Generator\MessageContext;
+use Symfony\Component\Scheduler\ScheduleProviderInterface;
+
+class FailureEvent
+{
+    public function __construct(
+        private readonly ScheduleProviderInterface $schedule,
+        private readonly MessageContext $messageContext,
+        private readonly object $message,
+        private readonly \Throwable $error,
+    ) {
+    }
+
+    public function getMessageContext(): MessageContext
+    {
+        return $this->messageContext;
+    }
+
+    public function getSchedule(): ScheduleProviderInterface
+    {
+        return $this->schedule;
+    }
+
+    public function getMessage(): object
+    {
+        return $this->message;
+    }
+
+    public function getError(): \Throwable
+    {
+        return $this->error;
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/EventListener/DispatchSchedulerEventListener.php b/src/Symfony/Component/Scheduler/EventListener/DispatchSchedulerEventListener.php
@@ -14,8 +14,12 @@
 use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
+use Symfony\Component\Messenger\Stamp\StampInterface;
+use Symfony\Component\Scheduler\Event\FailureEvent;
 use Symfony\Component\Scheduler\Event\PostRunEvent;
 use Symfony\Component\Scheduler\Event\PreRunEvent;
 use Symfony\Component\Scheduler\Messenger\ScheduledStamp;
@@ -31,11 +35,8 @@ public function __construct(
     public function onMessageHandled(WorkerMessageHandledEvent $event): void
     {
         $envelope = $event->getEnvelope();
-        if (!$scheduledStamp = $envelope->last(ScheduledStamp::class)) {
-            return;
-        }
 
-        if (!$this->scheduleProviderLocator->has($scheduledStamp->messageContext->name)) {
+        if (!$scheduledStamp = $this->getScheduledStamp($envelope)) {
             return;
         }
 
@@ -46,11 +47,7 @@ public function onMessageReceived(WorkerMessageReceivedEvent $event): void
     {
         $envelope = $event->getEnvelope();
 
-        if (!$scheduledStamp = $envelope->last(ScheduledStamp::class)) {
-            return;
-        }
-
-        if (!$this->scheduleProviderLocator->has($scheduledStamp->messageContext->name)) {
+        if (!$scheduledStamp = $this->getScheduledStamp($envelope)) {
             return;
         }
 
@@ -63,11 +60,36 @@ public function onMessageReceived(WorkerMessageReceivedEvent $event): void
         }
     }
 
+    public function onMessageFailed(WorkerMessageFailedEvent $event): void
+    {
+        $envelope = $event->getEnvelope();
+
+        if (!$scheduledStamp = $this->getScheduledStamp($envelope)) {
+            return;
+        }
+
+        $this->eventDispatcher->dispatch(new FailureEvent($this->scheduleProviderLocator->get($scheduledStamp->messageContext->name), $scheduledStamp->messageContext, $envelope->getMessage(), $event->getThrowable()));
+    }
+
+    private function getScheduledStamp(Envelope $envelope): ?StampInterface
+    {
+        if (!$scheduledStamp = $envelope->last(ScheduledStamp::class)) {
+            return null;
+        }
+
+        if (!$this->scheduleProviderLocator->has($scheduledStamp->messageContext->name)) {
+            return null;
+        }
+
+        return $scheduledStamp;
+    }
+
     public static function getSubscribedEvents(): array
     {
         return [
             WorkerMessageReceivedEvent::class => ['onMessageReceived'],
             WorkerMessageHandledEvent::class => ['onMessageHandled'],
+            WorkerMessageFailedEvent::class => ['onMessageFailed'],
         ];
     }
 }
diff --git a/src/Symfony/Component/Scheduler/Schedule.php b/src/Symfony/Component/Scheduler/Schedule.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Lock\LockInterface;
+use Symfony\Component\Scheduler\Event\FailureEvent;
 use Symfony\Component\Scheduler\Event\PostRunEvent;
 use Symfony\Component\Scheduler\Event\PreRunEvent;
 use Symfony\Component\Scheduler\Exception\LogicException;
@@ -152,6 +153,13 @@ public function after(callable $listener, int $priority = 0): static
         return $this;
     }
 
+    public function onFailure(callable $listener, int $priority = 0): static
+    {
+        $this->dispatcher->addListener(FailureEvent::class, $listener, $priority);
+
+        return $this;
+    }
+
     public function shouldRestart(): bool
     {
         return $this->shouldRestart;
diff --git a/src/Symfony/Component/Scheduler/Scheduler.php b/src/Symfony/Component/Scheduler/Scheduler.php
@@ -14,6 +14,7 @@
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Clock\Clock;
 use Symfony\Component\Clock\ClockInterface;
+use Symfony\Component\Scheduler\Event\FailureEvent;
 use Symfony\Component\Scheduler\Event\PostRunEvent;
 use Symfony\Component\Scheduler\Event\PreRunEvent;
 use Symfony\Component\Scheduler\Generator\MessageGenerator;
@@ -81,10 +82,14 @@ public function run(array $options = []): void
                         continue;
                     }
 
-                    $this->handlers[$message::class]($message);
-                    $ran = true;
+                    try {
+                        $this->handlers[$message::class]($message);
+                        $ran = true;
 
-                    $this->dispatcher->dispatch(new PostRunEvent($generator->getSchedule(), $context, $message));
+                        $this->dispatcher->dispatch(new PostRunEvent($generator->getSchedule(), $context, $message));
+                    } catch (\Throwable $error) {
+                        $this->dispatcher->dispatch(new FailureEvent($generator->getSchedule(), $context, $message, $error));
+                    }
                 }
             }
 
diff --git a/src/Symfony/Component/Scheduler/Tests/EventListener/DispatchSchedulerEventListenerTest.php b/src/Symfony/Component/Scheduler/Tests/EventListener/DispatchSchedulerEventListenerTest.php
@@ -15,7 +15,11 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
+use Symfony\Component\Scheduler\Event\FailureEvent;
+use Symfony\Component\Scheduler\Event\PostRunEvent;
 use Symfony\Component\Scheduler\Event\PreRunEvent;
 use Symfony\Component\Scheduler\EventListener\DispatchSchedulerEventListener;
 use Symfony\Component\Scheduler\Generator\MessageContext;
@@ -33,23 +37,29 @@ public function testDispatchSchedulerEvents()
 
         $schedulerProvider = new SomeScheduleProvider([$defaultRecurringMessage]);
         $scheduleProviderLocator = $this->createMock(ContainerInterface::class);
-        $scheduleProviderLocator->expects($this->once())->method('has')->willReturn(true);
-        $scheduleProviderLocator->expects($this->once())->method('get')->willReturn($schedulerProvider);
+        $scheduleProviderLocator->expects($this->any())->method('has')->willReturn(true);
+        $scheduleProviderLocator->expects($this->any())->method('get')->willReturn($schedulerProvider);
 
         $context = new MessageContext('default', 'default', $trigger, $this->createMock(\DateTimeImmutable::class));
         $envelope = (new Envelope(new \stdClass()))->with(new ScheduledStamp($context));
 
         /** @var ContainerInterface $scheduleProviderLocator */
         $listener = new DispatchSchedulerEventListener($scheduleProviderLocator, $eventDispatcher = new EventDispatcher());
         $workerReceivedEvent = new WorkerMessageReceivedEvent($envelope, 'default');
+        $workerHandledEvent = new WorkerMessageHandledEvent($envelope, 'default');
+        $workerFailedEvent = new WorkerMessageFailedEvent($envelope, 'default', new \Exception());
         $secondListener = new TestEventListener();
 
         $eventDispatcher->addListener(PreRunEvent::class, [$secondListener, 'preRun']);
-        $eventDispatcher->addListener(PreRunEvent::class, [$secondListener, 'postRun']);
+        $eventDispatcher->addListener(PostRunEvent::class, [$secondListener, 'postRun']);
+        $eventDispatcher->addListener(FailureEvent::class, [$secondListener, 'onFailure']);
         $listener->onMessageReceived($workerReceivedEvent);
+        $listener->onMessageHandled($workerHandledEvent);
+        $listener->onMessageFailed($workerFailedEvent);
 
         $this->assertTrue($secondListener->preInvoked);
         $this->assertTrue($secondListener->postInvoked);
+        $this->assertTrue($secondListener->failureInvoked);
     }
 }
 
@@ -58,6 +68,7 @@ class TestEventListener
     public string $name;
     public bool $preInvoked = false;
     public bool $postInvoked = false;
+    public bool $failureInvoked = false;
 
     /* Listener methods */
 
@@ -70,4 +81,9 @@ public function postRun($e)
     {
         $this->postInvoked = true;
     }
+
+    public function onFailure($e)
+    {
+        $this->failureInvoked = true;
+    }
 }
