From 3bdf4b0e0fa2d3379cb9f9e8ef446f8fccf5860e Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Tue, 23 Apr 2019 13:15:09 +0200 Subject: [PATCH] [Messenger] ease testing and allow forking the middleware stack --- .../Messenger/Middleware/StackInterface.php | 2 + .../Messenger/Middleware/StackMiddleware.php | 65 +++++++++++++++---- .../Test/Middleware/MiddlewareTestCase.php | 31 ++++----- .../Tests/Middleware/StackMiddlewareTest.php | 51 +++++++++++++++ 4 files changed, 121 insertions(+), 28 deletions(-) create mode 100644 src/Symfony/Component/Messenger/Tests/Middleware/StackMiddlewareTest.php diff --git a/src/Symfony/Component/Messenger/Middleware/StackInterface.php b/src/Symfony/Component/Messenger/Middleware/StackInterface.php index 1ee38ea6ea6b9..17f0acf4aba51 100644 --- a/src/Symfony/Component/Messenger/Middleware/StackInterface.php +++ b/src/Symfony/Component/Messenger/Middleware/StackInterface.php @@ -14,6 +14,8 @@ /** * @author Nicolas Grekas * + * Implementations must be cloneable, and each clone must unstack the stack independently. + * * @experimental in 4.2 */ interface StackInterface diff --git a/src/Symfony/Component/Messenger/Middleware/StackMiddleware.php b/src/Symfony/Component/Messenger/Middleware/StackMiddleware.php index 24516cd88111d..4c1c597cf70aa 100644 --- a/src/Symfony/Component/Messenger/Middleware/StackMiddleware.php +++ b/src/Symfony/Component/Messenger/Middleware/StackMiddleware.php @@ -20,27 +20,42 @@ */ class StackMiddleware implements MiddlewareInterface, StackInterface { - private $middlewareIterator; + private $stack; + private $offset = 0; - public function __construct(\Iterator $middlewareIterator = null) + /** + * @param iterable|MiddlewareInterface[]|MiddlewareInterface|null $middlewareIterator + */ + public function __construct($middlewareIterator = null) { - $this->middlewareIterator = $middlewareIterator; + $this->stack = new MiddlewareStack(); + + if (null === $middlewareIterator) { + return; + } + + if ($middlewareIterator instanceof \Iterator) { + $this->stack->iterator = $middlewareIterator; + } elseif ($middlewareIterator instanceof MiddlewareInterface) { + $this->stack->stack[] = $middlewareIterator; + } elseif (!\is_iterable($middlewareIterator)) { + throw new \TypeError(sprintf('Argument 1 passed to %s() must be iterable of %s, %s given.', __METHOD__, MiddlewareInterface::class, \is_object($middlewareIterator) ? \get_class($middlewareIterator) : \gettype($middlewareIterator))); + } else { + $this->stack->iterator = (function () use ($middlewareIterator) { + yield from $middlewareIterator; + })(); + } } public function next(): MiddlewareInterface { - if (null === $iterator = $this->middlewareIterator) { + if (null === $next = $this->stack->next($this->offset)) { return $this; } - $iterator->next(); - if (!$iterator->valid()) { - $this->middlewareIterator = null; + ++$this->offset; - return $this; - } - - return $iterator->current(); + return $next; } public function handle(Envelope $envelope, StackInterface $stack): Envelope @@ -48,3 +63,31 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope return $envelope; } } + +/** + * @internal + */ +class MiddlewareStack +{ + public $iterator; + public $stack = []; + + public function next(int $offset): ?MiddlewareInterface + { + if (isset($this->stack[$offset])) { + return $this->stack[$offset]; + } + + if (null === $this->iterator) { + return null; + } + + $this->iterator->next(); + + if (!$this->iterator->valid()) { + return $this->iterator = null; + } + + return $this->stack[] = $this->iterator->current(); + } +} diff --git a/src/Symfony/Component/Messenger/Test/Middleware/MiddlewareTestCase.php b/src/Symfony/Component/Messenger/Test/Middleware/MiddlewareTestCase.php index 35bdc727551de..5970cf285fc44 100644 --- a/src/Symfony/Component/Messenger/Test/Middleware/MiddlewareTestCase.php +++ b/src/Symfony/Component/Messenger/Test/Middleware/MiddlewareTestCase.php @@ -15,6 +15,7 @@ use Symfony\Component\Messenger\Envelope; use Symfony\Component\Messenger\Middleware\MiddlewareInterface; use Symfony\Component\Messenger\Middleware\StackInterface; +use Symfony\Component\Messenger\Middleware\StackMiddleware; /** * @author Nicolas Grekas @@ -25,23 +26,26 @@ abstract class MiddlewareTestCase extends TestCase { protected function getStackMock(bool $nextIsCalled = true) { + if (!$nextIsCalled) { + $stack = $this->createMock(StackInterface::class); + $stack + ->expects($this->never()) + ->method('next') + ; + + return $stack; + } + $nextMiddleware = $this->getMockBuilder(MiddlewareInterface::class)->getMock(); $nextMiddleware - ->expects($nextIsCalled ? $this->once() : $this->never()) + ->expects($this->once()) ->method('handle') ->willReturnCallback(function (Envelope $envelope, StackInterface $stack): Envelope { return $envelope; }) ; - $stack = $this->createMock(StackInterface::class); - $stack - ->expects($nextIsCalled ? $this->once() : $this->never()) - ->method('next') - ->willReturn($nextMiddleware) - ; - - return $stack; + return new StackMiddleware($nextMiddleware); } protected function getThrowingStackMock(\Throwable $throwable = null) @@ -53,13 +57,6 @@ protected function getThrowingStackMock(\Throwable $throwable = null) ->willThrowException($throwable ?? new \RuntimeException('Thrown from next middleware.')) ; - $stack = $this->createMock(StackInterface::class); - $stack - ->expects($this->once()) - ->method('next') - ->willReturn($nextMiddleware) - ; - - return $stack; + return new StackMiddleware($nextMiddleware); } } diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/StackMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/StackMiddlewareTest.php new file mode 100644 index 0000000000000..de75271960472 --- /dev/null +++ b/src/Symfony/Component/Messenger/Tests/Middleware/StackMiddlewareTest.php @@ -0,0 +1,51 @@ + + * + * 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\Envelope; +use Symfony\Component\Messenger\MessageBus; +use Symfony\Component\Messenger\Middleware\MiddlewareInterface; +use Symfony\Component\Messenger\Middleware\StackInterface; + +class StackMiddlewareTest extends TestCase +{ + public function testClone() + { + $middleware1 = $this->getMockBuilder(MiddlewareInterface::class)->getMock(); + $middleware1 + ->expects($this->once()) + ->method('handle') + ->willReturnCallback(function (Envelope $envelope, StackInterface $stack): Envelope { + $fork = clone $stack; + + $stack->next()->handle($envelope, $stack); + $fork->next()->handle($envelope, $fork); + + return $envelope; + }) + ; + + $middleware2 = $this->getMockBuilder(MiddlewareInterface::class)->getMock(); + $middleware2 + ->expects($this->exactly(2)) + ->method('handle') + ->willReturnCallback(function (Envelope $envelope, StackInterface $stack): Envelope { + return $envelope; + }) + ; + + $bus = new MessageBus([$middleware1, $middleware2]); + + $bus->dispatch(new \stdClass()); + } +} pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy