keystone/tactician-deferred

A Tactician middleware to allow commands to be handled asynchronously

0.1.0 2016-12-30 23:15 UTC

Requires

• php: >=5.6
• league/tactician: ^1.0
• radish/radish: ^0.2

Requires (Dev)

• keystone/mockery-callable-mock: ^1.0
• mockery/mockery: ^0.9
• phpunit/phpunit: ^5.7

MIT

README

A Tactician middleware to allow commands to be handled asynchronously using Keystone Queue.

Features:

• Unobtrusive API to allow asynchronous handling of commands.
• Publish command messages to any queue.
• Commands can be retried on failure.

Installation

Install via Composer

composer require --dev keystone/tactician-deferred

Usage

Create a command class that implemented DeferrableCommand to tell the middleware to handle it asynchronously.

use Keystone\Tactician\Deferred\Command\DeferrableCommand;

class SendWelcomeCommand implements DeferrableCommand
{
    public $email;
    public $name;

    public function __construct(string $email, string $name)
    {
        $this->email = $email;
        $this->name = $name;
    }

    public function getKey(): string
    {
        // The command key is used to determine which queue to publish to.
        return 'email';
    }
}

Create a command handler as normal using your desired inflector method.

class SendWelcomeHandler
{
    public function handle(SendWelcomeCommand $command)
    {
        // Send the welcome
    }
}

When the command is handled by the command bus the middleware will publish a message to the queue and halt the handler. The message will then be received by the consumer and the worker will delegate the command to the command bus. Since the command will be serialized within the queue it's properties should be simple scalar values.

$commandBus = new CommandBus([new DeferredMiddleware(...), new CommandHandlerMiddleware(...)]);
$commandBus->handle(new SendWelcomeCommand('[e-mail]', 'Ben'));

Consume the messages in a long running process (see Keystone Queue for more information).

use Keystone\Queue\Consumer;
use Keystone\Queue\Provider;

$provider = new Provider(...);
$consumer = new Consumer($provider, ...);
// The consumer will poll the queue for new messages and process them.
$consumer->consume();

When the middleware is not configured the command will be handled synchronously as normal, which can be useful for testing without worrying about asynchronous processes in development environments.

Credits

• Tom Graham (maintainer)

License

Released under the MIT Licence. See the bundled LICENSE file for details.