[Messenger] Compile-time errors fixes and tweaks #26672
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| <?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\Messenger\Tests\DependencyInjection; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\DependencyInjection\Reference; | ||
| use Symfony\Component\DependencyInjection\ServiceLocator; | ||
| use Symfony\Component\Messenger\ContainerHandlerLocator; | ||
| use Symfony\Component\Messenger\DependencyInjection\MessengerPass; | ||
| use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage; | ||
| use Symfony\Component\Messenger\Transport\ReceiverInterface; | ||
|
|
||
| class MessengerPassTest extends TestCase | ||
| { | ||
| public function testProcess() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(DummyHandler::class, DummyHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
| $container | ||
| ->register(DummyReceiver::class, DummyReceiver::class) | ||
| ->addTag('messenger.receiver') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
|
|
||
| $handlerLocatorDefinition = $container->getDefinition($container->getDefinition('messenger.handler_resolver')->getArgument(0)); | ||
| $this->assertSame(ServiceLocator::class, $handlerLocatorDefinition->getClass()); | ||
| $this->assertEquals( | ||
| array('handler.'.DummyMessage::class => new ServiceClosureArgument(new Reference(DummyHandler::class))), | ||
| $handlerLocatorDefinition->getArgument(0) | ||
| ); | ||
|
|
||
| $this->assertEquals( | ||
| array(DummyReceiver::class => new Reference(DummyReceiver::class)), | ||
| $container->getDefinition('messenger.receiver_locator')->getArgument(0) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
|
There was a problem hiding this comment. Not sure what's our stance on this, but phpunit advices to use method calls instead of annotations. There was a problem hiding this comment. for now we use annotations everywhere, perhaps it should be rediscussed on 2.7 |
||
| * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\UndefinedMessageHandler": message class "Symfony\Component\Messenger\Tests\DependencyInjection\UndefinedMessage" used as argument type in method "Symfony\Component\Messenger\Tests\DependencyInjection\UndefinedMessageHandler::__invoke()" does not exist. | ||
| */ | ||
| public function testUndefinedMessageClassForHandler() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(UndefinedMessageHandler::class, UndefinedMessageHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
| * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\NotInvokableHandler": class "Symfony\Component\Messenger\Tests\DependencyInjection\NotInvokableHandler" must have an "__invoke()" method. | ||
| */ | ||
| public function testNotInvokableHandler() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(NotInvokableHandler::class, NotInvokableHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
| * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler": method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentHandler::__invoke()" must have exactly one argument corresponding to the message it handles. | ||
| */ | ||
| public function testMissingArgumentHandler() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(MissingArgumentHandler::class, MissingArgumentHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
| * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentTypeHandler": argument "$message" of method "Symfony\Component\Messenger\Tests\DependencyInjection\MissingArgumentTypeHandler::__invoke()" must have a type-hint corresponding to the message class it handles. | ||
| */ | ||
| public function testMissingArgumentTypeHandler() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(MissingArgumentTypeHandler::class, MissingArgumentTypeHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
| * @expectedExceptionMessage Invalid handler service "Symfony\Component\Messenger\Tests\DependencyInjection\BuiltinArgumentTypeHandler": type-hint of argument "$message" in method "Symfony\Component\Messenger\Tests\DependencyInjection\BuiltinArgumentTypeHandler::__invoke()" must be a class , "string" given. | ||
| */ | ||
| public function testBuiltinArgumentTypeHandler() | ||
| { | ||
| $container = $this->getContainerBuilder(); | ||
| $container | ||
| ->register(BuiltinArgumentTypeHandler::class, BuiltinArgumentTypeHandler::class) | ||
| ->addTag('messenger.message_handler') | ||
| ; | ||
|
|
||
| (new MessengerPass())->process($container); | ||
| } | ||
|
|
||
| private function getContainerBuilder(): ContainerBuilder | ||
| { | ||
| $container = new ContainerBuilder(); | ||
| $container->setParameter('kernel.debug', true); | ||
| $container->register('message_bus', ContainerHandlerLocator::class); | ||
|
|
||
| $container | ||
| ->register('messenger.handler_resolver', ContainerHandlerLocator::class) | ||
| ->addArgument(new Reference('service_container')) | ||
| ; | ||
|
|
||
| $container->register('messenger.receiver_locator', ServiceLocator::class) | ||
| ->addArgument(new Reference('service_container')) | ||
| ; | ||
|
|
||
| return $container; | ||
| } | ||
| } | ||
|
|
||
| class DummyHandler | ||
| { | ||
| public function __invoke(DummyMessage $message): void | ||
| { | ||
| } | ||
| } | ||
|
|
||
| class DummyReceiver implements ReceiverInterface | ||
| { | ||
| public function receive(): iterable | ||
| { | ||
| for ($i = 0; $i < 3; ++$i) { | ||
| yield new DummyMessage("Dummy $i"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class UndefinedMessageHandler | ||
| { | ||
| public function __invoke(UndefinedMessage $message) | ||
| { | ||
| } | ||
| } | ||
|
|
||
| class NotInvokableHandler | ||
| { | ||
| } | ||
|
|
||
| class MissingArgumentHandler | ||
| { | ||
| public function __invoke() | ||
| { | ||
| } | ||
| } | ||
|
|
||
| class MissingArgumentTypeHandler | ||
| { | ||
| public function __invoke($message) | ||
| { | ||
| } | ||
| } | ||
|
|
||
| class BuiltinArgumentTypeHandler | ||
| { | ||
| public function __invoke(string $message) | ||
| { | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bad argument ordering in
sprintf