[FrameworkBundle] [Console][DX] add a warning when command is not found #26290
Conversation
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
52a9c9c to
dcfa734
Compare
|
Qualifies as a bug since an exception was thrown before 3.4, breaking the whole console with a clear stack trace, currently you have no information at all. |
chalasr
reviewed
Feb 23, 2018
| throw new CommandNotRegisteredException(implode(' | ||
| ', $errors), 0, $e); | ||
| } | ||
| throw $e; |
There was a problem hiding this comment.
IMO we should just call renderRegistrationErrors() before callingfind().
|
We can’t do that because of input and ouput we don’t have them
Le ven. 23 févr. 2018 à 20:08, Robin Chalas <notifications@github.com> a
écrit :
… ***@***.**** commented on this pull request.
------------------------------
In src/Symfony/Bundle/FrameworkBundle/Console/Application.php
<#26290 (comment)>:
> @@ -91,7 +93,18 @@ public function find($name)
{
$this->registerCommands();
- return parent::find($name);
+ try {
+ return parent::find($name);
+ } catch (CommandNotFoundException $e) {
+ if ($this->registrationErrors) {
+ foreach ($this->registrationErrors as $error) {
+ $errors[] = $error->getMessage();
+ }
+ throw new CommandNotRegisteredException(implode('
+ ', $errors), 0, $e);
+ }
+ throw $e;
IMO we should just call renderRegistrationErrors() before callingfind().
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#26290 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ADSq8rH-L4mX5Tdfb4REbJKzvxDsO0b_ks5tXwy5gaJpZM4SRR46>
.
|
|
if i get this right, wrapping the public function doRun(...)
{
// ...
try {
return parent::doRun($input, $output);
} catch (CommandNotFoundException $e) {
if ($this->registrationErrors) {
$this->renderRegistrationErrors($input, $output);
}
throw $e;
}
} |
|
Thanks @chr-hertel ! it's clearly better than what I thought. |
e24222f to
0f93cbd
Compare
chr-hertel
reviewed
Feb 24, 2018
| return parent::find($name); | ||
| try { | ||
| return parent::find($name); | ||
| } catch (CommandNotFoundException $e) { |
There was a problem hiding this comment.
this is not needed anymore when catching in doRun(...), is it?
0f93cbd to
ecefeec
Compare
chalasr
reviewed
Feb 25, 2018
| } | ||
|
|
||
| throw $e; | ||
| } |
There was a problem hiding this comment.
instead we can just call $this->registerCommands() before the if above
| $container = new ContainerBuilder(); | ||
| $container->register('event_dispatcher', EventDispatcher::class); | ||
| $container->register(ThrowingCommand::class, ThrowingCommand::class); | ||
| $container->setParameter('console.command.ids', array(ThrowingCommand::class => ThrowingCommand::class)); |
There was a problem hiding this comment.
the throwing command is not necessary for this test
| @@ -165,6 +165,37 @@ public function testRunOnlyWarnsOnUnregistrableCommand() | ||
| $this->assertContains('fine', $output); | ||
| } | ||
|
|
||
| public function testRunOnlyWarnsOnNoName() |
There was a problem hiding this comment.
testRegistrationErrorsAreDisplayedOnCommandNotFound
| $this->assertSame(1, $tester->getStatusCode()); | ||
| $this->assertContains('Some commands could not be registered:', $output); | ||
| $this->assertContains('throwing', $output); | ||
| $this->assertContains('fine', $output); |
|
|
||
| $tester = new ApplicationTester($application); | ||
| $tester->run(array('command' => 'fine')); | ||
| $tester->getOutput(); |
| $message = sprintf("[WARNING] Some commands could not be registered: \n %s", $message); | ||
| parent::__construct($message, $previous instanceof CommandNotFoundException ? $previous->getAlternatives() : array(), $code, $previous); | ||
| } | ||
| } |
c26aa09 to
84940c5
Compare
84940c5 to
efd8f7f
Compare
|
Status: Needs Review |
chalasr
approved these changes
Feb 26, 2018
fabpot
approved these changes
Feb 27, 2018
|
Thank you @Simperfit. |
fabpot
added a commit
that referenced
this pull request
Feb 27, 2018
… is not found (Simperfit) This PR was merged into the 3.4 branch. Discussion ---------- [FrameworkBundle] [Console][DX] add a warning when command is not found | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- don't forget to update UPGRADE-*.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | none | License | MIT | Doc PR | This PR add DX on the the console `find()` and `get()` methods when a command is not found because it has not been registered properly. Commits ------- efd8f7f [FrameworkBundle] [Console] add a warning when command is not found
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR add DX on the the console
find()andget()methods when a command is not found because it has not been registered properly.