2 Commits

Author SHA1 Message Date
9ab9561270 Refactor names in CommandResolverInterface 2024-12-28 15:35:41 +01:00
07f8ae467c Make CommandBus use CommandResolverInterface
* Add CommandResolverInterface to resolve commands.
* Replace single CommandRegistry with CommandResolverInterface[]
  in CommandBus.
* Make CommandRegistry implement CommandResolverInterface.
2024-12-15 13:24:57 +01:00
6 changed files with 159 additions and 15 deletions

View File

@ -13,30 +13,97 @@ class CommandBus implements CommandBusInterface
{
use EventEmitterTrait;
private CommandRegistry $commandRegistry;
/** @var array<CommandResolverInterface> */
private $resolvers = [];
private SplObjectStorage $connections;
private SplObjectStorage $servers;
public function __construct(CommandRegistry $commandRegistry)
public function __construct(?CommandResolverInterface $commands=null)
{
$this->commandRegistry = $commandRegistry;
if ($commands) {
$this->resolvers[] = $commands;
}
$this->connections = new SplObjectStorage();
$this->servers = new SplObjectStorage();
}
public function getRegistry(): CommandRegistry
/**
* Get the command registry
*
* @deprecated Use getCommandNames() instead
* @return null
*/
public function getRegistry(): ?CommandRegistry
{
return $this->commandRegistry;
return null; // $this->commandRegistry;
}
/**
* Add a CommandResolver
*
* @param CommandResolverInterface $resolver
* @return void
*/
public function addResolver(CommandResolverInterface $resolver): void
{
$this->resolvers[] = $resolver;
}
public function removeResolver(CommandResolverInterface $resolver): void
{
// FIXME implement
}
/**
* Get the names of defined commands
*
* @return array
*/
public function getCommandNames(): array
{
$commands = [];
foreach ($this->resolvers as $resolver) {
$commands = array_merge($commands, $resolver->getCommandNames());
}
sort($commands);
return array_unique($commands);
}
/**
* Find a command by searching through the resolvers
*
* @param string $command
* @return Command|null
*/
public function findCommand(string $command): ?Command
{
foreach ($this->resolvers as $resolver) {
if ($found = $resolver->findCommand($command))
return $found;
}
return null;
}
/**
* Add a server listener
*
* @param ServerInterface $server
* @return void
*/
public function addServer(ServerInterface $server): void
{
$this->servers->attach($server);
$server->on('connection', $this->onServerConnection(...));
}
/**
* Remove a server listener
*
* @param ServerInterface $server
* @return void
*/
public function removeServer(ServerInterface $server): void
{
$server->close();
@ -44,6 +111,11 @@ class CommandBus implements CommandBusInterface
$this->servers->detach($server);
}
/**
* Close and shutdown the servers
*
* @return void
*/
public function close(): void
{
foreach ($this->servers as $server) {
@ -106,7 +178,7 @@ class CommandBus implements CommandBusInterface
private function executeContext(Context $context): PromiseInterface
{
$command = $this->commandRegistry->find($context->getCommandName());
$command = $this->findCommand($context->getCommandName());
if (!$command) return new Promise(function (callable $resolve) use ($context) {
throw new \RuntimeException("Unable to resolve command: ".$context->getCommandName());
});

View File

@ -38,8 +38,8 @@ class CommandBusClient implements CommandBusInterface
{
$this->commandRegistry = $commandRegistry;
if ($commandRegistry) {
$commandRegistry->on(CommandRegistry::EVENT_REGISTERED, $this->onCommandRegistered(...));
$commandRegistry->on(CommandRegistry::EVENT_UNREGISTERED, $this->onCommandUnregistered(...));
$this->commandRegistry->on(CommandRegistry::EVENT_REGISTERED, $this->onCommandRegistered(...));
$this->commandRegistry->on(CommandRegistry::EVENT_UNREGISTERED, $this->onCommandUnregistered(...));
}
$this->connector = $connector??new TcpConnector();
}

View File

@ -8,7 +8,7 @@ use Evenement\EventEmitterTrait;
* A collection of commands that can be executed via CommandBusInterface
*
*/
class CommandRegistry implements EventEmitterInterface
class CommandRegistry implements CommandResolverInterface, EventEmitterInterface
{
use EventEmitterTrait;
@ -40,12 +40,12 @@ class CommandRegistry implements EventEmitterInterface
$this->emit(self::EVENT_UNREGISTERED, [ $command ]);
}
public function find(string $command): ?Command
public function findCommand(string $command): ?Command
{
return $this->commands[$command] ?? null;
}
public function getNames(): array
public function getCommandNames(): array
{
return array_keys($this->commands);
}

View File

@ -0,0 +1,19 @@
<?php
namespace NoccyLabs\React\CommandBus;
use Evenement\EventEmitterInterface;
use Evenement\EventEmitterTrait;
/**
* A collection of commands that can be executed via CommandBusInterface
*
*/
interface CommandResolverInterface
{
public function findCommand(string $command): ?Command;
public function getCommandNames(): array;
}

View File

@ -0,0 +1,53 @@
<?php
namespace NoccyLabs\React\CommandBus;
use Evenement\EventEmitterInterface;
use Evenement\EventEmitterTrait;
/**
* A collection of commands that can be executed via CommandBusInterface
*
*/
trait CommandResolverTrait implements EventEmitterInterface
{
use EventEmitterTrait;
const EVENT_REGISTERED = 'registered';
const EVENT_UNREGISTERED = 'unregistered';
/** @var array<string,Command> */
private array $commands = [];
public function registerCommand(string $command, callable $handler): void
{
$isNew = !array_key_exists($command, $this->commands);
$this->commands[$command] = new Command($command, $handler);
if ($isNew) {
$this->emit(self::EVENT_REGISTERED, [ $command ]);
}
}
public function unregisterCommand(string $command): void
{
if (!array_key_exists($command, $this->commands)) {
return;
}
unset($this->commands[$command]);
$this->emit(self::EVENT_UNREGISTERED, [ $command ]);
}
public function findCommand(string $command): ?Command
{
return $this->commands[$command] ?? null;
}
public function getCommandNames(): array
{
return array_keys($this->commands);
}
}

View File

@ -48,8 +48,8 @@ class CommandRegistryTest extends \PHPUnit\Framework\TestCase
$reg->register('a', $cmda);
$reg->register('b', $cmdb);
$this->assertEquals('a', $reg->find('a')?->getName());
$this->assertEquals('b', $reg->find('b')?->getName());
$this->assertEquals('a', $reg->findCommand('a')?->getName());
$this->assertEquals('b', $reg->findCommand('b')?->getName());
}
public function testGettingCommandNames()
@ -61,7 +61,7 @@ class CommandRegistryTest extends \PHPUnit\Framework\TestCase
$reg->register('a', $cmda);
$reg->register('b', $cmdb);
$this->assertEquals(['a','b'], $reg->getNames());
$this->assertEquals(['a','b'], $reg->getCommandNames());
}
}