Skip to content

[Console] fix clear of section with question #48897

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

Merged
merged 1 commit into from
Feb 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Symfony/Component/Console/Output/ConsoleSectionOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ public function addContent(string $input, bool $newline = true): int
// re-add the line break (that has been removed in the above `explode()` for
// - every line that is not the last line
// - if $newline is required, also add it to the last line
if ($i < $count || $newline) {
// - if it's not new line, but input ending with `\PHP_EOL`
if ($i < $count || $newline || str_ends_with($input, \PHP_EOL)) {
$lineContent .= \PHP_EOL;
}

Expand Down Expand Up @@ -149,6 +150,15 @@ public function addContent(string $input, bool $newline = true): int
return $linesAdded;
}

/**
* @internal
*/
public function addNewLineOfInputSubmit()
{
$this->content[] = \PHP_EOL;
++$this->lines;
}

protected function doWrite(string $message, bool $newline)
{
if (!$this->isDecorated()) {
Expand Down
6 changes: 6 additions & 0 deletions src/Symfony/Component/Console/Style/SymfonyStyle.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\ConsoleSectionOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\TrimmedBufferOutput;
use Symfony\Component\Console\Question\ChoiceQuestion;
Expand Down Expand Up @@ -298,6 +299,11 @@ public function askQuestion(Question $question): mixed
$answer = $this->questionHelper->ask($this->input, $this, $question);

if ($this->input->isInteractive()) {
if ($this->output instanceof ConsoleSectionOutput) {
// add the new line of the `return` to submit the input to ConsoleSectionOutput, because ConsoleSectionOutput is holding all it's lines.
// this is relevant when a `ConsoleSectionOutput::clear` is called.
$this->output->addNewLineOfInputSubmit();
}
$this->newLine();
$this->bufferedOutput->write("\n");
}
Expand Down
42 changes: 42 additions & 0 deletions src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Formatter\OutputFormatter;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\Input;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\ConsoleSectionOutput;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\StreamOutput;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Console\Tester\CommandTester;

Expand Down Expand Up @@ -181,4 +183,44 @@ public function testMemoryConsumption()

$this->assertSame(0, memory_get_usage() - $start);
}

public function testAskAndClearExpectFullSectionCleared()
{
$answer = 'Answer';
$inputStream = fopen('php://memory', 'r+');
fwrite($inputStream, $answer.\PHP_EOL);
rewind($inputStream);
$input = $this->createMock(Input::class);
$sections = [];
$output = new ConsoleSectionOutput(fopen('php://memory', 'r+', false), $sections, StreamOutput::VERBOSITY_NORMAL, true, new OutputFormatter());
$input
->method('isInteractive')
->willReturn(true);
$input
->method('getStream')
->willReturn($inputStream);

$style = new SymfonyStyle($input, $output);

$style->writeln('start');
$style->write('foo');
$style->writeln(' and bar');
$givenAnswer = $style->ask('Dummy question?');
$style->write('foo2'.\PHP_EOL);
$output->write('bar2');
$output->clear();

rewind($output->getStream());
$this->assertEquals($answer, $givenAnswer);
$this->assertEquals(
'start'.\PHP_EOL. // write start
'foo'.\PHP_EOL. // write foo
"\x1b[1A\x1b[0Jfoo and bar".\PHP_EOL. // complete line
\PHP_EOL.\PHP_EOL." \033[32mDummy question?\033[39m:".\PHP_EOL.' > '.\PHP_EOL.\PHP_EOL.\PHP_EOL. // question
'foo2'.\PHP_EOL.\PHP_EOL. // write foo2
'bar2'.\PHP_EOL. // write bar
"\033[12A\033[0J", // clear 12 lines (11 output lines and one from the answer input return)
stream_get_contents($output->getStream())
);
}
}