Skip to content

Commit

Permalink
bug #30278 Remove unnecessary ProgressBar stdout writes (fixes flicke…
Browse files Browse the repository at this point in the history
…ring) (ostrolucky)

This PR was merged into the 3.4 branch.

Discussion
----------

Remove unnecessary ProgressBar stdout writes (fixes flickering)

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

Currently ProgressBar flickers when writing a lot.

![ezgif-4-ad817e1834](https://user-images.githubusercontent.com/496233/38173299-44482400-35bc-11e8-88b6-83b480d55905.gif)

This patch fixes it and it's buttery smooth now.

Additionally, this improves performance by 60%. Test code
```php
$maxSteps = 1000000;
$progressBar = new ProgressBar(new ConsoleOutput(), $maxSteps);
for ($i=0; $i<= $maxSteps; $i++) {
    $progressBar->advance();
}
```

Commits
-------

3fbcb96 Remove unnecessary ProgressBar stdout writes (fixes flickering)
  • Loading branch information
fabpot committed Feb 17, 2019
2 parents ce7afc2 + 3fbcb96 commit 488e9e5
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions src/Symfony/Component/Console/Helper/ProgressBar.php
Expand Up @@ -466,19 +466,16 @@ private function overwrite($message)
{
if ($this->overwrite) {
if (!$this->firstRun) {
// Move the cursor to the beginning of the line
$this->output->write("\x0D");

// Erase the line
$this->output->write("\x1B[2K");

// Erase previous lines
if ($this->formatLineCount > 0) {
$this->output->write(str_repeat("\x1B[1A\x1B[2K", $this->formatLineCount));
$message = str_repeat("\x1B[1A\x1B[2K", $this->formatLineCount).$message;
}

// Move the cursor to the beginning of the line and erase the line
$message = "\x0D\x1B[2K$message";
}
} elseif ($this->step > 0) {
$this->output->writeln('');
$message = PHP_EOL.$message;
}

$this->firstRun = false;
Expand Down

0 comments on commit 488e9e5

Please sign in to comment.