[Console] fix a bug when you are passing a default value and passing -n would output the index #25521

Simperfit · 2017-12-16T05:47:16Z

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

We are fixing a bug when you are using a default value with -n, it would output the index instead of the value.

Simple reproducer Simperfit/symfony-reproducer@5079dd1?diff=split#diff-77efcc28bc5309e1af9ac07a1e073009R40

sroze

You are missing a test sir!

sroze · 2017-12-16T10:07:24Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

@@ -44,7 +44,13 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu
            $output = $output->getErrorOutput();
        }

-        if (!$input->isInteractive()) {
+        $isInteractive = !$input->isInteractive();


$isNotInteractive ?

sroze · 2017-12-16T10:09:05Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

-        if (!$input->isInteractive()) {
+        $isInteractive = !$input->isInteractive();
+
+        if ($isInteractive && $question instanceof ChoiceQuestion) {


Or I think that you should just put if ($question instanceof ChoiceQuestion) { within the existing if (!$input->isInteractive()) {.

shouldn’t the ChoiceQuestion itself take care of returning the correct default value ?

I don't know if we should nest theses ifs, IMO its clearer like this.

@mathroc I wanted to it like this firstly but it's hard since the getDefault is called without the choices being changed.

Nvm @sroze you are right, it avoids one test for nothing.

Simperfit · 2017-12-16T11:48:07Z

Test added

Simperfit · 2017-12-16T11:50:33Z

Status: Needs Review

mathroc · 2017-12-16T11:56:56Z

src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php

@@ -84,6 +84,10 @@ public function testAskChoice()
        $question->setMultiselect(true);

        $this->assertEquals(array('Superman', 'Batman'), $questionHelper->ask($this->createInputInterfaceMock(), $this->createOutputInterface(), $question));
+
+        $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, 0);
+        // We are supposed to get the default value since we are in interactive mode


since we are not in interactive mode

Thanks! forgot that little word :p

mathroc · 2017-12-16T12:01:26Z

thx @Simperfit to have taken a look at this. there’s still something odd.

I’m not sure the default value passed to the question should be its key, the doc comment says @param mixed $default The default answer to return so maybe the problem is instead that SymfonyStyle is converting the default value to its key

ps: but to be fair, that’s what the documentation is doing

Simperfit · 2017-12-16T12:05:15Z

@mathroc SymfonyStyle is transforming this array. So it has value -> key. This fixes both behaviour when passing the key or the value look at the reproducer i've done to be sure that nothing will be broken : Simperfit/symfony-reproducer@b37a2a5

…-n would ouput the index

Simperfit · 2017-12-16T12:30:56Z

Travis failure is unrelated

nicolas-grekas · 2017-12-18T19:55:50Z

Thank you @Simperfit.

…nd passing -n would output the index (Simperfit) This PR was merged into the 2.7 branch. Discussion ---------- [Console] fix a bug when you are passing a default value and passing -n would output the index | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no  | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | #25470 | License | MIT | Doc PR | We are fixing a bug when you are using a default value with -n, it would output the index instead of the value. Simple reproducer Simperfit/symfony-reproducer@5079dd1?diff=split#diff-77efcc28bc5309e1af9ac07a1e073009R40 Commits ------- 41ffc69 [Console] fix a bug when you are passing a default value and passing -n would ouput the index

This is how the QuestionHelper API was intended to be used, but it only has been so since a recent bugfix. See symfony/symfony#25521 Fixes Behat#1151

carsonbot added Status: Needs Review Console Bug labels Dec 16, 2017

sroze suggested changes Dec 16, 2017

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Dec 16, 2017

Simperfit force-pushed the bugfix/fix-a-wrong-output-when-passing-in-interactive-mode branch 2 times, most recently from 338c78d to 56ccf18 Compare December 16, 2017 11:44

Simperfit changed the base branch from master to 2.7 December 16, 2017 11:46

Simperfit force-pushed the bugfix/fix-a-wrong-output-when-passing-in-interactive-mode branch from 56ccf18 to 066108a Compare December 16, 2017 11:47

carsonbot added Status: Needs Review and removed Status: Needs Work labels Dec 16, 2017

mathroc reviewed Dec 16, 2017

View reviewed changes

Simperfit force-pushed the bugfix/fix-a-wrong-output-when-passing-in-interactive-mode branch 3 times, most recently from f878424 to 0704f80 Compare December 16, 2017 12:11

[Console] fix a bug when you are passing a default value and passing …

41ffc69

…-n would ouput the index

Simperfit force-pushed the bugfix/fix-a-wrong-output-when-passing-in-interactive-mode branch from 0704f80 to 41ffc69 Compare December 16, 2017 12:12

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 17, 2017

chalasr approved these changes Dec 17, 2017

View reviewed changes

xabbuh approved these changes Dec 18, 2017

View reviewed changes

nicolas-grekas added this to the 2.7 milestone Dec 18, 2017

nicolas-grekas merged commit 41ffc69 into symfony:2.7 Dec 18, 2017

Simperfit deleted the bugfix/fix-a-wrong-output-when-passing-in-interactive-mode branch December 19, 2017 07:59

This was referenced Jan 5, 2018

Release v2.7.40 #25688

Merged

Release v2.8.33 #25689

Merged

Release v3.3.15 #25690

Merged

Release v3.4.3 #25691

Merged

Release v4.0.3 #25692

Merged

jakzal mentioned this pull request May 21, 2018

Undefined index with question helper Behat/Behat#1151

Closed

greg0ire added a commit to greg0ire/Behat that referenced this pull request May 21, 2018

Use the key to provide a default

e17fd6f

This is how the QuestionHelper API was intended to be used, but it only has been so since a recent bugfix. See symfony/symfony#25521 Fixes Behat#1151

greg0ire mentioned this pull request May 21, 2018

Use key Behat/Behat#1152

Merged

greg0ire added a commit to greg0ire/Behat that referenced this pull request May 21, 2018

Use a valid key as the default

c99092a

This is how the QuestionHelper API was intended to be used, but it only has been so since a recent bugfix. See symfony/symfony#25521 Fixes Behat#1151

greg0ire added a commit to greg0ire/Behat that referenced this pull request May 21, 2018

Use a valid key as the default

7581001

This is how the QuestionHelper API was intended to be used, but it only has been so since a recent bugfix. See symfony/symfony#25521 Fixes Behat#1151

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Console] fix a bug when you are passing a default value and passing -n would output the index #25521

[Console] fix a bug when you are passing a default value and passing -n would output the index #25521

Uh oh!

Simperfit commented Dec 16, 2017 •

edited

Loading

Uh oh!

sroze left a comment

Uh oh!

sroze Dec 16, 2017

Uh oh!

sroze Dec 16, 2017

Uh oh!

mathroc Dec 16, 2017

Uh oh!

Simperfit Dec 16, 2017

Uh oh!

Simperfit Dec 16, 2017 •

edited

Loading

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

mathroc Dec 16, 2017

Uh oh!

Simperfit Dec 16, 2017

Uh oh!

mathroc commented Dec 16, 2017 •

edited

Loading

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

nicolas-grekas commented Dec 18, 2017

Uh oh!

Uh oh!

Uh oh!

[Console] fix a bug when you are passing a default value and passing -n would output the index #25521

[Console] fix a bug when you are passing a default value and passing -n would output the index #25521

Uh oh!

Conversation

Simperfit commented Dec 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sroze left a comment

Choose a reason for hiding this comment

Uh oh!

sroze Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

sroze Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

mathroc Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

Simperfit Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

Simperfit Dec 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

mathroc Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

Simperfit Dec 16, 2017

Choose a reason for hiding this comment

Uh oh!

mathroc commented Dec 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

Simperfit commented Dec 16, 2017

Uh oh!

nicolas-grekas commented Dec 18, 2017

Uh oh!

Uh oh!

Simperfit commented Dec 16, 2017 •

edited

Loading

Simperfit Dec 16, 2017 •

edited

Loading

mathroc commented Dec 16, 2017 •

edited

Loading