[Messenger] Add middleware allowing just for a single handler

pamil · pamil · commit 7088a74ac682 · 2018-10-03T21:44:23.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml
@@ -29,6 +29,9 @@
         <service id="messenger.middleware.call_message_handler" class="Symfony\Component\Messenger\Middleware\HandleMessageMiddleware" abstract="true">
             <argument /> <!-- Bus handler resolver -->
         </service>
+        <service id="messenger.middleware.allow_single_handler" class="Symfony\Component\Messenger\Middleware\AllowSingleHandlerMiddleware" abstract="true">
+            <argument /> <!-- Bus handler resolver -->
+        </service>
 
         <service id="messenger.middleware.validation" class="Symfony\Component\Messenger\Middleware\ValidationMiddleware" abstract="true">
             <argument type="service" id="validator" />
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -19,7 +19,8 @@ CHANGELOG
  * [BC BREAK] The `EncoderInterface` and `DecoderInterface` have been replaced by a unified `Symfony\Component\Messenger\Transport\Serialization\SerializerInterface`.
  * [BC BREAK] The locator passed to `ContainerHandlerLocator` should not prefix its keys by "handler." anymore
  * [BC BREAK] The `AbstractHandlerLocator::getHandler()` method uses `?callable` as return type
-
+ * Added `AllowSingleHandlerMiddleware` for message buses which behave like command buses.
+ 
 4.1.0
 -----
 
diff --git a/src/Symfony/Component/Messenger/Exception/MoreThanOneHandlerForMessageException.php b/src/Symfony/Component/Messenger/Exception/MoreThanOneHandlerForMessageException.php
@@ -0,0 +1,19 @@
+<?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\Exception;
+
+/**
+ * @author Kamil Kokot <kamil@kokot.me>
+ */
+class MoreThanOneHandlerForMessageException extends \LogicException implements ExceptionInterface
+{
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/AllowSingleHandlerMiddleware.php b/src/Symfony/Component/Messenger/Middleware/AllowSingleHandlerMiddleware.php
@@ -0,0 +1,43 @@
+<?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\Middleware;
+
+use Symfony\Component\Messenger\Exception\MoreThanOneHandlerForMessageException;
+use Symfony\Component\Messenger\Handler\ChainHandler;
+use Symfony\Component\Messenger\Handler\Locator\HandlerLocatorInterface;
+
+/**
+ * @author Kamil Kokot <kamil@kokot.me>
+ */
+class AllowSingleHandlerMiddleware implements MiddlewareInterface
+{
+    private $messageHandlerResolver;
+
+    public function __construct(HandlerLocatorInterface $messageHandlerResolver)
+    {
+        $this->messageHandlerResolver = $messageHandlerResolver;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle($message, callable $next)
+    {
+        $handler = $this->messageHandlerResolver->resolve($message);
+
+        if ($handler instanceof ChainHandler) {
+            throw new MoreThanOneHandlerForMessageException(sprintf('More than one handler for message "%s".', \get_class($message)));
+        }
+
+        return $next($message);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/AllowSingleHandlerMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/AllowSingleHandlerMiddlewareTest.php
@@ -0,0 +1,53 @@
+<?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\Middleware;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Handler\ChainHandler;
+use Symfony\Component\Messenger\Handler\Locator\HandlerLocator;
+use Symfony\Component\Messenger\Middleware\AllowSingleHandlerMiddleware;
+use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
+
+class AllowSingleHandlerMiddlewareTest extends TestCase
+{
+    public function testItCallsNextMiddlewareAndReturnsItsResult(): void
+    {
+        $message = new DummyMessage('Hey');
+
+        $handler = $this->createPartialMock(\stdClass::class, array('__invoke'));
+        $handler->method('__invoke')->willReturn('Hello');
+
+        $next = $this->createPartialMock(\stdClass::class, array('__invoke'));
+        $next->expects($this->once())->method('__invoke')->with($message)->willReturn('Foo');
+
+        $middleware = new AllowSingleHandlerMiddleware(new HandlerLocator(array(
+            DummyMessage::class => $handler,
+        )));
+
+        $this->assertSame('Foo', $middleware->handle($message, $next));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Messenger\Exception\MoreThanOneHandlerForMessageException
+     * @expectedExceptionMessage More than one handler for message "Symfony\Component\Messenger\Tests\Fixtures\DummyMessage".
+     */
+    public function testItThrowsAnExceptionIfHandlerIsChainHandler(): void
+    {
+        $next = $this->createPartialMock(\stdClass::class, array('__invoke'));
+
+        $middleware = new AllowSingleHandlerMiddleware(new HandlerLocator([
+            DummyMessage::class => new ChainHandler(array(new \stdClass(), new \stdClass())),
+        ]));
+
+        $middleware->handle(new DummyMessage('Hey'), $next);
+    }
+}
