Skip to content

[Messenger] Proposal: Alternative for the Stack #31185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 7 additions & 32 deletions src/Symfony/Component/Messenger/MessageBus.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\Messenger;

use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\StackMiddleware;
use Symfony\Component\Messenger\Middleware\Pipeline;

/**
* @author Samuel Roze <samuel.roze@gmail.com>
Expand All @@ -23,30 +23,14 @@
*/
class MessageBus implements MessageBusInterface
{
private $middlewareAggregate;
private $middlewares;

/**
* @param MiddlewareInterface[]|iterable $middlewareHandlers
*/
public function __construct(iterable $middlewareHandlers = [])
public function __construct(array $middlewares = [])
{
if ($middlewareHandlers instanceof \IteratorAggregate) {
$this->middlewareAggregate = $middlewareHandlers;
} elseif (\is_array($middlewareHandlers)) {
$this->middlewareAggregate = new \ArrayObject($middlewareHandlers);
} else {
$this->middlewareAggregate = new class() {
public $aggregate;
public $iterator;

public function getIterator()
{
return $this->aggregate = new \ArrayObject(iterator_to_array($this->iterator, false));
}
};
$this->middlewareAggregate->aggregate = &$this->middlewareAggregate;
$this->middlewareAggregate->iterator = $middlewareHandlers;
}
$this->middlewares = $middlewares;
}

/**
Expand All @@ -57,19 +41,10 @@ public function dispatch($message, array $stamps = []): Envelope
if (!\is_object($message)) {
throw new \TypeError(sprintf('Invalid argument provided to "%s()": expected object, but got %s.', __METHOD__, \gettype($message)));
}
$envelope = Envelope::wrap($message, $stamps);
$middlewareIterator = $this->middlewareAggregate->getIterator();

while ($middlewareIterator instanceof \IteratorAggregate) {
$middlewareIterator = $middlewareIterator->getIterator();
}
$middlewareIterator->rewind();

if (!$middlewareIterator->valid()) {
return $envelope;
}
$stack = new StackMiddleware($middlewareIterator);
$envelope = Envelope::wrap($message, $stamps);
$pipeline = new Pipeline($this->middlewares);

return $middlewareIterator->current()->handle($envelope, $stack);
return $pipeline->handle($envelope);
}
}
38 changes: 38 additions & 0 deletions src/Symfony/Component/Messenger/Middleware/Carrier.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

declare(strict_types=1);

namespace Symfony\Component\Messenger\Middleware;


use Symfony\Component\Messenger\Envelope;

class Carrier implements NextHandlerInterface
{
/**
* @var MiddlewareInterface
*/
private $currentMiddleware;

/**
* @var NextHandlerInterface
*/
private $nextHandler;

/**
* @param MiddlewareInterface $currentMiddleware
* @param NextHandlerInterface $nextHandler
*
*/
public function __construct(MiddlewareInterface $currentMiddleware, NextHandlerInterface $nextHandler)
{
$this->currentMiddleware = $currentMiddleware;
$this->nextHandler = $nextHandler;
}


public function handle(Envelope $envelope) : Envelope
{
return $this->currentMiddleware->handle($envelope, $this->nextHandler);
Copy link
Member

@nicolas-grekas nicolas-grekas Apr 19, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is what the current code avoids: this method now becomes a mandatory indirection point between all middleware frames.

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
*/
interface MiddlewareInterface
{
public function handle(Envelope $envelope, StackInterface $stack): Envelope;
public function handle(Envelope $envelope, NextHandlerInterface $next): Envelope;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

namespace Symfony\Component\Messenger\Middleware;


use Symfony\Component\Messenger\Envelope;

interface NextHandlerInterface
{
public function handle(Envelope $envelope) : Envelope;
}
30 changes: 30 additions & 0 deletions src/Symfony/Component/Messenger/Middleware/Pipeline.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

namespace Symfony\Component\Messenger\Middleware;


use function array_reverse;
use Symfony\Component\Messenger\Envelope;

class Pipeline
{
/**
* @var NextHandlerInterface
*/
private $handler;

public function __construct(array $middlewares)
{
$this->handler = new Recipient();
foreach (array_reverse($middlewares) as $middleware) {
$this->handler = new Carrier($middleware, $this->handler);
}
}

public function handle(Envelope $envelope) : Envelope
{
return $this->handler->handle($envelope);
}
}
17 changes: 17 additions & 0 deletions src/Symfony/Component/Messenger/Middleware/Recipient.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

declare(strict_types=1);

namespace Symfony\Component\Messenger\Middleware;


use Symfony\Component\Messenger\Envelope;

class Recipient implements NextHandlerInterface
{

public function handle(Envelope $envelope) : Envelope
{
return $envelope;
}
}
25 changes: 0 additions & 25 deletions src/Symfony/Component/Messenger/Middleware/StackInterface.php

This file was deleted.

50 changes: 0 additions & 50 deletions src/Symfony/Component/Messenger/Middleware/StackMiddleware.php

This file was deleted.