Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit77b4b53

Browse files
committed
[Messenger] Dispatch events before & after each handler
1 parent6283597 commit77b4b53

File tree

8 files changed

+158
-0
lines changed

8 files changed

+158
-0
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
->abstract()
8383
->args([
8484
abstract_arg('bus handler resolver'),
85+
false,
86+
service('event_dispatcher'),
8587
])
8688
->tag('monolog.logger', ['channel' =>'messenger'])
8789
->call('setLogger', [service('logger')->ignoreOnInvalid()])

‎src/Symfony/Component/Messenger/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
7.1
5+
---
6+
7+
* New events:`HandlerStartingEvent`,`HandlerSuccessEvent`,`HandlerFailureEvent`
8+
49
7.0
510
---
611

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespaceSymfony\Component\Messenger\Event;
13+
14+
useSymfony\Component\Messenger\Envelope;
15+
useSymfony\Component\Messenger\Handler\HandlerDescriptor;
16+
17+
abstractclass AbstractHandlerEvent
18+
{
19+
publicfunction__construct(
20+
publicreadonlyEnvelope$envelope,
21+
publicreadonlyHandlerDescriptor$handlerDescriptor,
22+
) {
23+
}
24+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespaceSymfony\Component\Messenger\Event;
13+
14+
useSymfony\Component\Messenger\Envelope;
15+
useSymfony\Component\Messenger\Handler\HandlerDescriptor;
16+
17+
/**
18+
* Event dispatched after a handler fails.
19+
*/
20+
finalclass HandlerFailureEventextends AbstractHandlerEvent
21+
{
22+
publicfunction__construct(
23+
Envelope$envelope,
24+
HandlerDescriptor$handlerDescriptor,
25+
publicreadonly\Throwable$exception,
26+
) {
27+
parent::__construct($envelope,$handlerDescriptor);
28+
}
29+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespaceSymfony\Component\Messenger\Event;
13+
14+
/**
15+
* Event dispatched before a handler is called.
16+
*/
17+
finalclass HandlerStartingEventextends AbstractHandlerEvent
18+
{
19+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespaceSymfony\Component\Messenger\Event;
13+
14+
/**
15+
* Event dispatched after a handler succeeds.
16+
*/
17+
finalclass HandlerSuccessEventextends AbstractHandlerEvent
18+
{
19+
}

‎src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@
1111

1212
namespaceSymfony\Component\Messenger\Middleware;
1313

14+
usePsr\EventDispatcher\EventDispatcherInterface;
1415
usePsr\Log\LoggerAwareTrait;
1516
useSymfony\Component\Messenger\Envelope;
17+
useSymfony\Component\Messenger\Event\HandlerFailureEvent;
18+
useSymfony\Component\Messenger\Event\HandlerStartingEvent;
19+
useSymfony\Component\Messenger\Event\HandlerSuccessEvent;
1620
useSymfony\Component\Messenger\Exception\HandlerFailedException;
1721
useSymfony\Component\Messenger\Exception\LogicException;
1822
useSymfony\Component\Messenger\Exception\NoHandlerForMessageException;
@@ -35,6 +39,7 @@ class HandleMessageMiddleware implements MiddlewareInterface
3539
publicfunction__construct(
3640
privateHandlersLocatorInterface$handlersLocator,
3741
privatebool$allowNoHandlers =false,
42+
private ?EventDispatcherInterface$eventDispatcher =null,
3843
) {
3944
}
4045

@@ -58,6 +63,10 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
5863
continue;
5964
}
6065

66+
$this->eventDispatcher?->dispatch(newHandlerStartingEvent($envelope,$handlerDescriptor));
67+
68+
$e =null;
69+
6170
try {
6271
$handler =$handlerDescriptor->getHandler();
6372
$batchHandler =$handlerDescriptor->getBatchHandler();
@@ -97,6 +106,14 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
97106
}catch (\Throwable$e) {
98107
$exceptions[$handlerDescriptor->getName()] =$e;
99108
}
109+
110+
if (null !==$this->eventDispatcher) {
111+
$event = (null !==$e)
112+
?newHandlerFailureEvent($envelope,$handlerDescriptor,$e)
113+
:newHandlerSuccessEvent($envelope,$handlerDescriptor);
114+
115+
$this->eventDispatcher->dispatch($event);
116+
}
100117
}
101118

102119
/** @var FlushBatchHandlersStamp $flushStamp */

‎src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111

1212
namespaceSymfony\Component\Messenger\Tests\Middleware;
1313

14+
usePsr\EventDispatcher\EventDispatcherInterface;
1415
useSymfony\Component\Messenger\Envelope;
16+
useSymfony\Component\Messenger\Event\HandlerFailureEvent;
17+
useSymfony\Component\Messenger\Event\HandlerStartingEvent;
18+
useSymfony\Component\Messenger\Event\HandlerSuccessEvent;
1519
useSymfony\Component\Messenger\Exception\HandlerFailedException;
1620
useSymfony\Component\Messenger\Exception\LogicException;
1721
useSymfony\Component\Messenger\Exception\NoHandlerForMessageException;
@@ -356,6 +360,45 @@ public function testHandlerArgumentsStampNamedArgument()
356360

357361
$middleware->handle($envelope,$this->getStackMock());
358362
}
363+
364+
publicfunctiontestDispatchHandlerEvents()
365+
{
366+
$message =newDummyMessage('Hey');
367+
$envelope =newEnvelope($message);
368+
369+
$successHandler =$this->createMock(HandleMessageMiddlewareTestCallable::class);
370+
$successHandler->expects($this->once())->method('__invoke');
371+
372+
$failureHandler =$this->createMock(HandleMessageMiddlewareTestCallable::class);
373+
$failureHandler->expects($this->once())->method('__invoke')->willThrowException(
374+
$exception =new \RuntimeException('Handler failed'),
375+
);
376+
377+
$handlersLocator =newHandlersLocator([
378+
DummyMessage::class => [
379+
$successHandlerDescriptor =newHandlerDescriptor($successHandler, ['alias' =>'successHandler']),
380+
$failureHandlerDescriptor =newHandlerDescriptor($failureHandler, ['alias' =>'failureHandler']),
381+
],
382+
]);
383+
384+
$dispatcher =$this->createMock(EventDispatcherInterface::class);
385+
386+
$handledStamp =newHandledStamp(null,$successHandlerDescriptor->getName());
387+
388+
$dispatcher->expects($this->exactly(4))
389+
->method('dispatch')
390+
->withConsecutive(
391+
[newHandlerStartingEvent($envelope,$successHandlerDescriptor)],
392+
[newHandlerSuccessEvent($envelope->with($handledStamp),$successHandlerDescriptor)],
393+
[newHandlerStartingEvent($envelope->with($handledStamp),$failureHandlerDescriptor)],
394+
[newHandlerFailureEvent($envelope->with($handledStamp),$failureHandlerDescriptor,$exception)],
395+
);
396+
397+
$middleware =newHandleMessageMiddleware($handlersLocator, eventDispatcher:$dispatcher);
398+
399+
$this->expectException(HandlerFailedException::class);
400+
$middleware->handle($envelope,newStackMiddleware());
401+
}
359402
}
360403

361404
class HandleMessageMiddlewareTestCallable

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp