[Messenger] Select alternatives on missing receiver arg or typo #27230

yceruto · 2018-05-10T21:42:01Z

Q	A
Branch?	4.1
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

If there is more than one receiver available - bin/console messenger:consume-messages:

If typo and there is similarities - bin/console messenger:consume-messages amq:

requires #27224

ogizanagi · 2018-05-11T06:22:45Z

src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php


-    public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, string $defaultReceiverName = null)
+    public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, array $receiverNames = null)


I think keeping the defaultReceiver argument would be better than arbitrary selecting the first one.

As we don't have default receiver by definition I'm selecting the first one and the only one when there is just one receiver... but I guess out-of-the-box could makes sense set a default one among several... still worth it?

I think we should never select a default ourself if many receivers are available. Within the fwb, this means just exposing the whole list except when there is only one receiver.
Without, it's the developper responsibility to set one.
I feel like selecting arbitrary the first receiver is against DX.

(but, interactively in the command, the choice question could have a default, as it still requires validating it)

But as far as I understand the code now, it only selects the first one only if there is only one receiver, so that works well.

😅 good point. I missed that.
I guess everything is fine then 😛

Small tweak in the test to prove it https://github.com/symfony/symfony/pull/27230/files#diff-9a060054c9ccf980baeb5ee6e153c5a2R34

ogizanagi · 2018-05-11T06:23:10Z

src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php

@@ -183,8 +182,12 @@ private function registerReceivers(ContainerBuilder $container)
            }
        }

-        if (1 === \count($taggedReceivers) && $container->hasDefinition('console.command.messenger_consume_messages')) {
-            $container->getDefinition('console.command.messenger_consume_messages')->replaceArgument(3, (string) current($receiverMapping));
+        if ($container->hasDefinition('console.command.messenger_consume_messages')) {


Relates to above, I think we should only have the default defined if there is just one like in removed lines (but still inject all names independently for interactivity)

yceruto · 2018-05-11T13:31:45Z

Rebased and ready.

sroze · 2018-05-11T14:34:19Z

I’m afraid that such interaction would cause troubles when developers add another transport but forget to update their worker script: it would prompt the transport same rather than failing so their monitoring wouldn’t pick it up (obsly when they run the worker somewhere that “supports” interactions).

…

On Fri, 11 May 2018 at 15:49, Yonel Ceruto ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php <#27230 (comment)>: > - public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, string $defaultReceiverName = null) + public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, array $receiverNames = null) Small tweak in the test to prove it https://github.com/symfony/symfony/pull/27230/files#diff-9a060054c9ccf980baeb5ee6e153c5a2R34 — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#27230 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxHEdd8CzFRKR22oPaINOQvF8kCsVdcks5txZcFgaJpZM4T6mOr> .

ogizanagi · 2018-05-11T14:45:18Z

Is that really an issue?
I think the best practice for scripts is to always use --no-interaction and define all arguments.

yceruto · 2018-05-11T15:10:32Z

I agree completely with @ogizanagi.

It's really useful only for development. In production you must always configure the receiver argument without interaction.

yceruto · 2018-05-14T13:02:58Z

What about to disable the interaction mode on debug false ?

sroze · 2018-05-14T17:48:44Z

That is a great idea 👍

…

On Mon, 14 May 2018 at 14:03, Yonel Ceruto ***@***.***> wrote: What about to disable the interaction mode on debug false ? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#27230 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxHEWJSWIwIUwOFN3eRp-1ZtH9mJd61ks5tyYCIgaJpZM4T6mOr> .

ogizanagi · 2018-05-14T17:55:48Z

That would still not solve the case the dev adds a receiver where previously there was only one and the script calls the command without explicit arguments (hence fails). So, also make the argument required if no debug?
Then it's probably semantically more correct to inject a default in the constructor rather than a $debug argument?
Disabling interaction on debug false isn't really something we do.
Again, do we really care?

sroze · 2018-05-14T19:27:58Z

src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php

@@ -134,4 +158,21 @@ private function convertToBytes(string $memoryLimit): int

        return $max;
    }
+
+    private function findAlternatives($name, array $collection)


Isn't this already somewhere else? Can't we share instead of copy? Maybe at least reference the other occurrences if it has been pasted so we know when maintaining it?

Yes, from debug command of the Form component, but still there is other places where similar procedure has been used, probably a trait could be created for such cases.

We don"t have a central place for such logic for 2 reasons: it's small enough and we don't want to create a "util" component.

@fabpot a good practice can be to add a comment that refers to the place it was copy/pasted from.

sroze · 2018-05-17T07:19:23Z

Thank you @yceruto.

…g or typo (yceruto) This PR was merged into the 4.1 branch. Discussion ---------- [Messenger] Select alternatives on missing receiver arg or typo | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - If there is more than one receiver available - `bin/console messenger:consume-messages`: ![messenger_consume_missing](https://user-images.githubusercontent.com/2028198/39895594-d4f652c6-5478-11e8-87cf-a1e08e681320.png) If typo and there is similarities - `bin/console messenger:consume-messages amq`: ![messenger_consume_typo](https://user-images.githubusercontent.com/2028198/39895599-d9f0705e-5478-11e8-9d6b-59d62930d4cb.png) requires #27224 Commits ------- 54c2541 Select alternatives on missing receiver arg or typo

carsonbot added Status: Needs Review Messenger Feature labels May 10, 2018

ogizanagi reviewed May 11, 2018

View reviewed changes

yceruto force-pushed the messenger_consume_cmd branch from 5f702be to 4c98ba8 Compare May 11, 2018 13:19

Select alternatives on missing receiver arg or typo

54c2541

yceruto force-pushed the messenger_consume_cmd branch from 4c98ba8 to 54c2541 Compare May 11, 2018 13:47

nicolas-grekas added this to the 4.1 milestone May 11, 2018

sroze added the DX DX = Developer eXperience (anything that improves the experience of using Symfony) label May 14, 2018

sroze approved these changes May 14, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 14, 2018

ogizanagi approved these changes May 15, 2018

View reviewed changes

sroze merged commit 54c2541 into symfony:4.1 May 17, 2018

yceruto deleted the messenger_consume_cmd branch May 17, 2018 10:58

fabpot mentioned this pull request May 21, 2018

Release v4.1.0-BETA2 #27331

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Messenger] Select alternatives on missing receiver arg or typo #27230

[Messenger] Select alternatives on missing receiver arg or typo #27230

yceruto commented May 10, 2018 •

edited

Loading

ogizanagi May 11, 2018

yceruto May 11, 2018

ogizanagi May 11, 2018 •

edited

Loading

sroze May 11, 2018

ogizanagi May 11, 2018

yceruto May 11, 2018

ogizanagi May 11, 2018

yceruto commented May 11, 2018

sroze commented May 11, 2018 via email

ogizanagi commented May 11, 2018

yceruto commented May 11, 2018 •

edited

Loading

yceruto commented May 14, 2018

sroze commented May 14, 2018 via email

ogizanagi commented May 14, 2018

sroze May 14, 2018

yceruto May 14, 2018

fabpot May 15, 2018

sroze May 17, 2018

sroze commented May 17, 2018


		public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, string $defaultReceiverName = null)
		public function __construct(MessageBusInterface $bus, ContainerInterface $receiverLocator, LoggerInterface $logger = null, array $receiverNames = null)

[Messenger] Select alternatives on missing receiver arg or typo #27230

[Messenger] Select alternatives on missing receiver arg or typo #27230

Conversation

yceruto commented May 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi May 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yceruto commented May 11, 2018

sroze commented May 11, 2018 via email

ogizanagi commented May 11, 2018

yceruto commented May 11, 2018 • edited Loading

yceruto commented May 14, 2018

sroze commented May 14, 2018 via email

ogizanagi commented May 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze commented May 17, 2018

yceruto commented May 10, 2018 •

edited

Loading

ogizanagi May 11, 2018 •

edited

Loading

yceruto commented May 11, 2018 •

edited

Loading