bug #28638 [Console] Fix clearing sections containing questions (chal…

…asr)

This PR was merged into the 4.1 branch.

Discussion
----------

[Console] Fix clearing sections containing questions

| Q             | A
| ------------- | ---
| Branch?       | 4.1
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #28615
| License       | MIT
| Doc PR        | n/a

Given:
```php
$section = $output->section();
$question = "What's your name?";
$name = (new QuestionHelper())->ask($input, $section, new Question($question));
$section->clear();
$section->writeln("$question (<info>$name</info>)");
```

Before:
![](https://i.imgur.com/nJdKXAo.gif)

After:
![](https://i.imgur.com/WdMtKvV.gif)

Commits
-------

81ec57d [Console] Fix clearing sections containing questions

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

@@ -17,6 +17,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\StreamableInputInterface;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
+use Symfony\Component\Console\Output\ConsoleSectionOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Question\Question;
@@ -123,6 +124,10 @@ private function doAsk(OutputInterface $output, Question $question)
             $ret = trim($this->autocomplete($output, $question, $inputStream, \is_array($autocomplete) ? $autocomplete : iterator_to_array($autocomplete, false)));
         }
 
+        if ($output instanceof ConsoleSectionOutput) {
+            $output->addContent($ret);
+        }
+
         $ret = \strlen($ret) > 0 ? $ret : $question->getDefault();
 
         if ($normalizer = $question->getNormalizer()) {

src/Symfony/Component/Console/Output/ConsoleSectionOutput.php

@@ -77,6 +77,18 @@ public function getContent(): string
         return implode('', $this->content);
     }
 
+    /**
+     * @internal
+     */
+    public function addContent(string $input)
+    {
+        foreach (explode(PHP_EOL, $input) as $lineContent) {
+            $this->lines += ceil($this->getDisplayLength($lineContent) / $this->terminal->getWidth()) ?: 1;
+            $this->content[] = $lineContent;
+            $this->content[] = PHP_EOL;
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -88,11 +100,7 @@ protected function doWrite($message, $newline)
 
         $erasedContent = $this->popStreamContentUntilCurrentSection();
 
-        foreach (explode(PHP_EOL, $message) as $lineContent) {
-            $this->lines += ceil($this->getDisplayLength($lineContent) / $this->terminal->getWidth()) ?: 1;
-            $this->content[] = $lineContent;
-            $this->content[] = PHP_EOL;
-        }
+        $this->addContent($message);
 
         parent::doWrite($message, true);
         parent::doWrite($erasedContent, false);

src/Symfony/Component/Console/Tests/Output/ConsoleSectionOutputTest.php

@@ -13,17 +13,20 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Formatter\OutputFormatter;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\StreamableInputInterface;
 use Symfony\Component\Console\Output\ConsoleSectionOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Output\StreamOutput;
+use Symfony\Component\Console\Question\Question;
 
 class ConsoleSectionOutputTest extends TestCase
 {
     private $stream;
 
     protected function setUp()
     {
-        $this->stream = fopen('php://memory', 'r+', false);
+        $this->stream = fopen('php://memory', 'r+b', false);
     }
 
     protected function tearDown()
@@ -137,4 +140,24 @@ public function testMultipleSectionsOutput()
         rewind($output->getStream());
         $this->assertEquals('Foo'.PHP_EOL.'Bar'.PHP_EOL."\x1b[2A\x1b[0JBar".PHP_EOL."\x1b[1A\x1b[0JBaz".PHP_EOL.'Bar'.PHP_EOL."\x1b[1A\x1b[0JFoobar".PHP_EOL, stream_get_contents($output->getStream()));
     }
+
+    public function testClearSectionContainingQuestion()
+    {
+        $inputStream = fopen('php://memory', 'r+b', false);
+        fwrite($inputStream, "Batman & Robin\n");
+        rewind($inputStream);
+
+        $input = $this->getMockBuilder(StreamableInputInterface::class)->getMock();
+        $input->expects($this->once())->method('isInteractive')->willReturn(true);
+        $input->expects($this->once())->method('getStream')->willReturn($inputStream);
+
+        $sections = array();
+        $output = new ConsoleSectionOutput($this->stream, $sections, OutputInterface::VERBOSITY_NORMAL, true, new OutputFormatter());
+
+        (new QuestionHelper())->ask($input, $output, new Question('What\'s your favorite super hero?'));
+        $output->clear();
+
+        rewind($output->getStream());
+        $this->assertSame('What\'s your favorite super hero?'.PHP_EOL."\x1b[2A\x1b[0J", stream_get_contents($output->getStream()));
+    }
 }