-
-
Notifications
You must be signed in to change notification settings - Fork 32
Introduce handler resolver #327
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
Open
vjik
wants to merge
2
commits into
master
Choose a base branch
from
message-handler-resolver
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+393
−272
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Queue\Message\Handler; | ||
|
|
||
| use Yiisoft\Queue\Message\MessageInterface; | ||
|
|
||
| /** | ||
| * Handles a message by invoking the given callable. | ||
| * | ||
| * @psalm-type MessageHandlerCallable = callable(MessageInterface $message): void | ||
| */ | ||
| final class CallableHandler implements HandlerInterface | ||
| { | ||
| /** | ||
| * @param callable $handler Callable invoked to handle a message. | ||
| * Format: `function (MessageInterface $message): void`. | ||
| * | ||
| * @psalm-param MessageHandlerCallable $handler | ||
| */ | ||
| public function __construct( | ||
| private readonly mixed $handler, | ||
| ) {} | ||
|
|
||
| public function handle(MessageInterface $message): void | ||
| { | ||
| ($this->handler)($message); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Queue\Message\Handler; | ||
|
|
||
| use Yiisoft\Queue\Message\MessageInterface; | ||
|
|
||
| /** | ||
| * Handles a message. | ||
| */ | ||
| interface HandlerInterface | ||
| { | ||
| /** | ||
| * Handle the given message. | ||
| */ | ||
| public function handle(MessageInterface $message): void; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Queue\Message\Handler\Resolver; | ||
|
|
||
| use LogicException; | ||
| use Throwable; | ||
|
|
||
| use function sprintf; | ||
|
|
||
| /** | ||
| * Thrown when a handler for the given message type is not found. | ||
| */ | ||
| final class HandlerNotFoundException extends LogicException | ||
| { | ||
| public function __construct(string $messageType, int $code = 0, ?Throwable $previous = null) | ||
| { | ||
| parent::__construct( | ||
| sprintf('Queue handler for message type "%s" does not exist.', $messageType), | ||
| $code, | ||
| $previous, | ||
| ); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Queue\Message\Handler\Resolver; | ||
|
|
||
| use Psr\Container\ContainerInterface; | ||
| use Yiisoft\Queue\Message\Handler\CallableHandler; | ||
| use Yiisoft\Queue\Message\Handler\HandlerInterface; | ||
| use Yiisoft\Queue\Message\MessageInterface; | ||
| use Yiisoft\Queue\Middleware\CallableFactory; | ||
| use Yiisoft\Queue\Middleware\InvalidCallableConfigurationException; | ||
|
|
||
| use function array_key_exists; | ||
| use function is_string; | ||
|
|
||
| /** | ||
| * Resolves message handlers from configuration, a DI container, or a callable factory. | ||
| */ | ||
| final class HandlerResolver implements HandlerResolverInterface | ||
| { | ||
| /** @var array<non-empty-string, HandlerInterface> Cache of resolved handlers */ | ||
| private array $cache = []; | ||
|
|
||
| public function __construct( | ||
| /** @var array<non-empty-string, array|callable|object|string|null> */ | ||
| private readonly array $handlers, | ||
| private readonly ContainerInterface $container, | ||
| private readonly CallableFactory $callableFactory, | ||
| ) {} | ||
|
|
||
| public function resolve(string $messageType): HandlerInterface | ||
| { | ||
| if ($messageType === '') { | ||
| throw new HandlerNotFoundException($messageType); | ||
| } | ||
|
|
||
| if (array_key_exists($messageType, $this->cache)) { | ||
| return $this->cache[$messageType]; | ||
| } | ||
|
|
||
| $definition = $this->handlers[$messageType] ?? $messageType; | ||
|
|
||
| if (is_string($definition) && $this->container->has($definition)) { | ||
| $resolved = $this->container->get($definition); | ||
|
|
||
| if ($resolved instanceof HandlerInterface) { | ||
| return $this->cache[$messageType] = $resolved; | ||
| } | ||
| } | ||
|
|
||
| try { | ||
| /** @psalm-var callable(MessageInterface): void $callable */ | ||
| $callable = $this->callableFactory->create($definition); | ||
|
|
||
| return $this->cache[$messageType] = new CallableHandler($callable); | ||
| } catch (InvalidCallableConfigurationException $exception) { | ||
| throw new HandlerNotFoundException($messageType, 0, $exception); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Queue\Message\Handler\Resolver; | ||
|
|
||
| use Yiisoft\Queue\Message\Handler\HandlerInterface; | ||
|
|
||
| /** | ||
| * Resolves a message type to a handler. | ||
| */ | ||
| interface HandlerResolverInterface | ||
| { | ||
| /** | ||
| * Get a handler for the given message type. | ||
| * | ||
| * @param string $messageType Message type. | ||
| * | ||
| * @throws HandlerNotFoundException If no handler exists for the message type. | ||
| */ | ||
| public function resolve(string $messageType): HandlerInterface; | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should use injector as it was previously.