Skip to content

[5.0] Dispatch commands through a pipeline #7189

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.

Sign up for GitHub

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
jwalton512 wants to merge 3 commits into from
Closed

[5.0] Dispatch commands through a pipeline #7189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6df52c3
Dispatch commands through a pipeline
jwalton512 Jan 29, 2015
04c8202
style fixes
jwalton512 Jan 29, 2015
80eb411
more style fixes
jwalton512 Jan 29, 2015
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
68 changes: 61 additions & 7 deletions src/Illuminate/Bus/Dispatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
use ArrayAccess;
use ReflectionClass;
use ReflectionParameter;
use Illuminate\Pipeline\Pipeline;
use Illuminate\Support\Collection;
use Illuminate\Contracts\Queue\Queue;
use Illuminate\Contracts\Bus\SelfHandling;
Expand All @@ -12,6 +13,7 @@
use Illuminate\Contracts\Queue\ShouldBeQueued;
use Illuminate\Contracts\Bus\QueueingDispatcher;
use Illuminate\Contracts\Bus\Dispatcher as DispatcherContract;
use Illuminate\Contracts\Pipeline\Pipeline as PipelineContract;

class Dispatcher implements DispatcherContract, QueueingDispatcher, HandlerResolver {

Expand Down Expand Up @@ -43,16 +45,32 @@ class Dispatcher implements DispatcherContract, QueueingDispatcher, HandlerResol
*/
protected $mapper;

/**
* The pipeline implementation.
*
* @var Pipeline
*/
protected $pipeline;

/**
* The pipes which the pipeline will send commands through.
*
* @var array
*/
protected $pipes = [];

/**
* Create a new command dispatcher instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @param \Illuminate\Contracts\Pipeline\Pipeline $pipeline
* @param \Closure|null $queueResolver
* @return void
*/
public function __construct(Container $container, Closure $queueResolver = null)
public function __construct(Container $container, PipelineContract $pipeline, Closure $queueResolver = null)
{
$this->container = $container;
$this->pipeline = $pipeline;
$this->queueResolver = $queueResolver;
}

Expand Down Expand Up @@ -160,6 +178,7 @@ public function dispatch($command, Closure $afterResolving = null)
{
if ($this->queueResolver && $this->commandShouldBeQueued($command))
{
$this->dispatchThroughPipeline($command);
return $this->dispatchToQueue($command);
}
else
Expand All @@ -178,16 +197,24 @@ public function dispatch($command, Closure $afterResolving = null)
public function dispatchNow($command, Closure $afterResolving = null)
{
if ($command instanceof SelfHandling)
return $this->container->call([$command, 'handle']);

$handler = $this->resolveHandler($command);
{
$handler = $command;
}
else
{
$handler = $this->resolveHandler($command);
}

if ($afterResolving)
call_user_func($afterResolving, $handler);

return call_user_func(
[$handler, $this->getHandlerMethod($command)], $command
);
$handle = function ($command) use ($handler) {
return call_user_func(
[$handler, $this->getHandlerMethod($command)], $command
);
};

return $this->dispatchThroughPipeline($command, $handle);
}

/**
Expand Down Expand Up @@ -355,4 +382,31 @@ public static function simpleMapping($command, $commandNamespace, $handlerNamesp
return $handlerNamespace.'\\'.trim($command, '\\').'Handler@handle';
}

/**
* Set the pipes which the pipeline will use when dispatching commands.
*
* @param array $pipes
* @return void
*/
public function setPipes(array $pipes)
{
$this->pipes = $pipes;
}

/**
* Dispatch the command through the pipeline
*
* @param mixed $command
* @param Closure|null $after
* @return mixed
*/
protected function dispatchThroughPipeline($command, \Closure $after = null)
{
$result = $this->pipeline->send($command)
->through($this->pipes)
->via('dispatch');

return $after ? $result->then($after) : $result;
}

}
53 changes: 45 additions & 8 deletions tests/Bus/BusDispatcherTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?php

use Illuminate\Pipeline\Pipeline;
use Mockery as m;
use Illuminate\Bus\Dispatcher;
use Illuminate\Container\Container;
Expand All @@ -15,10 +16,11 @@ public function tearDown()
public function testBasicDispatchingOfCommandsToHandlers()
{
$container = new Container;
$pipeline = new Pipeline($container);
$handler = m::mock('StdClass');
$handler->shouldReceive('handle')->once()->andReturn('foo');
$container->instance('Handler', $handler);
$dispatcher = new Dispatcher($container);
$dispatcher = new Dispatcher($container, $pipeline);
$dispatcher->mapUsing(function() { return 'Handler@handle'; });

$result = $dispatcher->dispatch(new BusDispatcherTestBasicCommand);
Expand All @@ -29,7 +31,8 @@ public function testBasicDispatchingOfCommandsToHandlers()
public function testCommandsThatShouldBeQueuedAreQueued()
{
$container = new Container;
$dispatcher = new Dispatcher($container, function() {
$pipeline = new Pipeline($container);
$dispatcher = new Dispatcher($container, $pipeline, function() {
$mock = m::mock('Illuminate\Contracts\Queue\Queue');
$mock->shouldReceive('push')->once();
return $mock;
Expand All @@ -42,7 +45,8 @@ public function testCommandsThatShouldBeQueuedAreQueued()
public function testCommandsThatShouldBeQueuedAreQueuedUsingCustomHandler()
{
$container = new Container;
$dispatcher = new Dispatcher($container, function() {
$pipeline = new Pipeline($container);
$dispatcher = new Dispatcher($container, $pipeline, function() {
$mock = m::mock('Illuminate\Contracts\Queue\Queue');
$mock->shouldReceive('push')->once();
return $mock;
Expand All @@ -55,7 +59,8 @@ public function testCommandsThatShouldBeQueuedAreQueuedUsingCustomHandler()
public function testHandlersThatShouldBeQueuedAreQueued()
{
$container = new Container;
$dispatcher = new Dispatcher($container, function() {
$pipeline = new Pipeline($container);
$dispatcher = new Dispatcher($container, $pipeline, function() {
$mock = m::mock('Illuminate\Contracts\Queue\Queue');
$mock->shouldReceive('push')->once();
return $mock;
Expand All @@ -69,10 +74,11 @@ public function testHandlersThatShouldBeQueuedAreQueued()
public function testDispatchNowShouldNeverQueue()
{
$container = new Container;
$pipeline = new Pipeline($container);
$handler = m::mock('StdClass');
$handler->shouldReceive('handle')->once()->andReturn('foo');
$container->instance('Handler', $handler);
$dispatcher = new Dispatcher($container);
$dispatcher = new Dispatcher($container, $pipeline);
$dispatcher->mapUsing(function() { return 'Handler@handle'; });

$result = $dispatcher->dispatch(m::mock('Illuminate\Contracts\Queue\ShouldBeQueued'));
Expand All @@ -83,10 +89,11 @@ public function testDispatchNowShouldNeverQueue()
public function testDispatchShouldCallAfterResolvingIfCommandNotQueued()
{
$container = new Container;
$pipeline = new Pipeline($container);
$handler = m::mock('StdClass')->shouldIgnoreMissing();
$handler->shouldReceive('after')->once();
$container->instance('Handler', $handler);
$dispatcher = new Dispatcher($container);
$dispatcher = new Dispatcher($container, $pipeline);
$dispatcher->mapUsing(function() { return 'Handler@handle'; });

$dispatcher->dispatch(new BusDispatcherTestBasicCommand, function($handler) { $handler->after(); });
Expand All @@ -95,18 +102,42 @@ public function testDispatchShouldCallAfterResolvingIfCommandNotQueued()

public function testDispatchingFromArray()
{
$instance = new Dispatcher(new Container);
$container = new Container();
$pipeline = new Pipeline($container);
$instance = new Dispatcher($container, $pipeline);
$result = $instance->dispatchFromArray('BusDispatcherTestSelfHandlingCommand', ['firstName' => 'taylor', 'lastName' => 'otwell']);
$this->assertEquals('taylor otwell', $result);
}


public function testMarshallArguments()
{
$instance = new Dispatcher(new Container);
$container = new Container();
$pipeline = new Pipeline($container);
$instance = new Dispatcher($container, $pipeline);
$result = $instance->dispatchFromArray('BusDispatcherTestArgumentMapping', ['flag' => false, 'emptyString' => '']);
$this->assertTrue($result);
}


public function testDispatchingSentThroughPipes()
{
$container = new Container();
$pipeline = new Pipeline($container);

$pipeDispatcher = m::mock('BusDispatcherPipelineDispatcher');
$pipeDispatcher->shouldReceive('dispatch')->once();
$container->instance('BusDispatcherPipelineDispatcher', $pipeDispatcher);

$handler = m::mock('StdClass')->shouldIgnoreMissing();
$container->instance('Handler', $handler);

$dispatcher = new Dispatcher($container, $pipeline);
$dispatcher->mapUsing(function() { return 'Handler@handle'; });
$dispatcher->setPipes(['BusDispatcherPipelineDispatcher']);
$dispatcher->dispatch(new BusDispatcherTestBasicCommand);
}

}

class BusDispatcherTestBasicCommand {
Expand Down Expand Up @@ -157,3 +188,9 @@ public function queue($queue, $command)
$queue->push($command);
}
}


class BusDispatcherPipelineDispatcher {
public function dispatch($command) {}
}